stringmatch 0.4.0

A library to match and compare strings.

Stringmatch

Yet another small, lightweight string matching library written in Python, based on the Levenshtein distance and the Levenshtein Python C Extension.
Inspired by seatgeek/thefuzz, which did not quite fit my needs, so I am building this library for myself, primarily.

Table of Contents

• Requirements
• Installation
• Basic Usage
  • Additional Arguments
• Links

Requirements

• Python 3.9 or later.

Installation

Install the latest stable version with pip:

pip install stringmatch

Or install the newest version via git (Might be unstable/unfinished):

pip install -U git+https://github.com/atomflunder/stringmatch

Basic Usage

from stringmatch import Match, Ratio, Strings

match = Match()
ratio = Ratio()
strings = Strings()

# Basic usage:
match.match("searchlib", "srchlib")                   # returns True
match.match("searchlib", "something else")            # returns False

# Matching lists:
searches = ["searchli", "searhli", "search", "lib", "whatever", "s"]
match.get_best_match("searchlib", searches)           # returns "searchli"
match.get_best_matches("searchlib", searches)         # returns ['searchli', 'searhli', 'search']

# Ratios:
ratio.ratio("searchlib", "searchlib")                 # returns 100
ratio.ratio("searchlib", "srechlib")                  # returns 82
searches = ["searchlib", "srechlib"]
ratio.ratio_list("searchlib", searches)               # returns [100, 82]

# Getting matches and ratios:
match.match_with_score("searchlib", "srechlib")       # returns (True, 82)
searches = ["test", "nope", "tset"]
match.get_best_match_with_score("test", searches)     # returns ("test", 100)
match.get_best_matches_with_score("test", searches)   # returns [("test", 100), ("tset", 75)]

# Modify strings:
# This is meant for internal use, but you can also use it yourself, if you choose to.
strings.latinise("Héllö, world!")                     # returns "Hello, world!"
strings.remove_punctuation("wh'at;, ever")            # returns "what ever"
strings.only_letters("Héllö, world!")                 # returns "Hll world"
strings.ignore_case("test test!", lower=False)        # returns "TEST TEST!"

Additional Arguments

You can pass in additional arguments for the Match() functions to customise your search further:

score=int

The score cutoff for matching, by default set to 70.

match("searchlib", "srechlib", score=85)    # returns False
match("searchlib", "srechlib", score=70)    # returns True

limit=int

The limit of how many matches to return. Only available for Matches().get_best_matches(). By default this is set to 5.

searches = ["limit 5", "limit 4", "limit 3", "limit 2", "limit 1", "limit 0"]
get_best_matches("limit 5", searches, limit=2)  # returns ["limit 5", "limit 4"]
get_best_matches("limit 5", searches, limit=1)  # returns ["limit 5"]

latinise=bool

Replaces special unicode characters with their latin alphabet equivalents. By default turned off.

match("séärçh", "search", latinise=True)    # returns True
match("séärçh", "search", latinise=False)   # returns False

ignore_case=bool

If you want to ignore case sensitivity while searching. By default turned off.

match("test", "TEST", ignore_case=True)     # returns True
match("test", "TEST", ignore_case=False)    # returns False

remove_punctuation=bool

Removes commonly used punctuation symbols from the strings, like .,;:!? and so on. Be careful when using this, because if you pass in a string that is only made up of punctuation symbols, you will get an EmptySearchException. By default turned off.

match("test,---....", "test", remove_punctuation=True)  # returns True
match("test,---....", "test", remove_punctuation=False) # returns False

only_letters=bool

Removes every character that is not in the latin alphabet, a more extreme version of remove_punctuation. The same rules apply here, be careful when you use it or you might get an EmptySearchException. By default turned off.

match("»»ᅳtestᅳ►", "test", only_letters=True)   # returns True
match("»»ᅳtestᅳ►", "test", only_letters=False)  # returns False

scorer=str

The scoring algorithm to use, the available options are: "levenshtein", "jaro", "jaro_winkler". Different algorithms will produce different results, obviously. By default set to "levenshtein".

match("test", "th test", scorer="levenshtein")  # returns True (score = 73)
match("test", "th test", scorer="jaro_winkler") # returns False (score = 60)

Links

Packages used:

• Levenshtein
• Unidecode

Related packages:

• thefuzz