Vidimera

Python signature and behaviour checker inspired by Elixir.

In Swedish, vidimera means to attest or to certify. It is commonly used to attest that a copy of a document is accurate compared to the original.

Installation

Install the package vidimera version 0.3+ from PyPI. The recommended requirements.txt line is vidimera~=0.3.

Current Functionality

assert_implements(object, expected, scope=Behaviour.PUBLIC_AND_SPECIAL)

• Raises an AssertionError listing missing callables and their signatures if there are any. Based on behaviour.implements.

Behaviour(object)

• Creates a new Behaviour instance.
• If object already is an instance of Behaviour, it is returned unchanged.

behaviour.implemented_by(other, scope=Behaviour.PUBLIC_AND_SPECIAL)

• Verifies that other at least has the same public and dunderscore callables with the same signatures as the behaviour.
• Creats a Behaviour from other before making the comparison.

behaviour.implements(other, scope=Behaviour.PUBLIC_AND_SPECIAL)

• Verifies that the behaviour at least has the same public and dunderscore callables with the same signatures as other.
• Creats a Behaviour from other before making the comparison.

behaviour.signatures(scope=Behaviour.PUBLIC_AND_SPECIAL)

• Returns a set of tuples that represent the name and the callable selected based on the scope.
• Possible scopes include PUBLIC, PRIVATE, SPECIAL, and PUBLIC_AND_SPECIAL.

MissingBehaviour(delta)

• An internal representation of missing behaviour. Created from a set of names and signatures. If the set is empty, this object will be truthy. If the set is non-empty, this object is falsy.