Comparable 0.0.2

Introduction

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

Getting Started

pip install 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 property to set the “similarity” ratio.

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)))