Skip to main content

Speccer provides simple means to test individual modules. It uses a minimal, assert-free syntax. This syntax is compiled to actual code utilizing Python’s unittest. Henceforth Speccer may be seen as an alternative to it in various situations.

Run “setup.py install” to start rocking. See “demo” folder for an actual example. Once you have installed the tool just invoke “run_specs” at that directory. You should see some test results. Feel free to tweak the files to give it a proper go.

Basic Specification Syntax

A module specification could look something like this:

myclass.spec: (tests myclass.py)

set up
    c = myclass.MyClass()

adds two and two
    c.add(2,2) == 4

adds negatives
    c.add(10, -10) == 0

fails adding int and string
    c.add(10, 'foo') raises TypeError

It looks pretty much like any other test you may have seen before. The syntax may be a bit lighter, though. As a test author you can focus on the essential while writing the assertions. In addition it’s a bit nicer to read this way.

Note that it’s possible to mix regular Python code within the tests. This might not work in all cases, though, and should be reported.

“set up” is a predefined test method that is run before each specification. This way you can set up some objects that are available for each test.

Each specification contains a name and some actual code asserting something. I have listed available assertions below:

  • ==, is equal

  • !=, is not equal

  • ~=, is almost equal

  • !~=, is not almost equal

  • >, bigger than

  • >=, bigger than or equal

  • <, smaller than

  • <=, smaller than or equal

  • x < y < z, multiple inequalities (mix with equality as you want)

These assertions map directly to ones available in Python’s unittest module. If some of those seem weird to you, see http://docs.python.org/library/unittest.html .

Changelog

  • 0.7.5 - Made it possible to define functions between test definitions and made the runner more robust altogether. Now it’s possible to separate tests to another directory. In addition it’s possible to run tests simply by passing this directory to the runner (ie. run_specs tests).

License

Speccer is available under MIT license. See LICENSE for more details.

Metadata

Release files for speccer 0.7.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for speccer 0.7.5
File Size Uploaded
speccer-0.7.5.tar.gz 10.9 kB Details

Release files / speccer-0.7.5.tar.gz

Download URL speccer-0.7.5.tar.gz
Size 10.9 kB
Tags Source
SHA-256 checksum
How to use checksums
f91cbb7c3fb20b301824a6be3dae183e13903025f7562a828b93021cb6deb702
BLAKE2b-256 checksum
How to use checksums
91b9a6b53a55c6cd0aa2b56c9f9d508d975e1584c8d3e41b81fc8a3f9f72058d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.7.5 This release

1 release file

0.6.0

1 release file

0.5.2

1 release file

0.5.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page