Hacking on zope.configuration

Getting the Code

The main repository for zope.configuration is in the Zope Foundation Github repository:

You can get a read-only checkout from there:

$ git clone https://github.com/zopefoundation/zope.configuration.git

or fork it and get a writeable checkout of your fork:

$ git clone git@github.com/jrandom/zope.configuration.git

The project also mirrors the trunk from the Github repository as a Bazaar branch on Launchpad:

https://code.launchpad.net/zope.configuration

You can branch the trunk from there using Bazaar:

$ bzr branch lp:zope.configuration

Working in a virtualenv

Installing

If you use the virtualenv package to create lightweight Python development environments, you can run the tests using nothing more than the python binary in a virtualenv. First, create a scratch environment:

$ /path/to/virtualenv --no-site-packages /tmp/hack-zope.configuration

Next, get this package registered as a “development egg” in the environment:

$ /tmp/hack-zope.configuration/bin/python setup.py develop

Running the tests

Run the tests using the build-in setuptools testrunner:

$ /tmp/hack-zope.configuration/bin/python setup.py test
running test
........
----------------------------------------------------------------------
Ran 249 tests in 0.366s

OK

If you have the nose package installed in the virtualenv, you can use its testrunner too:

$ /tmp/hack-zope.configuration/bin/easy_install nose
...
$ /tmp/hack-zope.configuration/bin/python setup.py nosetests
running nosetests
.......
----------------------------------------------------------------------
Ran 249 tests in 0.366s

OK

or:

$ /tmp/hack-zope.configuration/bin/nosetests
.......
----------------------------------------------------------------------
Ran 249 tests in 0.366s

OK

If you have the coverage pacakge installed in the virtualenv, you can see how well the tests cover the code:

$ /tmp/hack-zope.configuration/bin/easy_install nose coverage
...
$ /tmp/hack-zope.configuration/bin/python setup.py nosetests \
    --with coverage --cover-package=zope.configuration
running nosetests
...
Name                               Stmts   Miss  Cover   Missing
----------------------------------------------------------------
zope.configuration                     3      0   100%
zope.configuration._compat             2      0   100%
zope.configuration.config            439      0   100%
zope.configuration.docutils           34      0   100%
zope.configuration.exceptions          2      0   100%
zope.configuration.fields            111      0   100%
zope.configuration.interfaces         18      0   100%
zope.configuration.name               54      0   100%
zope.configuration.xmlconfig         269      0   100%
zope.configuration.zopeconfigure      17      0   100%
----------------------------------------------------------------
TOTAL                                955      0   100%
----------------------------------------------------------------------
Ran 256 tests in 1.063s

OK

Building the documentation

zope.configuration uses the nifty Sphinx documentation system for building its docs. Using the same virtualenv you set up to run the tests, you can build the docs:

$ /tmp/hack-zope.configuration/bin/easy_install Sphinx
...
$ cd docs
$ PATH=/tmp/hack-zope.configuration/bin:$PATH make html
sphinx-build -b html -d _build/doctrees   . _build/html
...
build succeeded.

Build finished. The HTML pages are in _build/html.

You can also test the code snippets in the documentation:

$ PATH=/tmp/hack-zope.configuration/bin:$PATH make doctest
sphinx-build -b doctest -d _build/doctrees   . _build/doctest
...

Doctest summary
===============
  554 tests
    0 failures in tests
    0 failures in setup code
build succeeded.
Testing of doctests in the sources finished, look at the  \
    results in _build/doctest/output.txt.

Using zc.buildout

Setting up the buildout

zope.configuration ships with its own buildout.cfg file and bootstrap.py for setting up a development buildout:

$ /path/to/python2.6 bootstrap.py
...
Generated script '.../bin/buildout'
$ bin/buildout
Develop: '/home/jrandom/projects/Zope/BTK/configuration/.'
...
Generated script '.../bin/sphinx-quickstart'.
Generated script '.../bin/sphinx-build'.

Running the tests

Run the tests:

$ bin/test --all
Running zope.testing.testrunner.layer.UnitTests tests:
  Set up zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
  Ran 249 tests with 0 failures and 0 errors in 0.366 seconds.
Tearing down left over layers:
  Tear down zope.testing.testrunner.layer.UnitTests in 0.000 seconds.

Using tox

Running Tests on Multiple Python Versions

tox is a Python-based test automation tool designed to run tests against multiple Python versions. It creates a virtualenv for each configured version, installs the current package and configured dependencies into each virtualenv, and then runs the configured commands.

zope.configuration configures the following tox environments via its tox.ini file:

  • The py26, py27, py33, py34, and pypy environments builds a virtualenv with pypy, installs zope.configuration and dependencies, and runs the tests via python setup.py test -q.
  • The coverage environment builds a virtualenv with python2.6, installs zope.configuration, installs nose and coverage, and runs nosetests with statement coverage.
  • The docs environment builds a virtualenv with python2.6, installs zope.configuration, installs Sphinx and dependencies, and then builds the docs and exercises the doctest snippets.

This example requires that you have a working python2.6 on your path, as well as installing tox:

$ tox -e py26
GLOB sdist-make: .../zope.interface/setup.py
py26 sdist-reinst: .../zope.interface/.tox/dist/zope.interface-4.0.2dev.zip
py26 runtests: commands[0]
..........
----------------------------------------------------------------------
Ran 249 tests in 0.366s

OK
___________________________________ summary ____________________________________
py26: commands succeeded
congratulations :)

Running tox with no arguments runs all the configured environments, including building the docs and testing their snippets:

$ tox
GLOB sdist-make: .../zope.interface/setup.py
py26 sdist-reinst: .../zope.interface/.tox/dist/zope.interface-4.0.2dev.zip
py26 runtests: commands[0]
...
Doctest summary
===============
 544 tests
   0 failures in tests
   0 failures in setup code
   0 failures in cleanup code
build succeeded.
___________________________________ summary ____________________________________
py26: commands succeeded
py27: commands succeeded
py32: commands succeeded
pypy: commands succeeded
coverage: commands succeeded
docs: commands succeeded
congratulations :)

Contributing to zope.configuration

Submitting a Bug Report

zope.configuration tracks its bugs on Github:

Please submit bug reports and feature requests there.

Sharing Your Changes

Note

Please ensure that all tests are passing before you submit your code. If possible, your submission should include new tests for new features or bug fixes, although it is possible that you may have tested your new code by updating existing tests.

If have made a change you would like to share, the best route is to fork the Githb repository, check out your fork, make your changes on a branch in your fork, and push it. You can then submit a pull request from your branch:

If you branched the code from Launchpad using Bazaar, you have another option: you can “push” your branch to Launchpad:

$ bzr push lp:~jrandom/zope.configuration/cool_feature

After pushing your branch, you can link it to a bug report on Launchpad, or request that the maintainers merge your branch using the Launchpad “merge request” feature.