zope.configuration.interfaces

class zope.configuration.interfaces.InvalidToken[source]

Invaid token in list.

interface zope.configuration.interfaces.IConfigurationContext[source]

Configuration Context

The configuration context manages information about the state of the configuration system, such as the package containing the configuration file. More importantly, it provides methods for importing objects and opening files relative to the package.

package

The current package name

This is the name of the package containing the configuration file being executed. If the configuration file was not included by package, then this is None.

resolve(dottedname)[source]

Resolve a dotted name to an object

A dotted name is constructed by concatenating a dotted module name with a global name within the module using a dot. For example, the object named “spam” in the foo.bar module has a dotted name of foo.bar.spam. If the current package is a prefix of a dotted name, then the package name can be relaced with a leading dot, So, for example, if the configuration file is in the foo package, then the dotted name foo.bar.spam can be shortened to .bar.spam.

If the current package is multiple levels deep, multiple leading dots can be used to refer to higher-level modules. For example, if the current package is x.y.z, the dotted object name ..foo refers to x.y.foo.

path(filename)[source]

Compute a full file name for the given file

If the filename is relative to the package, then the returned name will include the package path, otherwise, the original file name is returned.

checkDuplicate(filename)[source]

Check for duplicate imports of the same file.

Raises an exception if this file had been processed before. This is better than an unlimited number of conflict errors.

processFile(filename)[source]

Check whether a file needs to be processed.

Return True if processing is needed and False otherwise. If the file needs to be processed, it will be marked as processed, assuming that the caller will procces the file if it needs to be procssed.

action(discriminator, callable, args=(), kw={}, order=0, includepath=None, info=None)[source]

Record a configuration action

The job of most directives is to compute actions for later processing. The action method is used to record those actions. The discriminator is used to to find actions that conflict. Actions conflict if they have the same discriminator. The exception to this is the special case of the discriminator with the value None. An actions with a discriminator of None never conflicts with other actions. This is possible to add an order argument to crudely control the order of execution. ‘info’ is optional source line information, ‘includepath’ is None (the default) or a tuple of include paths for this action.

provideFeature(name)[source]

Record that a named feature is available in this context.

hasFeature(name)[source]

Check whether a named feature is available in this context.

interface zope.configuration.interfaces.IGroupingContext[source]
before()[source]

Do something before processing nested directives

after()[source]

Do something after processing nested directives