Method declare

ddserver/config.py:55–88

Declare a section. The section declaration is a context manager where the context is a function, which can be used to declare a option. Example: with config_decl.declare('my_section') as my: my('my_option', conv = str, default = 'my_defa

(self, section_name)

  @contextlib.contextmanager
  def declare(self, section_name):
    ''' Declare a section.

        The section declaration is a context manager where the context is a
        function, which can be used to declare a option. Example:

        with config_decl.declare('my_section') as my:
          my('my_option',
             conv = str,
             default = 'my_default')
          ...
    '''

    # Create a section declaration if it does not exists
    if section_name not in self.__sections:
      section = self.__sections[section_name] = {}

    else:
      section = self.__sections[section_name]

    # The option declaration function returned as the context
    def declarator(option_name,
                   conv = str,
                   default = self.REQUIRED):
      # Check if the section already contains the option
      if option_name in section:
        raise KeyError('Duplicated option declaration %s:%s' % (section_name, option_name))

      # Add the option to the section
      self.__sections[section_name][option_name] = self.Option(conv = conv,
                                                               default = default)

    # Return the function as context
    yield declarator


  @property