Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@
* 0.9.0 - Changed \_\_contains\_\_ and get() to conform to Pythonic conventions. Cleanup of type checking issues subsequent to change to mixin architecture.
* 0.9.1 - Added 'runtime_validation' property and initialization parameter for performance. Tweaked use of pyright directives to reduce visual noise in code. Simplified GeneralizedKey alias declaration by removing explict inclusion of 'str'.
* 0.9.2 - Refactor of exceptions and test code to use tagged exceptions. Seperation of testspecs testing framework into seperate file. First iteration of benchmarking code.
* 0.9.3 - Addition of coverage support. Tests for traversal.py. pytest support. Test orchestration using pytest-order and pytest-dependency. Fixed TrieValueError export.
2 changes: 1 addition & 1 deletion docs/html/.buildinfo.bak
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0484327447754750090e8467a7a1971f
config: 9571a42aa11f6494d3b2a158bf69a227
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 1 addition & 1 deletion docs/html/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.9.2',
VERSION: '0.9.3',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
16 changes: 8 additions & 8 deletions docs/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
<meta name="theme-color" media="(prefers-color-scheme: light)" content="white" />
<meta name="theme-color" media="(prefers-color-scheme: dark)" content="black" />

<title>Index | gen-tries 0.9.2 documentation</title>
<meta property="og:title" content="Index | gen-tries 0.9.2 documentation" />
<meta name="twitter:title" content="Index | gen-tries 0.9.2 documentation" />
<title>Index | gen-tries 0.9.3 documentation</title>
<meta property="og:title" content="Index | gen-tries 0.9.3 documentation" />
<meta name="twitter:title" content="Index | gen-tries 0.9.3 documentation" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=c309799c" />
<link rel="stylesheet" type="text/css" href="_static/theme.css?v=42baaae4" />
<link rel="search" title="Search" href="search.html" />
Expand All @@ -39,7 +39,7 @@
</a><header
class="sticky top-0 z-40 w-full border-b shadow-sm border-border supports-backdrop-blur:bg-background/60 bg-background/95 backdrop-blur"><div class="container flex items-center h-14">
<div class="hidden mr-4 md:flex">
<a href="index.html" class="flex items-center mr-6"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">gen-tries 0.9.2 documentation</span>
<a href="index.html" class="flex items-center mr-6"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">gen-tries 0.9.3 documentation</span>
</a></div><button
class="inline-flex items-center justify-center h-10 px-0 py-2 mr-2 text-base font-medium transition-colors rounded-md hover:text-accent-foreground hover:bg-transparent md:hidden"
type="button" @click="showSidebar = true">
Expand Down Expand Up @@ -94,7 +94,7 @@
class="fixed inset-y-0 left-0 md:top-14 z-50 md:z-30 bg-background md:bg-transparent transition-all duration-100 -translate-x-full md:translate-x-0 ml-0 p-6 md:p-0 md:-ml-2 md:h-[calc(100vh-3.5rem)] w-5/6 md:w-full shrink-0 overflow-y-auto border-r border-border md:sticky"
:aria-hidden="!showSidebar" :class="{ 'translate-x-0': showSidebar }">

<a href="index.html" class="!justify-start text-sm md:!hidden bg-background"><span class="font-bold text-clip whitespace-nowrap">gen-tries 0.9.2 documentation</span>
<a href="index.html" class="!justify-start text-sm md:!hidden bg-background"><span class="font-bold text-clip whitespace-nowrap">gen-tries 0.9.3 documentation</span>
</a>

