Skip to main content

Base class to enable objects to be compared for similarity.

Project description

Comparable

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

Getting Started

Requirements

  • Python 3.3+

Installation

Comparable can be installed with ‘pip’:

pip install Comparable

Or directly from the source code:

git clone https://github.com/jacebrowning/comparable.git
cd comparable
python setup.py 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.

Examples

Comparable includes many generic comparable types:

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

A basic script may 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

Installation

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

Changelog

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.

Project details


Release history Release notifications

History Node

1.0

This version
History Node

0.2.1

History Node

0.2

History Node

0.1.1

History Node

0.1.1-rc.1

History Node

0.1

History Node

0.0.3

History Node

0.0.2

History Node

0.0.1

History Node

0.0.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
Comparable-0.2.1-py3-none-any.whl (18.0 kB) Copy SHA256 hash SHA256 Wheel 3.4 May 18, 2014
Comparable-0.2.1.tar.gz (15.0 kB) Copy SHA256 hash SHA256 Source None May 18, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page