Skip to main content

Programming by contract

Project description

Deal

Build Status Coverage Status PyPI version Development Status

Deal -- python library for design by contract (DbC) and checking values, exceptions, and side-effects. Read intro to get started.

Features

Deal in 30 seconds

# the result is always non-negative
@deal.post(lambda result: result >= 0)
# the function has no side-effects
@deal.pure
def count(items: List[str], item: str) -> int:
    return items.count(item)

# test case
@pytest.mark.parametrize('case', deal.cases(count))
def test_count(case: deal.TestCase):
    case()

Now we can:

  • Run python3 -m deal lint or flake8 to statically check errors.
  • Run python3 -m deal test or pytest to generate and run tests.
  • Just use the function in the project and check errors in runtime.

Read more in the documentation.

Installation

python3 -m pip install --user deal

Contributing

Contributions are welcome! A few ideas what you can contribute:

  • Add new checks for the linter.
  • Improve documentation.
  • Add more tests.
  • Improve performance.
  • Found a bug? Fix it!
  • Made an article about deal? Great! Let's add it into the README.md.
  • Don't have time to code? No worries! Just tell your friends and subscribers about the project. More users -> more contributors -> more cool features.

Thank you :heart:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

deal-4.1.0.tar.gz (56.3 kB view details)

Uploaded Source

Built Distribution

deal-4.1.0-py3-none-any.whl (120.7 kB view details)

Uploaded Python 3

File details

Details for the file deal-4.1.0.tar.gz.

File metadata

  • Download URL: deal-4.1.0.tar.gz
  • Upload date:
  • Size: 56.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: DepHell/0.8.3

File hashes

Hashes for deal-4.1.0.tar.gz
Algorithm Hash digest
SHA256 989449acd0ea65041f4af3b99582ce80d5d6ff4a675ed2ac8c0d45db97f9c5ba
MD5 cc8f3f6c029f4149b24ee883259ce185
BLAKE2b-256 6742ca29396987827f96106c6ba5936d28318fbe317469ec1a0621012d0145b7

See more details on using hashes here.

File details

Details for the file deal-4.1.0-py3-none-any.whl.

File metadata

  • Download URL: deal-4.1.0-py3-none-any.whl
  • Upload date:
  • Size: 120.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: DepHell/0.8.3

File hashes

Hashes for deal-4.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fad86a0e7bc798edb9d269d2139adbe5a5c0d02c454d62a29f3d99575ceed830
MD5 8466bbc37538f33795b82cb847ae6d56
BLAKE2b-256 c23a5a29b7e5f9df992e3f8245bbc6dbf3eb78ce2e442ef87d3563465d5ff537

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page