<div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
Expand Down Expand Up @@ -126,7 +126,7 @@
class="flex items-center mb-4 space-x-1 text-sm text-muted-foreground">
<a class="overflow-hidden text-ellipsis whitespace-nowrap hover:text-foreground"
href="index.html">
<span class="hidden md:inline">gen-tries 0.9.2 documentation</span>
<span class="hidden md:inline">gen-tries 0.9.3 documentation</span>
<svg xmlns="http://www.w3.org/2000/svg"
height="18"
width="18"
Expand Down Expand Up @@ -672,7 +672,7 @@ <h2 id="T">T</h2>
</li>
<li><a href="gentrie.html#gentrie.TrieTypeError">TrieTypeError</a>, <a href="gentrie.html#gentrie.exceptions.TrieTypeError">[1]</a>
</li>
<li><a href="gentrie.html#gentrie.exceptions.TrieValueError">TrieValueError</a>
<li><a href="gentrie.html#gentrie.TrieValueError">TrieValueError</a>, <a href="gentrie.html#gentrie.exceptions.TrieValueError">[1]</a>
</li>
</ul></td>
</tr>
Expand Down Expand Up @@ -736,7 +736,7 @@ <h2 id="V">V</h2>
</footer>
</div>

<script src="_static/documentation_options.js?v=aa3b121e"></script>
<script src="_static/documentation_options.js?v=0e439607"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script defer="defer" src="_static/theme.js?v=073f68d9"></script>
Expand Down
34 changes: 27 additions & 7 deletions docs/html/gentrie.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
<meta content="white" media="(prefers-color-scheme: light)" name="theme-color"/>
<meta content="black" media="(prefers-color-scheme: dark)" name="theme-color"/>
<meta content="width=device-width, initial-scale=1" name="viewport"/>
<title>gentrie package | gen-tries 0.9.2 documentation</title>
<meta content="gentrie package | gen-tries 0.9.2 documentation" property="og:title"/>
<meta content="gentrie package | gen-tries 0.9.2 documentation" name="twitter:title"/>
<title>gentrie package | gen-tries 0.9.3 documentation</title>
<meta content="gentrie package | gen-tries 0.9.3 documentation" property="og:title"/>
<meta content="gentrie package | gen-tries 0.9.3 documentation" name="twitter:title"/>
<link href="_static/pygments.css?v=c309799c" rel="stylesheet" type="text/css"/>
<link href="_static/theme.css?v=42baaae4" rel="stylesheet" type="text/css"/>
<link href="search.html" rel="search" title="Search"/>
Expand All @@ -34,7 +34,7 @@
Skip to content
</a><header class="sticky top-0 z-40 w-full border-b shadow-sm border-border supports-backdrop-blur:bg-background/60 bg-background/95 backdrop-blur"><div class="container flex items-center h-14">
<div class="hidden mr-4 md:flex">
<a class="flex items-center mr-6" href="index.html"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">gen-tries 0.9.2 documentation</span>
<a class="flex items-center mr-6" href="index.html"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">gen-tries 0.9.3 documentation</span>
</a></div><button @click="showSidebar = true" class="inline-flex items-center justify-center h-10 px-0 py-2 mr-2 text-base font-medium transition-colors rounded-md hover:text-accent-foreground hover:bg-transparent md:hidden" type="button">
<svg aria-hidden="true" fill="currentColor" height="24" viewbox="0 96 960 960" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M152.587 825.087q-19.152 0-32.326-13.174t-13.174-32.326q0-19.152 13.174-32.326t32.326-13.174h440q19.152 0 32.326 13.174t13.174 32.326q0 19.152-13.174 32.326t-32.326 13.174h-440Zm0-203.587q-19.152 0-32.326-13.174T107.087 576q0-19.152 13.174-32.326t32.326-13.174h320q19.152 0 32.326 13.174T518.087 576q0 19.152-13.174 32.326T472.587 621.5h-320Zm0-203.587q-19.152 0-32.326-13.174t-13.174-32.326q0-19.152 13.174-32.326t32.326-13.174h440q19.152 0 32.326 13.174t13.174 32.326q0 19.152-13.174 32.326t-32.326 13.174h-440ZM708.913 576l112.174 112.174q12.674 12.674 12.674 31.826t-12.674 31.826Q808.413 764.5 789.261 764.5t-31.826-12.674l-144-144Q600 594.391 600 576t13.435-31.826l144-144q12.674-12.674 31.826-12.674t31.826 12.674q12.674 12.674 12.674 31.826t-12.674 31.826L708.913 576Z"></path>
Expand Down Expand Up @@ -64,7 +64,7 @@
</div>
</header>
<div class="flex-1"><div class="container flex-1 items-start md:grid md:grid-cols-[220px_minmax(0,1fr)] md:gap-6 lg:grid-cols-[240px_minmax(0,1fr)] lg:gap-10"><aside :aria-hidden="!showSidebar" :class="{ 'translate-x-0': showSidebar }" class="fixed inset-y-0 left-0 md:top-14 z-50 md:z-30 bg-background md:bg-transparent transition-all duration-100 -translate-x-full md:translate-x-0 ml-0 p-6 md:p-0 md:-ml-2 md:h-[calc(100vh-3.5rem)] w-5/6 md:w-full shrink-0 overflow-y-auto border-r border-border md:sticky" id="left-sidebar">
<a class="!justify-start text-sm md:!hidden bg-background" href="index.html"><span class="font-bold text-clip whitespace-nowrap">gen-tries 0.9.2 documentation</span>
<a class="!justify-start text-sm md:!hidden bg-background" href="index.html"><span class="font-bold text-clip whitespace-nowrap">gen-tries 0.9.3 documentation</span>
</a>
<div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
<div class="overflow-y-auto h-full w-full relative pr-6"><nav class="table w-full min-w-full my-6 lg:my-8">
Expand All @@ -89,7 +89,7 @@
<div class="w-full min-w-0 mx-auto">
<nav aria-label="breadcrumbs" class="flex items-center mb-4 space-x-1 text-sm text-muted-foreground">
<a class="overflow-hidden text-ellipsis whitespace-nowrap hover:text-foreground" href="index.html">
<span class="hidden md:inline">gen-tries 0.9.2 documentation</span>
<span class="hidden md:inline">gen-tries 0.9.3 documentation</span>
<svg aria-label="Home" class="md:hidden" fill="currentColor" height="18" stroke="none" viewbox="0 96 960 960" width="18" xmlns="http://www.w3.org/2000/svg">
<path d="M240 856h120V616h240v240h120V496L480 316 240 496v360Zm-80 80V456l320-240 320 240v480H520V696h-80v240H160Zm320-350Z"></path>
</svg>
Expand Down Expand Up @@ -992,6 +992,25 @@ <h4>Example 3 - Entries prefixed by a key<a class="headerlink" href="#example-3-
</dd>
</dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="gentrie.TrieValueError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gentrie.</span></span><span class="sig-name descname"><span class="pre">TrieValueError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gentrie.exceptions.ErrorTag" title="gentrie.exceptions.ErrorTag"><span class="pre">ErrorTag</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gentrie.TrieValueError" title="Link to this definition" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#gentrie.TrieValueError'">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></a></p>
<p>Base class for all trie-related value errors.</p>
<p>It differs from a standard ValueError by the addition of a
tag code used to very specifically identify where the error
was thrown in the code for testing and development support.</p>
<p>This tag code does not have a direct semantic meaning except to identify
the specific code throwing the exception for tests.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>msg</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The error message.</p></li>
<li><p><strong>tag</strong> (<a class="reference internal" href="#gentrie.ErrorTag" title="gentrie.ErrorTag"><em>ErrorTag</em></a>) – The tag code.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gentrie.is_generalizedkey">
<span class="sig-prename descclassname"><span class="pre">gentrie.</span></span><span class="sig-name descname"><span class="pre">is_generalizedkey</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span></span><a class="headerlink" href="#gentrie.is_generalizedkey" title="Link to this definition" x-intersect.margin.0%.0%.-70%.0%="activeSection = '#gentrie.is_generalizedkey'">¶</a></dt>
Expand Down Expand Up @@ -1142,6 +1161,7 @@ <h4>Example 3 - Entries prefixed by a key<a class="headerlink" href="#example-3-
<li><a :data-current="activeSection === '#gentrie.TrieKeyError'" class="reference internal" href="#gentrie.TrieKeyError"><code class="docutils literal notranslate"><span class="pre">TrieKeyError</span></code></a></li>
<li><a :data-current="activeSection === '#gentrie.TrieKeyToken'" class="reference internal" href="#gentrie.TrieKeyToken"><code class="docutils literal notranslate"><span class="pre">TrieKeyToken</span></code></a></li>
<li><a :data-current="activeSection === '#gentrie.TrieTypeError'" class="reference internal" href="#gentrie.TrieTypeError"><code class="docutils literal notranslate"><span class="pre">TrieTypeError</span></code></a></li>
<li><a :data-current="activeSection === '#gentrie.TrieValueError'" class="reference internal" href="#gentrie.TrieValueError"><code class="docutils literal notranslate"><span class="pre">TrieValueError</span></code></a></li>
<li><a :data-current="activeSection === '#gentrie.is_generalizedkey'" class="reference internal" href="#gentrie.is_generalizedkey"><code class="docutils literal notranslate"><span class="pre">is_generalizedkey()</span></code></a></li>
<li><a :data-current="activeSection === '#gentrie.is_hashable'" class="reference internal" href="#gentrie.is_hashable"><code class="docutils literal notranslate"><span class="pre">is_hashable()</span></code></a></li>
<li><a :data-current="activeSection === '#gentrie.is_triekeytoken'" class="reference internal" href="#gentrie.is_triekeytoken"><code class="docutils literal notranslate"><span class="pre">is_triekeytoken()</span></code></a></li>
Expand All @@ -1160,7 +1180,7 @@ <h4>Example 3 - Entries prefixed by a key<a class="headerlink" href="#example-3-
</div>
</footer>
</div>
<script src="_static/documentation_options.js?v=aa3b121e"></script>
<script src="_static/documentation_options.js?v=0e439607"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script defer="defer" src="_static/theme.js?v=073f68d9"></script>
Expand Down
14 changes: 7 additions & 7 deletions docs/html/gentrie.trie.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
<meta content="white" media="(prefers-color-scheme: light)" name="theme-color"/>
<meta content="black" media="(prefers-color-scheme: dark)" name="theme-color"/>
<meta content="width=device-width, initial-scale=1" name="viewport"/>
<title>gentrie.trie package | gen-tries 0.9.2 documentation</title>
<meta content="gentrie.trie package | gen-tries 0.9.2 documentation" property="og:title"/>
<meta content="gentrie.trie package | gen-tries 0.9.2 documentation" name="twitter:title"/>
<title>gentrie.trie package | gen-tries 0.9.3 documentation</title>
<meta content="gentrie.trie package | gen-tries 0.9.3 documentation" property="og:title"/>
<meta content="gentrie.trie package | gen-tries 0.9.3 documentation" name="twitter:title"/>
<link href="_static/pygments.css?v=c309799c" rel="stylesheet" type="text/css"/>
<link href="_static/theme.css?v=42baaae4" rel="stylesheet" type="text/css"/>
<link href="search.html" rel="search" title="Search"/>
Expand All @@ -33,7 +33,7 @@
Skip to content
</a><header class="sticky top-0 z-40 w-full border-b shadow-sm border-border supports-backdrop-blur:bg-background/60 bg-background/95 backdrop-blur"><div class="container flex items-center h-14">
<div class="hidden mr-4 md:flex">
<a class="flex items-center mr-6" href="index.html"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">gen-tries 0.9.2 documentation</span>
<a class="flex items-center mr-6" href="index.html"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">gen-tries 0.9.3 documentation</span>
</a></div><button @click="showSidebar = true" class="inline-flex items-center justify-center h-10 px-0 py-2 mr-2 text-base font-medium transition-colors rounded-md hover:text-accent-foreground hover:bg-transparent md:hidden" type="button">
<svg aria-hidden="true" fill="currentColor" height="24" viewbox="0 96 960 960" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M152.587 825.087q-19.152 0-32.326-13.174t-13.174-32.326q0-19.152 13.174-32.326t32.326-13.174h440q19.152 0 32.326 13.174t13.174 32.326q0 19.152-13.174 32.326t-32.326 13.174h-440Zm0-203.587q-19.152 0-32.326-13.174T107.087 576q0-19.152 13.174-32.326t32.326-13.174h320q19.152 0 32.326 13.174T518.087 576q0 19.152-13.174 32.326T472.587 621.5h-320Zm0-203.587q-19.152 0-32.326-13.174t-13.174-32.326q0-19.152 13.174-32.326t32.326-13.174h440q19.152 0 32.326 13.174t13.174 32.326q0 19.152-13.174 32.326t-32.326 13.174h-440ZM708.913 576l112.174 112.174q12.674 12.674 12.674 31.826t-12.674 31.826Q808.413 764.5 789.261 764.5t-31.826-12.674l-144-144Q600 594.391 600 576t13.435-31.826l144-144q12.674-12.674 31.826-12.674t31.826 12.674q12.674 12.674 12.674 31.826t-12.674 31.826L708.913 576Z"></path>
Expand Down Expand Up @@ -63,7 +63,7 @@
</div>
</header>
<div class="flex-1"><div class="container flex-1 items-start md:grid md:grid-cols-[220px_minmax(0,1fr)] md:gap-6 lg:grid-cols-[240px_minmax(0,1fr)] lg:gap-10"><aside :aria-hidden="!showSidebar" :class="{ 'translate-x-0': showSidebar }" class="fixed inset-y-0 left-0 md:top-14 z-50 md:z-30 bg-background md:bg-transparent transition-all duration-100 -translate-x-full md:translate-x-0 ml-0 p-6 md:p-0 md:-ml-2 md:h-[calc(100vh-3.5rem)] w-5/6 md:w-full shrink-0 overflow-y-auto border-r border-border md:sticky" id="left-sidebar">
<a class="!justify-start text-sm md:!hidden bg-background" href="index.html"><span class="font-bold text-clip whitespace-nowrap">gen-tries 0.9.2 documentation</span>
<a class="!justify-start text-sm md:!hidden bg-background" href="index.html"><span class="font-bold text-clip whitespace-nowrap">gen-tries 0.9.3 documentation</span>
</a>
<div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
<div class="overflow-y-auto h-full w-full relative pr-6"><nav class="table w-full min-w-full my-6 lg:my-8">
Expand All @@ -88,7 +88,7 @@
<div class="w-full min-w-0 mx-auto">
<nav aria-label="breadcrumbs" class="flex items-center mb-4 space-x-1 text-sm text-muted-foreground">
<a class="overflow-hidden text-ellipsis whitespace-nowrap hover:text-foreground" href="index.html">
<span class="hidden md:inline">gen-tries 0.9.2 documentation</span>
<span class="hidden md:inline">gen-tries 0.9.3 documentation</span>
<svg aria-label="Home" class="md:hidden" fill="currentColor" height="18" stroke="none" viewbox="0 96 960 960" width="18" xmlns="http://www.w3.org/2000/svg">
<path d="M240 856h120V616h240v240h120V496L480 316 240 496v360Zm-80 80V456l320-240 320 240v480H520V696h-80v240H160Zm320-350Z"></path>
</svg>
Expand Down Expand Up @@ -672,7 +672,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
</div>
</footer>
</div>
<script src="_static/documentation_options.js?v=aa3b121e"></script>
<script src="_static/documentation_options.js?v=0e439607"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script defer="defer" src="_static/theme.js?v=073f68d9"></script>
Expand Down
Loading