This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

Introduction

What’s the use to declare an interface if your class doesn’t implement correctly the interface ?

Of course you should verify that in a test but if you don’t want to write a test to check that all your code really implements the promised interfaces use this package.

It’s a simple patch that calls zope.interface.verify.verifyClass once you declare implementing an interface and print the BrokenImplementation or BrokenMethodImplementation as a warning (if any).

Simple example in testrunner:

By default the egg enable interface contract verification for zope.interface.implements and zope.interface.classImplements that are present in all your packages:

>>> write('buildout.cfg',
... """
... [buildout]
... parts =
...     test
...
... [test]
... recipe = zc.recipe.testrunner
... eggs = affinitic.verifyinterface
...        zope.exceptions
... defaults = ['-m', 'module']
... """)

>>> print system(buildout)
Installing test.
...

>>> from os.path import join
>>> print system(join('bin', 'test')),
<class 'affinitic.verifyinterface.tests.test_module1.Foo'> failed implementing <InterfaceClass affinitic.verifyinterface.tests.test_module1.IFoo>: An object has failed to implement interface <InterfaceClass affinitic.verifyinterface.tests.test_module1.IFoo>
<BLANKLINE>
        The bla attribute was not provided.
<BLANKLINE>
<class 'affinitic.verifyinterface.tests.test_module2.Bar'> failed implementing <InterfaceClass affinitic.verifyinterface.tests.test_module2.IBar>: An object has failed to implement interface <InterfaceClass affinitic.verifyinterface.tests.test_module2.IBar>
<BLANKLINE>
        The bla attribute was not provided.
<BLANKLINE>
Running zope.testing.testrunner.layer.UnitTests tests:
  Set up zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
  Ran 2 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.

Limit verifications

But you can limit the package where this verification needs to be done (sometimes you don’t care that a package you depend on didn’t implement correctly an interface).

This is done by adding an environment variable verifyinterface where you specify what packages/modules (separated by n as usual) you accept to verify interfaces.

Here is a simple example where I only want to have warning for bad implementation of interfaces used by module1:

>>> write('buildout.cfg',
... """
... [buildout]
... parts =
...     test
...
... [test]
... recipe = zc.recipe.testrunner
... eggs = affinitic.verifyinterface
...        zope.exceptions
... defaults = ['-m', 'module']
... environment = testenv
...
... [testenv]
... verifyinterface = affinitic.verifyinterface.tests.test_module1
... """)

>>> print system(buildout)
Uninstalling test.
Installing test.
...

>>> from os.path import join
>>> print system(join('bin', 'test'))
<class 'affinitic.verifyinterface.tests.test_module1.Foo'> failed implementing <InterfaceClass affinitic.verifyinterface.tests.test_module1.IFoo>: An object has failed to implement interface <InterfaceClass affinitic.verifyinterface.tests.test_module1.IFoo>
<BLANKLINE>
        The bla attribute was not provided.
<BLANKLINE>
Running zope.testing.testrunner.layer.UnitTests tests:
  Set up zope.testing.testrunner.layer.UnitTests in 0.000 seconds.
  Ran 2 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.

Changelog

0.1 (2009-12-18)

  • Initial release
Release History

Release History

0.1

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
affinitic.verifyinterface-0.1.tar.gz (4.6 kB) Copy SHA256 Checksum SHA256 Source Dec 18, 2009

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting