Skip to main content

Experiment for configuring with venusian instead of *.zcml

Project description


This package (venusianconfiguration) provides venusian based Python configuration syntax for zope.configuration as an alternative to zcml. This package does not replace zope.configuration like grok used to do, but just provides generic Python bindings for existing zope.configuration directives. So, venusianconfiguration is more an alternative to grok than it is to zope.configuration.

The current status of this package can be described as already in internal use, but maybe not yet ready for the community.

The good:

from venusianconfiguration import configure

    name='hello-world', for_=Interface,
class HelloWorld(BrowserView):
    def __call__(self):
        return u'Hello world!'

    title=_(u'My behavior),
    description=_(u'Enables magic'))
class IMyBehavior(model.Schema):
    custom_field = schema.TextLine()
alsoProvides(IMyBehavior, IFormFieldProvider)

The bad:

from venusianconfiguration import scan
from venusianconfiguration import configure

from mypackage import browser

import zcmlpackage

import otherpypackage
configure.include(package=otherpypackage, file='')

import mypackage.submodule

The ugly:

zope.configuration is mostly syntax-agnostic, but unfortunately ZCML has been the only implemented syntax for it and we have also used to call its ZCML-specific API directly (e.g. in test fixtures and in z3c.autoinclude).

Therefore a new zope.configuration syntax cannot be introduced outside zope.configuration without monkeypatching…

venusianconfiguration works by monkeypatching the processxmlfile method in zope.configuration’s ZCML-support to accept also Python files pass those to venusianconfiguration to process.

To support z3c.autoinclude, venusianconfiguration also monkeypatches z3c.autoincludes’s includePluginsDirective and includePluginsOveridesDirective (includeDependencies-directive is considered evil and is intentionally left unsupported).

So, three monkeypatches in total for zcml-free configuration.


recipe = plone.recipe.zope2instance
eggs =
zope-conf-additional =
    # Enable venuasianconfiguration monkeypatches
    %import venusianconfiguration

For more examples, look into the demo-package included in the sources.


Because the configuration now written in Python, your add-on must have its namespaces packages properly defined in its E.g. add-on called my.product would have following namespace package definition:


Even there’s no ZCML, the add-on must be registered to be configured. This can be done by adding the usual z3c.autoinclude-entrypoint into add-on’s

    # -*- Entry points: -*-
    target = plone

An alternative would be to add the package into the zcml-option of your Plone instance’s buildout-part for plone.recipe.zope2instance:

zcml = my.product


1.1.2 (2021-09-01)

  • Fix issue where PEP 320 hook failed on Plone 5.2 because dummy component.xml was returned as string instead of bytes [datakurre]

1.1.1 (2018-11-07)

  • Add faceted namespace [datakurre]

1.1.0 (2018-01-17)

  • Drop z3c.autoinclude plugin entrypoint for plone to fix issues with where z3c.autoinclude included wrong packages on and pip-installed Plone. This will disable the experimental ZCML directives from meta.zcml to be loaded by default with Plone. [datakurre]

1.0.2 (2017-12-21)

  • Fix issue where default configuration directive being mutable caused unexpected behavior [datakurre]

1.0.1 (2016-09-21)

  • Fix issue where zope.deferredimported module was not recognized as module [datakurre]

1.0.0 (2016-04-19)

  • First release.

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

venusianconfiguration-1.1.2.tar.gz (13.8 kB view hashes)

Uploaded source

Built Distribution

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