Skip to main content

Doing dirty (but extremely useful) things with equals.

Project description

dirty-equals

Doing dirty (but extremely useful) things with equals.

CI Coverage pypi versions license


Documentation: dirty-equals.helpmanual.io

Source Code: github.com/samuelcolvin/dirty-equals


dirty-equals is a python library that (mis)uses the __eq__ method to make python code (generally unit tests) more declarative and therefore easier to read and write.

dirty-equals can be used in whatever context you like, but it comes into its own when writing unit tests for applications where you're commonly checking the response to API calls and the contents of a database.

Usage

Here's a trivial example of what dirty-equals can do:

from dirty_equals import IsPositive

assert 1 == IsPositive
assert -2 == IsPositive  # this will fail!

That doesn't look very useful yet!, but consider the following unit test code using dirty-equals:

from dirty_equals import IsJson, IsNow, IsPositiveInt, IsStr

...

# user_data is a dict returned from a database or API which we want to test
assert user_data == {
    # we want to check that id is a positive int
    'id': IsPositiveInt,
    # we know avatar_file should be a string, but we need a regex as we don't know whole value
    'avatar_file': IsStr(regex=r'/[a-z0-9\-]{10}/example\.png'),
    # settings_json is JSON, but it's more robust to compare the value it encodes, not strings
    'settings_json': IsJson({'theme': 'dark', 'language': 'en'}),
    # created_ts is datetime, we don't know the exact value, but we know it should be close to now
    'created_ts': IsNow(delta=3),
}

Without dirty-equals, you'd have to compare individual fields and/or modify some fields before comparison - the test would not be declarative or as clear.

dirty-equals can do so much more than that, for example:

  • IsPartialDict lets you compare a subset of a dictionary
  • IsStrictDict lets you confirm order in a dictionary
  • IsList and IsTuple lets you compare partial lists and tuples, with or without order constraints
  • nesting any of these types inside any others
  • IsInstance lets you simply confirm the type of an object
  • You can even use boolean operators | and & to combine multiple conditions
  • and much more...

Installation

Simply:

pip install dirty-equals

dirty-equals requires Python 3.8+.

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

dirty_equals-0.9.0.tar.gz (50.4 kB view details)

Uploaded Source

Built Distribution

dirty_equals-0.9.0-py3-none-any.whl (28.2 kB view details)

Uploaded Python 3

File details

Details for the file dirty_equals-0.9.0.tar.gz.

File metadata

  • Download URL: dirty_equals-0.9.0.tar.gz
  • Upload date:
  • Size: 50.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for dirty_equals-0.9.0.tar.gz
Algorithm Hash digest
SHA256 17f515970b04ed7900b733c95fd8091f4f85e52f1fb5f268757f25c858eb1f7b
MD5 30c11543fce834296173f13512c81202
BLAKE2b-256 b099133892f401ced5a27e641a473c547d5fbdb39af8f85dac8a9d633ea3e7a7

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirty_equals-0.9.0.tar.gz:

Publisher: ci.yml on samuelcolvin/dirty-equals

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dirty_equals-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: dirty_equals-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 28.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for dirty_equals-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ff4d027f5cfa1b69573af00f7ba9043ea652dbdce3fe5cbe828e478c7346db9c
MD5 7a7623ccaf6e6694c283596cd2db7e9a
BLAKE2b-256 770c03cc99bf3b6328604b10829de3460f2b2ad3373200c45665c38508e550c6

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirty_equals-0.9.0-py3-none-any.whl:

Publisher: ci.yml on samuelcolvin/dirty-equals

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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