← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/config/__init__.py

Added module ivle.config, which takes care of some work interfacing with
    configobj, including searching for the file and opening the object.
ivle.conf.conf now uses this instead of having its own search.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/config/__init__.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2009 The University of Melbourne
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
17
 
 
18
# Author: Matt Giuca, Will Grant
 
19
 
 
20
"""
 
21
Provides programmatic access to the IVLE configuration file.
 
22
"""
 
23
 
 
24
import os
 
25
 
 
26
from configobj import ConfigObj
 
27
 
 
28
__all__ = ["ConfigError", "Config"]
 
29
 
 
30
class ConfigError(Exception):
 
31
    """
 
32
    An error reading or writing the configuration file.
 
33
    """
 
34
    pass
 
35
 
 
36
def search_conffile():
 
37
    """
 
38
    Search for the config file, and return it as a filename.
 
39
    1. Environment var IVLECONF (full filename).
 
40
    2. ./etc/ivle.conf
 
41
    3. /etc/ivle/ivle.conf
 
42
    Raises a ConfigError on error.
 
43
    """
 
44
    if 'IVLECONF' in os.environ:
 
45
        fname = os.environ['IVLECONF']
 
46
        if os.path.exists(fname):
 
47
            return fname
 
48
    if os.path.exists('./etc/ivle.conf'):
 
49
        return './etc/ivle.conf'
 
50
    if os.path.exists('/etc/ivle/ivle.conf'):
 
51
        return '/etc/ivle/ivle.conf'
 
52
    raise ConfigError("Could not find IVLE config file")
 
53
 
 
54
class Config(ConfigObj):
 
55
    """
 
56
    The configuration object. Can be instantiated with no arguments (will
 
57
    implicitly find the ivle.conf file and load it).
 
58
    """
 
59
    def __init__(self, *args, **kwargs):
 
60
        conffile = search_conffile()
 
61
        super(Config, self).__init__(infile=conffile, *args, **kwargs)