Hacking on zope.location
¶
Getting the Code¶
The main repository for zope.location
is in the Zope Foundation
Github repository:
You can get a read-only checkout from there:
$ git clone https://github.com/zopefoundation/zope.location.git
or fork it and get a writeable checkout of your fork:
$ git clone git@github.com/jrandom/zope.location.git
The project also mirrors the trunk from the Github repository as a Bazaar branch on Launchpad:
https://code.launchpad.net/zope.location
You can branch the trunk from there using Bazaar:
$ bzr branch lp:zope.location
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.location
Next, get this package registered as a “development egg” in the environment:
$ /tmp/hack-zope.location/bin/python setup.py develop
Running the tests¶
Then, you canrun the tests using the build-in setuptools
testrunner:
$ /tmp/hack-zope.location/bin/python setup.py test -q
...............................................................................
----------------------------------------------------------------------
Ran 83 tests in 0.037s
OK
If you have the nose
package installed in the virtualenv, you can
use its testrunner too:
$ /tmp/hack-zope.location/bin/nosetests
.......................................................................................
----------------------------------------------------------------------
Ran 87 tests in 0.037s
OK
If you have the coverage
pacakge installed in the virtualenv,
you can see how well the tests cover the code:
$ /tmp/hack-zope.location/bin/easy_install nose coverage
...
$ /tmp/hack-zope.location/bin/nosetests --with coverage
.......................................................................................
Name Stmts Miss Cover Missing
--------------------------------------------------------
zope.location 5 0 100%
zope.location._compat 2 0 100%
zope.location.interfaces 23 0 100%
zope.location.location 61 0 100%
zope.location.pickling 14 0 100%
zope.location.traversing 80 0 100%
--------------------------------------------------------
TOTAL 185 0 100%
----------------------------------------------------------------------
Ran 87 tests in 0.315s
OK
Building the documentation¶
zope.location
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.location/bin/easy_install \
Sphinx repoze.sphinx.autoitnerface zope.component
...
$ cd docs
$ PATH=/tmp/hack-zope.location/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.location/bin:$PATH make doctest
sphinx-build -b doctest -d _build/doctrees . _build/doctest
...
running tests...
...
Doctest summary
===============
187 tests
0 failures in tests
0 failures in setup code
0 failures in cleanup 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.location
ships with its own buildout.cfg
file and
bootstrap.py
for setting up a development buildout:
$ /path/to/python2.7 bootstrap.py
...
Generated script '.../bin/buildout'
$ bin/buildout
Develop: '/home/jrandom/projects/Zope/zope.location/.'
...
Got coverage 3.7.1
Running the tests¶
You can now 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 79 tests with 0 failures and 0 errors in 0.000 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.location
configures the following tox
environments via
its tox.ini
file:
The
py26
,py27
,py33
,py34
, andpypy
environments builds avirtualenv
withpypy
, installszope.location
and dependencies, and runs the tests viapython setup.py test -q
.The
coverage
environment builds avirtualenv
withpython2.6
, installszope.location
, installsnose
andcoverage
, and runsnosetests
with statement coverage.The
docs
environment builds a virtualenv withpython2.6
, installszope.location
, installsSphinx
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: /home/jrandom/projects/Zope/Z3/zope.location/setup.py
py26 create: /home/jrandom/projects/Zope/Z3/zope.location/.tox/py26
py26 installdeps: zope.configuration, zope.copy, zope.interface, zope.proxy, zope.schema
py26 inst: /home/jrandom/projects/Zope/Z3/zope.location/.tox/dist/zope.location-4.0.4.dev0.zip
py26 runtests: PYTHONHASHSEED='3489368878'
py26 runtests: commands[0] | python setup.py test -q
running test
...
...................................................................................
----------------------------------------------------------------------
Ran 83 tests in 0.066s
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.location/setup.py
py26 sdist-reinst: .../zope.location/.tox/dist/zope.location-4.0.2dev.zip
...
Doctest summary
===============
187 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
py33: commands succeeded
py34: commands succeeded
pypy: commands succeeded
coverage: commands succeeded
docs: commands succeeded
congratulations :)
Contributing to zope.location
¶
Submitting a Bug Report¶
zope.location
tracks its bugs on Github:
Please submit bug reports and feature requests there.