Package stocks3 :: Package core :: Module config :: Class Configurable
[hide private]
[frames] | no frames]

Class Configurable

source code

Все класс, порожденные от этого класса, тем или иным образом создаются на основе конфигурации, хранящейся в XML-файле.

После инициализации объект этого класса получает в распоряжении дерево XML-файла - Configurable.tree.

Instance Methods [hide private]
 
__init__(self, tree, node) source code
 
makeConfig(self)
Должна быть переопределена в дочерних классах.
source code
 
createObjects(self, factory, path, *args)
Создает объекты, конфигурация которых прописана в ветке path.
source code
 
_get_nodes_by_path(self, path)
Возвращает список узлов по пути path.
source code
 
_get_node_by_path(self, path)
Возвращает узел по его адресу.
source code
 
readString(self, path, attrib=None, default=None)
Читает строку из файла конфигурации.
source code
 
readInt(self, path, attrib=None, default=None) source code
 
readFloat(self, path, attrib=None, default=None) source code
 
readBool(self, path, attrib=None, default=None) source code
Method Details [hide private]

__init__(self, tree, node)
(Constructor)

source code 
Parameters:
  • tree - XML-дерево.
  • node - XML-узел с конфигурацией для данного объекта.

makeConfig(self)

source code 

Должна быть переопределена в дочерних классах. Собственна эта функция и загружает конфигурацию из переданной нам ветки self.node.

createObjects(self, factory, path, *args)

source code 

Создает объекты, конфигурация которых прописана в ветке path.

Например:

  • source.createObjects(factories.transports,"../transports/transport")
Parameters:
  • factory (ConfigurableFactory) - Фабрика объектов.
  • path - Путь до узлов с конфигурацией.

_get_node_by_path(self, path)

source code 

Возвращает узел по его адресу.

Parameters:
  • path (xpath) - Адрес узла.
Raises:
  • ConfigurationError - Найдено больше или меньше одного узла.

readString(self, path, attrib=None, default=None)

source code 

Читает строку из файла конфигурации.

Parameters:
  • path (строка) - Адрес узла XML-файла.
  • attrib (строка) - Имя атрибута. Если имя атрибута не указано, то возвращается text.
  • default - Значение по умолчанию. Если искомый атрибут не найден и указано значение по умолчанию, то возвращается оно. Иначе генерируется исключение KeyError.

readInt(self, path, attrib=None, default=None)

source code 
Decorators:
  • @config_check_value

readFloat(self, path, attrib=None, default=None)

source code 
Decorators:
  • @config_check_value

readBool(self, path, attrib=None, default=None)

source code 
Decorators:
  • @config_check_value