c.l.i.c.IConfigSchema(Interface) : interface documentation

Part of canonical.lazr.interfaces.config View In Hierarchy

Known subclasses: canonical.lazr.interfaces.config.IConfigData, canonical.lazr.interfaces.config.IStackableConfig

A process configuration schema.

The config file contains sections enclosed in square brackets ([]). The section name may be divided into major and minor categories using a dot (.). Beneath each section is a list of key-value pairs, separated by a colon (:). Multiple sections with the same major category may have their keys defined in another section that appends the '.template' suffix to the category name. A section with '.optional' suffix is not required. Lines that start with a hash (#) are comments.

Attribute	name	The basename of the config filename.
Attribute	filename	The path to config file
Attribute	category_names	The list of section category names.
Method	__iter__	Iterate over the `ISectionSchema`s.
Method	__contains__	Return True or False if the name matches a `ISectionSchema`.
Method	__getitem__	Return the `ISectionSchema` with the matching name.
Method	getByCategory	Return a list of ISectionSchemas that belong to the category name.

name =

The basename of the config filename.

filename =

The path to config file

category_names =

The list of section category names.

def __iter__():

Iterate over the `ISectionSchema`s.

def __contains__(name):

Return True or False if the name matches a ISectionSchema.

def __getitem__(name):

Return the ISectionSchema with the matching name.

Raises NoSectionError if the no ISectionSchema has the name.

def getByCategory(name):

Return a list of ISectionSchemas that belong to the category name.

ISectionSchema names may be made from a category name and a group name, separated by a dot (.). The category is synonymous with a arbitrary resource such as a database or a vhost. Thus database.bugs and database.answers are two sections that both use the database resource.

Raises CategoryNotFound if no sections have a name that starts with the category name.

API Documentation for Launchpad, generated by pydoctor at 2010-09-27 00:00:11.