https://github.com/datakurre/collective.venusianconfig

zope.configuration without zcml
https://github.com/datakurre/collective.venusianconfig

Last synced: about 2 months ago
JSON representation

zope.configuration without zcml

• Host: GitHub
• URL: https://github.com/datakurre/collective.venusianconfig
• Owner: datakurre
• Created: 2013-11-24T13:58:08.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2014-11-22T06:29:47.000Z (about 10 years ago)
• Last Synced: 2024-10-15T17:44:18.367Z (3 months ago)
• Language: Python
• Homepage:
• Size: 460 KB
• Stars: 2
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.txt

Awesome Lists containing this project

README

        
venusianconfiguration

=====================

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*.

.. _venusian: https://pypi.python.org/pypi/venusian

.. _zope.configuration: https://pypi.python.org/pypi/zope.configuration

.. image:: https://travis-ci.org/datakurre/collective.venusianconfig.png

   :target: http://travis-ci.org/datakurre/collective.venusianconfig

The good:

.. code:: python

   from venusianconfiguration import configure

   configure.i18n.registerTranslations(directory='locales')

   @configure.browser.page.klass(

       name='hello-world', for_=Interface,

       permission='zope2.View')

   class HelloWorld(BrowserView):

       def __call__(self):

           return u'Hello world!'

   @configure.plone.behavior.provides(

       title=_(u'My behavior),

       description=_(u'Enables magic'))

   class IMyBehavior(model.Schema):

       custom_field = schema.TextLine()

   alsoProvides(IMyBehavior, IFormFieldProvider)

The bad:

.. code:: python

   from venusianconfiguration import scan

   from venusianconfiguration import configure

   from mypackage import browser

   scan(browser)

   import zcmlpackage

   configure.include(package=zcmlpackage)

   import otherpypackage

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

   import mypackage.submodule

   configure.include(package=mypackage.submodule,

                     file='configure.py')

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.

Usage

-----

.. code:: ini

   [instance]

   recipe = plone.recipe.zope2instance

   ...

   eggs =

       ...

       venusianconfiguration

   zope-conf-additional =

       # Enable venuasianconfiguration monkeypatches

       %import venusianconfiguration

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

Troubleshooting

---------------

Because the configuration now written in Python, your add-on must have its

namespaces packages properly defined in its setup.py. E.g. add-on called

my.product would have following namespace package definition:

..  code:: python

    setup(

        ...

        namespace_packages=['my'],

        ...

     )

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 setup.py:

..  code:: python

   setup(

       ...

       entry_points="""

       # -*- Entry points: -*-

       [z3c.autoinclude.plugin]

       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:

..  code:: ini

    [instance]

    recipe=plone.recipe.zope2instance

    ...

    zcml = my.product