Skip to main content

A fast implementation of the Aho-Corasick algorithm using the compact double-array data structure

Project description

python-daachorse

daachorse is a fast implementation of the Aho-Corasick algorithm using the compact double-array data structure. This is a Python wrapper.

Installation

To use daachorse, run the following command:

$ pip install daachorse

Example usage

Daachorse contains some search options, ranging from basic matching with the Aho-Corasick algorithm to trickier matching. All of them will run very fast based on the double-array data structure and can be easily plugged into your application as shown below.

Finding overlapped occurrences

To search for all occurrences of registered patterns that allow for positional overlap in the input text, use find_overlapping(). When you instantiate a new automaton, unique identifiers are assigned to each pattern in the input order. The match result has the byte positions of the occurrence and its identifier.

>> import daachorse
>> patterns = ['bcd', 'ab', 'a']
>> pma = daachorse.Automaton(patterns)
>> pma.find_overlapping('abcd')
[(0, 1, 2), (0, 2, 1), (1, 4, 0)]

Finding non-overlapped occurrences with standard matching

If you do not want to allow positional overlap, use find() instead. It performs the search on the Aho-Corasick automaton and reports patterns first found in each iteration.

>> import daachorse
>> patterns = ['bcd', 'ab', 'a']
>> pma = daachorse.Automaton(patterns)
>> pma.find('abcd')
[(0, 1, 2), (1, 4, 0)]

Finding non-overlapped occurrences with longest matching

If you want to search for the longest pattern without positional overlap in each iteration, use MATCH_KIND_LEFTMOST_LONGEST in the construction.

>> import daachorse
>> patterns = ['ab', 'a', 'abcd']
>> pma = daachorse.Automaton(patterns, daachorse.MATCH_KIND_LEFTMOST_LONGEST)
>> pma.find('abcd')
[(0, 4, 2)]

Finding non-overlapped occurrences with leftmost-first matching

If you want to find the the earliest registered pattern among ones starting from the search position, use MATCH_KIND_LEFTMOST_FIRST.

This is so-called the leftmost first match, a bit tricky search option. For example, in the following code, ab is reported because it is the earliest registered one.

>> import daachorse
>> patterns = ['ab', 'a', 'abcd']
>> pma = daachorse.Automaton(patterns, daachorse.MATCH_KIND_LEFTMOST_FIRST)
>> pma.find('abcd')
[(0, 2, 0)]

License

Licensed under either of

at your option.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

daachorse-0.1.2-pp37-pypy37_pp73-manylinux_2_5_x86_64.manylinux1_x86_64.whl (548.6 kB view hashes)

Uploaded PyPy manylinux: glibc 2.5+ x86-64

daachorse-0.1.2-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.whl (547.2 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.5+ x86-64

daachorse-0.1.2-cp310-none-win_amd64.whl (144.4 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

daachorse-0.1.2-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.whl (547.2 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.5+ x86-64

daachorse-0.1.2-cp310-cp310-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl (480.4 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ universal2 (ARM64, x86-64) macOS 10.9+ x86-64 macOS 11.0+ ARM64

daachorse-0.1.2-cp39-none-win_amd64.whl (144.6 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

daachorse-0.1.2-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.whl (547.2 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.5+ x86-64

daachorse-0.1.2-cp39-cp39-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl (480.6 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ universal2 (ARM64, x86-64) macOS 10.9+ x86-64 macOS 11.0+ ARM64

daachorse-0.1.2-cp38-none-win_amd64.whl (145.2 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

daachorse-0.1.2-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.whl (547.6 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.5+ x86-64

daachorse-0.1.2-cp38-cp38-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl (480.7 kB view hashes)

Uploaded CPython 3.8 macOS 10.9+ universal2 (ARM64, x86-64) macOS 10.9+ x86-64 macOS 11.0+ ARM64

daachorse-0.1.2-cp37-none-win_amd64.whl (145.1 kB view hashes)

Uploaded CPython 3.7 Windows x86-64

daachorse-0.1.2-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl (547.6 kB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.5+ x86-64

daachorse-0.1.2-cp37-cp37m-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl (480.7 kB view hashes)

Uploaded CPython 3.7m macOS 10.9+ universal2 (ARM64, x86-64) macOS 10.9+ x86-64 macOS 11.0+ ARM64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page