Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Base class to enable objects to be compared for similarity.

Project Description


Comparable is a library providing abstract base classes that enable subclasses to be compared for “equality” and “similarity” based on their attributes.

Getting Started


  • Python 3.3+


Comparable can be installed with pip:

$ pip install comparable

or directly from the source code:

$ git clone
$ cd comparable
$ python install

Basic Usage

After installation, abstract base classes can be imported from the package:

$ python
>>> import comparable
>>> comparable.__version__
>>> from comparable import SimpleComparable, CompoundComparable

Comparable classes use == as the operation for “equality” and % as the operation for “similarity”. They may also override a threshold attribute to set the “similarity” ratio.

Simple Comparables

Simple comparable types must override the equality and similarity methods to return bool and Similarity objects, respectively. See comparable.simple for examples.

Compound Comparables

Compound comparable types contain multiple simple comparable types. They must override the attributes property to define which attributes should be used for comparison. See comparable.compund for examples.


Comparable includes many generic comparable types:

$ python
>>> from comparable.simple import Number, Text, TextEnum, TextTitle
>>> from comparable.compound import Group

A basic script might look similar to the following:

from comparable.simple import TextTitle
from comparable import tools

base = TextTitle("The Cat and the Hat")
items = [TextTitle("cat & hat"), TextTitle("cat & the hat")]

print("Equality: {}".format(base == items[0]))
print("Similarity: {}".format(base % items[0]))

print("Duplicates: {}".format(tools.duplicates(base, items)))

For Contributors


Create a virtualenv:

$ make env

Run the tests:

$ make test
$ make tests  # includes integration tests

Build the documentation:

$ make doc

Run static analysis:

$ make pep8
$ make pep257
$ make pylint
$ make check  # includes all checks

Prepare a release:

$ make dist  # dry run
$ make upload


1.0 (2015/03/19)

  • Freeze public API.

0.2.1 (2014/05/17)

  • Added __bool__ to the base simple type.

0.2 (2014/05/12)

  • Added similarity assertions to the TestCase class.

0.1.1 (2014/03/03)

  • README cleanup.

0.1 (2014/03/03)

  • Code cleanup.

0.0.3 (2013/10/13)

  • Comparable.threshold is now an attribute (instead of property)
  • Fixed package-level imports

0.0.2 (2013/10/04)

  • Replaced Comparable.equality_list/similarity_dict with attributes
  • Replaced Comparable.similarity_threshold with threshold

0.0.1 (2013/10/02)

  • Initial release of Comparable.
Release History

Release History

This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
Comparable-1.0-py3-none-any.whl (18.1 kB) Copy SHA256 Checksum SHA256 3.4 Wheel Mar 19, 2015
Comparable-1.0.tar.gz (15.3 kB) Copy SHA256 Checksum SHA256 Source Mar 19, 2015

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