1

"""

     2

    Support for loading config files with twisted.python.usage

     3

"""

     4

     5

from twisted.python import usage

     6

     7

import traceback

     8

     9

class ConfigMapper (dict) :

    10

    """

    11

        Provides access to a usage.Options's keys via python names.

    12

    """

    13

    14

    IGNORED_NAMES = ('__doc__', )

    15

    16

    def __init__ (self, opts, defaults=None) :

    17

        """

    18

            opts        - store the values from the config file into the given dict

    19

            defaults    - (optional) update any pre-exisitng values from the config file into the given dict

    20

        """

    21

    22

        self.opts = opts

    23

        self.defaults = defaults

    24

    25

        # temp. vars

    26

        self.locals = {}

    27

    28

    def optname (self, name) :

    29

        return name.replace('_', '-')

    30

    31

    def __getitem__ (self, name) :

    32

        """

    33

            Map from foo_bar -> foo-bar

    34

        """

    35

    36

        # translate

    37

        optname = self.optname(name)

    38

    39

        if optname in self.opts :

    40

            # normal long opt

    41

            return self.opts[optname]

    42

    43

        elif name in self.locals :

    44

            # temp local

    45

            return self.locals[name]

    46

    47

        else :

    48

            # unknown

    49

            raise NameError(name)

    50

    51

    def __setitem__ (self, name, value) :

    52

        """

    53

            Map from foo_bar -> foo-bar

    54

        """

    55

    56

        store = self.opts

    57

    58

        # filter out certain keys

    59

        if name in self.IGNORED_NAMES :

    60

            # skip things like __doc__

    61

            return

    62

    63

        # translate name

    64

        optname = self.optname(name)

    65

    66

        if optname in self.opts :

    67

            # normal long opt

    68

            name = optname

    69

    70

        else :

    71

            # store as a local

    72

            store = self.locals

    73

    74

        # store

    75

        store[name] = value

    76

    77

        if self.defaults is not None and name in self.defaults :

    78

            self.defaults[name] = value

    79

    80

class ConfigOptions (usage.Options) :

    81

    """

    82

        Provide a --config param to read in new values/defaults for any defined options from the given config file

    83

    """

    84

    85

    def opt_config (self, path) :

    86

        """

    87

            Read the given configuration file

    88

        """

    89

    90

        # set up env for the config module

    91

        globals = {}

    92

        locals = ConfigMapper(self.opts, self.defaults)

    93

    94

        try :

    95

            # run config

    96

            execfile(path, globals, locals)

    97

    98

        except :

    99

            # XXX: raising a usage.error prints out --help

   100

            raise usage.error("Error reading config file: %s\n%s" % (path, traceback.format_exc()))

   101

   102

    opt_c = opt_config

   103