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
Requirements
GNU Make:
Windows: http://cygwin.com/install.html
Linux: http://www.gnu.org/software/make (likely already installed)
virtualenv: https://pypi-hypernode.com/pypi/virtualenv#installation
Graphviz: http://www.graphviz.org/Download.php
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file Comparable-0.2.1.tar.gz.
File metadata
- Download URL: Comparable-0.2.1.tar.gz
- Upload date:
- Size: 15.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5517959db99f73efc5dc576a4498f8e4c642166e8c751c28ae6d1ff453acbe86 |
|
| MD5 | 8a63c63011c2684b9d876f1295bb65c7 |
|
| BLAKE2b-256 | 0a08c8fec5d1e35f6d071490ec817f9559b96d21416b7b6fb73e0ee2655e57b8 |
File details
Details for the file Comparable-0.2.1-py3-none-any.whl.
File metadata
- Download URL: Comparable-0.2.1-py3-none-any.whl
- Upload date:
- Size: 18.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 67189b0cc3fdd853b2ec7c488d0d8f37a33c2fa6fe94c69a995e54cf733334f9 |
|
| MD5 | 288eac1e12676a9873c6fbe782b0dbd0 |
|
| BLAKE2b-256 | 348938638a74f1c43cdfd533e7396986aec716be2f5a9dbe4f9f0e8a76a26c59 |
