Skip to main content

Extensions to zope.configuration

Project description

Changes

1.1

  • Move the exclude directive into the original zope.configuration package.

    So, this package is currently contains only a backward-compatibility import for exclude directive and is not useful anymore. However it’s intended to contain miscellaneous extensions to the configuration framework and may contain more in future, so we are not marking is as deprecated for now.

1.0

Initial release.

Detailed Documentation

Configuration Extensions for Filtering or Inhibiting Configuration

The zc.configuration package used to provide the exclude directive for inhibiting configuration. It was included in the zope.configuration and this package currently provides a backward-compatibility imports and tests that ensure that it will work for people who are already using zc.configuration and not the newer zope.configuration.

This package may contain more configuration extensions in future, but currently, it’s not useful anymore as the only feature it provided, the exclude directive was merged into the original zope.configuration package.

First, let’s look at an example. The zc.configuration.demo package has a ZCML configuration that includes some other configuration files.

We’ll set a log handler so we can see what’s going on:

>>> import logging, sys
>>> logger = logging.getLogger('config')
>>> oldlevel = logger.level
>>> logger.setLevel(logging.DEBUG)
>>> handler = logging.StreamHandler(sys.stdout)
>>> logger.addHandler(handler)

Now, we’ll include the zc.configuration.demo config:

>>> from zope.configuration import xmlconfig
>>> _ = xmlconfig.string('<include package="zc.configuration.demo" />')
include /zc.configuration/src/zc/configuration/demo/configure.zcml
include /zc.configuration/src/zc/configuration/demo/sub/configure.zcml
include /zc.configuration/src/zc/configuration/demo/spam.zcml

Each run of the configuration machinery runs with fresh state, so rerunning gives the same thing:

>>> _ = xmlconfig.string('<include package="zc.configuration.demo" />')
include /zc.configuration/src/zc/configuration/demo/configure.zcml
include /zc.configuration/src/zc/configuration/demo/sub/configure.zcml
include /zc.configuration/src/zc/configuration/demo/spam.zcml

Now, we’ll load the zc.configuration meta.zcml and use the exclude directive to exclude the two files included by the configuration file in zc.configuration.demo:

>>> _ = xmlconfig.string(
... '''
... <configure  xmlns="http://namespaces.zope.org/zope">
...   <include package="zc.configuration" file="meta.zcml" />
...   <exclude package="zc.configuration.demo.sub" />
...   <exclude package="zc.configuration.demo" file="spam.zcml" />
...   <include package="zc.configuration.demo" />
... </configure>
... ''')
include /zc.configuration/src/zc/configuration/meta.zcml
include /zc.configuration/src/zc/configuration/demo/configure.zcml

Download

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zc.configuration-1.1.tar.gz (3.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page