commit 057e20163d2676e9f6e1510ee81d313199152aee Author: Sam G. Date: Thu Mar 28 23:11:30 2024 -0700 initial commit diff --git a/.python-version b/.python-version new file mode 100644 index 0000000..94aa8a4 --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +co4 diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..e69de29 diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..8d88d76 --- /dev/null +++ b/Makefile @@ -0,0 +1,16 @@ +PYTHON=/home/smgr/.pyenv/versions/co4/bin/python +BASH=/usr/bin/bash + + +## ------------------ docs ------------------ ## +docs-build: + sphinx-apidoc --module-first -o docs/_autoref/ co4 + make -C docs/ html + +docs-serve: + cd docs/_build/html && python -m http.server 9090 + +docs-clean: + make -C docs/ clean +## ------------------------------------------ ## + diff --git a/README.md b/README.md new file mode 100644 index 0000000..fff4fd0 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Overview +`co3` is a package for file conversion and associated database operations. The `CO3` base class +provides a standard interface for performing conversions, preparing inserts, and +interacting with database schemas that mirror the class hierarchy. + +Simplified description of the operational model: + +**Goal**: interact with a storage medium (database, pickled structure, VSS framework) with +a known schema. + +- **Accessor** to provide access to stored items +- **Composer** to compose common access points (e.g., JOINed tables) +- **Indexer** to index/cache access queries +- **Manager** to manage storage state (e.g., supported inserts, database syncs) +- **Collector** to collect data for updating storage state +- **Database** to collect data for updating storage state +- **Mapper** to collect data for updating storage state +- **Relation** to collect data for updating storage state + +**CO3** is an abstract base class that makes it easy to integrate this model with object +hierarchies that mirror a storage schema. diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/__init__.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/__init__.py new file mode 120000 index 0000000..6945f64 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/__init__.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/__init__.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/accessor.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/accessor.py new file mode 120000 index 0000000..2ef50e7 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/accessor.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/accessor.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/accessors/__init__.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/accessors/__init__.py new file mode 120000 index 0000000..d57d1d7 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/accessors/__init__.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/accessors/__init__.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/accessors/fts.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/accessors/fts.py new file mode 120000 index 0000000..a015fd1 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/accessors/fts.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/accessors/fts.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/accessors/sql.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/accessors/sql.py new file mode 120000 index 0000000..3f162d7 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/accessors/sql.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/accessors/sql.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/accessors/vss.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/accessors/vss.py new file mode 120000 index 0000000..e0e5848 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/accessors/vss.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/accessors/vss.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/co3.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/co3.py new file mode 120000 index 0000000..202952a --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/co3.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/co3.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/collector.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/collector.py new file mode 120000 index 0000000..6d2ae9a --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/collector.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/collector.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/composer.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/composer.py new file mode 120000 index 0000000..7802f23 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/composer.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/composer.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/database.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/database.py new file mode 120000 index 0000000..8438d1e --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/database.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/database.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/databases/__init__.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/databases/__init__.py new file mode 120000 index 0000000..36b6a34 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/databases/__init__.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/databases/__init__.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/databases/fts.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/databases/fts.py new file mode 120000 index 0000000..7cff9ab --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/databases/fts.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/databases/fts.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/databases/sql.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/databases/sql.py new file mode 120000 index 0000000..9b158a9 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/databases/sql.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/databases/sql.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/databases/vss.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/databases/vss.py new file mode 120000 index 0000000..c92c586 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/databases/vss.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/databases/vss.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/indexer.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/indexer.py new file mode 120000 index 0000000..410ce45 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/indexer.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/indexer.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/manager.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/manager.py new file mode 120000 index 0000000..e575dc4 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/manager.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/manager.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/managers/__init__.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/managers/__init__.py new file mode 120000 index 0000000..5e3ac6f --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/managers/__init__.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/managers/__init__.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/managers/fts.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/managers/fts.py new file mode 120000 index 0000000..fd3745f --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/managers/fts.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/managers/fts.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/managers/sql.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/managers/sql.py new file mode 120000 index 0000000..cbeec0f --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/managers/sql.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/managers/sql.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/managers/vss.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/managers/vss.py new file mode 120000 index 0000000..58f2c07 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/managers/vss.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/managers/vss.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/mapper.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/mapper.py new file mode 120000 index 0000000..3fd58c9 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/mapper.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/mapper.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/relation.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/relation.py new file mode 120000 index 0000000..0b07dfb --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/relation.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/relation.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/relations/__init__.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/relations/__init__.py new file mode 120000 index 0000000..25617d3 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/relations/__init__.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/relations/__init__.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/util/__init__.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/util/__init__.py new file mode 120000 index 0000000..00f184b --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/util/__init__.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/util/__init__.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/util/db.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/util/db.py new file mode 120000 index 0000000..0f263c2 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/util/db.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/util/db.py \ No newline at end of file diff --git a/build/__editable__.co3-0.1.1-py3-none-any/co3/util/regex.py b/build/__editable__.co3-0.1.1-py3-none-any/co3/util/regex.py new file mode 120000 index 0000000..eeb2ce3 --- /dev/null +++ b/build/__editable__.co3-0.1.1-py3-none-any/co3/util/regex.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co3/co3/util/regex.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/__init__.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/__init__.py new file mode 120000 index 0000000..2185402 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/__init__.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/__init__.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/accessor.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/accessor.py new file mode 120000 index 0000000..fe0209c --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/accessor.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/accessor.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/accessors/__init__.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/accessors/__init__.py new file mode 120000 index 0000000..67548ba --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/accessors/__init__.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/accessors/__init__.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/accessors/fts.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/accessors/fts.py new file mode 120000 index 0000000..c266881 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/accessors/fts.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/accessors/fts.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/accessors/table.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/accessors/table.py new file mode 120000 index 0000000..2e05a5d --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/accessors/table.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/accessors/table.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/accessors/vss.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/accessors/vss.py new file mode 120000 index 0000000..97eacf6 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/accessors/vss.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/accessors/vss.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/co4.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/co4.py new file mode 120000 index 0000000..e4548c1 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/co4.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/co4.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/collector.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/collector.py new file mode 120000 index 0000000..f762f63 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/collector.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/collector.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/composer.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/composer.py new file mode 120000 index 0000000..2220175 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/composer.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/composer.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/__init__.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/__init__.py new file mode 120000 index 0000000..124710b --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/__init__.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/databases/__init__.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/_base.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/_base.py new file mode 120000 index 0000000..0620c20 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/_base.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/databases/_base.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/core.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/core.py new file mode 120000 index 0000000..ddb8a85 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/core.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/databases/core.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/fts.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/fts.py new file mode 120000 index 0000000..8fba3cb --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/fts.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/databases/fts.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/vss.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/vss.py new file mode 120000 index 0000000..2daa6c6 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/databases/vss.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/databases/vss.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/indexer.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/indexer.py new file mode 120000 index 0000000..757ffd2 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/indexer.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/indexer.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/manager.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/manager.py new file mode 120000 index 0000000..8585495 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/manager.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/manager.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/managers/__init__.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/managers/__init__.py new file mode 120000 index 0000000..1c4ff87 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/managers/__init__.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/managers/__init__.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/managers/core.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/managers/core.py new file mode 120000 index 0000000..872cf15 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/managers/core.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/managers/core.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/managers/fts.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/managers/fts.py new file mode 120000 index 0000000..d9fae88 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/managers/fts.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/managers/fts.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/managers/vss.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/managers/vss.py new file mode 120000 index 0000000..bd70f75 --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/managers/vss.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/managers/vss.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/utils/db.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/utils/db.py new file mode 120000 index 0000000..7e332ab --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/utils/db.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/utils/db.py \ No newline at end of file diff --git a/build/__editable__.co4-0.1.1-py3-none-any/co4/utils/paths.py b/build/__editable__.co4-0.1.1-py3-none-any/co4/utils/paths.py new file mode 120000 index 0000000..f3790de --- /dev/null +++ b/build/__editable__.co4-0.1.1-py3-none-any/co4/utils/paths.py @@ -0,0 +1 @@ +/home/smgr/Documents/projects/ontolog/co4/co4/utils/paths.py \ No newline at end of file diff --git a/co3.egg-info/PKG-INFO b/co3.egg-info/PKG-INFO new file mode 100644 index 0000000..17a54cd --- /dev/null +++ b/co3.egg-info/PKG-INFO @@ -0,0 +1,30 @@ +Metadata-Version: 2.1 +Name: co3 +Version: 0.1.1 +Summary: Lightweight ORM +Author-email: Sam Griesemer +Classifier: Programming Language :: Python :: 3 +Classifier: License :: OSI Approved :: MIT License +Classifier: Operating System :: OS Independent +Requires-Python: >=3.11 +Description-Content-Type: text/markdown +Requires-Dist: tqdm + +# Overview +`co4` is a package for file conversion and associated database operations. The `CO4` base class +provides a standard interface for performing conversions, preparing inserts, and +interacting with database schemas that mirror the class hierarchy. + +Simplified description of the operational model: + +**Goal**: interact with a storage medium (database, pickled structure, VSS framework) with +a known schema. + +- **Accessor** to provide access to stored items +- **Composer** to compose common access points (e.g., JOINed tables) +- **Indexer** to index/cache access queries +- **Manager** to manage storage state (e.g., supported inserts, database syncs) +- **Collector** to collect data for updating storage state + +**CO4** is an abstract base class that makes it easy to integrate this model with object +hierarchies that mirror a storage schema. diff --git a/co3.egg-info/SOURCES.txt b/co3.egg-info/SOURCES.txt new file mode 100644 index 0000000..fde29fa --- /dev/null +++ b/co3.egg-info/SOURCES.txt @@ -0,0 +1,34 @@ +MANIFEST.in +README.md +pyproject.toml +co3/__init__.py +co3/accessor.py +co3/co3.py +co3/collector.py +co3/composer.py +co3/database.py +co3/indexer.py +co3/manager.py +co3/mapper.py +co3/relation.py +co3.egg-info/PKG-INFO +co3.egg-info/SOURCES.txt +co3.egg-info/dependency_links.txt +co3.egg-info/requires.txt +co3.egg-info/top_level.txt +co3/accessors/__init__.py +co3/accessors/fts.py +co3/accessors/sql.py +co3/accessors/vss.py +co3/databases/__init__.py +co3/databases/fts.py +co3/databases/sql.py +co3/databases/vss.py +co3/managers/__init__.py +co3/managers/fts.py +co3/managers/sql.py +co3/managers/vss.py +co3/relations/__init__.py +co3/util/__init__.py +co3/util/db.py +co3/util/regex.py \ No newline at end of file diff --git a/co3.egg-info/dependency_links.txt b/co3.egg-info/dependency_links.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/co3.egg-info/dependency_links.txt @@ -0,0 +1 @@ + diff --git a/co3.egg-info/requires.txt b/co3.egg-info/requires.txt new file mode 100644 index 0000000..78620c4 --- /dev/null +++ b/co3.egg-info/requires.txt @@ -0,0 +1 @@ +tqdm diff --git a/co3.egg-info/top_level.txt b/co3.egg-info/top_level.txt new file mode 100644 index 0000000..7d71d10 --- /dev/null +++ b/co3.egg-info/top_level.txt @@ -0,0 +1 @@ +co3 diff --git a/co3/__init__.py b/co3/__init__.py new file mode 100644 index 0000000..0b6fc93 --- /dev/null +++ b/co3/__init__.py @@ -0,0 +1,109 @@ +''' +Database submodule + +- `db`: contains SQLAlchemy-based schema definitions +- `accessors`: convenience methods for accessing database entries +- `populate`: convenience methods for populating database tables + +The `accessors` and `populate` submodules are each split into `schema` and `fts` method +groups. The former concerns methods relating to the actual database schema, the latter to +their SQLite FTS counterparts. + +Note: Subpackages organization + Subpackages are broken up by inheritance. Within a given submodule, you have a + `_base.py` file defining the base class associated with that submodule's title, along + with concrete subclasses of that base in their own files. Deeper inheritance would + recursively extend this structure. The `__init__.py` for a given submodule then + exposes the concrete instances, leaving the base hidden. For example, + + accessors/ + _base.py + core.py + fts.py + + `core` and `fts` house the `CoreAccessor` and `FTSAccessor` classes, respectively, + and are the direct subclasses of the `Accessor` parent found in the `_base`. This base + class _could_ be placed outside of the submodule in the parent directory (imported + with something like `from db import accessor` instead of `from db.accessor import + _base`). This is entirely valid, but I tend to prefer when the base class is among its + direct children, as + + - In this case at least, the base doesn't need to be exposed + - The base class is being stowed away under an appropriately named submodule; having a + separate `accessor.py` and `accessors/` file/directory can feel a little cluttered. + - It makes imports across the accessors feel standardized: + + ```py + from localsys.db.accessors._base import Accessor + + from localsys.db.accessors.core import CoreAccessor + ``` + + Both have the same level of nesting to reach the class. + + Frankly, both means of organization are perfectly fine, and as far as I can tell, + semantically sound in their own right. This particular scheme is just a preference in + the moment, and so long as I keep things consistent, choosing one over the other + shouldn't matter. + + Additionally, note how `__init__.py`s are typically set up when providing wider access + to internal modules. The `init` typically pulls out classes from sibling modules + (i.e., files), but will import subpackages are the topmost level. For example, for the + structure + + ``` + db/ + __init__.py + accessors/ + __init__.py + _base.py + core.py + fts.py + ``` + + we have + + ```db/__init__.py + from localsys.db import accessors + ``` + + which just imports the subpackage `accessors`. However, within subpackage: + + ```db/accessors/__init__.py + from localsys.db.accessors.core import CoreAccessor + ``` + + we don't just import the submodule `core`; we did into the file to grab the relevant + class and pull it into the outer namespace. Overarching point: `__init__.py` files + typically reach into the sibling files (submodules) and pull out classes. Given that + this behavior is recursive, `__init__.py` then respect subpackages (nested + directories), importing them at the top-level and expecting an internal `__init__.py` + will have managed access appropriately. + +Note: Organization for inheritance over composition + At a glance, the organization of subpackages here feels like it clashes with those + seen in `localsys.primitives`. `note_components`, for instance, houses the components + for the outer `note` module. Contrast this with how the `core` submodule looks: it's + composing `*/core.py` files across subpackages `accessors` and `managers`, rather than + a single subpackage like `note`. This seems inconsistent, but the subpackages here are + actually still organized in the same way: by inheritance. It just happens that the + all of the note components inherit from the same base class, and are thus confined to + a single subpackage. This aside, the subpackages themselves are still created around + inheritance, wrapping up a base and direct subclasses. +''' + +from co3.accessor import Accessor +from co3.co3 import CO3 +from co3.collector import Collector +from co3.composer import Composer +from co3.database import Database +from co3.indexer import Indexer +from co3.manager import Manager +from co3.mapper import Mapper +from co3.relation import Relation + +from co3 import accessors +from co3 import databases +from co3 import managers +from co3 import relations +from co3 import util diff --git a/co3/__pycache__/__init__.cpython-311.pyc b/co3/__pycache__/__init__.cpython-311.pyc new file mode 100644 index 0000000..279a321 Binary files /dev/null and b/co3/__pycache__/__init__.cpython-311.pyc differ diff --git a/co3/__pycache__/__init__.cpython-312.pyc b/co3/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000..d700a87 Binary files /dev/null and b/co3/__pycache__/__init__.cpython-312.pyc differ diff --git a/co3/__pycache__/accessor.cpython-311.pyc b/co3/__pycache__/accessor.cpython-311.pyc new file mode 100644 index 0000000..2aa0c1c Binary files /dev/null and b/co3/__pycache__/accessor.cpython-311.pyc differ diff --git a/co3/__pycache__/accessor.cpython-312.pyc b/co3/__pycache__/accessor.cpython-312.pyc new file mode 100644 index 0000000..b4c4b53 Binary files /dev/null and b/co3/__pycache__/accessor.cpython-312.pyc differ diff --git a/co3/__pycache__/co3.cpython-312.pyc b/co3/__pycache__/co3.cpython-312.pyc new file mode 100644 index 0000000..5d4e7aa Binary files /dev/null and b/co3/__pycache__/co3.cpython-312.pyc differ diff --git a/co3/__pycache__/co4.cpython-311.pyc b/co3/__pycache__/co4.cpython-311.pyc new file mode 100644 index 0000000..8f13620 Binary files /dev/null and b/co3/__pycache__/co4.cpython-311.pyc differ diff --git a/co3/__pycache__/collector.cpython-311.pyc b/co3/__pycache__/collector.cpython-311.pyc new file mode 100644 index 0000000..a709f04 Binary files /dev/null and b/co3/__pycache__/collector.cpython-311.pyc differ diff --git a/co3/__pycache__/collector.cpython-312.pyc b/co3/__pycache__/collector.cpython-312.pyc new file mode 100644 index 0000000..4d3aac1 Binary files /dev/null and b/co3/__pycache__/collector.cpython-312.pyc differ diff --git a/co3/__pycache__/composer.cpython-311.pyc b/co3/__pycache__/composer.cpython-311.pyc new file mode 100644 index 0000000..3008c65 Binary files /dev/null and b/co3/__pycache__/composer.cpython-311.pyc differ diff --git a/co3/__pycache__/composer.cpython-312.pyc b/co3/__pycache__/composer.cpython-312.pyc new file mode 100644 index 0000000..8d71fc9 Binary files /dev/null and b/co3/__pycache__/composer.cpython-312.pyc differ diff --git a/co3/__pycache__/database.cpython-312.pyc b/co3/__pycache__/database.cpython-312.pyc new file mode 100644 index 0000000..5aa0666 Binary files /dev/null and b/co3/__pycache__/database.cpython-312.pyc differ diff --git a/co3/__pycache__/indexer.cpython-311.pyc b/co3/__pycache__/indexer.cpython-311.pyc new file mode 100644 index 0000000..772dcb5 Binary files /dev/null and b/co3/__pycache__/indexer.cpython-311.pyc differ diff --git a/co3/__pycache__/indexer.cpython-312.pyc b/co3/__pycache__/indexer.cpython-312.pyc new file mode 100644 index 0000000..1507ded Binary files /dev/null and b/co3/__pycache__/indexer.cpython-312.pyc differ diff --git a/co3/__pycache__/manager.cpython-311.pyc b/co3/__pycache__/manager.cpython-311.pyc new file mode 100644 index 0000000..94a5ac6 Binary files /dev/null and b/co3/__pycache__/manager.cpython-311.pyc differ diff --git a/co3/__pycache__/manager.cpython-312.pyc b/co3/__pycache__/manager.cpython-312.pyc new file mode 100644 index 0000000..ac06779 Binary files /dev/null and b/co3/__pycache__/manager.cpython-312.pyc differ diff --git a/co3/__pycache__/mapper.cpython-312.pyc b/co3/__pycache__/mapper.cpython-312.pyc new file mode 100644 index 0000000..598cc83 Binary files /dev/null and b/co3/__pycache__/mapper.cpython-312.pyc differ diff --git a/co3/__pycache__/relation.cpython-312.pyc b/co3/__pycache__/relation.cpython-312.pyc new file mode 100644 index 0000000..e2c9507 Binary files /dev/null and b/co3/__pycache__/relation.cpython-312.pyc differ diff --git a/co3/accessor.py b/co3/accessor.py new file mode 100644 index 0000000..ef69d42 --- /dev/null +++ b/co3/accessor.py @@ -0,0 +1,28 @@ +''' +Accessor + +Provides access to an underlying schema through a supported set of operations. Class +methods could be general, high-level SQL wrappers, or convenience functions for common +schema-specific queries. +''' +import inspect +from pathlib import Path +from collections import defaultdict + +import sqlalchemy as sa + +#from co3.database import Database + + +class Accessor[D: 'Database']: + ''' + Access wrapper class for complex queries and easy integration with Composer tables. + Implements high-level access to things like common constrained SELECT queries. + + Parameters: + engine: SQLAlchemy engine to use for queries. Engine is initialized dynamically as + a property (based on the config) if not provided + ''' + def __init__(self, database: D): + self.database = database + diff --git a/co3/accessors/__init__.py b/co3/accessors/__init__.py new file mode 100644 index 0000000..72fad51 --- /dev/null +++ b/co3/accessors/__init__.py @@ -0,0 +1,24 @@ +''' +Note that subclasses in this subpackage are split differently to other subpackages in the +DB. Instead of being split by table group, corresponding to a Composer (which defines that +table group), Accessors are split by a separate dimension: table "type". This is why we +have a "TableAccessor" and an "FTSAccessor": the former exposes access operations +available to generic tables, the latter to FTS tables (instead of being designed +specifically around "core" and "fts" groups, for instance). + +Seeing as FTS tables are "generic" tables, it seems inconsistent not to have FTSAccessor +inherit from TableAccessor. While this would work fine, the model we're working with +doesn't really need it; you can instead think of the FTSAccessor as defining _only_ +FTS-specific operations. Given that you have a Composer for your desired table group, you +can then wrap it with your desired set of "access actions," available in separate Accessor +subclasses. + +For instance, you could wrap an FTSComposer in either a TableAccessor or FTSAccessor. The +former will treat the tables in the composer like regular tables, exposing methods like +`.select` and `.select_one`, whereas the latter defines FTS-specific actions like +`.search`. +''' + +from co3.accessors.sql import SQLAccessor +from co3.accessors.fts import FTSAccessor +from co3.accessors.vss import VSSAccessor diff --git a/co3/accessors/__pycache__/__init__.cpython-311.pyc b/co3/accessors/__pycache__/__init__.cpython-311.pyc new file mode 100644 index 0000000..f4649fb Binary files /dev/null and b/co3/accessors/__pycache__/__init__.cpython-311.pyc differ diff --git a/co3/accessors/__pycache__/__init__.cpython-312.pyc b/co3/accessors/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000..0f28ebe Binary files /dev/null and b/co3/accessors/__pycache__/__init__.cpython-312.pyc differ diff --git a/co3/accessors/__pycache__/_base.cpython-311.pyc b/co3/accessors/__pycache__/_base.cpython-311.pyc new file mode 100644 index 0000000..2f2bd8a Binary files /dev/null and b/co3/accessors/__pycache__/_base.cpython-311.pyc differ diff --git a/co3/accessors/__pycache__/fts.cpython-311.pyc b/co3/accessors/__pycache__/fts.cpython-311.pyc new file mode 100644 index 0000000..fa6fd32 Binary files /dev/null and b/co3/accessors/__pycache__/fts.cpython-311.pyc differ diff --git a/co3/accessors/__pycache__/fts.cpython-312.pyc b/co3/accessors/__pycache__/fts.cpython-312.pyc new file mode 100644 index 0000000..b4b9663 Binary files /dev/null and b/co3/accessors/__pycache__/fts.cpython-312.pyc differ diff --git a/co3/accessors/__pycache__/sql.cpython-312.pyc b/co3/accessors/__pycache__/sql.cpython-312.pyc new file mode 100644 index 0000000..15d6bc3 Binary files /dev/null and b/co3/accessors/__pycache__/sql.cpython-312.pyc differ diff --git a/co3/accessors/__pycache__/table.cpython-311.pyc b/co3/accessors/__pycache__/table.cpython-311.pyc new file mode 100644 index 0000000..a77af73 Binary files /dev/null and b/co3/accessors/__pycache__/table.cpython-311.pyc differ diff --git a/co3/accessors/__pycache__/vss.cpython-311.pyc b/co3/accessors/__pycache__/vss.cpython-311.pyc new file mode 100644 index 0000000..5522cb2 Binary files /dev/null and b/co3/accessors/__pycache__/vss.cpython-311.pyc differ diff --git a/co3/accessors/__pycache__/vss.cpython-312.pyc b/co3/accessors/__pycache__/vss.cpython-312.pyc new file mode 100644 index 0000000..9732100 Binary files /dev/null and b/co3/accessors/__pycache__/vss.cpython-312.pyc differ diff --git a/co3/accessors/fts.py b/co3/accessors/fts.py new file mode 100644 index 0000000..2a7cf9c --- /dev/null +++ b/co3/accessors/fts.py @@ -0,0 +1,147 @@ +import sqlalchemy as sa + +from co3 import util +from co3.accessor import Accessor + + +class FTSAccessor(Accessor): + def search( + self, + table_name : str, + select_cols : str | list | None = '*', + search_cols : str | None = None, + q : str | None = None, + colq : str | None = None, + snip_col : int | None = 0, + hl_col : int | None = 0, + limit : int | None = 100, + snip : int | None = 64, + tokenizer : str | None = 'unicode61', + group_by : str | None = None, + agg_cols : list | None = None, + wherein_dict: dict | None = None, + unique_on : dict | None = None, + ): + ''' + Execute a search query against an indexed FTS table for specific primitives. This + method is mostly a generic FTS handler, capable of handling queries to any available + FTS table with a matching naming scheme (`fts__`). The current + intention is support all tokenizers, for file, note, block, and link primitives. + + Search results include all FTS table columns, as well as SQLite-supported `snippet`s + and `highlight`s for matches. Matches are filtered and ordered by SQLite's + `MATCH`-based score for the text & column queries. Results are (a list of) fully + expanded dictionaries housing column-value pairs. + + Note: + GROUP BY cannot be paired with SQLITE FTS extensions; thus, we perform manual + group checks on the result set in Python before response + + Analysis: + The returned JSON structure has been (loosely) optimized for speed on the client + side. Fully forming individual dictionary based responses saves time in + Javascript, as the JSON parser is expected to be able to create the objects + faster than post-hoc construction in JS. This return structure was compared + against returning an array of arrays (all ordered in the same fashion), along with + a column list to be associated with each of the result values. While this saves + some size on the payload (the same column names don't have to be transmitted for + each result), the size of the returned content massively outweighs the + predominantly short column names. The only way this structure would be viable is + if a significant amount was saved on transfer compared to the slow down in JS + object construction; this is (almost) never the case. + + Parameters: + table_name : name of FTS table to search + search_cols : space separated string of columns to use for primary queries + q : search query + colq : column constraint string; must conform to SQLite standards (e.g., + `:` + snip_col : table column to use for snippets (default: 1; source content column) + hl_col : table column to use for highlights (default: 2; format column, applied + to HTML targets) + limit : maximum number of results to return in the SQL query + snip : snippet length (max: 64) + tokenizer : tokenizer to use (assumes relevant FTS table has been built) + ... + wherein_dict: (col-name, value-list) pairs to match result set against, via + WHERE ... IN clauses + + Returns: + Dictionary with search results (list of column indexed dictionaries) and relevant + metadata. + ''' + search_q = '' + + if type(select_cols) is list: + select_cols = ', '.join(select_cols) + + # construct main search query + if search_cols and q: + search_q = f'{{{search_cols}}} : {q}' + + # add auxiliary search constraints + if colq: + search_q += f' {colq}' + + search_q = search_q.strip() + + hl_start = '' + hl_end = '' + + fts_table_name = f'{table_name}_fts_{tokenizer}' + + sql = f''' + SELECT + {select_cols}, + snippet({fts_table_name}, {snip_col}, '{hl_start}', '{hl_end}', '...', {snip}) AS snippet, + highlight({fts_table_name}, {hl_col}, '{hl_start}', '{hl_end}') AS highlight + FROM {fts_table_name} + ''' + + where_clauses = [] + if search_q: + where_clauses.append(f"{fts_table_name} MATCH '{search_q}'\n") + + if wherein_dict: + for col, vals in wherein_dict.items(): + where_clauses.append(f'{col} IN {tuple(vals)}\n') + + if where_clauses: + where_str = " AND ".join(where_clauses) + sql += f'WHERE {where_str}' + + sql += f'ORDER BY rank LIMIT {limit};' + + row_dicts, cols = self.raw_select(sql, include_cols=True) + + if group_by is None: + return row_dicts, cols + + if agg_cols is None: + agg_cols = [] + + # "group by" block ID and wrangle the links into a list + # note we can't perform native GROUP BYs with FTS results + group_by_idx = {} + for row in row_dicts: + group_by_attr = row.get(group_by) + + # add new entries + for agg_col in agg_cols: + row[f'{agg_col}_agg'] = set() + + if group_by_attr is None: + continue + + if group_by_attr not in group_by_idx: + group_by_idx[group_by_attr] = row + + for agg_col in agg_cols: + if agg_col in row: + group_by_idx[group_by_attr][f'{agg_col}_agg'].add(row[agg_col]) + + return { + 'results' : group_by_idx, + 'columns' : cols, + 'num_results' : len(row_dicts), + } diff --git a/co3/accessors/sql.py b/co3/accessors/sql.py new file mode 100644 index 0000000..1ee0fea --- /dev/null +++ b/co3/accessors/sql.py @@ -0,0 +1,96 @@ +from pathlib import Path +from collections.abc import Iterable +import inspect +from functools import cache + +import sqlalchemy as sa + +from co3 import util +from co3.accessor import Accessor +from co3.relation import Relation + +#from co3.databases.sql import RelationalDatabase, TabularDatabase, SQLDatabase +from co3.relations import TabularRelation, SQLTable + + +class RelationalAccessor[D: 'RelationalDatabase', R: Relation](Accessor[D]): + pass + + +class TabularAccessor[D: 'TabularDatabase', R: TabularRelation](RelationalAccessor[D, R]): + pass + + +class SQLAccessor(TabularAccessor['SQLDatabase', SQLTable]): + def raw_select( + self, + sql, + bind_params=None, + mappings=False, + include_cols=False, + ): + res_method = utils.db.sa_exec_dicts + if mappings: + res_method = utils.db.sa_exec_mappings + + return res_method(self.database.engine, sa.text(sql), bind_params=bind_params, include_cols=include_cols) + + def select( + self, + table: sa.Table | sa.Subquery | sa.Join, + cols = None, + where = None, + distinct_on = None, + order_by = None, + limit = 0, + mappings = False, + include_cols = False, + ): + ''' + Perform a SELECT query against the provided table-like object (see + `check_table()`). + + Deprecated: String aliases + String aliases for tables are no longer supported. This method no longer checks + against any specific schema table-maps or Composers. Instead, this should be + done outside the Accessor. + + Parameters: + group_by: list of columns to group by; for now serves as a proxy for DISTINCT + (no aggregation methods accepted) + order_by: column to order results by (can use .desc() to order + by descending) + ''' + if where is None: + where = sa.true() + + res_method = utils.db.sa_exec_dicts + if mappings: + res_method = utils.db.sa_exec_mappings + + stmt = sa.select(table).where(where) + if cols is not None: + stmt = sa.select(*cols).select_from(table).where(where) + + if distinct_on is not None: + stmt = stmt.group_by(distinct_on) + + if order_by is not None: + stmt = stmt.order_by(order_by) + + if limit > 0: + stmt = stmt.limit(limit) + + return res_method(self.engine, stmt, include_cols=include_cols) + + def select_one(self, table, cols=None, where=None, mappings=False, include_cols=False): + res = self.select(table, cols, where, mappings, include_cols, limit=1) + + if include_cols and len(res[0]) > 0: + return res[0][0], res[1] + + if len(res) > 0: + return res[0] + + return None + diff --git a/co3/accessors/vss.py b/co3/accessors/vss.py new file mode 100644 index 0000000..46d119c --- /dev/null +++ b/co3/accessors/vss.py @@ -0,0 +1,100 @@ +import pickle +import logging +from pathlib import Path +import time + +import sqlalchemy as sa +#from sentence_transformers import SentenceTransformer, util + +from co3.accessor import Accessor + + +logger = logging.getLogger(__name__) + +class VSSAccessor(Accessor): + def __init__(self, cache_path): + super().__init__() + + self._model = None + self._embeddings = None + + self._embedding_size = 384 + self.embedding_path = Path(cache_path, 'embeddings.pkl') + + def write_embeddings(self, embedding_dict): + self.embedding_path.write_bytes(pickle.dumps(embedding_dict)) + + def read_embeddings(self): + if not self.embedding_path.exists(): + logger.warning( + f'Attempting to access non-existent embeddings at {self.embedding_path}' + ) + return None + + return pickle.loads(self.embedding_path.read_bytes()) + + @property + def model(self): + if self._model is None: + # model trained with 128 token seqs + self._model = SentenceTransformer('sentence-transformers/all-MiniLM-L12-v2') + return self._model + + @property + def embeddings(self): + if self._embeddings is None: + self._embeddings = self.read_embeddings() + return self._embeddings + + def embed_chunks(self, chunks, batch_size=64, show_prog=True): + return self.model.encode( + chunks, + batch_size = batch_size, + show_progress_bar = show_prog, + convert_to_numpy = True, + normalize_embeddings = True + ) + + def search( + self, + query : str, + index_name : str, + limit : int = 10, + score_threshold = 0.5, + ): + ''' + Parameters: + index_name: one of ['chunks','blocks','notes'] + ''' + if not query: + return None + + if index_name not in self.embeddings: + logger.warning( + f'Index "{index_name}" does not exist' + ) + return None + + start = time.time() + + query_embedding = self.embed_chunks(query, show_prog=False) + index_ids, index_embeddings, index_items = self.embeddings[index_name] + + hits = util.semantic_search( + query_embedding, + index_embeddings, + top_k=limit, + score_function=util.dot_score + )[0] + + hits = [hit for hit in hits if hit['score'] >= score_threshold] + + for hit in hits: + idx = hit['corpus_id'] + hit['group_name'] = index_ids[idx] + hit['item'] = index_items[idx] + + logger.info(f'{len(hits)} hits in {time.time()-start:.2f}s') + + return hits + diff --git a/co3/co3.py b/co3/co3.py new file mode 100644 index 0000000..0018d87 --- /dev/null +++ b/co3/co3.py @@ -0,0 +1,106 @@ +''' +CO4 + +CO4 is an abstract base class for scaffolding object hierarchies and managing operations +with associated database schemas. It facilitates something like a "lightweight ORM" for +classes/tables/states with fixed transformations of interest. The canonical use case is +managing hierarchical document relations, format conversions, and syntactical components. +''' + +import inspect +import logging +from functools import wraps, partial + +#from localsys.db.schema import tables + +logger = logging.getLogger(__name__) + + +#def register_format(_format): +# def decorator(func): +# self.collate.format_map[_format] = func +# +# @wraps(func) +# def register(*args, **kwargs): +# return func(*args, **kwargs) +# +# return register +# return decorator + +def collate(action_key, action_groups=None): + def decorator(func): + if action_groups is None: + action_groups = [None] + func._action_data = (action_key, action_groups) + return func + return decorator + +class FormatRegistryMeta(type): + def __new__(cls, name, bases, attrs): + action_registry = {} + + # add registered superclass methods; iterate over bases (usually just one), then + # that base's chain down (reversed), then methods from each subclass + for base in bases: + for _class in reversed(base.mro()): + methods = inspect.getmembers(_class, predicate=inspect.isfunction) + for _, method in methods: + if hasattr(method, '_action_data'): + action_key, action_groups = method._action_data + action_registry[action_key] = (method, action_groups) + + # add final registered formats for the current class, overwriting any found in + # superclass chain + for attr_name, attr_value in attrs.items(): + if hasattr(attr_value, '_action_data'): + action_key, action_groups = attr_value._action_data + action_registry[action_key] = (method, action_groups) + + attrs['action_map'] = action_registry + + return super().__new__(cls, name, bases, attrs) + +class CO3(metaclass=FormatRegistryMeta): + ''' + CO3: COllate, COllect, COmpose - conversion & DB insertion base + + - Collate: organize and transform conversion outputs, possibly across class components + - Collect: gather core attributes, conversion data, and subcomponents for DB insertion + - Compose: construct object-associated DB table references through the class hierarchy + + Note: on action groups + Group keys are simply named collections to make it easy for storage components to + be attached to action subsets. They do _not_ augment the action registration + namespace, meaning the action key should still be unique; the group key is purely + auxiliary. + + Action methods can also be attached to several groups, in case there is + overlapping utility within or across schemas or storage media. In this case, it + becomes particularly critical to ensure registered `collate` methods really are + just "gathering results" from possibly heavy-duty operations, rather than + performing them when called, so as to reduce wasted computation. + ''' + @property + def attributes(self): + ''' + Method to define how a subtype's inserts should be handled under `collect` for + canonical attributes, i.e., inserts to the type's table. + ''' + return vars(self) + + @property + def components(self): + ''' + Method to define how a subtype's inserts should be handled under `collect` for + constituent components that need handling. + ''' + return [] + + def collate(self, action_key, *action_args, **action_kwargs): + if action_key not in self.action_map: + logger.debug(f'Collation for {action_key} not supported') + return None + else: + return self.action_map[action_key](self) + + diff --git a/co3/collector.py b/co3/collector.py new file mode 100644 index 0000000..3880504 --- /dev/null +++ b/co3/collector.py @@ -0,0 +1,109 @@ +''' +Defines the Collector base class. + +This module is the critical "middleware" connecting the primitive object definitions and +their representations in the database. It operates with full knowledge of how both are +defined, and abstracts away both the prep work for DB insertions as well as updates +trickling down the primitive hierarchy. + +The `src` format target is re-used for both canonical tables/primitives, as well as +_conversion_matter tables in tables/conversions under the `src` format. The latter +is meant to extend those attributes that are format-specific (i.e., would change when, say, +converting to `html5`), and thus need to be broken across the format dimension. + +Note: + Despite the structure of the database module, this class does not currently inherit + from a super class in localsys.db (like the accessors and managers, for instance). + This will likely ultimately be the model that's embraced, but until FTS (or other + groups) need a collector, this will be remain an independent class. It is, however, + named like a concrete subclass, taking on the "Core" prefix. +''' + +from pathlib import Path +from collections import defaultdict +import logging +import importlib +import subprocess +from uuid import uuid4 + +import sqlalchemy as sa + +from co3 import util +#from localsys.db.schema import tables + + +logger = logging.getLogger(__name__) + +class Collector: + def __init__(self): + self._inserts = defaultdict(lambda: defaultdict(list)) + + @property + def inserts(self): + return self._inserts_from_receipts() + + def _inserts_from_receipts(self, receipts=None, pop=False): + inserts = defaultdict(list) + + if receipts is None: + receipts = list(self._inserts.keys()) + + for receipt in receipts: + if pop: insert_dict = self._inserts.pop(receipt, {}) + else: insert_dict = self._inserts[receipt] + + for table, insert_list in insert_dict.items(): + inserts[table].extend(insert_list) + + return dict(inserts) + + def _reset_session(self): + self._inserts = defaultdict(lambda: defaultdict(list)) + + def _generate_unique_receipt(self): + return str(uuid4()) + + def add_insert(self, table_name, insert_dict, receipts=None): + ''' + TODO: formalize table_name mapping; at class level provide a `table_map`, or provide + the table object itself to this method + ''' + if table_name not in tables.table_map: + #logger.debug(f'Inserts provided for non-existent table {table_name}') + return None + + receipt = self._generate_unique_receipt() + + self._inserts[receipt][table_name].append( + utils.db.prepare_insert( + tables.table_map[table_name], + insert_dict + ) + ) + + if receipts is not None: + receipts.append(receipt) + + return receipt + + def collect_inserts(self, receipts=None): + ''' + Collect insert-ready dictionaries for the core primitive schema. This method is + effectively a light wrapper around the File and Note-based collection logic + elsewhere in the class. + + The overall collection scheme embraces a session-like sequential update model to + an internal insert tracker. The sequence of insert methods is ordered according to + the schema hierarchy, and higher level inserts dictate the scope for lower level + inserts (all methods check and populate the same `inserts` dictionary). Calling + this method flushes any existing inserts, ensuring a re-scan takes place across + calls (or "sessions"). + + Parameters: + skip_updated: whether to ignore primitives with existing up-to-date + database entries + + Returns: + Table name-indexed dictionary of insert lists (of column name-indexed dicts) + ''' + return self._inserts_from_receipts(receipts, pop=True) diff --git a/co3/composer.py b/co3/composer.py new file mode 100644 index 0000000..6161518 --- /dev/null +++ b/co3/composer.py @@ -0,0 +1,89 @@ +''' +Composer + +Base for manually defining table compositions outside those natural to the schema +hierarchy (i.e., constructable by a `CO4.compose()` call). + +Example: suppose we have a simple object hierarchy A(CO4) -> B -> C. C's in-built +`compose()` method may not always be desirable when constructing composite tables and +running related queries. In this case, a custom Composer can be used to make needed +composite tables easier to reference; in the case below, we define the "BC" composite +table. + +``` +class ExampleComposer(Composer): + + @register_table + def BC(self): + full_B = B.compose(full=True) + full_C = C.compose(full=True) + + return full_B.join( + full_C, + full_B.c.name == full_C.c.name, # TODO: is this fine? or do we need base table refs + outer=True + ) +''' +from pathlib import Path + +from co3.mapper import Mapper + + +def register_table(table_name=None): + ''' + Registry decorator for defined composer classes. Decorating a class method simply + attaches a `table_name` attribute to it, setting it to either a provided value or the + name of the method itself. Methods with a `table_name` attribute are later swept up at + the class level and placed in the `table_map`. + ''' + def decorator(func): + if table_name is None: + table_name = func.__name__ + func.table_name = table_name + return func + return decorator + +class Composer[M: Mapper]: + ''' + Base composer wrapper for table groupings. + + The schema is centered around a connected group of tables (via foreign keys). Thus, + most operations need to be coordinated across tables. The `accessors` submodules + are mostly intended to provide a "secondary layer" over the base set of tables in the + schema, exposing common higher level table compositions (i.e., chained JOINs). See + concrete instances (e.g., CoreAccess, FTSAccessor) for actual implementations these + tables; the base class does not expose + + Tables in subclasses are registered with the `register_table` decorator, automatically + indexing them under the provided name and making them available via the `table_map`. + ''' + def __init__(self): + self._set_tables() + + def _set_tables(self): + ''' + Skip properties (so appropriate delays can be used), and + + Set the table registry at the class level. This only takes place during the first + instantiation of the class, and makes it possible to definitively tie methods to + composed tables during lookup with `get_table()`. + ''' + cls = self.__class__ + + # in case the class has already be instantiated + if hasattr(cls, 'table_map'): return + + table_map = {} + for key, value in cls.__dict__.items(): + if isinstance(value, property): + continue # Skip properties + if callable(value) and hasattr(value, 'table_name'): + table_map[value.table_name] = value(self) + + cls.table_map = table_map + + def get_table(self, table_name): + ''' + Retrieve the named table composition, if defined. + ''' + return self.table_map.get(table_name) diff --git a/co3/database.py b/co3/database.py new file mode 100644 index 0000000..2b46052 --- /dev/null +++ b/co3/database.py @@ -0,0 +1,87 @@ +''' +Database + +Central object for defining storage protocol-specific interfaces. The database wraps up +central items for interacting with database resources, namely the Accessor and Manager +objects. + +The Database type hierarchy attempts to be exceedingly general; SQL-derivatives should +subclass from the RelationalDatabase subtype, for example, which itself becomes a new +generic via type dependence on Relation. +''' + +import logging +from typing import Self + +from co3.accessor import Accessor +from co3.composer import Composer +from co3.manager import Manager +from co3.indexer import Indexer + +logger = logging.getLogger(__name__) + + +class Database: + accessor: type[Accessor[Self]] = Accessor + manager: type[Manager[Self]] = Manager + + def __init__(self, resource): + ''' + Variables: + _local_cache: a database-local property store for ad-hoc CacheBlock-esque + methods, that are nevertheless _not_ query/group-by responses to + pass on to the Indexer. Dependent properties should write to the + this cache and check for existence of stored results; the cache + state must be managed globally. + ''' + self.resource = resource + + self._access = self.accessor(self) + self._manage = self.manager(self) + + self._index = Indexer(self._access) + self._local_cache = {} + + self.reset_cache = False + + @property + def engine(self): + ''' + Database property to provide a singleton engine for DB interaction, initializing + the database if it doesn't already exist. + + TODO: figure out thread safety across engines and/or connection. Any issue with + hanging on to the same engine instance for the Database instance? + ''' + raise NotImplementedError + + def connect(self): + self.engine.connect() + + @property + def access(self): + return self._access + + @property + def compose(self): + return self._compose + + @property + def index(self): + if self.reset_cache: + self._index.cache_clear() + self.reset_cache = False + return self._index + + @property + def manage(self): + ''' + Accessing `.manage` queues a cache clear on the external index, as well wipes the + local index. + ''' + self.reset_cache = True + self._local_cache = {} + return self._manage + + def populate_indexes(self): pass + diff --git a/co3/databases/__init__.py b/co3/databases/__init__.py new file mode 100644 index 0000000..17bdc87 --- /dev/null +++ b/co3/databases/__init__.py @@ -0,0 +1,3 @@ +from co3.databases.sql import * +from co3.databases.fts import FTSDatabase +from co3.databases.vss import VSSDatabase diff --git a/co3/databases/__pycache__/__init__.cpython-311.pyc b/co3/databases/__pycache__/__init__.cpython-311.pyc new file mode 100644 index 0000000..9e9cc9d Binary files /dev/null and b/co3/databases/__pycache__/__init__.cpython-311.pyc differ diff --git a/co3/databases/__pycache__/__init__.cpython-312.pyc b/co3/databases/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000..78a4276 Binary files /dev/null and b/co3/databases/__pycache__/__init__.cpython-312.pyc differ diff --git a/co3/databases/__pycache__/_base.cpython-311.pyc b/co3/databases/__pycache__/_base.cpython-311.pyc new file mode 100644 index 0000000..a872176 Binary files /dev/null and b/co3/databases/__pycache__/_base.cpython-311.pyc differ diff --git a/co3/databases/__pycache__/core.cpython-311.pyc b/co3/databases/__pycache__/core.cpython-311.pyc new file mode 100644 index 0000000..7fb74b6 Binary files /dev/null and b/co3/databases/__pycache__/core.cpython-311.pyc differ diff --git a/co3/databases/__pycache__/fts.cpython-311.pyc b/co3/databases/__pycache__/fts.cpython-311.pyc new file mode 100644 index 0000000..3a19a9b Binary files /dev/null and b/co3/databases/__pycache__/fts.cpython-311.pyc differ diff --git a/co3/databases/__pycache__/fts.cpython-312.pyc b/co3/databases/__pycache__/fts.cpython-312.pyc new file mode 100644 index 0000000..63818d1 Binary files /dev/null and b/co3/databases/__pycache__/fts.cpython-312.pyc differ diff --git a/co3/databases/__pycache__/sql.cpython-312.pyc b/co3/databases/__pycache__/sql.cpython-312.pyc new file mode 100644 index 0000000..aa1f424 Binary files /dev/null and b/co3/databases/__pycache__/sql.cpython-312.pyc differ diff --git a/co3/databases/__pycache__/vss.cpython-312.pyc b/co3/databases/__pycache__/vss.cpython-312.pyc new file mode 100644 index 0000000..7e63254 Binary files /dev/null and b/co3/databases/__pycache__/vss.cpython-312.pyc differ diff --git a/co3/databases/fts.py b/co3/databases/fts.py new file mode 100644 index 0000000..f8817ef --- /dev/null +++ b/co3/databases/fts.py @@ -0,0 +1,8 @@ +from co3.database import Database + +from co3.accessors.fts import FTSAccessor +from co3.managers.fts import FTSManager + +class FTSDatabase(Database): + accessor = FTSAccessor + manager = FTSManager diff --git a/co3/databases/sql.py b/co3/databases/sql.py new file mode 100644 index 0000000..9c4b08d --- /dev/null +++ b/co3/databases/sql.py @@ -0,0 +1,34 @@ +from typing import Self + +from co3.database import Database + +from co3.accessors.sql import RelationalAccessor, TabularAccessor, SQLAccessor +from co3.managers.sql import RelationalManager, TabularManager, SQLManager + +from co3.relation import Relation +from co3.relations import TabularRelation, SQLTable + + +class RelationalDatabase[R: Relation](Database): + accessor: type[RelationalAccessor[Self, R]] = RelationalAccessor[Self, R] + manager: type[RelationalManager[Self, R]] = RelationalManager[Self, R] + + +class TabularDatabase[R: TabularRelation](RelationalDatabase[R]): + ''' + accessor/manager assignments satisfy supertype's type settings; + `TabluarAccessor[Self, R]` is of type `type[RelationalAccessor[Self, R]]` + (and yes, `type[]` specifies that the variable is itself being set to a type or a + class, rather than a satisfying _instance_) + ''' + accessor: type[TabularAccessor[Self, R]] = TabularAccessor[Self, R] + manager: type[TabularManager[Self, R]] = TabularManager[Self, R] + + +class SQLDatabase[R: SQLTable](TabularDatabase[R]): + accessor = SQLAccessor + manager = SQLManager + + +class SQLiteDatabase(SQLDatabase[SQLTable]): + pass diff --git a/co3/databases/vss.py b/co3/databases/vss.py new file mode 100644 index 0000000..f02016b --- /dev/null +++ b/co3/databases/vss.py @@ -0,0 +1,9 @@ +from co3.database import Database + +from co3.accessors.vss import VSSAccessor +from co3.managers.vss import VSSManager + + +class VSSDatabase(Database): + accessor = VSSAccessor + manager = VSSManager diff --git a/co3/indexer.py b/co3/indexer.py new file mode 100644 index 0000000..be87d1b --- /dev/null +++ b/co3/indexer.py @@ -0,0 +1,433 @@ +import time +import logging +import threading +from collections import defaultdict +from collections.abc import Iterable + +import sqlalchemy as sa + + +logger = logging.getLogger(__name__) + +class Indexer: + ''' + Indexer class + + Provides restricted access to an underlying Accessor to enable more efficient, superficial + caching. + + Cache clearing is to be handled by a wrapper class, like the Database. + + Caching occurs at the class level, with indexes prefixed by table's origin Composer. + This means that cached selects/group-bys will be available regardless of the provided + Accessors so long as the same Composer is used under the hood. + ''' + _cls_select_cache = {} + _cls_groupby_cache = defaultdict(dict) + + def __init__(self, accessor, cache_select=True, cache_groupby=True): + self.accessor = accessor + + # set instance caches; if remains None, methods can't index + self._select_cache = None + self._groupby_cache = None + + if cache_groupby and not cache_select: + raise ValueError('cannot cache groupbys without select caching enabled') + + if cache_select: + self._select_cache = self._cls_select_cache + + if cache_groupby: + self._groupby_cache = self._cls_groupby_cache + + self._access_lock = threading.Lock() + + def cache_clear(self, group_by_only=False): + self._groupby_cache.clear() + if not group_by_only: + self._select_cache.clear() + + def cache_block( + self, + table, + **kwargs, + ): + ''' + Provide a user-friendly, dynamically re-indexable + ''' + return CacheBlock( + indexer = self, + table = table, + **kwargs, + ) + + def cached_query( + self, + table, + + cols = None, + where = None, + distinct_on = None, + order_by = None, + limit = 0, + + group_by = None, + agg_on = None, + index_on = None, + ): + ''' + Like `group_by`, but makes a full query to the Accessors table `table_name` and + caches the results. The processing performed by the GROUP BY is also cached. + + Update: `cached_select` and `cached_group_by` now unified by a single + `cached_query` method. This allows better defined GROUP BY caches, that are + reactive to the full set of parameters returning the result set (and not just the + table, requiring a full query). + + Note: on cache keys + Cache keys are now fully stringified, as many objects are now allowed to be + native SQLAlchemy objects. Indexing these objects works, but doing so will + condition the cache on their memory addresses, which isn't what we want. + SQLAlchemy converts most join/column/table-like objects to reasonable strings, + which will look the same regardless of instance. + + Context: this became a clear issue when passing in more + `order_by=.desc()`. The `desc()` causes the index to store the column in + an instance-specific way, rather than an easily re-usable, canonical column + reference. Each time the CoreDatabase.files() was being called, for instance, + that @property would be re-evaluated, causing `desc()` to be re-initialized, + and thus look different to the cache. Stringifying everything prevents this + (although this could well be an indication that only a single `cache_block` + should ever be returned be database properties). + + Note: on access locks + A double-checked locking scheme is employed before both of the stages (select + and manual group by), using the same lock. This resolves the common scenario + where many threads need to look up a query in the cache, experience a cache + miss, and try to do the work. This non-linearly explodes the total time to + wait in my experience, so doing this only when needed saves tons of time, + especially in high-congestion moments. + ''' + start = time.time() + cache_key = tuple(map(str, (table, cols, where, distinct_on, order_by, limit))) + + # apparently this is the double-check locking scheme (didn't realize when implementing) + if self._select_cache is None or cache_key not in self._select_cache: + # cache re-compute possible, acquire lock to continue. A later thread may + # acquire this after work has been done by an earlier thread, so re-eval the + # condition below before actually performing a DB read. If access results in a + # cache hit, locking isn't needed. + with self._access_lock: + if self._select_cache is None or cache_key not in self._select_cache: + results = self.accessor.select( + table, + cols=cols, + where=where, + distinct_on=distinct_on, + order_by=order_by, + limit=limit, + mappings=True + ) + + # cache results if select_cache is defined + if self._select_cache is not None: + self._select_cache[cache_key] = results + + logger.debug( + f'Indexer "select" cache miss for table "{table}": access in {time.time()-start:.4f}s' + ) + else: + results = self._select_cache[cache_key] + logger.debug( + f'Indexer "select" cache hit for table "{table}": access in {time.time()-start:.4f}s' + ) + else: + results = self._select_cache[cache_key] + logger.debug( + f'Indexer "select" cache hit for table "{table}": access in {time.time()-start:.4f}s' + ) + + start = time.time() + cache_key = (*cache_key, group_by, agg_on, index_on) + + if group_by is not None: + if self._groupby_cache is None or cache_key not in self._groupby_cache: + with self._access_lock: + if self._groupby_cache is None or cache_key not in self._groupby_cache: + results = self.group_by( + results, + group_by = group_by, + agg_on = agg_on, + index_on = index_on, + return_index = True, + ) + + if self._groupby_cache is not None: + self._groupby_cache[cache_key] = results + + logger.debug( + f'Indexer "group_by" cache miss for table "{table}": access in {time.time()-start:.4f}s' + ) + else: + results = self._groupby_cache[cache_key] + logger.debug( + f'Indexer "group_by" cache hit for table "{table}": access in {time.time()-start:.4f}s' + ) + else: + results = self._groupby_cache[cache_key] + logger.debug( + f'Indexer "group_by" cache hit for table "{table}": access in {time.time()-start:.4f}s' + ) + + return results + + @classmethod + def group_by( + cls, + rows, + group_by, + agg_on=None, + index_on=None, + return_index=False, + ): + ''' + Post-query "group by"-like aggregation. Creates an index over a set of columns + (`group_by_cols`), and aggregates values from `agg_cols` under the groups. + + Rows can be dicts or mappings, and columns can be strings or SQLAlchemy columns. + To ensure the right columns are being used for the operation, it's best to pass in + mappings and use SQA columns if you aren't sure exactly how the keys look in your + results (dicts can have ambiguous keys across tables with the same columns and/or + different labeling schemes altogether). + + TODO: add a flag that handles None's as distinct. That is, for the group_by + column(s) of interest, if rows in the provided query set have NULL values for + these columns, treat all such rows as their "own group" and return them alongside + the grouped/aggregated ones. This is behavior desired by something like + FTSManager.recreate(), which wants to bundle up conversions for blocks + (effectively grouping by blocks.name and link.id, aggregating on + block_conversions.format, then flattening). You could either do this, or as the + caller just make sure to first filter the result set before grouping (e.g., + splitting the NULL-valued rows from those that are well-defined), and then + stitching the two sets back together afterward. + + Multi-dim update: + + - group_by: can be a tuple of tuples of columns. Each inner tuple is a nested + "group by index" in the group by index + - + ''' + if not rows: + return {} if return_index else [] + + rows_are_mappings = not isinstance(rows[0], dict) + + if not rows_are_mappings: + if isinstance(group_by, sa.Column): + group_by = group_by.name + else: + group_by = str(group_by) + + #if group_by is None: group_by = [] + #elif not isinstance(group_by, Iterable): group_by = [group_by] + + if agg_on is None: agg_on = [] + elif not isinstance(agg_on, Iterable): agg_on = [agg_on] + + if index_on is None: index_on = [] + elif not isinstance(index_on, Iterable): index_on = [index_on] + + agg_on_names = [] + for agg in agg_on: + # if a SQA column, can either use `.name` or `str(c)`. The latter includes the + # table name, the former doesn't; ambiguity can be introduced here. + if isinstance(agg, sa.Column): + agg_on_names.append(agg.name) + else: + agg_on_names.append(str(agg)) + + index_on_names = [] + for index in index_on: + # if a SQA column, can either use `.name` or `str(c)`. The latter includes the + # table name, the former doesn't; ambiguity can be introduced here. + if isinstance(index, sa.Column): + index_on_names.append(index.name) + else: + index_on_names.append(str(index)) + + # when rows are dicts, use columns' string names + if not rows_are_mappings: + agg_on = agg_on_names + index_on = index_on_names + + #print(f'rows_are_mappings: {rows_are_mappings}') + #print(f'group_by: {group_by}') + #print(f'agg_on: {agg_on}') + #print(f'agg_on_names: {agg_on_names}') + #print(f'index_on: {index_on}') + #print(f'index_on_names: {index_on_names}') + + # "group by" block ID and wrangle the links into a list + group_by_idx = {} + for row in rows: + # generic get + group_by_attr = row.get(group_by) + + # wrap possible mapping dict + row_dict = dict(row) + + # add new entries; standardize + #aggregates = {} + #for agg_name in agg_on_names: + # aggregates[agg_name] = [] + #row_dict['aggregates'] = aggregates + row_dict['aggregates'] = [] + + indexes = {} + for index_name in index_on_names: + indexes[index_name] = {} + row_dict['indexes'] = indexes + + if group_by_attr is None: + continue + + if group_by_attr not in group_by_idx: + group_by_idx[group_by_attr] = row_dict + + # actually include all agg cols, even if None, so agg array indexes align + agg_dict = { + agg_on_names[i] : row.get(agg_col) + for i, agg_col in enumerate(agg_on) + } + + #aggregates = group_by_idx[group_by_attr]['aggregates'] + #for agg_key, agg_val in agg_dict.items(): + # aggregates[agg_key].append(agg_val) + aggregates = group_by_idx[group_by_attr]['aggregates'] + aggregates.append(agg_dict) + + indexes = group_by_idx[group_by_attr]['indexes'] + for i, index_col in enumerate(index_on): + index_name = index_on_names[i] + indexes[index_name][row[index_col]] = agg_dict + + if return_index: + return group_by_idx + + return list(group_by_idx.values()) + +class CacheBlock: + ''' + CacheBlock class + + Wraps up a set of query parameters for a specific entity, and provides cached access + to different types of "re-queries" via an associated Indexer. + + The goal here is to help build/define entities as the possibly complex transformations + on the base schema that they are. For example, the Note primitive (entity) + incorporates details across `files`, `notes`, `note_conversions`, and + `note_conversion_matter` tables (defined in a single endpoint by a Composer), often + needs to be selected in particular ways (via an Accessor), and results stored for fast + access later on (handled by an Indexer). This pipeline can be daunting and requires + too many moving parts to be handled explicitly everywhere. CacheBlocks wrap up a set + of query "preferences," exposing a simpler interface for downstream access to + entities. It still allows for low-level control over re-grouping/indexing, raw hits to + the actual DB, etc, but keeps things tighter and well-behaved for the Indexer. + + You can think of these as the Indexer's "fingers"; they're deployable mini-Indexes + that "send back" results to the class cache, which is "broadcast" to all other + instances for use when necessary. + + Note: Example usage + + ```py + cb = CacheBlock() + + # Set up cached queries with chained params or via call: + + cb.where(t.notes.c.name=="name").group_by(t.note_conversions.c.format) + cb() # get results + + # - OR - # (use strings when known) + + cb.where(t.notes.c.name=="name").group_by('format') + cb() # get results + + # - OR - # (use kwargs in the call; results returned right away) + + cb( + where=(t.notes.c.name=="name"), + group_by='format' + ) + ``` + + ''' + def __init__( + self, + indexer, + table, + + cols = None, + where = None, + distinct_on = None, + order_by = None, + limit = 0, + + group_by = None, + agg_on = None, + index_on = None, + ): + self.indexer = indexer + + self.query_args = { + 'table' : table, + + 'cols' : cols, + 'where' : where, + 'distinct_on' : distinct_on, + 'order_by' : order_by, + 'limit' : limit, + + 'group_by' : group_by, + 'agg_on' : agg_on, + 'index_on' : index_on, + } + + def _query(self, **kwargs): + '''Make cached query with defaults, override with those provided''' + return self.indexer.cached_query(**{ + k : (v if k not in kwargs else kwargs[k]) + for k,v in self.query_args.items() + }) + + def __call__(self, **kwargs): + ''' + TODO: overload this for the queries, i.e. getting keys or returning aggregates + ''' + return self._query(**kwargs) + + def where(self, where): + self.query_args['where'] = where + return self + #return self._query(where=where) + + def distinct_on(self, distinct_on): + self.query_args['distinct_on'] = distinct_on + return self + #return self._query(distinct_on=distinct_on) + + def order_by(self, order_by): + self.query_args['order_by'] = order_by + return self + #return self._query(order_by=order_by) + + def limit(self, limit): + self.query_args['limit'] = limit + return self + + def group_by(self, group_by): + self.query_args['group_by'] = group_by + return self + #return self._query(group_by=group_by) + diff --git a/co3/manager.py b/co3/manager.py new file mode 100644 index 0000000..f8ced6d --- /dev/null +++ b/co3/manager.py @@ -0,0 +1,38 @@ +''' +Manager + +Wrapper for state-changing database operations. Managers expose the formalized means of +interacting with an underlying database, like inserts and schema recreation. +''' +from pathlib import Path +from abc import ABCMeta, abstractmethod + +#from co3.database import Database + + +class Manager[D: 'Database'](metaclass=ABCMeta): + ''' + Management wrapper class for table groupings. + + The schema is centered around a connected group of tables (via foreign keys). Thus, + most operations need to be coordinated across tables. A few common operations are + wrapped up in this class to then also be mirrored for the FTS counterparts. + ''' + def __init__(self, database: D): + self.database = database + + @abstractmethod + def recreate(self): + raise NotImplementedError + + @abstractmethod + def migrate(self): + raise NotImplementedError + + @abstractmethod + def insert(self): + raise NotImplementedError + + @abstractmethod + def sync(self): + raise NotImplementedError diff --git a/co3/managers/__init__.py b/co3/managers/__init__.py new file mode 100644 index 0000000..7c0a91a --- /dev/null +++ b/co3/managers/__init__.py @@ -0,0 +1,3 @@ +from co3.managers.sql import SQLManager +from co3.managers.fts import FTSManager +from co3.managers.vss import VSSManager diff --git a/co3/managers/__pycache__/__init__.cpython-311.pyc b/co3/managers/__pycache__/__init__.cpython-311.pyc new file mode 100644 index 0000000..9820f79 Binary files /dev/null and b/co3/managers/__pycache__/__init__.cpython-311.pyc differ diff --git a/co3/managers/__pycache__/__init__.cpython-312.pyc b/co3/managers/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000..42c94cb Binary files /dev/null and b/co3/managers/__pycache__/__init__.cpython-312.pyc differ diff --git a/co3/managers/__pycache__/_base.cpython-311.pyc b/co3/managers/__pycache__/_base.cpython-311.pyc new file mode 100644 index 0000000..9ebfee3 Binary files /dev/null and b/co3/managers/__pycache__/_base.cpython-311.pyc differ diff --git a/co3/managers/__pycache__/core.cpython-311.pyc b/co3/managers/__pycache__/core.cpython-311.pyc new file mode 100644 index 0000000..dfd4f20 Binary files /dev/null and b/co3/managers/__pycache__/core.cpython-311.pyc differ diff --git a/co3/managers/__pycache__/fts.cpython-311.pyc b/co3/managers/__pycache__/fts.cpython-311.pyc new file mode 100644 index 0000000..75f58cd Binary files /dev/null and b/co3/managers/__pycache__/fts.cpython-311.pyc differ diff --git a/co3/managers/__pycache__/fts.cpython-312.pyc b/co3/managers/__pycache__/fts.cpython-312.pyc new file mode 100644 index 0000000..2ee04b6 Binary files /dev/null and b/co3/managers/__pycache__/fts.cpython-312.pyc differ diff --git a/co3/managers/__pycache__/sql.cpython-312.pyc b/co3/managers/__pycache__/sql.cpython-312.pyc new file mode 100644 index 0000000..08ab146 Binary files /dev/null and b/co3/managers/__pycache__/sql.cpython-312.pyc differ diff --git a/co3/managers/__pycache__/vss.cpython-312.pyc b/co3/managers/__pycache__/vss.cpython-312.pyc new file mode 100644 index 0000000..8813b5b Binary files /dev/null and b/co3/managers/__pycache__/vss.cpython-312.pyc differ diff --git a/co3/managers/fts.py b/co3/managers/fts.py new file mode 100644 index 0000000..466b52b --- /dev/null +++ b/co3/managers/fts.py @@ -0,0 +1,216 @@ +from collections import defaultdict +import logging +import time + +from tqdm import tqdm +import sqlalchemy as sa + +from co3 import util + +from co3.manager import Manager +from co3.accessors.sql import SQLAccessor + + +logger = logging.getLogger(__name__) + +class FTSManager(Manager): + def __init__(self, database, engine=None): + super().__init__(database, engine) + + self.accessor = SQLAccessor(engine) + self.composer = CoreComposer() + + def recreate_simple(self): + select_cols = [ + tables.files.c.rpath, tables.files.c.ftype, + + tables.notes.c.title, tables.notes.c.link, + + tables.note_conversion_matter.c.type, + + tables.blocks.c.name, tables.blocks.c.header, + tables.blocks.c.elem_pos, + + tables.block_conversion_matter.c.content, + + tables.links.c.target, + #tables.links.c.target.label('link_target'), + ] + + inserts, res_cols = self.accessor.select( + 'leftward_link_conversions', + cols=select_cols, + include_cols=True, + ) + + util.db.populate_fts5( + self.engine, + ['search'], + #columns=select_cols, + columns=res_cols, + inserts=inserts, + ) + + def recreate_pivot(self): + block_cols = [ + tables.files.c.rpath, tables.files.c.ftype, + + tables.notes.c.title, tables.notes.c.link, + + tables.note_conversion_matter.c.type, + + tables.blocks.c.name, tables.blocks.c.header, + tables.blocks.c.elem_pos, + + #tables.block_conversion_matter.c.content, + + #tables.links.c.target, + + #tables.links.c.target.label('link_target'), + ] + + lcp = self.accessor.link_content_pivot(cols=block_cols) + + start = time.time() + inserts, cols = self.accessor.select( + lcp, + #cols=select_cols + include_cols=True, + ) + logger.info(f'FTS recreate: pre-index SELECT took {time.time()-start:.2f}s') + + return inserts + + #util.db.populate_fts5( + # self.engine, + # ['search'], + # #columns=select_cols, + # columns=res_cols, + # inserts=inserts, + #) + + def recreate(self): + select_cols = [ + tables.links.c.id, + + tables.files.c.rpath, tables.files.c.ftype, + + tables.files.c.title, tables.files.c.link, + + tables.notes.c.type, + + tables.elements.c.name, tables.blocks.c.header, + tables.elements.c.elem_pos, + + tables.element_conversions.c.format, + tables.element_conversions.c.content, + + tables.links.c.target, + tables.links.c.type.label('link_type'), + #tables.links.c.target.label('link_target'), + ] + + start = time.time() + + fts_basis = self.composer.get_table('leftward_link_conversions') + inserts = self.accessor.select( + fts_basis, + cols=select_cols, + ) + logger.info(f'FTS recreate: pre-index SELECT took {time.time()-start:.2f}s') + + start = time.time() + flattened_blocks = defaultdict(lambda:defaultdict(lambda:None)) + other_results = [] + + # flatten conversions across supported formats + # i.e. put "src" and "html" into columns within a single row + for row in inserts: + name = row['name'] + + # remove pure identifier rows + link_id = row.pop('id') + _format = row.pop('format') + content = row.pop('content') + + # add new derived rows + row['src'] = None + row['html'] = None + + if name is None: + other_results.append(row) + continue + + if flattened_blocks[name][link_id] is None: + flattened_blocks[name][link_id] = row + + nrow = flattened_blocks[name][link_id] + if _format == 'src': + nrow['src'] = content + elif _format == 'html5': + nrow['html'] = content + + inserts = other_results + for name, link_dict in flattened_blocks.items(): + for link_id, row in link_dict.items(): + inserts.append(row) + + # should have at least one result to index + assert len(inserts) > 0 + cols = inserts[0].keys() + + # all keys should match + assert all([cols == d.keys() for d in inserts]) + + logger.info(f'FTS recreate: insert post-processing took {time.time()-start:.2f}s') + + util.db.populate_fts5( + self.engine, + ['search'], + columns=list(cols), + inserts=inserts, + ) + + def update(self): pass + + def sync(self): pass + + def migrate(self): pass + + + +def recreate_old(self): + full_table = schema.leftward_block_conversions() + primitive_tables = schema.primitive_tables() + + virtual_inserts = [] + for ptype, table in primitive_tables.items(): + table_rows = db.util.sa_exec_dicts(self.engine, sa.select(table)) + for row in table_rows: + pdict = util.db.prepare_insert(full_table, row) + pdict['ptype'] = ptype + + virtual_inserts.append(pdict) + + select_cols = [ + tables.blocks.c.name, tables.blocks.c.content, + tables.blocks.c.html, tables.blocks.c.header, + tables.blocks.c.block_pos, tables.blocks.c.note_name, + + tables.links.c.to_file, + + tables.notes.c.link, + + tables.note_conversion_matter.c.type, + tables.note_conversion_matter.c.summary, + + 'ptype', + ] + + util.db.populate_fts5( + self.engine, + 'search', + columns=select_cols, + inserts=virtual_inserts, + ) + diff --git a/co3/managers/sql.py b/co3/managers/sql.py new file mode 100644 index 0000000..43b676a --- /dev/null +++ b/co3/managers/sql.py @@ -0,0 +1,383 @@ +''' +Note: Common on insert behavior + - Tables with unique constraints have been equipped with `sqlite_on_conflict_unique` + flags, enabling conflicting bulk inserts to replace conflicting rows gracefully. No + need to worry about explicitly handling upserts. + - The bulk insert via conn.execute(,) automatically ignores + irrelevant column names within provided record dicts, whereas explicit .values() calls + for non-bulk inserts will throw errors if not aligned perfectly. We want to keep these + bulk calls AND allow update/replacements on conflict; the setting above allows this + bulk usage to continue as is. + +Note: Options for insert/update model + 1. Collect all possible update objects, and use a SQLite bulk insert that only updates + if needed (based on modified time, for example). This sounds on the surface like + the right approach since we defer as much to bulk SQL logic, but it's far and away + the worse option b/c prepping all file/note/etc objects is too expensive to + ultimately throw away when finding out an update isn't needed. For example, if we + wanted to perform note updates _inside_ the SQL call (like an `INSERT .. UPDATE .. + IF`, as opposed to determining the objects to insert _outside_ of the SQL call), + you would need to bring each of the note's HTML prior to the insert check. There's + no 2-stage processing here where you can check if the note needs to be converted + b/c it's out of date, and only then perform the computation. + 2. Instantiate objects sequentially, each time checking with the DB to see if full + processing is needed. This makes much more sense when the full processing is very + expensive, as it is with Note conversion. This would iterate through available notes, + perform a `SELECT` on the target table to see if the note needs updating, and if so + perform the remaining computation. Those objects then get added to a "update object + list" to be inserted in bulk, but you make sequential `SELECT` checks before that. + + The one extra optimization you could maybe make here is doing a full SELECT on the + target table and bring all rows into memory before iterating through the objects. + This would likely make it faster than whatever SQLAlchemy overhead there may be. It + also might just be outright required given Connection objects aren't thread-safe; + we can get away with single thread global SELECT, threaded checking during object + build, then single thread bulk INSERT. (**Note**: this is what the method does). +''' + +from pathlib import Path +from collections import defaultdict +import logging +import threading +import math +import time +import pprint +from concurrent.futures import wait, as_completed + +import sqlalchemy as sa +from tqdm.auto import tqdm + +from co3 import util + +from co3.manager import Manager +from co3.relation import Relation +#from co3.databases import SQLDatabase +#from localsys.reloader.router._base import ChainRouter, Event +from co3.relations import TabularRelation, SQLTable + + +logger = logging.getLogger(__name__) + + +class RelationalManager[D: 'RelationalDatabase', R: Relation](Manager[D]): + pass + + +class TabularManager[D: 'TabularDatabase', R: TabularRelation](RelationalManager[D, R]): + pass + + +class SQLManager(TabularManager['SQLDatabase', SQLTable]): + ''' + Core schema table manager. Exposes common operations and facilitates joint operations + needed for highly connected schemas. + + In particular, Managers expose insertion abstractions that take table-indexed groups + of rows and bundle them under a single transaction. This is important for table groups + with foreign keys and cascading deletions: inserts need to be coordinated. Note that + actually collecting the inserts that need to take place is outside the scope of the + Manager (see the Collector). We do, however, implement a `sync` operation that can + saturates a router with events (dynamically) and sweeps up inserts on session basis + from an attached collector. + ''' + conversion_formats = ['src', 'html5'] + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + self.routers = [] + + self._router = None + self._insert_lock = threading.Lock() + + @property + def router(self): + if self._router is None: + self._router = ChainRouter(self.routers) + return self._router + + def add_router(self, router): + self.routers.append(router) + + def recreate(self): + tables.metadata.drop_all(self.engine) + tables.metadata.create_all(self.engine, checkfirst=True) + + def update(self): pass + + def insert(self, inserts: dict): + ''' + Perform provided table inserts. + + Parameters: + inserts: table-indexed dictionary of insert lists + ''' + total_inserts = sum([len(ilist) for ilist in inserts.values()]) + if total_inserts < 1: return + + logger.info(f'Total of {total_inserts} sync inserts to perform') + + # TODO: add some exception handling? may be fine w default propagation + start = time.time() + with self.engine.connect() as connection: + with self._insert_lock: + for table_str in inserts: + table_inserts = inserts[table_str] + if len(table_inserts) == 0: continue + + table = tables.table_map[table_str] + + logger.info( + f'Inserting {len(table_inserts)} out-of-date entries into table "{table_str}"' + ) + + connection.execute( + sa.insert(table), + table_inserts + ) + connection.commit() + logger.info(f'Insert transaction completed successfully in {time.time()-start:.2f}s') + + def _file_sync_bools(self): + synced_bools = [] + fpaths = utils.paths.iter_nested_paths(self.collector.basepath, no_dir=True) + db_rpath_index = self.database.files.group_by('rpath')() + + for fpath in fpaths: + file = File(fpath, self.collector.basepath) + db_file = db_rpath_index.get(file.rpath) + + file_in_sync = db_file and float(db_file.get('mtime','0')) >= file.mtime + synced_bools.append(file_in_sync) + + return fpaths, synced_bools + + def sync( + self, + limit=0, + chunk_time=0, + dry=False, + chunk_size_cap=1000, + print_report=True, + ): + ''' + Note: + Could be dangerous if going from fast file processing to note processing. + Imagine estimating 1000 iter/sec, then transferring that to the next batch + when it's more like 0.2 iter/sec. We would lose any chunking. (Luckily, in + practice, turns out that notes are almost always processed before the huge set + of nested files lurking and we don't experience this issue.) + ''' + #filepaths, update_bools = self.collector.file_inserts(dry_run=True) + #fpaths_to_update = [f for (f, b) in zip(filepaths, update_bools) if not b] + filepaths, update_bools = self._file_sync_bools() + fpaths_to_update = [f for (f, b) in zip(filepaths, update_bools) if not b] + + def calc_chunk_size(sec_per_file): + ''' + Chunk cap only applied here; if manually set elsewhere in the method, it's + intentional e.g., if chunk_time <= 0 and we just want one big iteration. + ''' + return min(max(int(chunk_time / sec_per_file), 1), chunk_size_cap) + + # nothing to do + if not fpaths_to_update: + logger.info('Sync has nothing to do, exiting') + return None + + ood_count = len(fpaths_to_update) + total_fps = len(filepaths) + ood_prcnt = ood_count/total_fps*100 + logger.info( + f'Pre-sync scan yielded {ood_count}/{total_fps} ({ood_prcnt:.2f}%) out-of-date files' + ) + + if limit <= 0: limit = ood_count + + if chunk_time <= 0: + chunk_size = ood_count + else: + chunk_size = calc_chunk_size(5) + + dry_inserts = None + remaining = limit + + chunk_time_used = 0 + pbar = tqdm( + desc=f'Adaptive chunked sync for [limit {limit}]', + total=remaining, + ) + + report = [] + def collect_report(): + report.append({ + 'chunk_size': chunk_limit, + 'chunk_time_used': chunk_time_used, + }) + + with pbar as _: + while remaining > 0: + time_pcnt = chunk_time_used / max(chunk_time,1) * 100 + pbar.set_description( + f'Adaptive chunked sync [size {chunk_size} (max {chunk_size_cap})] ' + f'[prev chunk {chunk_time_used:.2f}s/{chunk_time}s ({time_pcnt:.2f}%)]' + ) + + chunk_limit = min(remaining, chunk_size) + start_idx = limit - remaining + chunk_fpaths = fpaths_to_update[start_idx:start_idx+chunk_limit] + + chunk_time_start = time.time() + #inserts = self.collector.collect_inserts( + # chunk_fpaths, + # skip_updated=False, # saves on DB check given provided list + #) + + # 1) flush synthetic events for the batch through the chained router + # 2) block until completed and sweep up the collected inserts + futures = self.router.submit([ + Event( + endpoint=str(self.collector.basepath), + name=str(path.relative_to(self.collector.basepath)), + action=[0xffffffff], # synthetic action to match any flag filters + ) for path in chunk_fpaths + ]) + + for future in tqdm( + as_completed(futures), + total=chunk_size, + desc=f'Awaiting chunk futures [submitted {len(futures)}/{chunk_size}]' + ): + #print('Finished future', cfuture) + try: + result = future.result() + except Exception as e: + logger.warning(f"Sync job failed with exception {e}") + + #wait(futures)#, timeout=10) + inserts = self.collector.collect_inserts() + + chunk_time_used = time.time() - chunk_time_start + + collect_report() + #if not inserts: break + + if dry: + if dry_inserts is None: + dry_inserts = inserts + else: + for ik, iv in inserts.items(): + dry_inserts[ik].extend(iv) + else: + self.insert(inserts) + + remaining -= chunk_limit + + # re-calculate chunk size + sec_per_file = chunk_time_used / chunk_size + chunk_size = calc_chunk_size(sec_per_file) + + #pbar.update(n=limit-remaining) + pbar.update(n=chunk_limit) + + if print_report: + num_chunks = len(report) + total_ins = sum(map(lambda c:c['chunk_size'], report)) + avg_chunk = total_ins / num_chunks + total_time = sum(map(lambda c:c['chunk_time_used'], report)) + avg_time = total_time / num_chunks + time_match = avg_time / max(chunk_time*100, 1) + + print( 'Sync report: ') + print(f' Total chunks : {num_chunks} ') + print(f' Total file inserts : {total_ins} / {limit} ') + print(f' Average chunk size : {avg_chunk:.2f} ') + print(f' Total time spent : {total_time:.2f}s ') + print(f' Average time / chunk : {avg_time:.2f}s / {chunk_time}s') + print(f' Percent time match : {time_match:.2f}% ') + + if dry: return dry_inserts + + def migrate(self): + # create MD object representation current DB state + pre_metadata = sa.MetaData() + pre_metadata.reflect(bind=self.engine) + + table_rows = {} + for table_name, table in pre_metadata.tables.items(): + # pre-migration rows + select_results = utils.db.sa_execute(self.engine, sa.select(table)) + named_results = utils.db.named_results(table, select_results) + + table_rows[table_name] = named_results + + + #table_update_map = { + # 'files': ( + # lambda r: File(Path(NOTEPATH, r['name']), NOTEPATH).get_table_data() + # ), + # 'notes': ( + # lambda r: Note(Path(NOTEPATH, r['name']), NOTEPATH).get_table_data() + # ), + # 'note_conversion_matter': ( + # lambda r: Note(Path(NOTEPATH, r['name']), NOTEPATH).get_table_data() + # ), + #} + + # update schema + self.recreate() + + with self.engine.connect() as connection: + for table_name, table in tables.metadata.tables.items(): + if table_name not in table_rows: continue + + logger.info(f'Migrating table "{table_name}"') + + if table_name == 'files': + update_note_rows = [] + + for i,note_row in enumerate(table_rows['files']): + file = File(Path(NOTEPATH, note_row['name']), NOTEPATH) + u_note_row = utils.db.prepare_insert( + tables.files, + file.get_table_data() + ) + note_row.update({k:v for k,v in u_note_row.items() if v}) + update_note_rows.append(note_row) + + table_rows['files'] = update_note_rows + elif table_name == 'notes': + update_note_rows = [] + + for note_row in table_rows['notes']: + note = Note(Path(NOTEPATH, note_row['name']), NOTEPATH) + u_note_row = utils.db.prepare_insert( + tables.notes, + note.get_table_data() + ) + note_row.update({k:v for k,v in u_note_row.items() if v}) + update_note_rows.append(note_row) + + table_rows['notes'] = update_note_rows + + # generic update blueprint for later; now doesn't matter as conversion based + # inserts require re-converting...so you may as well just do a full re-build. + #update_rows = [] + #if table_name in table_update_map: + # for i,row in enumerate(table_rows['files']): + # update_obj = table_update_map[table_name](row) + + # u_row = utils.db.prepare_insert( + # table, + # note.get_table_data() + # ) + # note_row.update({k:v for k,v in u_note_row.items() if v}) + # update_note_rows.append(note_row) + + connection.execute( + sa.insert(table), + table_rows[table_name] + ) + + connection.commit() + diff --git a/co3/managers/vss.py b/co3/managers/vss.py new file mode 100644 index 0000000..4727cf8 --- /dev/null +++ b/co3/managers/vss.py @@ -0,0 +1,142 @@ +from collections import defaultdict +import logging +import pickle +import time +from pathlib import Path + +import numpy as np +from tqdm import tqdm +import sqlalchemy as sa + +from co3.manager import Manager +from co3 import util + + +logger = logging.getLogger(__name__) + +class VSSManager(Manager): + def __init__(self, database, engine=None): + super().__init__(database, engine) + + from localsys.db.databases.core import CoreDatabase + + self.core_db = CoreDatabase() + + def recreate(self): + start = time.time() + + chunks = [] + chunk_ids = [] + block_map = {} + for note_name, note_groupby in self.core_db.blocks().items(): + blocks = note_groupby.get('aggregates', []) + for block in blocks: + if block.get('format') != 'src': continue + + block_name = block.get('name', '') + block_content = block.get('content', '') + block_map[block_name] = block_content + + block_chunks, chunk_ranges = utils.embed.split_block(block_content) + + chunks.extend(block_chunks) + chunk_ids.extend([f'{block_name}@{r[0]}:{r[1]}' for r in chunk_ranges]) + + logger.info(f'VSS pre-index SELECT took {time.time()-start:.2f}s') + start = time.time() + + # one-time batched embedding + chunk_embeddings = self.database.access.embed_chunks(chunks) + + logger.info(f'VSS embeddings took {time.time()-start:.2f}s') + start = time.time() + + # aggregate embeddings up the content hierarchy + zero_embed = lambda: np.atleast_2d( + np.zeros(self.database.access._embedding_size, dtype='float32') + ) + block_embedding_map = defaultdict(zero_embed) + note_embedding_map = defaultdict(zero_embed) + + for i, chunk_id in enumerate(chunk_ids): + at_split = chunk_id.split('@') + note_name = at_split[0] + block_name = '@'.join(at_split[:3]) + + block_embedding_map[block_name] += chunk_embeddings[i] + note_embedding_map[note_name] += chunk_embeddings[i] + + # re-normalize aggregated embeddings + # > little inefficient but gobbled up asymptotically by chunk processing + # > could o/w first convert each map to a full 2D np array, then back + for embed_map in [block_embedding_map, note_embedding_map]: + for k, agg_embedding in embed_map.items(): + embed_map[k] = utils.embed.unit_row_wise(agg_embedding) + + logger.info(f'VSS recreate: pre-index SELECT took {time.time()-start:.2f}s') + + # cols = ['rowid', 'chunk_embedding'] + # def pack_inserts(embeddings): + # return [ + # { cols[0]: i, cols[1]: embedding.tobytes() } + # for i, embedding in enumerate(embeddings) + # ] + + # chunk_inserts = pack_inserts(chunk_embeddings) + # block_inserts = pack_inserts(block_embedding_map.values()) + # note_inserts = pack_inserts(note_embedding_map.values()) + + chunk_ids = chunk_ids + block_ids = list(block_embedding_map.keys()) + note_ids = list(note_embedding_map.keys()) + + block_embeddings = np.vstack(list(block_embedding_map.values())) + note_embeddings = np.vstack(list(note_embedding_map.values())) + + blocks = [block_map[b] for b in block_ids] + notes = note_ids + + self.database.access.write_embeddings({ + 'chunks': (chunk_ids, chunk_embeddings, chunks), + 'blocks': (block_ids, block_embeddings, blocks), + 'notes' : (note_ids, note_embeddings, notes), + }) + + logger.info(f'Post-embedding parsing took {time.time()-start:.2f}s') + + # utils.db.create_vss0( + # self.engine, + # 'chunks', + # columns=list(cols), + # inserts=chunk_inserts, + # populate=True, + # reset=True, + # embedding_size=self._embedding_size, + # ) + + def update(self): pass + + def sync(self): pass + + def migrate(self): pass + + def _archive_note_embed(self): + for block in blocks: + content = block.get('content') + if not content: continue + + block_chunks = utils.embed.split_block(content) + chunks.extend(block_chunks) + + embeddings = utils.embed.embed_chunks(chunks) + block_embeddings = utils.embed.map_groups(embeddings, embed_block_map) + + self.convert_map['vect'] = block_embeddings + + note_embedding = utils.embed.unit_row_wise( + embeddings.sum(axis=0).reshape(1, -1) + ) + + return { + 'content': note_embedding.tobytes(), + } diff --git a/co3/mapper.py b/co3/mapper.py new file mode 100644 index 0000000..813a70e --- /dev/null +++ b/co3/mapper.py @@ -0,0 +1,208 @@ +''' +Mapper + +Used to house useful objects for storage schemas (e.g., SQLAlchemy table definitions). +Provides a general interface for mapping from CO4 class names to storage structures for +auto-collection and composition. + +Example: + +mapper = Mapper[sa.Table]() + +mapper.attach( + Type, + attributes=TypeTable, + collation=CollateTable, + collation_groups={ + 'name': NameConversions + } +) +''' +from collections import defaultdict + +from co3.co3 import CO3 +from co3.relation import Relation + + +class Mapper[R: Relation]: + ''' + Mapper base class for housing schema components and managing relationships between CO3 + types and storage targets (of type R). + ''' + def __init__(self): + self.attribute_comps: dict[CO3, R] = {} + self.collation_groups: dict[CO3, dict[str|None, R]] = defaultdict(dict) + + def attach( + self, + type_ref : CO3, + attr_comp : R, + coll_comp : R | None = None, + coll_groups : dict[str | None, R] = None + ) -> None: + ''' + Parameters: + type_ref: CO3 subtype to map to provided storage components + attr_comp: storage component for provided type's canonical attributes + coll_comp: storage component for provided type's default/unnamed collation + targets + coll_groups: storage components for named collation groups; dict mapping group + names to components + ''' + self.attribute_comps[type_ref] = attr_comp + + if coll_comp is not None: + self.collation_groups[type_ref][None] = attr_comp + + if coll_groups is not None: + self.collation_groups[type_ref].update(attr_comp) + + def join_attribute_relations(self, r1: R, r2: R) -> R: + ''' + Specific mechanism for joining attribute-based relations. + ''' + pass + + def join_collation_relations(self, r1: R, r2: R) -> R: + ''' + Specific mechanism for joining collation-based relations. + ''' + pass + + def get_connective_data( + self, + type_instance: CO3, + action_key, + action_group=None, + ) -> dict: + ''' + Return data relevant for connecting collation entries to primary storage + containers. This is typically some combination of the action key and a unique + identifier from the target CO3 instance to form a unique key for inserts from + actions. This is called just prior to collector send-off for collation inserts and + injected alongside collation data. + ''' + return {} + + def get_attribute_comp(self, type_ref: CO3) -> R | None: + return self.attribute_comps.get(type_ref, None) + + def get_collation_comp(self, type_ref: CO3, group=str | None) -> R | None: + return self.collation_group.get(type_ref, {}).get(group, None) + + def collect(self, collector, mapper, action_keys=None) -> dict: + ''' + Stages inserts up the inheritance chain, and down through components. + + Note: + Even with ORM, a method like this would be needed to trace up parent tables and + how inserts should be handled for inheritance. ORM would make component + inserts a little easier perhaps, since they can be attached as attributes to + constructed row objects and a sa.Relationship will handle the rest. Granted, + we don't do a whole lot more here: we just call `collect` over those + components, adding them to the collector session all the same. + + Returns: dict with keys and values relevant for associated SQLite tables + ''' + if action_keys is None: + action_keys = list(self.action_map.keys()) + + receipts = [] + for _cls in reversed(self.__class__.__mro__[:-2]): + attribute_component = mapper.get_attribute_comp(_cls) + + # require an attribute component for type consideration + if attribute_component is None: + continue + + collector.add_insert( + attribute_component, + self.attributes, + receipts=receipts, + ) + + for action_key in action_keys: + collation_data = self.collate(action_key) + + # if method either returned no data or isn't registered, ignore + if collation_data is None: + continue + + _, action_groups = self.action_map[action_key] + for action_group in action_groups: + collation_component = mapper.get_collation_comp(_cls, group=action_group) + + if collation_component is None: + continue + + # gather connective data for collation components + connective_data = mapper.get_connective_data(self, action_key, action_group) + + collector.add_insert( + collation_component, + { + **connective_data, + **collation_data, + }, + receipts=receipts, + ) + + # handle components + for comp in self.components: + receipts.extend(comp.collect(collector, formats=formats)) + + return receipts + + @classmethod + def compose(cls, outer=False, conversion=False, full=False): + ''' + Note: + Comparing to ORM, this method would likely also still be needed, since it may + not be explicitly clear how some JOINs should be handled up the inheritance + chain (for components / sa.Relationships, it's a little easier). + + Parameters: + outer: whether to use outer joins down the chain + conversion: whether to return conversion joins or base primitives + full: whether to return fully connected primitive and conversion table + ''' + def join_builder(outer=False, conversion=False): + head_table = None + last_table = None + join_table = None + + for _cls in reversed(cls.__mro__[:-2]): + table_str = None + table_prefix = _cls.table_prefix + + if conversion: table_str = f'{table_prefix}_conversions' + else: table_str = f'{table_prefix}s' + + if table_str not in tables.table_map: + continue + + table = tables.table_map[table_str] + + if join_table is None: + head_table = table + join_table = table + else: + if conversion: + join_condition = last_table.c.name_fmt == table.c.name_fmt + else: + join_condition = last_table.c.name == table.c.name + + join_table = join_table.join(table, join_condition, isouter=outer) + + last_table = table + + return join_table, head_table + + if full: + # note how the join isn't an OUTER join b/w the two + core, core_h = join_builder(outer=outer, conversion=False) + conv, conv_h = join_builder(outer=outer, conversion=True) + return core.join(conv, core_h.c.name == conv_h.c.name) + + join_table, _ = join_builder(outer=outer, conversion=conversion) + return join_table diff --git a/co3/relation.py b/co3/relation.py new file mode 100644 index 0000000..b2049ee --- /dev/null +++ b/co3/relation.py @@ -0,0 +1,37 @@ +''' +Relation + +Loose wrapper for table-like objects to be used in various database contexts. Relations +can be thought of generally as named data containers that contain tuples of attributes +(adhering to relational algebra terms). Relation subtypes are referred to commonly across +CO3 generics, serving as a fundamental abstraction within particular storage protocols. + +Note: development tasks + As it stands, the Relation skeleton is incredibly lax compared to the properties and + operations that should be formally available, according its pure relational algebra + analog. + + Relations are also generic up to a type T, which ultimately serves as the base object + for Relation instances. We aren't attempting to implement some generally useful + table-like class here; instead we're just exposing a lightweight interface that's + needed for a few CO3 contexts, and commonly off-loading most of the heavy-lifting to + true relation objects like SQLAlchemy tables. +''' +from typing import Self + + +class Relation[T]: + def __init__(self, name, obj: T): + self.name = name + self.obj = obj + + def get_attributes(self): + raise NotImplementedError + + def join( + self, + corelation: Self, + on, + outer=False + ): + raise NotImplementedError diff --git a/co3/relations/__init__.py b/co3/relations/__init__.py new file mode 100644 index 0000000..5bc5ba3 --- /dev/null +++ b/co3/relations/__init__.py @@ -0,0 +1,16 @@ +import sqlalchemy as sa + +from co3.relation import Relation + + +class DictRelation(Relation[dict]): + def get_attributes(self): + return tuple(self.obj.keys()) + +class TabularRelation(Relation[sa.Table]): + def get_attributes(self): + return tuple(self.obj.columns) + + +class SQLTable(Relation[sa.Table]): + pass diff --git a/co3/relations/__pycache__/__init__.cpython-312.pyc b/co3/relations/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000..3916fde Binary files /dev/null and b/co3/relations/__pycache__/__init__.cpython-312.pyc differ diff --git a/co3/util/__init__.py b/co3/util/__init__.py new file mode 100644 index 0000000..9ba947c --- /dev/null +++ b/co3/util/__init__.py @@ -0,0 +1,2 @@ +from co3.util import db +from co3.util import regex diff --git a/co3/util/__pycache__/__init__.cpython-311.pyc b/co3/util/__pycache__/__init__.cpython-311.pyc new file mode 100644 index 0000000..c1dc52d Binary files /dev/null and b/co3/util/__pycache__/__init__.cpython-311.pyc differ diff --git a/co3/util/__pycache__/__init__.cpython-312.pyc b/co3/util/__pycache__/__init__.cpython-312.pyc new file mode 100644 index 0000000..fa62950 Binary files /dev/null and b/co3/util/__pycache__/__init__.cpython-312.pyc differ diff --git a/co3/util/__pycache__/db.cpython-311.pyc b/co3/util/__pycache__/db.cpython-311.pyc new file mode 100644 index 0000000..52c31c0 Binary files /dev/null and b/co3/util/__pycache__/db.cpython-311.pyc differ diff --git a/co3/util/__pycache__/db.cpython-312.pyc b/co3/util/__pycache__/db.cpython-312.pyc new file mode 100644 index 0000000..9572a98 Binary files /dev/null and b/co3/util/__pycache__/db.cpython-312.pyc differ diff --git a/co3/util/__pycache__/paths.cpython-311.pyc b/co3/util/__pycache__/paths.cpython-311.pyc new file mode 100644 index 0000000..d1e65bb Binary files /dev/null and b/co3/util/__pycache__/paths.cpython-311.pyc differ diff --git a/co3/util/__pycache__/regex.cpython-311.pyc b/co3/util/__pycache__/regex.cpython-311.pyc new file mode 100644 index 0000000..87ea7c1 Binary files /dev/null and b/co3/util/__pycache__/regex.cpython-311.pyc differ diff --git a/co3/util/__pycache__/regex.cpython-312.pyc b/co3/util/__pycache__/regex.cpython-312.pyc new file mode 100644 index 0000000..05794a0 Binary files /dev/null and b/co3/util/__pycache__/regex.cpython-312.pyc differ diff --git a/co3/util/db.py b/co3/util/db.py new file mode 100644 index 0000000..ac1543a --- /dev/null +++ b/co3/util/db.py @@ -0,0 +1,375 @@ +''' +Example usage for this file's utilities: + +# get SA engine, creating folder hierarchy to provided DB path +engine = db.get_engine() + +# execute a single SA statement, returns a CursorResult +select_results = db.sa_execute(engine, sa.select()) + +# convert raw results to dictionaries, keys corresponding to col names +select_dicts = db.named_results(
, select_results) + +# use table defaults and cols to create compliant insert +insert_dicts = [ db.prepare_insert(
, sd) for sd in select_dicts ] + +# perform a bulk insert +with engine.connect() as connection: + connection.execute( + sa.insert(
), + insert_dicts + ) +''' + +import time +import logging +import functools +import sqlalchemy as sa +from pathlib import Path + + +logger = logging.getLogger(__name__) + +def get_engine(db_path, echo=False): + Path(db_path).parent.mkdir(parents=True, exist_ok=True) + return sa.create_engine(f"sqlite:///{db_path}", echo=echo) + +def named_results(table, results): + ''' + Note the implications of this for results from compound tables containing the same + column names: only the last column name will be indexed. + ''' + return [ + { c.name:r[i] for i, c in enumerate(table.columns) } + for r in results + ] + +# RAW CURSOR-RESULT MANIPULATION -- SEE SA-PREFIXED METHODS FOR CONN-WRAPPED COUNTERPARTS +def result_mappings(results): + return results.mappings() + +def result_mappings_all(results): + return result_mappings(results).all() + +def result_dicts(results, query_cols=None): + ''' + Parse SQLAlchemy results into Python dicts. Leverages mappings to associate full + column name context. + + If `query_cols` is provided, their implicit names will be used for the keys of the + returned dictionaries. This information is not available under CursorResults and thus + must be provided separately. This will yield results like the following: + + [..., {'table1.col':, 'table2.col':, ...}, ...] + + Instead of the automatic mapping names: + + [..., {'col':, 'col_1':, ...}, ...] + + which can make accessing certain results a little more intuitive. + ''' + if query_cols: + return [ + { str(c):r[c] for c in query_cols } + for r in result_mappings_all(results) + ] + + return [dict(r) for r in result_mappings_all(results)] + +def sa_execute(engine, stmt, bind_params=None, include_cols=False): + ''' + Simple single-statement execution in a with-block + ''' + with engine.connect() as conn: + res = conn.execute(stmt, bind_params) + + if include_cols: + cols = list(res.mappings().keys()) + return res, cols + + return res + +def sa_exec_mappings(engine, stmt, bind_params=None, include_cols=False): + ''' + All mappings fetched inside of connect context, safe to access outside + ''' + with engine.connect() as conn: + res = conn.execute(stmt, bind_params) + mappings = result_mappings_all(res) + + if include_cols: + cols = list(res.mappings().keys()) + return mappings, cols + + return mappings + +def sa_exec_dicts(engine, stmt, bind_params=None, include_cols=False): + with engine.connect() as conn: + res = conn.execute(stmt, bind_params) + dicts = result_dicts(res) + + if include_cols: + cols = list(res.mappings().keys()) + return dicts, cols + + return dicts + +def sa_exec_explicit(engine, stmt, bind_params=None): + with engine.connect() as conn: + trans = conn.begin() # start a new transaction explicitly + try: + result = conn.execute(stmt, bind_params) + trans.commit() # commit the transaction explicitly + return result + except: + trans.rollback() # rollback the transaction explicitly + raise + +def prepare_insert(table, value_dict): + ''' + Modifies insert dictionary with full table column defaults + ''' + insert_dict = get_column_defaults(table) + #insert_dict.update(value_dict) + insert_dict.update( + { k:v for k,v in value_dict.items() if k in insert_dict } + ) + + return insert_dict + +def deferred_fkey(target, **kwargs): + return sa.ForeignKey( + target, + deferrable=True, + initially='DEFERRED', + **kwargs + ) + +def deferred_cd_fkey(target, **kwargs): + ''' + Prefer this when using FKEYs; need to really justify _not_ having a CASCADE deletion + enabled + ''' + return deferred_fkey(target, ondelete='CASCADE', **kwargs) + +def get_column_defaults(table, include_all=True): + ''' + Provide column:default pairs for a provided SQLAlchemy table. + + Parameters: + table: SQLAlchemy table + include_all: whether to include all columns, even those without explicit defaults + ''' + default_values = {} + for column in table.columns: + if column.default is not None: + default_values[column.name] = column.default.arg + elif column.nullable: + default_values[column.name] = None + else: + # assume empty string if include_all and col has no explicit default + # and isn't nullable + if include_all and column.name != 'id': + default_values[column.name] = '' + + return default_values + +def get_column_names_str_table(engine, table: str): + col_sql = f'PRAGMA table_info({table});' + with engine.connect() as connection: + try: + cols = connection.execute(sa.text(col_sql)) + except sa.exc.OperationalError as e: + logger.error(f'Column retrieval for table "{table}" failed') + raise + + return cols + +def create_fts5( + engine, + table: sa.Table | str, + columns=None, + populate=False, + inserts=None, + reset_fts=False, + tokenizer='unicode61', + ): + ''' + Create and optionally populate an FTS5 table in SQLite. Can be used directly for + existing tables in the same database. It can also be used for composite tables (i.e., + those created from JOINs) or really any other data by providing explicit inserts and + column names to use during population. + + Parameters: + table: either SQLAlchemy table instance, or table name string + columns: list of SQLAlchemy table columns to insert into virtual table. These + columns must be present in the provided table if not manually specifying + inserts (since the table must be queried automatically) + inserts: + ''' + is_sa_table = isinstance(table, sa.Table) + table_name = table.name if is_sa_table else table + + if columns is None: + if is_sa_table: + columns = [c.name for c in table.c] + else: + columns = get_column_names_str_table(engine, table) + + col_str = ", ".join(columns) + fts_table_name = f'{table_name}_fts_{tokenizer}' + + sql = f""" + CREATE VIRTUAL TABLE {fts_table_name} USING fts5 + ( + {col_str}, + tokenize = '{tokenizer}' + ); + """ + + sql_insert = f""" + INSERT INTO {fts_table_name} + ( + {col_str} + ) + """ + if inserts is None: + sql_insert += f""" + SELECT {col_str} + FROM {table_name}; + """ + else: + sql_insert += f""" + VALUES ({', '.join(':' + c for c in columns)}) + """ + + sql_drop = f"DROP TABLE IF EXISTS {fts_table_name}" + + with engine.connect() as connection: + if reset_fts: + connection.execute(sa.text(sql_drop)) + + connection.execute(sa.text(sql)) + + if populate: + if inserts is None: + connection.execute(sa.text(sql_insert)) + else: + connection.execute( + sa.text(sql_insert), + inserts, + ) + + connection.commit() + +def populate_fts5(engine, tables, columns=None, inserts=None): + # create indexes + tokenizers = ['unicode61', 'porter', 'trigram'] + + for table in tables: + for tokenizer in tokenizers: + start = time.time() + create_fts5( + engine, + table, + columns=columns, + populate=True, + inserts=inserts, + reset_fts=True, + tokenizer=tokenizer + ) + + is_sa_table = isinstance(table, sa.Table) + table_name = table.name if is_sa_table else table + print(f'Created FTS5 index for table "{table_name}+{tokenizer}"; took {time.time() - start}s') + + +def create_vss0( + engine, + table: sa.Table | str, + columns=None, + populate=False, + inserts=None, + reset=False, + embedding_size=384, + ): + ''' + Create a VSS table + + Parameters: + table: either SQLAlchemy table instance, or table name string + columns: list of SQLAlchemy table columns to insert into virtual table. These + columns must be present in the provided table if not manually specifying + inserts (since the table must be queried automatically) + inserts: + ''' + is_sa_table = isinstance(table, sa.Table) + table_name = table.name if is_sa_table else table + + if columns is None: + if is_sa_table: + columns = [c.name for c in table.c] + else: + columns = get_column_names_str_table(engine, table) + + col_str = ", ".join(columns) + vss_table_name = f'{table_name}_vss' + + sql = f""" + CREATE VIRTUAL TABLE {vss_table_name} USING vss0 + ( + chunk_embedding({embedding_size}), + query_embedding({embedding_size}), + ); + """ + + sql_insert = f""" + INSERT INTO {vss_table_name} + ( + rowid, chunk_embedding + ) + """ + if inserts is None: + sql_insert += f""" + SELECT {col_str} + FROM {table_name}; + """ + else: + sql_insert += f""" + VALUES ({', '.join(':' + c for c in columns)}) + """ + + sql_drop = f"DROP TABLE IF EXISTS {vss_table_name}" + + with engine.connect() as connection: + if reset: + connection.execute(sa.text(sql_drop)) + + connection.execute(sa.text(sql)) + + if populate: + if inserts is None: + connection.execute(sa.text(sql_insert)) + else: + connection.execute( + sa.text(sql_insert), + inserts, + ) + + connection.commit() + +def fts5_prep_composite(engine, table, table_name, columns=None): + ''' + Helper method for prepping JOIN tables for FTS5 creation. + ''' + table.name = table_name + + rows, cols = utils.db.sa_execute( + engine, + sa.select(*select_cols).select_from(all_search), + include_cols=True + ) + rows = utils.db.result_dicts(rows) + + return table, rows, cols + diff --git a/co3/util/regex.py b/co3/util/regex.py new file mode 100644 index 0000000..8ba41d4 --- /dev/null +++ b/co3/util/regex.py @@ -0,0 +1,7 @@ +import re + + +camel2snake_regex = re.compile(r'(? + + + + + + + + co4.accessors package - co4 documentation + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+
+
co4 documentation
 +
+
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+ +
+ +
+ +
+
+
+

co4.accessors package#

+
+

Submodules#

+
+
+

co4.accessors.fts module#

+
+
+

co4.accessors.table module#

+
+
+

co4.accessors.vss module#

+
+
+ +
+
+ +
+ +
+
+ + + + + \ No newline at end of file diff --git a/docs/_build/html/_autoref/co4.collectors.html b/docs/_build/html/_autoref/co4.collectors.html new file mode 100644 index 0000000..1867725 --- /dev/null +++ b/docs/_build/html/_autoref/co4.collectors.html @@ -0,0 +1,292 @@ + + + + + + + + + co4.collectors package - co4 documentation + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+
+
co4 documentation
 +
+
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+ +
+ +
+ +
+
+
+

co4.collectors package#

+
+

Submodules#

+
+
+

co4.collectors.core module#

+
+
+ +
+
+ +
+ +
+
+ + + + + \ No newline at end of file diff --git a/docs/_build/html/_autoref/co4.composers.html b/docs/_build/html/_autoref/co4.composers.html new file mode 100644 index 0000000..35d3349 --- /dev/null +++ b/docs/_build/html/_autoref/co4.composers.html @@ -0,0 +1,296 @@ + + + + + + + + + co4.composers package - co4 documentation + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+
+
co4 documentation
 +
+
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+ +
+ +
+ +
+
+
+

co4.composers package#

+
+

Submodules#

+
+
+

co4.composers.core module#

+
+
+

co4.composers.fts module#

+
+
+ +
+
+ +
+ +
+
+ + + + + \ No newline at end of file diff --git a/docs/_build/html/_autoref/co4.databases.html b/docs/_build/html/_autoref/co4.databases.html new file mode 100644 index 0000000..97f3f95 --- /dev/null +++ b/docs/_build/html/_autoref/co4.databases.html @@ -0,0 +1,300 @@ + + + + + + + + + co4.databases package - co4 documentation + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+
+
co4 documentation
 +
+
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+ +
+ +
+ +
+
+
+

co4.databases package#

+
+

Submodules#

+
+
+

co4.databases.core module#

+
+
+

co4.databases.fts module#

+
+
+

co4.databases.vss module#

+
+
+ +
+
+ +
+ +
+
+ + + + + \ No newline at end of file diff --git a/docs/_build/html/_autoref/co4.html b/docs/_build/html/_autoref/co4.html new file mode 100644 index 0000000..cbf2136 --- /dev/null +++ b/docs/_build/html/_autoref/co4.html @@ -0,0 +1,352 @@ + + + + + + + + + co4 package - co4 documentation + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+
+
co4 documentation
 +
+
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+ +
+ +
+ +
+
+
+

co4 package#

+
+

Subpackages#

+
+ +
+
+
+

Submodules#

+
+
+

co4.accessor module#

+
+
+

co4.co4 module#

+
+
+

co4.collector module#

+
+
+

co4.composer module#

+
+
+

co4.indexer module#

+
+
+

co4.manager module#

+
+
+ +
+
+ +
+ +
+
+ + + + + \ No newline at end of file diff --git a/docs/_build/html/_autoref/co4.managers.html b/docs/_build/html/_autoref/co4.managers.html new file mode 100644 index 0000000..7482d65 --- /dev/null +++ b/docs/_build/html/_autoref/co4.managers.html @@ -0,0 +1,300 @@ + + + + + + + + + co4.managers package - co4 documentation + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+
+
co4 documentation
 +
+
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+ +
+ +
+ +
+
+
+

co4.managers package#

+
+

Submodules#

+
+
+

co4.managers.core module#

+
+
+

co4.managers.fts module#

+
+
+

co4.managers.vss module#

+
+
+ +
+
+ +
+ +
+
+ + + + + \ No newline at end of file diff --git a/docs/_build/html/_autoref/modules.html b/docs/_build/html/_autoref/modules.html new file mode 100644 index 0000000..c7d96e9 --- /dev/null +++ b/docs/_build/html/_autoref/modules.html @@ -0,0 +1,297 @@ + + + + + + + + + co4 - co4 documentation + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+
+
co4 documentation
 +
+
+
+ +
+ +
+
+ +
+
+
+ + + + + Back to top + +
+ +
+ +
+ +
+
+
+

co4#

+
+ +
+
+ +
+
+
+ +
+ + +
+
+
+
+ Copyright © 2023, Sam Griesemer +
+ Made with Sphinx and @pradyunsg's + + Furo + +
+
+ +
+
+ +
+
+ +
+
+ + + + + \ No newline at end of file diff --git a/docs/_build/html/_sources/_autoref/co4.accessors.rst.txt b/docs/_build/html/_sources/_autoref/co4.accessors.rst.txt new file mode 100644 index 0000000..f1233e2 --- /dev/null +++ b/docs/_build/html/_sources/_autoref/co4.accessors.rst.txt @@ -0,0 +1,34 @@ +co4.accessors package +===================== + +.. automodule:: co4.accessors + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +co4.accessors.fts module +------------------------ + +.. automodule:: co4.accessors.fts + :members: + :undoc-members: + :show-inheritance: + +co4.accessors.table module +-------------------------- + +.. automodule:: co4.accessors.table + :members: + :undoc-members: + :show-inheritance: + +co4.accessors.vss module +------------------------ + +.. automodule:: co4.accessors.vss + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/_build/html/_sources/_autoref/co4.collectors.rst.txt b/docs/_build/html/_sources/_autoref/co4.collectors.rst.txt new file mode 100644 index 0000000..72d7ce2 --- /dev/null +++ b/docs/_build/html/_sources/_autoref/co4.collectors.rst.txt @@ -0,0 +1,18 @@ +co4.collectors package +====================== + +.. automodule:: co4.collectors + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +co4.collectors.core module +-------------------------- + +.. automodule:: co4.collectors.core + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/_build/html/_sources/_autoref/co4.composers.rst.txt b/docs/_build/html/_sources/_autoref/co4.composers.rst.txt new file mode 100644 index 0000000..5eb604b --- /dev/null +++ b/docs/_build/html/_sources/_autoref/co4.composers.rst.txt @@ -0,0 +1,26 @@ +co4.composers package +===================== + +.. automodule:: co4.composers + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +co4.composers.core module +------------------------- + +.. automodule:: co4.composers.core + :members: + :undoc-members: + :show-inheritance: + +co4.composers.fts module +------------------------ + +.. automodule:: co4.composers.fts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/_build/html/_sources/_autoref/co4.databases.rst.txt b/docs/_build/html/_sources/_autoref/co4.databases.rst.txt new file mode 100644 index 0000000..d542e91 --- /dev/null +++ b/docs/_build/html/_sources/_autoref/co4.databases.rst.txt @@ -0,0 +1,34 @@ +co4.databases package +===================== + +.. automodule:: co4.databases + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +co4.databases.core module +------------------------- + +.. automodule:: co4.databases.core + :members: + :undoc-members: + :show-inheritance: + +co4.databases.fts module +------------------------ + +.. automodule:: co4.databases.fts + :members: + :undoc-members: + :show-inheritance: + +co4.databases.vss module +------------------------ + +.. automodule:: co4.databases.vss + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/_build/html/_sources/_autoref/co4.managers.rst.txt b/docs/_build/html/_sources/_autoref/co4.managers.rst.txt new file mode 100644 index 0000000..cea3f3d --- /dev/null +++ b/docs/_build/html/_sources/_autoref/co4.managers.rst.txt @@ -0,0 +1,34 @@ +co4.managers package +==================== + +.. automodule:: co4.managers + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +co4.managers.core module +------------------------ + +.. automodule:: co4.managers.core + :members: + :undoc-members: + :show-inheritance: + +co4.managers.fts module +----------------------- + +.. automodule:: co4.managers.fts + :members: + :undoc-members: + :show-inheritance: + +co4.managers.vss module +----------------------- + +.. automodule:: co4.managers.vss + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/_build/html/_sources/_autoref/co4.rst.txt b/docs/_build/html/_sources/_autoref/co4.rst.txt new file mode 100644 index 0000000..7d5ccfc --- /dev/null +++ b/docs/_build/html/_sources/_autoref/co4.rst.txt @@ -0,0 +1,70 @@ +co4 package +=========== + +.. automodule:: co4 + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + co4.accessors + co4.collectors + co4.composers + co4.databases + co4.managers + +Submodules +---------- + +co4.accessor module +------------------- + +.. automodule:: co4.accessor + :members: + :undoc-members: + :show-inheritance: + +co4.co4 module +-------------- + +.. automodule:: co4.co4 + :members: + :undoc-members: + :show-inheritance: + +co4.collector module +-------------------- + +.. automodule:: co4.collector + :members: + :undoc-members: + :show-inheritance: + +co4.composer module +------------------- + +.. automodule:: co4.composer + :members: + :undoc-members: + :show-inheritance: + +co4.indexer module +------------------ + +.. automodule:: co4.indexer + :members: + :undoc-members: + :show-inheritance: + +co4.manager module +------------------ + +.. automodule:: co4.manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/_build/html/_sources/_autoref/modules.rst.txt b/docs/_build/html/_sources/_autoref/modules.rst.txt new file mode 100644 index 0000000..a72e900 --- /dev/null +++ b/docs/_build/html/_sources/_autoref/modules.rst.txt @@ -0,0 +1,7 @@ +co4 +=== + +.. toctree:: + :maxdepth: 4 + + co4 diff --git a/docs/_build/html/_sources/index.md.txt b/docs/_build/html/_sources/index.md.txt new file mode 100644 index 0000000..cd39ee1 --- /dev/null +++ b/docs/_build/html/_sources/index.md.txt @@ -0,0 +1,24 @@ +# `co4` package docs +{ref}`genindex` +{ref}`modindex` +{ref}`search` + +```{toctree} +:maxdepth: 3 +:caption: Autoref + +_autoref/co4.rst +``` + +```{toctree} +:maxdepth: 3 +:caption: Contents + +reference/documentation/index +reference/site/index +``` + +```{include} ../../README.md +``` + + diff --git a/docs/_build/html/_sources/reference/documentation/index.md.txt b/docs/_build/html/_sources/reference/documentation/index.md.txt new file mode 100644 index 0000000..a14cdde --- /dev/null +++ b/docs/_build/html/_sources/reference/documentation/index.md.txt @@ -0,0 +1,8 @@ +# Documentation + +```{toctree} +:hidden: + +sphinx +``` + diff --git a/docs/_build/html/_sources/reference/documentation/sphinx.md.txt b/docs/_build/html/_sources/reference/documentation/sphinx.md.txt new file mode 100644 index 0000000..33d6f27 --- /dev/null +++ b/docs/_build/html/_sources/reference/documentation/sphinx.md.txt @@ -0,0 +1,111 @@ +# Sphinx +The primary driver of this package's documentation is Sphinx's `autodoc` extension, +using the [Furo theme][1]. + +**High-level details**: + +- `sphinx-apidoc` generates package-based documentation to the `_autoref/` directory, + with navigation available under "Autoref" in the sidebar. +- Markdown-based documentation files are manually written under the `reference/` + directory, showing up under "Contents" in the sidebar. + +## Detailed directory structure +All files are placed under `docs/sphinx`: + +- `_`-prefixed are Sphinx-managed directories + * `_build/html/` houses output HTML files + * `_autoref/` is the target for module-based RST files written by `autodoc` +- `reference/`: houses all manually written documentation (totally separate from + auto-generated package docs) +- `conf.py`: single Sphinx configuration file +- `index.md`: documentation index, setups up a persistent sidebar across all other pages + +For manually written documentation under `reference/`, topics are nested as needed. Within +a nested directory `reference/`, an `index.md` should created with content like: + +``` +# + +\`\`\`{toctree} +:hidden: + +sub-topic-1.rst +sub-topic-2.rst +... +\`\`\` +``` + +This will add the nested directory to the sidebar navigation, using the name set under the +top-level header. See [Markdown syntax][#markdown-syntax] for more details on the syntax. + +## Sphinx autodoc +Sphinx's `autodoc` extension allows automatic generation of documents according to +(Python) subpackage structure and available docstrings. A few notes here: + +- In the `conf.py` file, autodoc is enabled by adding `"sphinx.ext.autodoc"` to + the extensions list. `"sphinx.ext.viewcode"` can also be added to provide + links to source code. +- Documents are actually generated by calling the `sphinx-apidoc` CLI command. The + current Makefile uses the following call: + + ```sh + sphinx-apidoc --module-first -o docs/sphinx/_autoref/ localsys + ``` + + This writes the automatically generated docs for modules in the package at the + local directory `localsys/` to the `docs/sphinx/_autoref` directory. These are + reStructuredText files by default. + * `--module-first` places the module-level descriptions at the top of the module page. + By default, this is placed at the bottom (oddly), and can be obscured by large lists + of subpackages if this flag isn't provided. + * See available `sphinx-apidoc` options [here][2], as well as more advanced config + [here][3]. + + +## Markdown syntax +The `myst_parser` extension enables Markdown (or something close to it) to be used when +writing documentation files. The Sphinx directives can be difficult to track, and +they change slightly under the MyST Markdown syntax. The following are a few common +blocks: + +**Page hierarchies**: the following will generate link hierarchy according to the provided +pages: + +``` +\`\`\`{toctree} +:maxdepth: +:caption:
+:hidden: + +example-file-1 +example-file-2 +example-dir/index +... +\`\`\` +``` + +- `:maxdepth:` limits the depth of nesting +- `:caption:` title for the group of pages +- `:hidden:` if provided, links will only show in the sidebar (hidden on the page) +- Constituent files: listed files will be rendered as a link directly. If a listed file + has a `{toctree}` directive, this tree will be rendered in place of the page's link as a + dropdown. The dropdown will be named according to the file's top-level heading, and + clicking directly on the dropdown header will show that page's content. Files found in + the tree will be placed as links under the dropdown, recursively subject to same rules + described here. + +**Include files**: the following will include file content +pages: + +``` +\`\`\`{include} README.md +\`\`\` +``` + +**Reference directives** + + +[1]: https://pradyunsg.me/furo/ +[2]: https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html +[3]: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html# + diff --git a/docs/_build/html/_static/basic.css b/docs/_build/html/_static/basic.css new file mode 100644 index 0000000..30fee9d --- /dev/null +++ b/docs/_build/html/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/_build/html/_static/debug.css b/docs/_build/html/_static/debug.css new file mode 100644 index 0000000..74d4aec --- /dev/null +++ b/docs/_build/html/_static/debug.css @@ -0,0 +1,69 @@ +/* + This CSS file should be overridden by the theme authors. It's + meant for debugging and developing the skeleton that this theme provides. +*/ +body { + font-family: -apple-system, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, + "Apple Color Emoji", "Segoe UI Emoji"; + background: lavender; +} +.sb-announcement { + background: rgb(131, 131, 131); +} +.sb-announcement__inner { + background: black; + color: white; +} +.sb-header { + background: lightskyblue; +} +.sb-header__inner { + background: royalblue; + color: white; +} +.sb-header-secondary { + background: lightcyan; +} +.sb-header-secondary__inner { + background: cornflowerblue; + color: white; +} +.sb-sidebar-primary { + background: lightgreen; +} +.sb-main { + background: blanchedalmond; +} +.sb-main__inner { + background: antiquewhite; +} +.sb-header-article { + background: lightsteelblue; +} +.sb-article-container { + background: snow; +} +.sb-article-main { + background: white; +} +.sb-footer-article { + background: lightpink; +} +.sb-sidebar-secondary { + background: lightgoldenrodyellow; +} +.sb-footer-content { + background: plum; +} +.sb-footer-content__inner { + background: palevioletred; +} +.sb-footer { + background: pink; +} +.sb-footer__inner { + background: salmon; +} +.sb-article { + background: white; +} diff --git a/docs/_build/html/_static/doctools.js b/docs/_build/html/_static/doctools.js new file mode 100644 index 0000000..d06a71d --- /dev/null +++ b/docs/_build/html/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js new file mode 100644 index 0000000..7e4c114 --- /dev/null +++ b/docs/_build/html/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/docs/_build/html/_static/file.png b/docs/_build/html/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/docs/_build/html/_static/file.png differ diff --git a/docs/_build/html/_static/language_data.js b/docs/_build/html/_static/language_data.js new file mode 100644 index 0000000..250f566 --- /dev/null +++ b/docs/_build/html/_static/language_data.js @@ -0,0 +1,199 @@ +/* + * language_data.js + * ~~~~~~~~~~~~~~~~ + * + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; + + +/* Non-minified version is copied as a separate JS file, is available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/docs/_build/html/_static/minus.png b/docs/_build/html/_static/minus.png new file mode 100644 index 0000000..d96755f Binary files /dev/null and b/docs/_build/html/_static/minus.png differ diff --git a/docs/_build/html/_static/plus.png b/docs/_build/html/_static/plus.png new file mode 100644 index 0000000..7107cec Binary files /dev/null and b/docs/_build/html/_static/plus.png differ diff --git a/docs/_build/html/_static/pygments.css b/docs/_build/html/_static/pygments.css new file mode 100644 index 0000000..c2e07c7 --- /dev/null +++ b/docs/_build/html/_static/pygments.css @@ -0,0 +1,258 @@ +.highlight pre { line-height: 125%; } +.highlight td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +.highlight span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +.highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #8f5902; font-style: italic } /* Comment */ +.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ +.highlight .g { color: #000000 } /* Generic */ +.highlight .k { color: #204a87; font-weight: bold } /* Keyword */ +.highlight .l { color: #000000 } /* Literal */ +.highlight .n { color: #000000 } /* Name */ +.highlight .o { color: #ce5c00; font-weight: bold } /* Operator */ +.highlight .x { color: #000000 } /* Other */ +.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ +.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #8f5902; font-style: italic } /* Comment.Preproc */ +.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #a40000 } /* Generic.Deleted */ +.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #000000; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #ef2929 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #000000; font-style: italic } /* Generic.Output */ +.highlight .gp { color: #8f5902 } /* Generic.Prompt */ +.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ +.highlight .kc { color: #204a87; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #204a87; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #204a87; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #204a87; font-weight: bold } /* Keyword.Pseudo */ +.highlight .kr { color: #204a87; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #204a87; font-weight: bold } /* Keyword.Type */ +.highlight .ld { color: #000000 } /* Literal.Date */ +.highlight .m { color: #0000cf; font-weight: bold } /* Literal.Number */ +.highlight .s { color: #4e9a06 } /* Literal.String */ +.highlight .na { color: #c4a000 } /* Name.Attribute */ +.highlight .nb { color: #204a87 } /* Name.Builtin */ +.highlight .nc { color: #000000 } /* Name.Class */ +.highlight .no { color: #000000 } /* Name.Constant */ +.highlight .nd { color: #5c35cc; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #ce5c00 } /* Name.Entity */ +.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #000000 } /* Name.Function */ +.highlight .nl { color: #f57900 } /* Name.Label */ +.highlight .nn { color: #000000 } /* Name.Namespace */ +.highlight .nx { color: #000000 } /* Name.Other */ +.highlight .py { color: #000000 } /* Name.Property */ +.highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #000000 } /* Name.Variable */ +.highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ +.highlight .w { color: #f8f8f8 } /* Text.Whitespace */ +.highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ +.highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ +.highlight .mh { color: #0000cf; font-weight: bold } /* Literal.Number.Hex */ +.highlight .mi { color: #0000cf; font-weight: bold } /* Literal.Number.Integer */ +.highlight .mo { color: #0000cf; font-weight: bold } /* Literal.Number.Oct */ +.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ +.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ +.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ +.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ +.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ +.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ +.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ +.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ +.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ +.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ +.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ +.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ +.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #000000 } /* Name.Function.Magic */ +.highlight .vc { color: #000000 } /* Name.Variable.Class */ +.highlight .vg { color: #000000 } /* Name.Variable.Global */ +.highlight .vi { color: #000000 } /* Name.Variable.Instance */ +.highlight .vm { color: #000000 } /* Name.Variable.Magic */ +.highlight .il { color: #0000cf; font-weight: bold } /* Literal.Number.Integer.Long */ +@media not print { +body[data-theme="dark"] .highlight pre { line-height: 125%; } +body[data-theme="dark"] .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } +body[data-theme="dark"] .highlight span.linenos { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } +body[data-theme="dark"] .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +body[data-theme="dark"] .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +body[data-theme="dark"] .highlight .hll { background-color: #404040 } +body[data-theme="dark"] .highlight { background: #202020; color: #d0d0d0 } +body[data-theme="dark"] .highlight .c { color: #ababab; font-style: italic } /* Comment */ +body[data-theme="dark"] .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ +body[data-theme="dark"] .highlight .esc { color: #d0d0d0 } /* Escape */ +body[data-theme="dark"] .highlight .g { color: #d0d0d0 } /* Generic */ +body[data-theme="dark"] .highlight .k { color: #6ebf26; font-weight: bold } /* Keyword */ +body[data-theme="dark"] .highlight .l { color: #d0d0d0 } /* Literal */ +body[data-theme="dark"] .highlight .n { color: #d0d0d0 } /* Name */ +body[data-theme="dark"] .highlight .o { color: #d0d0d0 } /* Operator */ +body[data-theme="dark"] .highlight .x { color: #d0d0d0 } /* Other */ +body[data-theme="dark"] .highlight .p { color: #d0d0d0 } /* Punctuation */ +body[data-theme="dark"] .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */ +body[data-theme="dark"] .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */ +body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* Comment.Preproc */ +body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ +body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ +body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ +body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ +body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ +body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ +body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ +body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ +body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ +body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ +body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ +body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ +body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ +body[data-theme="dark"] .highlight .kp { color: #6ebf26 } /* Keyword.Pseudo */ +body[data-theme="dark"] .highlight .kr { color: #6ebf26; font-weight: bold } /* Keyword.Reserved */ +body[data-theme="dark"] .highlight .kt { color: #6ebf26; font-weight: bold } /* Keyword.Type */ +body[data-theme="dark"] .highlight .ld { color: #d0d0d0 } /* Literal.Date */ +body[data-theme="dark"] .highlight .m { color: #51b2fd } /* Literal.Number */ +body[data-theme="dark"] .highlight .s { color: #ed9d13 } /* Literal.String */ +body[data-theme="dark"] .highlight .na { color: #bbbbbb } /* Name.Attribute */ +body[data-theme="dark"] .highlight .nb { color: #2fbccd } /* Name.Builtin */ +body[data-theme="dark"] .highlight .nc { color: #71adff; text-decoration: underline } /* Name.Class */ +body[data-theme="dark"] .highlight .no { color: #40ffff } /* Name.Constant */ +body[data-theme="dark"] .highlight .nd { color: #ffa500 } /* Name.Decorator */ +body[data-theme="dark"] .highlight .ni { color: #d0d0d0 } /* Name.Entity */ +body[data-theme="dark"] .highlight .ne { color: #bbbbbb } /* Name.Exception */ +body[data-theme="dark"] .highlight .nf { color: #71adff } /* Name.Function */ +body[data-theme="dark"] .highlight .nl { color: #d0d0d0 } /* Name.Label */ +body[data-theme="dark"] .highlight .nn { color: #71adff; text-decoration: underline } /* Name.Namespace */ +body[data-theme="dark"] .highlight .nx { color: #d0d0d0 } /* Name.Other */ +body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ +body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ +body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ +body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ +body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ +body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ +body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ +body[data-theme="dark"] .highlight .mh { color: #51b2fd } /* Literal.Number.Hex */ +body[data-theme="dark"] .highlight .mi { color: #51b2fd } /* Literal.Number.Integer */ +body[data-theme="dark"] .highlight .mo { color: #51b2fd } /* Literal.Number.Oct */ +body[data-theme="dark"] .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */ +body[data-theme="dark"] .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */ +body[data-theme="dark"] .highlight .sc { color: #ed9d13 } /* Literal.String.Char */ +body[data-theme="dark"] .highlight .dl { color: #ed9d13 } /* Literal.String.Delimiter */ +body[data-theme="dark"] .highlight .sd { color: #ed9d13 } /* Literal.String.Doc */ +body[data-theme="dark"] .highlight .s2 { color: #ed9d13 } /* Literal.String.Double */ +body[data-theme="dark"] .highlight .se { color: #ed9d13 } /* Literal.String.Escape */ +body[data-theme="dark"] .highlight .sh { color: #ed9d13 } /* Literal.String.Heredoc */ +body[data-theme="dark"] .highlight .si { color: #ed9d13 } /* Literal.String.Interpol */ +body[data-theme="dark"] .highlight .sx { color: #ffa500 } /* Literal.String.Other */ +body[data-theme="dark"] .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */ +body[data-theme="dark"] .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */ +body[data-theme="dark"] .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */ +body[data-theme="dark"] .highlight .bp { color: #2fbccd } /* Name.Builtin.Pseudo */ +body[data-theme="dark"] .highlight .fm { color: #71adff } /* Name.Function.Magic */ +body[data-theme="dark"] .highlight .vc { color: #40ffff } /* Name.Variable.Class */ +body[data-theme="dark"] .highlight .vg { color: #40ffff } /* Name.Variable.Global */ +body[data-theme="dark"] .highlight .vi { color: #40ffff } /* Name.Variable.Instance */ +body[data-theme="dark"] .highlight .vm { color: #40ffff } /* Name.Variable.Magic */ +body[data-theme="dark"] .highlight .il { color: #51b2fd } /* Literal.Number.Integer.Long */ +@media (prefers-color-scheme: dark) { +body:not([data-theme="light"]) .highlight pre { line-height: 125%; } +body:not([data-theme="light"]) .highlight td.linenos .normal { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } +body:not([data-theme="light"]) .highlight span.linenos { color: #aaaaaa; background-color: transparent; padding-left: 5px; padding-right: 5px; } +body:not([data-theme="light"]) .highlight td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +body:not([data-theme="light"]) .highlight span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +body:not([data-theme="light"]) .highlight .hll { background-color: #404040 } +body:not([data-theme="light"]) .highlight { background: #202020; color: #d0d0d0 } +body:not([data-theme="light"]) .highlight .c { color: #ababab; font-style: italic } /* Comment */ +body:not([data-theme="light"]) .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ +body:not([data-theme="light"]) .highlight .esc { color: #d0d0d0 } /* Escape */ +body:not([data-theme="light"]) .highlight .g { color: #d0d0d0 } /* Generic */ +body:not([data-theme="light"]) .highlight .k { color: #6ebf26; font-weight: bold } /* Keyword */ +body:not([data-theme="light"]) .highlight .l { color: #d0d0d0 } /* Literal */ +body:not([data-theme="light"]) .highlight .n { color: #d0d0d0 } /* Name */ +body:not([data-theme="light"]) .highlight .o { color: #d0d0d0 } /* Operator */ +body:not([data-theme="light"]) .highlight .x { color: #d0d0d0 } /* Other */ +body:not([data-theme="light"]) .highlight .p { color: #d0d0d0 } /* Punctuation */ +body:not([data-theme="light"]) .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */ +body:not([data-theme="light"]) .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */ +body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bold } /* Comment.Preproc */ +body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ +body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ +body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ +body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ +body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ +body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ +body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ +body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ +body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ +body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ +body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ +body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ +body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ +body:not([data-theme="light"]) .highlight .kp { color: #6ebf26 } /* Keyword.Pseudo */ +body:not([data-theme="light"]) .highlight .kr { color: #6ebf26; font-weight: bold } /* Keyword.Reserved */ +body:not([data-theme="light"]) .highlight .kt { color: #6ebf26; font-weight: bold } /* Keyword.Type */ +body:not([data-theme="light"]) .highlight .ld { color: #d0d0d0 } /* Literal.Date */ +body:not([data-theme="light"]) .highlight .m { color: #51b2fd } /* Literal.Number */ +body:not([data-theme="light"]) .highlight .s { color: #ed9d13 } /* Literal.String */ +body:not([data-theme="light"]) .highlight .na { color: #bbbbbb } /* Name.Attribute */ +body:not([data-theme="light"]) .highlight .nb { color: #2fbccd } /* Name.Builtin */ +body:not([data-theme="light"]) .highlight .nc { color: #71adff; text-decoration: underline } /* Name.Class */ +body:not([data-theme="light"]) .highlight .no { color: #40ffff } /* Name.Constant */ +body:not([data-theme="light"]) .highlight .nd { color: #ffa500 } /* Name.Decorator */ +body:not([data-theme="light"]) .highlight .ni { color: #d0d0d0 } /* Name.Entity */ +body:not([data-theme="light"]) .highlight .ne { color: #bbbbbb } /* Name.Exception */ +body:not([data-theme="light"]) .highlight .nf { color: #71adff } /* Name.Function */ +body:not([data-theme="light"]) .highlight .nl { color: #d0d0d0 } /* Name.Label */ +body:not([data-theme="light"]) .highlight .nn { color: #71adff; text-decoration: underline } /* Name.Namespace */ +body:not([data-theme="light"]) .highlight .nx { color: #d0d0d0 } /* Name.Other */ +body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Property */ +body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ +body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ +body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ +body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ +body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ +body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ +body:not([data-theme="light"]) .highlight .mh { color: #51b2fd } /* Literal.Number.Hex */ +body:not([data-theme="light"]) .highlight .mi { color: #51b2fd } /* Literal.Number.Integer */ +body:not([data-theme="light"]) .highlight .mo { color: #51b2fd } /* Literal.Number.Oct */ +body:not([data-theme="light"]) .highlight .sa { color: #ed9d13 } /* Literal.String.Affix */ +body:not([data-theme="light"]) .highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */ +body:not([data-theme="light"]) .highlight .sc { color: #ed9d13 } /* Literal.String.Char */ +body:not([data-theme="light"]) .highlight .dl { color: #ed9d13 } /* Literal.String.Delimiter */ +body:not([data-theme="light"]) .highlight .sd { color: #ed9d13 } /* Literal.String.Doc */ +body:not([data-theme="light"]) .highlight .s2 { color: #ed9d13 } /* Literal.String.Double */ +body:not([data-theme="light"]) .highlight .se { color: #ed9d13 } /* Literal.String.Escape */ +body:not([data-theme="light"]) .highlight .sh { color: #ed9d13 } /* Literal.String.Heredoc */ +body:not([data-theme="light"]) .highlight .si { color: #ed9d13 } /* Literal.String.Interpol */ +body:not([data-theme="light"]) .highlight .sx { color: #ffa500 } /* Literal.String.Other */ +body:not([data-theme="light"]) .highlight .sr { color: #ed9d13 } /* Literal.String.Regex */ +body:not([data-theme="light"]) .highlight .s1 { color: #ed9d13 } /* Literal.String.Single */ +body:not([data-theme="light"]) .highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */ +body:not([data-theme="light"]) .highlight .bp { color: #2fbccd } /* Name.Builtin.Pseudo */ +body:not([data-theme="light"]) .highlight .fm { color: #71adff } /* Name.Function.Magic */ +body:not([data-theme="light"]) .highlight .vc { color: #40ffff } /* Name.Variable.Class */ +body:not([data-theme="light"]) .highlight .vg { color: #40ffff } /* Name.Variable.Global */ +body:not([data-theme="light"]) .highlight .vi { color: #40ffff } /* Name.Variable.Instance */ +body:not([data-theme="light"]) .highlight .vm { color: #40ffff } /* Name.Variable.Magic */ +body:not([data-theme="light"]) .highlight .il { color: #51b2fd } /* Literal.Number.Integer.Long */ +} +} \ No newline at end of file diff --git a/docs/_build/html/_static/scripts/furo-extensions.js b/docs/_build/html/_static/scripts/furo-extensions.js new file mode 100644 index 0000000..e69de29 diff --git a/docs/_build/html/_static/scripts/furo.js b/docs/_build/html/_static/scripts/furo.js new file mode 100644 index 0000000..32e7c05 --- /dev/null +++ b/docs/_build/html/_static/scripts/furo.js @@ -0,0 +1,3 @@ +/*! For license information please see furo.js.LICENSE.txt */ +(()=>{var t={212:function(t,e,n){var o,r;r=void 0!==n.g?n.g:"undefined"!=typeof window?window:this,o=function(){return function(t){"use strict";var e={navClass:"active",contentClass:"active",nested:!1,nestedClass:"active",offset:0,reflow:!1,events:!0},n=function(t,e,n){if(n.settings.events){var o=new CustomEvent(t,{bubbles:!0,cancelable:!0,detail:n});e.dispatchEvent(o)}},o=function(t){var e=0;if(t.offsetParent)for(;t;)e+=t.offsetTop,t=t.offsetParent;return e>=0?e:0},r=function(t){t&&t.sort((function(t,e){return o(t.content)=Math.max(document.body.scrollHeight,document.documentElement.scrollHeight,document.body.offsetHeight,document.documentElement.offsetHeight,document.body.clientHeight,document.documentElement.clientHeight)},l=function(t,e){var n=t[t.length-1];if(function(t,e){return!(!s()||!c(t.content,e,!0))}(n,e))return n;for(var o=t.length-1;o>=0;o--)if(c(t[o].content,e))return t[o]},a=function(t,e){if(e.nested&&t.parentNode){var n=t.parentNode.closest("li");n&&(n.classList.remove(e.nestedClass),a(n,e))}},i=function(t,e){if(t){var o=t.nav.closest("li");o&&(o.classList.remove(e.navClass),t.content.classList.remove(e.contentClass),a(o,e),n("gumshoeDeactivate",o,{link:t.nav,content:t.content,settings:e}))}},u=function(t,e){if(e.nested){var n=t.parentNode.closest("li");n&&(n.classList.add(e.nestedClass),u(n,e))}};return function(o,c){var s,a,d,f,m,v={setup:function(){s=document.querySelectorAll(o),a=[],Array.prototype.forEach.call(s,(function(t){var e=document.getElementById(decodeURIComponent(t.hash.substr(1)));e&&a.push({nav:t,content:e})})),r(a)},detect:function(){var t=l(a,m);t?d&&t.content===d.content||(i(d,m),function(t,e){if(t){var o=t.nav.closest("li");o&&(o.classList.add(e.navClass),t.content.classList.add(e.contentClass),u(o,e),n("gumshoeActivate",o,{link:t.nav,content:t.content,settings:e}))}}(t,m),d=t):d&&(i(d,m),d=null)}},h=function(e){f&&t.cancelAnimationFrame(f),f=t.requestAnimationFrame(v.detect)},g=function(e){f&&t.cancelAnimationFrame(f),f=t.requestAnimationFrame((function(){r(a),v.detect()}))};return v.destroy=function(){d&&i(d,m),t.removeEventListener("scroll",h,!1),m.reflow&&t.removeEventListener("resize",g,!1),a=null,s=null,d=null,f=null,m=null},m=function(){var t={};return Array.prototype.forEach.call(arguments,(function(e){for(var n in e){if(!e.hasOwnProperty(n))return;t[n]=e[n]}})),t}(e,c||{}),v.setup(),v.detect(),t.addEventListener("scroll",h,!1),m.reflow&&t.addEventListener("resize",g,!1),v}}(r)}.apply(e,[]),void 0===o||(t.exports=o)}},e={};function n(o){var r=e[o];if(void 0!==r)return r.exports;var c=e[o]={exports:{}};return t[o].call(c.exports,c,c.exports,n),c.exports}n.n=t=>{var e=t&&t.__esModule?()=>t.default:()=>t;return n.d(e,{a:e}),e},n.d=(t,e)=>{for(var o in e)n.o(e,o)&&!n.o(t,o)&&Object.defineProperty(t,o,{enumerable:!0,get:e[o]})},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(t){if("object"==typeof window)return window}}(),n.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e),(()=>{"use strict";var t=n(212),e=n.n(t),o=null,r=null,c=window.pageYOffset||document.documentElement.scrollTop;const s=64;function l(){const t=localStorage.getItem("theme")||"auto";var e;"light"!==(e=window.matchMedia("(prefers-color-scheme: dark)").matches?"auto"===t?"light":"light"==t?"dark":"auto":"auto"===t?"dark":"dark"==t?"light":"auto")&&"dark"!==e&&"auto"!==e&&(console.error(`Got invalid theme mode: ${e}. Resetting to auto.`),e="auto"),document.body.dataset.theme=e,localStorage.setItem("theme",e),console.log(`Changed to ${e} mode.`)}function a(){!function(){const t=document.getElementsByClassName("theme-toggle");Array.from(t).forEach((t=>{t.addEventListener("click",l)}))}(),function(){let t=0,e=!1;window.addEventListener("scroll",(function(n){t=window.scrollY,e||(window.requestAnimationFrame((function(){var n;n=t,0==Math.floor(r.getBoundingClientRect().top)?r.classList.add("scrolled"):r.classList.remove("scrolled"),function(t){tc&&document.documentElement.classList.remove("show-back-to-top"),c=t}(n),function(t){null!==o&&(0==t?o.scrollTo(0,0):Math.ceil(t)>=Math.floor(document.documentElement.scrollHeight-window.innerHeight)?o.scrollTo(0,o.scrollHeight):document.querySelector(".scroll-current"))}(n),e=!1})),e=!0)})),window.scroll()}(),null!==o&&new(e())(".toc-tree a",{reflow:!0,recursive:!0,navClass:"scroll-current",offset:()=>{let t=parseFloat(getComputedStyle(document.documentElement).fontSize);return r.getBoundingClientRect().height+.5*t+1}})}document.addEventListener("DOMContentLoaded",(function(){document.body.parentNode.classList.remove("no-js"),r=document.querySelector("header"),o=document.querySelector(".toc-scroll"),a()}))})()})(); +//# sourceMappingURL=furo.js.map \ No newline at end of file diff --git a/docs/_build/html/_static/scripts/furo.js.LICENSE.txt b/docs/_build/html/_static/scripts/furo.js.LICENSE.txt new file mode 100644 index 0000000..1632189 --- /dev/null +++ b/docs/_build/html/_static/scripts/furo.js.LICENSE.txt @@ -0,0 +1,7 @@ +/*! + * gumshoejs v5.1.2 (patched by @pradyunsg) + * A simple, framework-agnostic scrollspy script. + * (c) 2019 Chris Ferdinandi + * MIT License + * http://github.com/cferdinandi/gumshoe + */ diff --git a/docs/_build/html/_static/scripts/furo.js.map b/docs/_build/html/_static/scripts/furo.js.map new file mode 100644 index 0000000..4705302 --- /dev/null +++ b/docs/_build/html/_static/scripts/furo.js.map @@ -0,0 +1 @@ +{"version":3,"file":"scripts/furo.js","mappings":";iCAAA,MAQWA,SAWS,IAAX,EAAAC,EACH,EAAAA,EACkB,oBAAXC,OACLA,OACAC,KAbO,EAAF,WACP,OAaJ,SAAUD,GACR,aAMA,IAAIE,EAAW,CAEbC,SAAU,SACVC,aAAc,SAGdC,QAAQ,EACRC,YAAa,SAGbC,OAAQ,EACRC,QAAQ,EAGRC,QAAQ,GA6BNC,EAAY,SAAUC,EAAMC,EAAMC,GAEpC,GAAKA,EAAOC,SAASL,OAArB,CAGA,IAAIM,EAAQ,IAAIC,YAAYL,EAAM,CAChCM,SAAS,EACTC,YAAY,EACZL,OAAQA,IAIVD,EAAKO,cAAcJ,EAVgB,CAWrC,EAOIK,EAAe,SAAUR,GAC3B,IAAIS,EAAW,EACf,GAAIT,EAAKU,aACP,KAAOV,GACLS,GAAYT,EAAKW,UACjBX,EAAOA,EAAKU,aAGhB,OAAOD,GAAY,EAAIA,EAAW,CACpC,EAMIG,EAAe,SAAUC,GACvBA,GACFA,EAASC,MAAK,SAAUC,EAAOC,GAG7B,OAFcR,EAAaO,EAAME,SACnBT,EAAaQ,EAAMC,UACF,EACxB,CACT,GAEJ,EAwCIC,EAAW,SAAUlB,EAAME,EAAUiB,GACvC,IAAIC,EAASpB,EAAKqB,wBACd1B,EAnCU,SAAUO,GAExB,MAA+B,mBAApBA,EAASP,OACX2B,WAAWpB,EAASP,UAItB2B,WAAWpB,EAASP,OAC7B,CA2Be4B,CAAUrB,GACvB,OAAIiB,EAEAK,SAASJ,EAAOD,OAAQ,KACvB/B,EAAOqC,aAAeC,SAASC,gBAAgBC,cAG7CJ,SAASJ,EAAOS,IAAK,KAAOlC,CACrC,EAMImC,EAAa,WACf,OACEC,KAAKC,KAAK5C,EAAOqC,YAAcrC,EAAO6C,cAnCjCF,KAAKG,IACVR,SAASS,KAAKC,aACdV,SAASC,gBAAgBS,aACzBV,SAASS,KAAKE,aACdX,SAASC,gBAAgBU,aACzBX,SAASS,KAAKP,aACdF,SAASC,gBAAgBC,aAkC7B,EAmBIU,EAAY,SAAUzB,EAAUX,GAClC,IAAIqC,EAAO1B,EAASA,EAAS2B,OAAS,GACtC,GAbgB,SAAUC,EAAMvC,GAChC,SAAI4B,MAAgBZ,EAASuB,EAAKxB,QAASf,GAAU,GAEvD,CAUMwC,CAAYH,EAAMrC,GAAW,OAAOqC,EACxC,IAAK,IAAII,EAAI9B,EAAS2B,OAAS,EAAGG,GAAK,EAAGA,IACxC,GAAIzB,EAASL,EAAS8B,GAAG1B,QAASf,GAAW,OAAOW,EAAS8B,EAEjE,EAOIC,EAAmB,SAAUC,EAAK3C,GAEpC,GAAKA,EAAST,QAAWoD,EAAIC,WAA7B,CAGA,IAAIC,EAAKF,EAAIC,WAAWE,QAAQ,MAC3BD,IAGLA,EAAGE,UAAUC,OAAOhD,EAASR,aAG7BkD,EAAiBG,EAAI7C,GAV0B,CAWjD,EAOIiD,EAAa,SAAUC,EAAOlD,GAEhC,GAAKkD,EAAL,CAGA,IAAIL,EAAKK,EAAMP,IAAIG,QAAQ,MACtBD,IAGLA,EAAGE,UAAUC,OAAOhD,EAASX,UAC7B6D,EAAMnC,QAAQgC,UAAUC,OAAOhD,EAASV,cAGxCoD,EAAiBG,EAAI7C,GAGrBJ,EAAU,oBAAqBiD,EAAI,CACjCM,KAAMD,EAAMP,IACZ5B,QAASmC,EAAMnC,QACff,SAAUA,IAjBM,CAmBpB,EAOIoD,EAAiB,SAAUT,EAAK3C,GAElC,GAAKA,EAAST,OAAd,CAGA,IAAIsD,EAAKF,EAAIC,WAAWE,QAAQ,MAC3BD,IAGLA,EAAGE,UAAUM,IAAIrD,EAASR,aAG1B4D,EAAeP,EAAI7C,GAVS,CAW9B,EA6LA,OA1JkB,SAAUsD,EAAUC,GAKpC,IACIC,EAAU7C,EAAU8C,EAASC,EAAS1D,EADtC2D,EAAa,CAUjBA,MAAmB,WAEjBH,EAAWhC,SAASoC,iBAAiBN,GAGrC3C,EAAW,GAGXkD,MAAMC,UAAUC,QAAQC,KAAKR,GAAU,SAAUjB,GAE/C,IAAIxB,EAAUS,SAASyC,eACrBC,mBAAmB3B,EAAK4B,KAAKC,OAAO,KAEjCrD,GAGLJ,EAAS0D,KAAK,CACZ1B,IAAKJ,EACLxB,QAASA,GAEb,IAGAL,EAAaC,EACf,EAKAgD,OAAoB,WAElB,IAAIW,EAASlC,EAAUzB,EAAUX,GAG5BsE,EASDb,GAAWa,EAAOvD,UAAY0C,EAAQ1C,UAG1CkC,EAAWQ,EAASzD,GAzFT,SAAUkD,EAAOlD,GAE9B,GAAKkD,EAAL,CAGA,IAAIL,EAAKK,EAAMP,IAAIG,QAAQ,MACtBD,IAGLA,EAAGE,UAAUM,IAAIrD,EAASX,UAC1B6D,EAAMnC,QAAQgC,UAAUM,IAAIrD,EAASV,cAGrC8D,EAAeP,EAAI7C,GAGnBJ,EAAU,kBAAmBiD,EAAI,CAC/BM,KAAMD,EAAMP,IACZ5B,QAASmC,EAAMnC,QACff,SAAUA,IAjBM,CAmBpB,CAqEIuE,CAASD,EAAQtE,GAGjByD,EAAUa,GAfJb,IACFR,EAAWQ,EAASzD,GACpByD,EAAU,KAchB,GAMIe,EAAgB,SAAUvE,GAExByD,GACFxE,EAAOuF,qBAAqBf,GAI9BA,EAAUxE,EAAOwF,sBAAsBf,EAAWgB,OACpD,EAMIC,EAAgB,SAAU3E,GAExByD,GACFxE,EAAOuF,qBAAqBf,GAI9BA,EAAUxE,EAAOwF,uBAAsB,WACrChE,EAAaC,GACbgD,EAAWgB,QACb,GACF,EAkDA,OA7CAhB,EAAWkB,QAAU,WAEfpB,GACFR,EAAWQ,EAASzD,GAItBd,EAAO4F,oBAAoB,SAAUN,GAAe,GAChDxE,EAASN,QACXR,EAAO4F,oBAAoB,SAAUF,GAAe,GAItDjE,EAAW,KACX6C,EAAW,KACXC,EAAU,KACVC,EAAU,KACV1D,EAAW,IACb,EAOEA,EA3XS,WACX,IAAI+E,EAAS,CAAC,EAOd,OANAlB,MAAMC,UAAUC,QAAQC,KAAKgB,WAAW,SAAUC,GAChD,IAAK,IAAIC,KAAOD,EAAK,CACnB,IAAKA,EAAIE,eAAeD,GAAM,OAC9BH,EAAOG,GAAOD,EAAIC,EACpB,CACF,IACOH,CACT,CAkXeK,CAAOhG,EAAUmE,GAAW,CAAC,GAGxCI,EAAW0B,QAGX1B,EAAWgB,SAGXzF,EAAOoG,iBAAiB,SAAUd,GAAe,GAC7CxE,EAASN,QACXR,EAAOoG,iBAAiB,SAAUV,GAAe,GAS9CjB,CACT,CAOF,CArcW4B,CAAQvG,EAChB,UAFM,SAEN,uBCXDwG,EAA2B,CAAC,EAGhC,SAASC,EAAoBC,GAE5B,IAAIC,EAAeH,EAAyBE,GAC5C,QAAqBE,IAAjBD,EACH,OAAOA,EAAaE,QAGrB,IAAIC,EAASN,EAAyBE,GAAY,CAGjDG,QAAS,CAAC,GAOX,OAHAE,EAAoBL,GAAU1B,KAAK8B,EAAOD,QAASC,EAAQA,EAAOD,QAASJ,GAGpEK,EAAOD,OACf,CCrBAJ,EAAoBO,EAAKF,IACxB,IAAIG,EAASH,GAAUA,EAAOI,WAC7B,IAAOJ,EAAiB,QACxB,IAAM,EAEP,OADAL,EAAoBU,EAAEF,EAAQ,CAAEG,EAAGH,IAC5BA,CAAM,ECLdR,EAAoBU,EAAI,CAACN,EAASQ,KACjC,IAAI,IAAInB,KAAOmB,EACXZ,EAAoBa,EAAED,EAAYnB,KAASO,EAAoBa,EAAET,EAASX,IAC5EqB,OAAOC,eAAeX,EAASX,EAAK,CAAEuB,YAAY,EAAMC,IAAKL,EAAWnB,IAE1E,ECNDO,EAAoBxG,EAAI,WACvB,GAA0B,iBAAf0H,WAAyB,OAAOA,WAC3C,IACC,OAAOxH,MAAQ,IAAIyH,SAAS,cAAb,EAChB,CAAE,MAAOC,GACR,GAAsB,iBAAX3H,OAAqB,OAAOA,MACxC,CACA,CAPuB,GCAxBuG,EAAoBa,EAAI,CAACrB,EAAK6B,IAAUP,OAAOzC,UAAUqB,eAAenB,KAAKiB,EAAK6B,4CCK9EC,EAAY,KACZC,EAAS,KACTC,EAAgB/H,OAAO6C,aAAeP,SAASC,gBAAgByF,UACnE,MAAMC,EAAmB,GA2EzB,SAASC,IACP,MAAMC,EAAeC,aAAaC,QAAQ,UAAY,OAZxD,IAAkBC,EACH,WADGA,EAaItI,OAAOuI,WAAW,gCAAgCC,QAI/C,SAAjBL,EACO,QACgB,SAAhBA,EACA,OAEA,OAIU,SAAjBA,EACO,OACgB,QAAhBA,EACA,QAEA,SA9BoB,SAATG,GAA4B,SAATA,IACzCG,QAAQC,MAAM,2BAA2BJ,yBACzCA,EAAO,QAGThG,SAASS,KAAK4F,QAAQC,MAAQN,EAC9BF,aAAaS,QAAQ,QAASP,GAC9BG,QAAQK,IAAI,cAAcR,UA0B5B,CAkDA,SAASnC,KART,WAEE,MAAM4C,EAAUzG,SAAS0G,uBAAuB,gBAChDrE,MAAMsE,KAAKF,GAASlE,SAASqE,IAC3BA,EAAI9C,iBAAiB,QAAS8B,EAAe,GAEjD,CAGEiB,GA9CF,WAEE,IAAIC,EAA6B,EAC7BC,GAAU,EAEdrJ,OAAOoG,iBAAiB,UAAU,SAAUuB,GAC1CyB,EAA6BpJ,OAAOsJ,QAE/BD,IACHrJ,OAAOwF,uBAAsB,WAzDnC,IAAuB+D,IA0DDH,EA9GkC,GAAlDzG,KAAK6G,MAAM1B,EAAO7F,wBAAwBQ,KAC5CqF,EAAOjE,UAAUM,IAAI,YAErB2D,EAAOjE,UAAUC,OAAO,YAI5B,SAAmCyF,GAC7BA,EAAYtB,EACd3F,SAASC,gBAAgBsB,UAAUC,OAAO,oBAEtCyF,EAAYxB,EACdzF,SAASC,gBAAgBsB,UAAUM,IAAI,oBAC9BoF,EAAYxB,GACrBzF,SAASC,gBAAgBsB,UAAUC,OAAO,oBAG9CiE,EAAgBwB,CAClB,CAoCEE,CAA0BF,GAlC5B,SAA6BA,GACT,OAAd1B,IAKa,GAAb0B,EACF1B,EAAU6B,SAAS,EAAG,GAGtB/G,KAAKC,KAAK2G,IACV5G,KAAK6G,MAAMlH,SAASC,gBAAgBS,aAAehD,OAAOqC,aAE1DwF,EAAU6B,SAAS,EAAG7B,EAAU7E,cAGhBV,SAASqH,cAAc,mBAc3C,CAKEC,CAAoBL,GAwDdF,GAAU,CACZ,IAEAA,GAAU,EAEd,IACArJ,OAAO6J,QACT,CA6BEC,GA1BkB,OAAdjC,GAKJ,IAAI,IAAJ,CAAY,cAAe,CACzBrH,QAAQ,EACRuJ,WAAW,EACX5J,SAAU,iBACVI,OAAQ,KACN,IAAIyJ,EAAM9H,WAAW+H,iBAAiB3H,SAASC,iBAAiB2H,UAChE,OAAOpC,EAAO7F,wBAAwBkI,OAAS,GAAMH,EAAM,CAAC,GAiBlE,CAcA1H,SAAS8D,iBAAiB,oBAT1B,WACE9D,SAASS,KAAKW,WAAWG,UAAUC,OAAO,SAE1CgE,EAASxF,SAASqH,cAAc,UAChC9B,EAAYvF,SAASqH,cAAc,eAEnCxD,GACF","sources":["webpack:///./src/furo/assets/scripts/gumshoe-patched.js","webpack:///webpack/bootstrap","webpack:///webpack/runtime/compat get default export","webpack:///webpack/runtime/define property getters","webpack:///webpack/runtime/global","webpack:///webpack/runtime/hasOwnProperty shorthand","webpack:///./src/furo/assets/scripts/furo.js"],"sourcesContent":["/*!\n * gumshoejs v5.1.2 (patched by @pradyunsg)\n * A simple, framework-agnostic scrollspy script.\n * (c) 2019 Chris Ferdinandi\n * MIT License\n * http://github.com/cferdinandi/gumshoe\n */\n\n(function (root, factory) {\n if (typeof define === \"function\" && define.amd) {\n define([], function () {\n return factory(root);\n });\n } else if (typeof exports === \"object\") {\n module.exports = factory(root);\n } else {\n root.Gumshoe = factory(root);\n }\n})(\n typeof global !== \"undefined\"\n ? global\n : typeof window !== \"undefined\"\n ? window\n : this,\n function (window) {\n \"use strict\";\n\n //\n // Defaults\n //\n\n var defaults = {\n // Active classes\n navClass: \"active\",\n contentClass: \"active\",\n\n // Nested navigation\n nested: false,\n nestedClass: \"active\",\n\n // Offset & reflow\n offset: 0,\n reflow: false,\n\n // Event support\n events: true,\n };\n\n //\n // Methods\n //\n\n /**\n * Merge two or more objects together.\n * @param {Object} objects The objects to merge together\n * @returns {Object} Merged values of defaults and options\n */\n var extend = function () {\n var merged = {};\n Array.prototype.forEach.call(arguments, function (obj) {\n for (var key in obj) {\n if (!obj.hasOwnProperty(key)) return;\n merged[key] = obj[key];\n }\n });\n return merged;\n };\n\n /**\n * Emit a custom event\n * @param {String} type The event type\n * @param {Node} elem The element to attach the event to\n * @param {Object} detail Any details to pass along with the event\n */\n var emitEvent = function (type, elem, detail) {\n // Make sure events are enabled\n if (!detail.settings.events) return;\n\n // Create a new event\n var event = new CustomEvent(type, {\n bubbles: true,\n cancelable: true,\n detail: detail,\n });\n\n // Dispatch the event\n elem.dispatchEvent(event);\n };\n\n /**\n * Get an element's distance from the top of the Document.\n * @param {Node} elem The element\n * @return {Number} Distance from the top in pixels\n */\n var getOffsetTop = function (elem) {\n var location = 0;\n if (elem.offsetParent) {\n while (elem) {\n location += elem.offsetTop;\n elem = elem.offsetParent;\n }\n }\n return location >= 0 ? location : 0;\n };\n\n /**\n * Sort content from first to last in the DOM\n * @param {Array} contents The content areas\n */\n var sortContents = function (contents) {\n if (contents) {\n contents.sort(function (item1, item2) {\n var offset1 = getOffsetTop(item1.content);\n var offset2 = getOffsetTop(item2.content);\n if (offset1 < offset2) return -1;\n return 1;\n });\n }\n };\n\n /**\n * Get the offset to use for calculating position\n * @param {Object} settings The settings for this instantiation\n * @return {Float} The number of pixels to offset the calculations\n */\n var getOffset = function (settings) {\n // if the offset is a function run it\n if (typeof settings.offset === \"function\") {\n return parseFloat(settings.offset());\n }\n\n // Otherwise, return it as-is\n return parseFloat(settings.offset);\n };\n\n /**\n * Get the document element's height\n * @private\n * @returns {Number}\n */\n var getDocumentHeight = function () {\n return Math.max(\n document.body.scrollHeight,\n document.documentElement.scrollHeight,\n document.body.offsetHeight,\n document.documentElement.offsetHeight,\n document.body.clientHeight,\n document.documentElement.clientHeight,\n );\n };\n\n /**\n * Determine if an element is in view\n * @param {Node} elem The element\n * @param {Object} settings The settings for this instantiation\n * @param {Boolean} bottom If true, check if element is above bottom of viewport instead\n * @return {Boolean} Returns true if element is in the viewport\n */\n var isInView = function (elem, settings, bottom) {\n var bounds = elem.getBoundingClientRect();\n var offset = getOffset(settings);\n if (bottom) {\n return (\n parseInt(bounds.bottom, 10) <\n (window.innerHeight || document.documentElement.clientHeight)\n );\n }\n return parseInt(bounds.top, 10) <= offset;\n };\n\n /**\n * Check if at the bottom of the viewport\n * @return {Boolean} If true, page is at the bottom of the viewport\n */\n var isAtBottom = function () {\n if (\n Math.ceil(window.innerHeight + window.pageYOffset) >=\n getDocumentHeight()\n )\n return true;\n return false;\n };\n\n /**\n * Check if the last item should be used (even if not at the top of the page)\n * @param {Object} item The last item\n * @param {Object} settings The settings for this instantiation\n * @return {Boolean} If true, use the last item\n */\n var useLastItem = function (item, settings) {\n if (isAtBottom() && isInView(item.content, settings, true)) return true;\n return false;\n };\n\n /**\n * Get the active content\n * @param {Array} contents The content areas\n * @param {Object} settings The settings for this instantiation\n * @return {Object} The content area and matching navigation link\n */\n var getActive = function (contents, settings) {\n var last = contents[contents.length - 1];\n if (useLastItem(last, settings)) return last;\n for (var i = contents.length - 1; i >= 0; i--) {\n if (isInView(contents[i].content, settings)) return contents[i];\n }\n };\n\n /**\n * Deactivate parent navs in a nested navigation\n * @param {Node} nav The starting navigation element\n * @param {Object} settings The settings for this instantiation\n */\n var deactivateNested = function (nav, settings) {\n // If nesting isn't activated, bail\n if (!settings.nested || !nav.parentNode) return;\n\n // Get the parent navigation\n var li = nav.parentNode.closest(\"li\");\n if (!li) return;\n\n // Remove the active class\n li.classList.remove(settings.nestedClass);\n\n // Apply recursively to any parent navigation elements\n deactivateNested(li, settings);\n };\n\n /**\n * Deactivate a nav and content area\n * @param {Object} items The nav item and content to deactivate\n * @param {Object} settings The settings for this instantiation\n */\n var deactivate = function (items, settings) {\n // Make sure there are items to deactivate\n if (!items) return;\n\n // Get the parent list item\n var li = items.nav.closest(\"li\");\n if (!li) return;\n\n // Remove the active class from the nav and content\n li.classList.remove(settings.navClass);\n items.content.classList.remove(settings.contentClass);\n\n // Deactivate any parent navs in a nested navigation\n deactivateNested(li, settings);\n\n // Emit a custom event\n emitEvent(\"gumshoeDeactivate\", li, {\n link: items.nav,\n content: items.content,\n settings: settings,\n });\n };\n\n /**\n * Activate parent navs in a nested navigation\n * @param {Node} nav The starting navigation element\n * @param {Object} settings The settings for this instantiation\n */\n var activateNested = function (nav, settings) {\n // If nesting isn't activated, bail\n if (!settings.nested) return;\n\n // Get the parent navigation\n var li = nav.parentNode.closest(\"li\");\n if (!li) return;\n\n // Add the active class\n li.classList.add(settings.nestedClass);\n\n // Apply recursively to any parent navigation elements\n activateNested(li, settings);\n };\n\n /**\n * Activate a nav and content area\n * @param {Object} items The nav item and content to activate\n * @param {Object} settings The settings for this instantiation\n */\n var activate = function (items, settings) {\n // Make sure there are items to activate\n if (!items) return;\n\n // Get the parent list item\n var li = items.nav.closest(\"li\");\n if (!li) return;\n\n // Add the active class to the nav and content\n li.classList.add(settings.navClass);\n items.content.classList.add(settings.contentClass);\n\n // Activate any parent navs in a nested navigation\n activateNested(li, settings);\n\n // Emit a custom event\n emitEvent(\"gumshoeActivate\", li, {\n link: items.nav,\n content: items.content,\n settings: settings,\n });\n };\n\n /**\n * Create the Constructor object\n * @param {String} selector The selector to use for navigation items\n * @param {Object} options User options and settings\n */\n var Constructor = function (selector, options) {\n //\n // Variables\n //\n\n var publicAPIs = {};\n var navItems, contents, current, timeout, settings;\n\n //\n // Methods\n //\n\n /**\n * Set variables from DOM elements\n */\n publicAPIs.setup = function () {\n // Get all nav items\n navItems = document.querySelectorAll(selector);\n\n // Create contents array\n contents = [];\n\n // Loop through each item, get it's matching content, and push to the array\n Array.prototype.forEach.call(navItems, function (item) {\n // Get the content for the nav item\n var content = document.getElementById(\n decodeURIComponent(item.hash.substr(1)),\n );\n if (!content) return;\n\n // Push to the contents array\n contents.push({\n nav: item,\n content: content,\n });\n });\n\n // Sort contents by the order they appear in the DOM\n sortContents(contents);\n };\n\n /**\n * Detect which content is currently active\n */\n publicAPIs.detect = function () {\n // Get the active content\n var active = getActive(contents, settings);\n\n // if there's no active content, deactivate and bail\n if (!active) {\n if (current) {\n deactivate(current, settings);\n current = null;\n }\n return;\n }\n\n // If the active content is the one currently active, do nothing\n if (current && active.content === current.content) return;\n\n // Deactivate the current content and activate the new content\n deactivate(current, settings);\n activate(active, settings);\n\n // Update the currently active content\n current = active;\n };\n\n /**\n * Detect the active content on scroll\n * Debounced for performance\n */\n var scrollHandler = function (event) {\n // If there's a timer, cancel it\n if (timeout) {\n window.cancelAnimationFrame(timeout);\n }\n\n // Setup debounce callback\n timeout = window.requestAnimationFrame(publicAPIs.detect);\n };\n\n /**\n * Update content sorting on resize\n * Debounced for performance\n */\n var resizeHandler = function (event) {\n // If there's a timer, cancel it\n if (timeout) {\n window.cancelAnimationFrame(timeout);\n }\n\n // Setup debounce callback\n timeout = window.requestAnimationFrame(function () {\n sortContents(contents);\n publicAPIs.detect();\n });\n };\n\n /**\n * Destroy the current instantiation\n */\n publicAPIs.destroy = function () {\n // Undo DOM changes\n if (current) {\n deactivate(current, settings);\n }\n\n // Remove event listeners\n window.removeEventListener(\"scroll\", scrollHandler, false);\n if (settings.reflow) {\n window.removeEventListener(\"resize\", resizeHandler, false);\n }\n\n // Reset variables\n contents = null;\n navItems = null;\n current = null;\n timeout = null;\n settings = null;\n };\n\n /**\n * Initialize the current instantiation\n */\n var init = function () {\n // Merge user options into defaults\n settings = extend(defaults, options || {});\n\n // Setup variables based on the current DOM\n publicAPIs.setup();\n\n // Find the currently active content\n publicAPIs.detect();\n\n // Setup event listeners\n window.addEventListener(\"scroll\", scrollHandler, false);\n if (settings.reflow) {\n window.addEventListener(\"resize\", resizeHandler, false);\n }\n };\n\n //\n // Initialize and return the public APIs\n //\n\n init();\n return publicAPIs;\n };\n\n //\n // Return the Constructor\n //\n\n return Constructor;\n },\n);\n","// The module cache\nvar __webpack_module_cache__ = {};\n\n// The require function\nfunction __webpack_require__(moduleId) {\n\t// Check if module is in cache\n\tvar cachedModule = __webpack_module_cache__[moduleId];\n\tif (cachedModule !== undefined) {\n\t\treturn cachedModule.exports;\n\t}\n\t// Create a new module (and put it into the cache)\n\tvar module = __webpack_module_cache__[moduleId] = {\n\t\t// no module.id needed\n\t\t// no module.loaded needed\n\t\texports: {}\n\t};\n\n\t// Execute the module function\n\t__webpack_modules__[moduleId].call(module.exports, module, module.exports, __webpack_require__);\n\n\t// Return the exports of the module\n\treturn module.exports;\n}\n\n","// getDefaultExport function for compatibility with non-harmony modules\n__webpack_require__.n = (module) => {\n\tvar getter = module && module.__esModule ?\n\t\t() => (module['default']) :\n\t\t() => (module);\n\t__webpack_require__.d(getter, { a: getter });\n\treturn getter;\n};","// define getter functions for harmony exports\n__webpack_require__.d = (exports, definition) => {\n\tfor(var key in definition) {\n\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n\t\t}\n\t}\n};","__webpack_require__.g = (function() {\n\tif (typeof globalThis === 'object') return globalThis;\n\ttry {\n\t\treturn this || new Function('return this')();\n\t} catch (e) {\n\t\tif (typeof window === 'object') return window;\n\t}\n})();","__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))","import Gumshoe from \"./gumshoe-patched.js\";\n\n////////////////////////////////////////////////////////////////////////////////\n// Scroll Handling\n////////////////////////////////////////////////////////////////////////////////\nvar tocScroll = null;\nvar header = null;\nvar lastScrollTop = window.pageYOffset || document.documentElement.scrollTop;\nconst GO_TO_TOP_OFFSET = 64;\n\nfunction scrollHandlerForHeader() {\n if (Math.floor(header.getBoundingClientRect().top) == 0) {\n header.classList.add(\"scrolled\");\n } else {\n header.classList.remove(\"scrolled\");\n }\n}\n\nfunction scrollHandlerForBackToTop(positionY) {\n if (positionY < GO_TO_TOP_OFFSET) {\n document.documentElement.classList.remove(\"show-back-to-top\");\n } else {\n if (positionY < lastScrollTop) {\n document.documentElement.classList.add(\"show-back-to-top\");\n } else if (positionY > lastScrollTop) {\n document.documentElement.classList.remove(\"show-back-to-top\");\n }\n }\n lastScrollTop = positionY;\n}\n\nfunction scrollHandlerForTOC(positionY) {\n if (tocScroll === null) {\n return;\n }\n\n // top of page.\n if (positionY == 0) {\n tocScroll.scrollTo(0, 0);\n } else if (\n // bottom of page.\n Math.ceil(positionY) >=\n Math.floor(document.documentElement.scrollHeight - window.innerHeight)\n ) {\n tocScroll.scrollTo(0, tocScroll.scrollHeight);\n } else {\n // somewhere in the middle.\n const current = document.querySelector(\".scroll-current\");\n if (current == null) {\n return;\n }\n\n // https://github.com/pypa/pip/issues/9159 This breaks scroll behaviours.\n // // scroll the currently \"active\" heading in toc, into view.\n // const rect = current.getBoundingClientRect();\n // if (0 > rect.top) {\n // current.scrollIntoView(true); // the argument is \"alignTop\"\n // } else if (rect.bottom > window.innerHeight) {\n // current.scrollIntoView(false);\n // }\n }\n}\n\nfunction scrollHandler(positionY) {\n scrollHandlerForHeader();\n scrollHandlerForBackToTop(positionY);\n scrollHandlerForTOC(positionY);\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Theme Toggle\n////////////////////////////////////////////////////////////////////////////////\nfunction setTheme(mode) {\n if (mode !== \"light\" && mode !== \"dark\" && mode !== \"auto\") {\n console.error(`Got invalid theme mode: ${mode}. Resetting to auto.`);\n mode = \"auto\";\n }\n\n document.body.dataset.theme = mode;\n localStorage.setItem(\"theme\", mode);\n console.log(`Changed to ${mode} mode.`);\n}\n\nfunction cycleThemeOnce() {\n const currentTheme = localStorage.getItem(\"theme\") || \"auto\";\n const prefersDark = window.matchMedia(\"(prefers-color-scheme: dark)\").matches;\n\n if (prefersDark) {\n // Auto (dark) -> Light -> Dark\n if (currentTheme === \"auto\") {\n setTheme(\"light\");\n } else if (currentTheme == \"light\") {\n setTheme(\"dark\");\n } else {\n setTheme(\"auto\");\n }\n } else {\n // Auto (light) -> Dark -> Light\n if (currentTheme === \"auto\") {\n setTheme(\"dark\");\n } else if (currentTheme == \"dark\") {\n setTheme(\"light\");\n } else {\n setTheme(\"auto\");\n }\n }\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Setup\n////////////////////////////////////////////////////////////////////////////////\nfunction setupScrollHandler() {\n // Taken from https://developer.mozilla.org/en-US/docs/Web/API/Document/scroll_event\n let last_known_scroll_position = 0;\n let ticking = false;\n\n window.addEventListener(\"scroll\", function (e) {\n last_known_scroll_position = window.scrollY;\n\n if (!ticking) {\n window.requestAnimationFrame(function () {\n scrollHandler(last_known_scroll_position);\n ticking = false;\n });\n\n ticking = true;\n }\n });\n window.scroll();\n}\n\nfunction setupScrollSpy() {\n if (tocScroll === null) {\n return;\n }\n\n // Scrollspy -- highlight table on contents, based on scroll\n new Gumshoe(\".toc-tree a\", {\n reflow: true,\n recursive: true,\n navClass: \"scroll-current\",\n offset: () => {\n let rem = parseFloat(getComputedStyle(document.documentElement).fontSize);\n return header.getBoundingClientRect().height + 0.5 * rem + 1;\n },\n });\n}\n\nfunction setupTheme() {\n // Attach event handlers for toggling themes\n const buttons = document.getElementsByClassName(\"theme-toggle\");\n Array.from(buttons).forEach((btn) => {\n btn.addEventListener(\"click\", cycleThemeOnce);\n });\n}\n\nfunction setup() {\n setupTheme();\n setupScrollHandler();\n setupScrollSpy();\n}\n\n////////////////////////////////////////////////////////////////////////////////\n// Main entrypoint\n////////////////////////////////////////////////////////////////////////////////\nfunction main() {\n document.body.parentNode.classList.remove(\"no-js\");\n\n header = document.querySelector(\"header\");\n tocScroll = document.querySelector(\".toc-scroll\");\n\n setup();\n}\n\ndocument.addEventListener(\"DOMContentLoaded\", main);\n"],"names":["root","g","window","this","defaults","navClass","contentClass","nested","nestedClass","offset","reflow","events","emitEvent","type","elem","detail","settings","event","CustomEvent","bubbles","cancelable","dispatchEvent","getOffsetTop","location","offsetParent","offsetTop","sortContents","contents","sort","item1","item2","content","isInView","bottom","bounds","getBoundingClientRect","parseFloat","getOffset","parseInt","innerHeight","document","documentElement","clientHeight","top","isAtBottom","Math","ceil","pageYOffset","max","body","scrollHeight","offsetHeight","getActive","last","length","item","useLastItem","i","deactivateNested","nav","parentNode","li","closest","classList","remove","deactivate","items","link","activateNested","add","selector","options","navItems","current","timeout","publicAPIs","querySelectorAll","Array","prototype","forEach","call","getElementById","decodeURIComponent","hash","substr","push","active","activate","scrollHandler","cancelAnimationFrame","requestAnimationFrame","detect","resizeHandler","destroy","removeEventListener","merged","arguments","obj","key","hasOwnProperty","extend","setup","addEventListener","factory","__webpack_module_cache__","__webpack_require__","moduleId","cachedModule","undefined","exports","module","__webpack_modules__","n","getter","__esModule","d","a","definition","o","Object","defineProperty","enumerable","get","globalThis","Function","e","prop","tocScroll","header","lastScrollTop","scrollTop","GO_TO_TOP_OFFSET","cycleThemeOnce","currentTheme","localStorage","getItem","mode","matchMedia","matches","console","error","dataset","theme","setItem","log","buttons","getElementsByClassName","from","btn","setupTheme","last_known_scroll_position","ticking","scrollY","positionY","floor","scrollHandlerForBackToTop","scrollTo","querySelector","scrollHandlerForTOC","scroll","setupScrollHandler","recursive","rem","getComputedStyle","fontSize","height"],"sourceRoot":""} \ No newline at end of file diff --git a/docs/_build/html/_static/searchtools.js b/docs/_build/html/_static/searchtools.js new file mode 100644 index 0000000..7918c3f --- /dev/null +++ b/docs/_build/html/_static/searchtools.js @@ -0,0 +1,574 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + /** + * execute search (requires search index to be loaded) + */ + query: (query) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + results.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id] of foundEntries) { + let score = Math.round(100 * queryLower.length / entry.length) + results.push([ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // lookup as object + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); + + // now sort the results by score (in opposite order of appearance, since the + // display function below uses pop() to retrieve items) and then + // alphabetically + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; + }); + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords) => { + const text = Search.htmlToText(htmlText); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/docs/_build/html/_static/skeleton.css b/docs/_build/html/_static/skeleton.css new file mode 100644 index 0000000..467c878 --- /dev/null +++ b/docs/_build/html/_static/skeleton.css @@ -0,0 +1,296 @@ +/* Some sane resets. */ +html { + height: 100%; +} + +body { + margin: 0; + min-height: 100%; +} + +/* All the flexbox magic! */ +body, +.sb-announcement, +.sb-content, +.sb-main, +.sb-container, +.sb-container__inner, +.sb-article-container, +.sb-footer-content, +.sb-header, +.sb-header-secondary, +.sb-footer { + display: flex; +} + +/* These order things vertically */ +body, +.sb-main, +.sb-article-container { + flex-direction: column; +} + +/* Put elements in the center */ +.sb-header, +.sb-header-secondary, +.sb-container, +.sb-content, +.sb-footer, +.sb-footer-content { + justify-content: center; +} +/* Put elements at the ends */ +.sb-article-container { + justify-content: space-between; +} + +/* These elements grow. */ +.sb-main, +.sb-content, +.sb-container, +article { + flex-grow: 1; +} + +/* Because padding making this wider is not fun */ +article { + box-sizing: border-box; +} + +/* The announcements element should never be wider than the page. */ +.sb-announcement { + max-width: 100%; +} + +.sb-sidebar-primary, +.sb-sidebar-secondary { + flex-shrink: 0; + width: 17rem; +} + +.sb-announcement__inner { + justify-content: center; + + box-sizing: border-box; + height: 3rem; + + overflow-x: auto; + white-space: nowrap; +} + +/* Sidebars, with checkbox-based toggle */ +.sb-sidebar-primary, +.sb-sidebar-secondary { + position: fixed; + height: 100%; + top: 0; +} + +.sb-sidebar-primary { + left: -17rem; + transition: left 250ms ease-in-out; +} +.sb-sidebar-secondary { + right: -17rem; + transition: right 250ms ease-in-out; +} + +.sb-sidebar-toggle { + display: none; +} +.sb-sidebar-overlay { + position: fixed; + top: 0; + width: 0; + height: 0; + + transition: width 0ms ease 250ms, height 0ms ease 250ms, opacity 250ms ease; + + opacity: 0; + background-color: rgba(0, 0, 0, 0.54); +} + +#sb-sidebar-toggle--primary:checked + ~ .sb-sidebar-overlay[for="sb-sidebar-toggle--primary"], +#sb-sidebar-toggle--secondary:checked + ~ .sb-sidebar-overlay[for="sb-sidebar-toggle--secondary"] { + width: 100%; + height: 100%; + opacity: 1; + transition: width 0ms ease, height 0ms ease, opacity 250ms ease; +} + +#sb-sidebar-toggle--primary:checked ~ .sb-container .sb-sidebar-primary { + left: 0; +} +#sb-sidebar-toggle--secondary:checked ~ .sb-container .sb-sidebar-secondary { + right: 0; +} + +/* Full-width mode */ +.drop-secondary-sidebar-for-full-width-content + .hide-when-secondary-sidebar-shown { + display: none !important; +} +.drop-secondary-sidebar-for-full-width-content .sb-sidebar-secondary { + display: none !important; +} + +/* Mobile views */ +.sb-page-width { + width: 100%; +} + +.sb-article-container, +.sb-footer-content__inner, +.drop-secondary-sidebar-for-full-width-content .sb-article, +.drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 100vw; +} + +.sb-article, +.match-content-width { + padding: 0 1rem; + box-sizing: border-box; +} + +@media (min-width: 32rem) { + .sb-article, + .match-content-width { + padding: 0 2rem; + } +} + +/* Tablet views */ +@media (min-width: 42rem) { + .sb-article-container { + width: auto; + } + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 42rem; + } + .sb-article, + .match-content-width { + width: 42rem; + } +} +@media (min-width: 46rem) { + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 46rem; + } + .sb-article, + .match-content-width { + width: 46rem; + } +} +@media (min-width: 50rem) { + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 50rem; + } + .sb-article, + .match-content-width { + width: 50rem; + } +} + +/* Tablet views */ +@media (min-width: 59rem) { + .sb-sidebar-secondary { + position: static; + } + .hide-when-secondary-sidebar-shown { + display: none !important; + } + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 59rem; + } + .sb-article, + .match-content-width { + width: 42rem; + } +} +@media (min-width: 63rem) { + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 63rem; + } + .sb-article, + .match-content-width { + width: 46rem; + } +} +@media (min-width: 67rem) { + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 67rem; + } + .sb-article, + .match-content-width { + width: 50rem; + } +} + +/* Desktop views */ +@media (min-width: 76rem) { + .sb-sidebar-primary { + position: static; + } + .hide-when-primary-sidebar-shown { + display: none !important; + } + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 59rem; + } + .sb-article, + .match-content-width { + width: 42rem; + } +} + +/* Full desktop views */ +@media (min-width: 80rem) { + .sb-article, + .match-content-width { + width: 46rem; + } + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 63rem; + } +} + +@media (min-width: 84rem) { + .sb-article, + .match-content-width { + width: 50rem; + } + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 67rem; + } +} + +@media (min-width: 88rem) { + .sb-footer-content__inner, + .drop-secondary-sidebar-for-full-width-content .sb-article, + .drop-secondary-sidebar-for-full-width-content .match-content-width { + width: 67rem; + } + .sb-page-width { + width: 88rem; + } +} diff --git a/docs/_build/html/_static/sphinx_highlight.js b/docs/_build/html/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/docs/_build/html/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/docs/_build/html/_static/styles/furo-extensions.css b/docs/_build/html/_static/styles/furo-extensions.css new file mode 100644 index 0000000..bc447f2 --- /dev/null +++ b/docs/_build/html/_static/styles/furo-extensions.css @@ -0,0 +1,2 @@ +#furo-sidebar-ad-placement{padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)}#furo-sidebar-ad-placement .ethical-sidebar{background:var(--color-background-secondary);border:none;box-shadow:none}#furo-sidebar-ad-placement .ethical-sidebar:hover{background:var(--color-background-hover)}#furo-sidebar-ad-placement .ethical-sidebar a{color:var(--color-foreground-primary)}#furo-sidebar-ad-placement .ethical-callout a{color:var(--color-foreground-secondary)!important}#furo-readthedocs-versions{background:transparent;display:block;position:static;width:100%}#furo-readthedocs-versions .rst-versions{background:#1a1c1e}#furo-readthedocs-versions .rst-current-version{background:var(--color-sidebar-item-background);cursor:unset}#furo-readthedocs-versions .rst-current-version:hover{background:var(--color-sidebar-item-background)}#furo-readthedocs-versions .rst-current-version .fa-book{color:var(--color-foreground-primary)}#furo-readthedocs-versions>.rst-other-versions{padding:0}#furo-readthedocs-versions>.rst-other-versions small{opacity:1}#furo-readthedocs-versions .injected .rst-versions{position:unset}#furo-readthedocs-versions:focus-within,#furo-readthedocs-versions:hover{box-shadow:0 0 0 1px var(--color-sidebar-background-border)}#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:hover .rst-current-version{background:#1a1c1e;font-size:inherit;height:auto;line-height:inherit;padding:12px;text-align:right}#furo-readthedocs-versions:focus-within .rst-current-version .fa-book,#furo-readthedocs-versions:hover .rst-current-version .fa-book{color:#fff;float:left}#furo-readthedocs-versions:focus-within .fa-caret-down,#furo-readthedocs-versions:hover .fa-caret-down{display:none}#furo-readthedocs-versions:focus-within .injected,#furo-readthedocs-versions:focus-within .rst-current-version,#furo-readthedocs-versions:focus-within .rst-other-versions,#furo-readthedocs-versions:hover .injected,#furo-readthedocs-versions:hover .rst-current-version,#furo-readthedocs-versions:hover .rst-other-versions{display:block}#furo-readthedocs-versions:focus-within>.rst-current-version,#furo-readthedocs-versions:hover>.rst-current-version{display:none}.highlight:hover button.copybtn{color:var(--color-code-foreground)}.highlight button.copybtn{align-items:center;background-color:var(--color-code-background);border:none;color:var(--color-background-item);cursor:pointer;height:1.25em;opacity:1;right:.5rem;top:.625rem;transition:color .3s,opacity .3s;width:1.25em}.highlight button.copybtn:hover{background-color:var(--color-code-background);color:var(--color-brand-content)}.highlight button.copybtn:after{background-color:transparent;color:var(--color-code-foreground);display:none}.highlight button.copybtn.success{color:#22863a;transition:color 0ms}.highlight button.copybtn.success:after{display:block}.highlight button.copybtn svg{padding:0}body{--sd-color-primary:var(--color-brand-primary);--sd-color-primary-highlight:var(--color-brand-content);--sd-color-primary-text:var(--color-background-primary);--sd-color-shadow:rgba(0,0,0,.05);--sd-color-card-border:var(--color-card-border);--sd-color-card-border-hover:var(--color-brand-content);--sd-color-card-background:var(--color-card-background);--sd-color-card-text:var(--color-foreground-primary);--sd-color-card-header:var(--color-card-marginals-background);--sd-color-card-footer:var(--color-card-marginals-background);--sd-color-tabs-label-active:var(--color-brand-content);--sd-color-tabs-label-hover:var(--color-foreground-muted);--sd-color-tabs-label-inactive:var(--color-foreground-muted);--sd-color-tabs-underline-active:var(--color-brand-content);--sd-color-tabs-underline-hover:var(--color-foreground-border);--sd-color-tabs-underline-inactive:var(--color-background-border);--sd-color-tabs-overline:var(--color-background-border);--sd-color-tabs-underline:var(--color-background-border)}.sd-tab-content{box-shadow:0 -2px var(--sd-color-tabs-overline),0 1px var(--sd-color-tabs-underline)}.sd-card{box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)}.sd-shadow-sm{box-shadow:0 .1rem .25rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-shadow-md{box-shadow:0 .3rem .75rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-shadow-lg{box-shadow:0 .6rem 1.5rem var(--sd-color-shadow),0 0 .0625rem rgba(0,0,0,.1)!important}.sd-card-hover:hover{transform:none}.sd-cards-carousel{gap:.25rem;padding:.25rem}body{--tabs--label-text:var(--color-foreground-muted);--tabs--label-text--hover:var(--color-foreground-muted);--tabs--label-text--active:var(--color-brand-content);--tabs--label-text--active--hover:var(--color-brand-content);--tabs--label-background:transparent;--tabs--label-background--hover:transparent;--tabs--label-background--active:transparent;--tabs--label-background--active--hover:transparent;--tabs--padding-x:0.25em;--tabs--margin-x:1em;--tabs--border:var(--color-background-border);--tabs--label-border:transparent;--tabs--label-border--hover:var(--color-foreground-muted);--tabs--label-border--active:var(--color-brand-content);--tabs--label-border--active--hover:var(--color-brand-content)}[role=main] .container{max-width:none;padding-left:0;padding-right:0}.shadow.docutils{border:none;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)!important}.sphinx-bs .card{background-color:var(--color-background-secondary);color:var(--color-foreground)} +/*# sourceMappingURL=furo-extensions.css.map*/ \ No newline at end of file diff --git a/docs/_build/html/_static/styles/furo-extensions.css.map b/docs/_build/html/_static/styles/furo-extensions.css.map new file mode 100644 index 0000000..9ba5637 --- /dev/null +++ b/docs/_build/html/_static/styles/furo-extensions.css.map @@ -0,0 +1 @@ +{"version":3,"file":"styles/furo-extensions.css","mappings":"AAGA,2BACE,oFACA,4CAKE,6CAHA,YACA,eAEA,CACA,kDACE,yCAEF,8CACE,sCAEJ,8CACE,kDAEJ,2BAGE,uBACA,cAHA,gBACA,UAEA,CAGA,yCACE,mBAEF,gDAEE,gDADA,YACA,CACA,sDACE,gDACF,yDACE,sCAEJ,+CACE,UACA,qDACE,UAGF,mDACE,eAEJ,yEAEE,4DAEA,mHASE,mBAPA,kBAEA,YADA,oBAGA,aADA,gBAIA,CAEA,qIAEE,WADA,UACA,CAEJ,uGACE,aAEF,iUAGE,cAEF,mHACE,aC1EJ,gCACE,mCAEF,0BAKE,mBAUA,8CACA,YAFA,mCAKA,eAZA,cALA,UASA,YADA,YAYA,iCAdA,YAcA,CAEA,gCAEE,8CADA,gCACA,CAEF,gCAGE,6BADA,mCADA,YAEA,CAEF,kCAEE,cADA,oBACA,CACA,wCACE,cAEJ,8BACE,UC5CN,KAEE,6CAA8C,CAC9C,uDAAwD,CACxD,uDAAwD,CAGxD,iCAAsC,CAGtC,+CAAgD,CAChD,uDAAwD,CACxD,uDAAwD,CACxD,oDAAqD,CACrD,6DAA8D,CAC9D,6DAA8D,CAG9D,uDAAwD,CACxD,yDAA0D,CAC1D,4DAA6D,CAC7D,2DAA4D,CAC5D,8DAA+D,CAC/D,iEAAkE,CAClE,uDAAwD,CACxD,wDAAyD,CAG3D,gBACE,qFAGF,SACE,6EAEF,cACE,uFAEF,cACE,uFAEF,cACE,uFAGF,qBACE,eAEF,mBACE,WACA,eChDF,KACE,gDAAiD,CACjD,uDAAwD,CACxD,qDAAsD,CACtD,4DAA6D,CAC7D,oCAAqC,CACrC,2CAA4C,CAC5C,4CAA6C,CAC7C,mDAAoD,CACpD,wBAAyB,CACzB,oBAAqB,CACrB,6CAA8C,CAC9C,gCAAiC,CACjC,yDAA0D,CAC1D,uDAAwD,CACxD,8DAA+D,CCbjE,uBACE,eACA,eACA,gBAGF,iBACE,YACA,+EAGF,iBACE,mDACA","sources":["webpack:///./src/furo/assets/styles/extensions/_readthedocs.sass","webpack:///./src/furo/assets/styles/extensions/_copybutton.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-design.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-inline-tabs.sass","webpack:///./src/furo/assets/styles/extensions/_sphinx-panels.sass"],"sourcesContent":["// This file contains the styles used for tweaking how ReadTheDoc's embedded\n// contents would show up inside the theme.\n\n#furo-sidebar-ad-placement\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n .ethical-sidebar\n // Remove the border and box-shadow.\n border: none\n box-shadow: none\n // Manage the background colors.\n background: var(--color-background-secondary)\n &:hover\n background: var(--color-background-hover)\n // Ensure the text is legible.\n a\n color: var(--color-foreground-primary)\n\n .ethical-callout a\n color: var(--color-foreground-secondary) !important\n\n#furo-readthedocs-versions\n position: static\n width: 100%\n background: transparent\n display: block\n\n // Make the background color fit with the theme's aesthetic.\n .rst-versions\n background: rgb(26, 28, 30)\n\n .rst-current-version\n cursor: unset\n background: var(--color-sidebar-item-background)\n &:hover\n background: var(--color-sidebar-item-background)\n .fa-book\n color: var(--color-foreground-primary)\n\n > .rst-other-versions\n padding: 0\n small\n opacity: 1\n\n .injected\n .rst-versions\n position: unset\n\n &:hover,\n &:focus-within\n box-shadow: 0 0 0 1px var(--color-sidebar-background-border)\n\n .rst-current-version\n // Undo the tweaks done in RTD's CSS\n font-size: inherit\n line-height: inherit\n height: auto\n text-align: right\n padding: 12px\n\n // Match the rest of the body\n background: #1a1c1e\n\n .fa-book\n float: left\n color: white\n\n .fa-caret-down\n display: none\n\n .rst-current-version,\n .rst-other-versions,\n .injected\n display: block\n\n > .rst-current-version\n display: none\n",".highlight\n &:hover button.copybtn\n color: var(--color-code-foreground)\n\n button.copybtn\n // Make it visible\n opacity: 1\n\n // Align things correctly\n align-items: center\n\n height: 1.25em\n width: 1.25em\n\n top: 0.625rem // $code-spacing-vertical\n right: 0.5rem\n\n // Make it look better\n color: var(--color-background-item)\n background-color: var(--color-code-background)\n border: none\n\n // Change to cursor to make it obvious that you can click on it\n cursor: pointer\n\n // Transition smoothly, for aesthetics\n transition: color 300ms, opacity 300ms\n\n &:hover\n color: var(--color-brand-content)\n background-color: var(--color-code-background)\n\n &::after\n display: none\n color: var(--color-code-foreground)\n background-color: transparent\n\n &.success\n transition: color 0ms\n color: #22863a\n &::after\n display: block\n\n svg\n padding: 0\n","body\n // Colors\n --sd-color-primary: var(--color-brand-primary)\n --sd-color-primary-highlight: var(--color-brand-content)\n --sd-color-primary-text: var(--color-background-primary)\n\n // Shadows\n --sd-color-shadow: rgba(0, 0, 0, 0.05)\n\n // Cards\n --sd-color-card-border: var(--color-card-border)\n --sd-color-card-border-hover: var(--color-brand-content)\n --sd-color-card-background: var(--color-card-background)\n --sd-color-card-text: var(--color-foreground-primary)\n --sd-color-card-header: var(--color-card-marginals-background)\n --sd-color-card-footer: var(--color-card-marginals-background)\n\n // Tabs\n --sd-color-tabs-label-active: var(--color-brand-content)\n --sd-color-tabs-label-hover: var(--color-foreground-muted)\n --sd-color-tabs-label-inactive: var(--color-foreground-muted)\n --sd-color-tabs-underline-active: var(--color-brand-content)\n --sd-color-tabs-underline-hover: var(--color-foreground-border)\n --sd-color-tabs-underline-inactive: var(--color-background-border)\n --sd-color-tabs-overline: var(--color-background-border)\n --sd-color-tabs-underline: var(--color-background-border)\n\n// Tabs\n.sd-tab-content\n box-shadow: 0 -2px var(--sd-color-tabs-overline), 0 1px var(--sd-color-tabs-underline)\n\n// Shadows\n.sd-card // Have a shadow by default\n box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n.sd-shadow-sm\n box-shadow: 0 0.1rem 0.25rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n.sd-shadow-md\n box-shadow: 0 0.3rem 0.75rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n.sd-shadow-lg\n box-shadow: 0 0.6rem 1.5rem var(--sd-color-shadow), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n// Cards\n.sd-card-hover:hover // Don't change scale on hover\n transform: none\n\n.sd-cards-carousel // Have a bit of gap in the carousel by default\n gap: 0.25rem\n padding: 0.25rem\n","// This file contains styles to tweak sphinx-inline-tabs to work well with Furo.\n\nbody\n --tabs--label-text: var(--color-foreground-muted)\n --tabs--label-text--hover: var(--color-foreground-muted)\n --tabs--label-text--active: var(--color-brand-content)\n --tabs--label-text--active--hover: var(--color-brand-content)\n --tabs--label-background: transparent\n --tabs--label-background--hover: transparent\n --tabs--label-background--active: transparent\n --tabs--label-background--active--hover: transparent\n --tabs--padding-x: 0.25em\n --tabs--margin-x: 1em\n --tabs--border: var(--color-background-border)\n --tabs--label-border: transparent\n --tabs--label-border--hover: var(--color-foreground-muted)\n --tabs--label-border--active: var(--color-brand-content)\n --tabs--label-border--active--hover: var(--color-brand-content)\n","// This file contains styles to tweak sphinx-panels to work well with Furo.\n\n// sphinx-panels includes Bootstrap 4, which uses .container which can conflict\n// with docutils' `.. container::` directive.\n[role=\"main\"] .container\n max-width: initial\n padding-left: initial\n padding-right: initial\n\n// Make the panels look nicer!\n.shadow.docutils\n border: none\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1) !important\n\n// Make panel colors respond to dark mode\n.sphinx-bs .card\n background-color: var(--color-background-secondary)\n color: var(--color-foreground)\n"],"names":[],"sourceRoot":""} \ No newline at end of file diff --git a/docs/_build/html/_static/styles/furo.css b/docs/_build/html/_static/styles/furo.css new file mode 100644 index 0000000..3d29a21 --- /dev/null +++ b/docs/_build/html/_static/styles/furo.css @@ -0,0 +1,2 @@ +/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */html{-webkit-text-size-adjust:100%;line-height:1.15}body{margin:0}main{display:block}h1{font-size:2em;margin:.67em 0}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace,monospace;font-size:1em}a{background-color:transparent}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:.35em .75em .625em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{vertical-align:baseline}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details{display:block}summary{display:list-item}[hidden],template{display:none}@media print{.content-icon-container,.headerlink,.mobile-header,.related-pages{display:none!important}.highlight{border:.1pt solid var(--color-foreground-border)}a,blockquote,dl,ol,pre,table,ul{page-break-inside:avoid}caption,figure,h1,h2,h3,h4,h5,h6,img{page-break-after:avoid;page-break-inside:avoid}dl,ol,ul{page-break-before:avoid}}.visually-hidden{clip:rect(0,0,0,0)!important;border:0!important;height:1px!important;margin:-1px!important;overflow:hidden!important;padding:0!important;position:absolute!important;white-space:nowrap!important;width:1px!important}:-moz-focusring{outline:auto}body{--font-stack:-apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji;--font-stack--monospace:"SFMono-Regular",Menlo,Consolas,Monaco,Liberation Mono,Lucida Console,monospace;--font-size--normal:100%;--font-size--small:87.5%;--font-size--small--2:81.25%;--font-size--small--3:75%;--font-size--small--4:62.5%;--sidebar-caption-font-size:var(--font-size--small--2);--sidebar-item-font-size:var(--font-size--small);--sidebar-search-input-font-size:var(--font-size--small);--toc-font-size:var(--font-size--small--3);--toc-font-size--mobile:var(--font-size--normal);--toc-title-font-size:var(--font-size--small--4);--admonition-font-size:0.8125rem;--admonition-title-font-size:0.8125rem;--code-font-size:var(--font-size--small--2);--api-font-size:var(--font-size--small);--header-height:calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*4);--header-padding:0.5rem;--sidebar-tree-space-above:1.5rem;--sidebar-caption-space-above:1rem;--sidebar-item-line-height:1rem;--sidebar-item-spacing-vertical:0.5rem;--sidebar-item-spacing-horizontal:1rem;--sidebar-item-height:calc(var(--sidebar-item-line-height) + var(--sidebar-item-spacing-vertical)*2);--sidebar-expander-width:var(--sidebar-item-height);--sidebar-search-space-above:0.5rem;--sidebar-search-input-spacing-vertical:0.5rem;--sidebar-search-input-spacing-horizontal:0.5rem;--sidebar-search-input-height:1rem;--sidebar-search-icon-size:var(--sidebar-search-input-height);--toc-title-padding:0.25rem 0;--toc-spacing-vertical:1.5rem;--toc-spacing-horizontal:1.5rem;--toc-item-spacing-vertical:0.4rem;--toc-item-spacing-horizontal:1rem;--icon-search:url('data:image/svg+xml;charset=utf-8,');--icon-pencil:url('data:image/svg+xml;charset=utf-8,');--icon-abstract:url('data:image/svg+xml;charset=utf-8,');--icon-info:url('data:image/svg+xml;charset=utf-8,');--icon-flame:url('data:image/svg+xml;charset=utf-8,');--icon-question:url('data:image/svg+xml;charset=utf-8,');--icon-warning:url('data:image/svg+xml;charset=utf-8,');--icon-failure:url('data:image/svg+xml;charset=utf-8,');--icon-spark:url('data:image/svg+xml;charset=utf-8,');--color-admonition-title--caution:#ff9100;--color-admonition-title-background--caution:rgba(255,145,0,.2);--color-admonition-title--warning:#ff9100;--color-admonition-title-background--warning:rgba(255,145,0,.2);--color-admonition-title--danger:#ff5252;--color-admonition-title-background--danger:rgba(255,82,82,.2);--color-admonition-title--attention:#ff5252;--color-admonition-title-background--attention:rgba(255,82,82,.2);--color-admonition-title--error:#ff5252;--color-admonition-title-background--error:rgba(255,82,82,.2);--color-admonition-title--hint:#00c852;--color-admonition-title-background--hint:rgba(0,200,82,.2);--color-admonition-title--tip:#00c852;--color-admonition-title-background--tip:rgba(0,200,82,.2);--color-admonition-title--important:#00bfa5;--color-admonition-title-background--important:rgba(0,191,165,.2);--color-admonition-title--note:#00b0ff;--color-admonition-title-background--note:rgba(0,176,255,.2);--color-admonition-title--seealso:#448aff;--color-admonition-title-background--seealso:rgba(68,138,255,.2);--color-admonition-title--admonition-todo:grey;--color-admonition-title-background--admonition-todo:hsla(0,0%,50%,.2);--color-admonition-title:#651fff;--color-admonition-title-background:rgba(101,31,255,.2);--icon-admonition-default:var(--icon-abstract);--color-topic-title:#14b8a6;--color-topic-title-background:rgba(20,184,166,.2);--icon-topic-default:var(--icon-pencil);--color-problematic:#b30000;--color-foreground-primary:#000;--color-foreground-secondary:#5a5c63;--color-foreground-muted:#646776;--color-foreground-border:#878787;--color-background-primary:#fff;--color-background-secondary:#f8f9fb;--color-background-hover:#efeff4;--color-background-hover--transparent:#efeff400;--color-background-border:#eeebee;--color-background-item:#ccc;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#2962ff;--color-brand-content:#2a5adf;--color-api-background:var(--color-background-hover--transparent);--color-api-background-hover:var(--color-background-hover);--color-api-overall:var(--color-foreground-secondary);--color-api-name:var(--color-problematic);--color-api-pre-name:var(--color-problematic);--color-api-paren:var(--color-foreground-secondary);--color-api-keyword:var(--color-foreground-primary);--color-highlight-on-target:#ffc;--color-inline-code-background:var(--color-background-secondary);--color-highlighted-background:#def;--color-highlighted-text:var(--color-foreground-primary);--color-guilabel-background:#ddeeff80;--color-guilabel-border:#bedaf580;--color-guilabel-text:var(--color-foreground-primary);--color-admonition-background:transparent;--color-table-header-background:var(--color-background-secondary);--color-table-border:var(--color-background-border);--color-card-border:var(--color-background-secondary);--color-card-background:transparent;--color-card-marginals-background:var(--color-background-secondary);--color-header-background:var(--color-background-primary);--color-header-border:var(--color-background-border);--color-header-text:var(--color-foreground-primary);--color-sidebar-background:var(--color-background-secondary);--color-sidebar-background-border:var(--color-background-border);--color-sidebar-brand-text:var(--color-foreground-primary);--color-sidebar-caption-text:var(--color-foreground-muted);--color-sidebar-link-text:var(--color-foreground-secondary);--color-sidebar-link-text--top-level:var(--color-brand-primary);--color-sidebar-item-background:var(--color-sidebar-background);--color-sidebar-item-background--current:var( --color-sidebar-item-background );--color-sidebar-item-background--hover:linear-gradient(90deg,var(--color-background-hover--transparent) 0%,var(--color-background-hover) var(--sidebar-item-spacing-horizontal),var(--color-background-hover) 100%);--color-sidebar-item-expander-background:transparent;--color-sidebar-item-expander-background--hover:var( --color-background-hover );--color-sidebar-search-text:var(--color-foreground-primary);--color-sidebar-search-background:var(--color-background-secondary);--color-sidebar-search-background--focus:var(--color-background-primary);--color-sidebar-search-border:var(--color-background-border);--color-sidebar-search-icon:var(--color-foreground-muted);--color-toc-background:var(--color-background-primary);--color-toc-title-text:var(--color-foreground-muted);--color-toc-item-text:var(--color-foreground-secondary);--color-toc-item-text--hover:var(--color-foreground-primary);--color-toc-item-text--active:var(--color-brand-primary);--color-content-foreground:var(--color-foreground-primary);--color-content-background:transparent;--color-link:var(--color-brand-content);--color-link--hover:var(--color-brand-content);--color-link-underline:var(--color-background-border);--color-link-underline--hover:var(--color-foreground-border)}.only-light{display:block!important}html body .only-dark{display:none!important}@media not print{body[data-theme=dark]{--color-problematic:#ee5151;--color-foreground-primary:#ffffffcc;--color-foreground-secondary:#9ca0a5;--color-foreground-muted:#81868d;--color-foreground-border:#666;--color-background-primary:#131416;--color-background-secondary:#1a1c1e;--color-background-hover:#1e2124;--color-background-hover--transparent:#1e212400;--color-background-border:#303335;--color-background-item:#444;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#2b8cee;--color-brand-content:#368ce2;--color-highlighted-background:#083563;--color-guilabel-background:#08356380;--color-guilabel-border:#13395f80;--color-api-keyword:var(--color-foreground-secondary);--color-highlight-on-target:#330;--color-admonition-background:#18181a;--color-card-border:var(--color-background-secondary);--color-card-background:#18181a;--color-card-marginals-background:var(--color-background-hover)}html body[data-theme=dark] .only-light{display:none!important}body[data-theme=dark] .only-dark{display:block!important}@media(prefers-color-scheme:dark){body:not([data-theme=light]){--color-problematic:#ee5151;--color-foreground-primary:#ffffffcc;--color-foreground-secondary:#9ca0a5;--color-foreground-muted:#81868d;--color-foreground-border:#666;--color-background-primary:#131416;--color-background-secondary:#1a1c1e;--color-background-hover:#1e2124;--color-background-hover--transparent:#1e212400;--color-background-border:#303335;--color-background-item:#444;--color-announcement-background:#000000dd;--color-announcement-text:#eeebee;--color-brand-primary:#2b8cee;--color-brand-content:#368ce2;--color-highlighted-background:#083563;--color-guilabel-background:#08356380;--color-guilabel-border:#13395f80;--color-api-keyword:var(--color-foreground-secondary);--color-highlight-on-target:#330;--color-admonition-background:#18181a;--color-card-border:var(--color-background-secondary);--color-card-background:#18181a;--color-card-marginals-background:var(--color-background-hover)}html body:not([data-theme=light]) .only-light{display:none!important}body:not([data-theme=light]) .only-dark{display:block!important}}}body[data-theme=auto] .theme-toggle svg.theme-icon-when-auto,body[data-theme=dark] .theme-toggle svg.theme-icon-when-dark,body[data-theme=light] .theme-toggle svg.theme-icon-when-light{display:block}body{font-family:var(--font-stack)}code,kbd,pre,samp{font-family:var(--font-stack--monospace)}body{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}article{line-height:1.5}h1,h2,h3,h4,h5,h6{border-radius:.5rem;font-weight:700;line-height:1.25;margin:.5rem -.5rem;padding-left:.5rem;padding-right:.5rem}h1+p,h2+p,h3+p,h4+p,h5+p,h6+p{margin-top:0}h1{font-size:2.5em;margin-bottom:1rem}h1,h2{margin-top:1.75rem}h2{font-size:2em}h3{font-size:1.5em}h4{font-size:1.25em}h5{font-size:1.125em}h6{font-size:1em}small{font-size:80%;opacity:75%}p{margin-bottom:.75rem;margin-top:.5rem}hr.docutils{background-color:var(--color-background-border);border:0;height:1px;margin:2rem 0;padding:0}.centered{text-align:center}a{color:var(--color-link);text-decoration:underline;text-decoration-color:var(--color-link-underline)}a:hover{color:var(--color-link--hover);text-decoration-color:var(--color-link-underline--hover)}a.muted-link{color:inherit}a.muted-link:hover{color:var(--color-link);text-decoration-color:var(--color-link-underline--hover)}html{overflow-x:hidden;overflow-y:scroll;scroll-behavior:smooth}.sidebar-scroll,.toc-scroll,article[role=main] *{scrollbar-color:var(--color-foreground-border) transparent;scrollbar-width:thin}.sidebar-scroll::-webkit-scrollbar,.toc-scroll::-webkit-scrollbar,article[role=main] ::-webkit-scrollbar{height:.25rem;width:.25rem}.sidebar-scroll::-webkit-scrollbar-thumb,.toc-scroll::-webkit-scrollbar-thumb,article[role=main] ::-webkit-scrollbar-thumb{background-color:var(--color-foreground-border);border-radius:.125rem}body,html{background:var(--color-background-primary);color:var(--color-foreground-primary);height:100%}article{background:var(--color-content-background);color:var(--color-content-foreground);overflow-wrap:break-word}.page{display:flex;min-height:100%}.mobile-header{background-color:var(--color-header-background);border-bottom:1px solid var(--color-header-border);color:var(--color-header-text);display:none;height:var(--header-height);width:100%;z-index:10}.mobile-header.scrolled{border-bottom:none;box-shadow:0 0 .2rem rgba(0,0,0,.1),0 .2rem .4rem rgba(0,0,0,.2)}.mobile-header .header-center a{color:var(--color-header-text);text-decoration:none}.main{display:flex;flex:1}.sidebar-drawer{background:var(--color-sidebar-background);border-right:1px solid var(--color-sidebar-background-border);box-sizing:border-box;display:flex;justify-content:flex-end;min-width:15em;width:calc(50% - 26em)}.sidebar-container,.toc-drawer{box-sizing:border-box;width:15em}.toc-drawer{background:var(--color-toc-background);padding-right:1rem}.sidebar-sticky,.toc-sticky{display:flex;flex-direction:column;height:min(100%,100vh);height:100vh;position:sticky;top:0}.sidebar-scroll,.toc-scroll{flex-grow:1;flex-shrink:1;overflow:auto;scroll-behavior:smooth}.content{display:flex;flex-direction:column;justify-content:space-between;padding:0 3em;width:46em}.icon{display:inline-block;height:1rem;width:1rem}.icon svg{height:100%;width:100%}.announcement{align-items:center;background-color:var(--color-announcement-background);color:var(--color-announcement-text);display:flex;height:var(--header-height);overflow-x:auto}.announcement+.page{min-height:calc(100% - var(--header-height))}.announcement-content{box-sizing:border-box;min-width:100%;padding:.5rem;text-align:center;white-space:nowrap}.announcement-content a{color:var(--color-announcement-text);text-decoration-color:var(--color-announcement-text)}.announcement-content a:hover{color:var(--color-announcement-text);text-decoration-color:var(--color-link--hover)}.no-js .theme-toggle-container{display:none}.theme-toggle-container{vertical-align:middle}.theme-toggle{background:transparent;border:none;cursor:pointer;padding:0}.theme-toggle svg{color:var(--color-foreground-primary);display:none;height:1rem;vertical-align:middle;width:1rem}.theme-toggle-header{float:left;padding:1rem .5rem}.nav-overlay-icon,.toc-overlay-icon{cursor:pointer;display:none}.nav-overlay-icon .icon,.toc-overlay-icon .icon{color:var(--color-foreground-secondary);height:1rem;width:1rem}.nav-overlay-icon,.toc-header-icon{align-items:center;justify-content:center}.toc-content-icon{height:1.5rem;width:1.5rem}.content-icon-container{display:flex;float:right;gap:.5rem;margin-bottom:1rem;margin-left:1rem;margin-top:1.5rem}.content-icon-container .edit-this-page svg{color:inherit;height:1rem;width:1rem}.sidebar-toggle{display:none;position:absolute}.sidebar-toggle[name=__toc]{left:20px}.sidebar-toggle:checked{left:40px}.overlay{background-color:rgba(0,0,0,.54);height:0;opacity:0;position:fixed;top:0;transition:width 0ms,height 0ms,opacity .25s ease-out;width:0}.sidebar-overlay{z-index:20}.toc-overlay{z-index:40}.sidebar-drawer{transition:left .25s ease-in-out;z-index:30}.toc-drawer{transition:right .25s ease-in-out;z-index:50}#__navigation:checked~.sidebar-overlay{height:100%;opacity:1;width:100%}#__navigation:checked~.page .sidebar-drawer{left:0;top:0}#__toc:checked~.toc-overlay{height:100%;opacity:1;width:100%}#__toc:checked~.page .toc-drawer{right:0;top:0}.back-to-top{background:var(--color-background-primary);border-radius:1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 1px 0 hsla(220,9%,46%,.502);display:none;font-size:.8125rem;left:0;margin-left:50%;padding:.5rem .75rem .5rem .5rem;position:fixed;text-decoration:none;top:1rem;transform:translateX(-50%);z-index:10}.back-to-top svg{fill:currentColor;display:inline-block;height:1rem;width:1rem}.back-to-top span{margin-left:.25rem}.show-back-to-top .back-to-top{align-items:center;display:flex}@media(min-width:97em){html{font-size:110%}}@media(max-width:82em){.toc-content-icon{display:flex}.toc-drawer{border-left:1px solid var(--color-background-muted);height:100vh;position:fixed;right:-15em;top:0}.toc-tree{border-left:none;font-size:var(--toc-font-size--mobile)}.sidebar-drawer{width:calc(50% - 18.5em)}}@media(max-width:67em){.nav-overlay-icon{display:flex}.sidebar-drawer{height:100vh;left:-15em;position:fixed;top:0;width:15em}.toc-header-icon{display:flex}.theme-toggle-content,.toc-content-icon{display:none}.theme-toggle-header{display:block}.mobile-header{align-items:center;display:flex;justify-content:space-between;position:sticky;top:0}.mobile-header .header-left,.mobile-header .header-right{display:flex;height:var(--header-height);padding:0 var(--header-padding)}.mobile-header .header-left label,.mobile-header .header-right label{height:100%;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:100%}.nav-overlay-icon .icon,.theme-toggle svg{height:1.25rem;width:1.25rem}:target{scroll-margin-top:var(--header-height)}.back-to-top{top:calc(var(--header-height) + .5rem)}.page{flex-direction:column;justify-content:center}.content{margin-left:auto;margin-right:auto}}@media(max-width:52em){.content{overflow-x:auto;width:100%}}@media(max-width:46em){.content{padding:0 1em}article aside.sidebar{float:none;margin:1rem 0;width:100%}}.admonition,.topic{background:var(--color-admonition-background);border-radius:.2rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1);font-size:var(--admonition-font-size);margin:1rem auto;overflow:hidden;padding:0 .5rem .5rem;page-break-inside:avoid}.admonition>:nth-child(2),.topic>:nth-child(2){margin-top:0}.admonition>:last-child,.topic>:last-child{margin-bottom:0}.admonition p.admonition-title,p.topic-title{font-size:var(--admonition-title-font-size);font-weight:500;line-height:1.3;margin:0 -.5rem .5rem;padding:.4rem .5rem .4rem 2rem;position:relative}.admonition p.admonition-title:before,p.topic-title:before{content:"";height:1rem;left:.5rem;position:absolute;width:1rem}p.admonition-title{background-color:var(--color-admonition-title-background)}p.admonition-title:before{background-color:var(--color-admonition-title);-webkit-mask-image:var(--icon-admonition-default);mask-image:var(--icon-admonition-default);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}p.topic-title{background-color:var(--color-topic-title-background)}p.topic-title:before{background-color:var(--color-topic-title);-webkit-mask-image:var(--icon-topic-default);mask-image:var(--icon-topic-default);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.admonition{border-left:.2rem solid var(--color-admonition-title)}.admonition.caution{border-left-color:var(--color-admonition-title--caution)}.admonition.caution>.admonition-title{background-color:var(--color-admonition-title-background--caution)}.admonition.caution>.admonition-title:before{background-color:var(--color-admonition-title--caution);-webkit-mask-image:var(--icon-spark);mask-image:var(--icon-spark)}.admonition.warning{border-left-color:var(--color-admonition-title--warning)}.admonition.warning>.admonition-title{background-color:var(--color-admonition-title-background--warning)}.admonition.warning>.admonition-title:before{background-color:var(--color-admonition-title--warning);-webkit-mask-image:var(--icon-warning);mask-image:var(--icon-warning)}.admonition.danger{border-left-color:var(--color-admonition-title--danger)}.admonition.danger>.admonition-title{background-color:var(--color-admonition-title-background--danger)}.admonition.danger>.admonition-title:before{background-color:var(--color-admonition-title--danger);-webkit-mask-image:var(--icon-spark);mask-image:var(--icon-spark)}.admonition.attention{border-left-color:var(--color-admonition-title--attention)}.admonition.attention>.admonition-title{background-color:var(--color-admonition-title-background--attention)}.admonition.attention>.admonition-title:before{background-color:var(--color-admonition-title--attention);-webkit-mask-image:var(--icon-warning);mask-image:var(--icon-warning)}.admonition.error{border-left-color:var(--color-admonition-title--error)}.admonition.error>.admonition-title{background-color:var(--color-admonition-title-background--error)}.admonition.error>.admonition-title:before{background-color:var(--color-admonition-title--error);-webkit-mask-image:var(--icon-failure);mask-image:var(--icon-failure)}.admonition.hint{border-left-color:var(--color-admonition-title--hint)}.admonition.hint>.admonition-title{background-color:var(--color-admonition-title-background--hint)}.admonition.hint>.admonition-title:before{background-color:var(--color-admonition-title--hint);-webkit-mask-image:var(--icon-question);mask-image:var(--icon-question)}.admonition.tip{border-left-color:var(--color-admonition-title--tip)}.admonition.tip>.admonition-title{background-color:var(--color-admonition-title-background--tip)}.admonition.tip>.admonition-title:before{background-color:var(--color-admonition-title--tip);-webkit-mask-image:var(--icon-info);mask-image:var(--icon-info)}.admonition.important{border-left-color:var(--color-admonition-title--important)}.admonition.important>.admonition-title{background-color:var(--color-admonition-title-background--important)}.admonition.important>.admonition-title:before{background-color:var(--color-admonition-title--important);-webkit-mask-image:var(--icon-flame);mask-image:var(--icon-flame)}.admonition.note{border-left-color:var(--color-admonition-title--note)}.admonition.note>.admonition-title{background-color:var(--color-admonition-title-background--note)}.admonition.note>.admonition-title:before{background-color:var(--color-admonition-title--note);-webkit-mask-image:var(--icon-pencil);mask-image:var(--icon-pencil)}.admonition.seealso{border-left-color:var(--color-admonition-title--seealso)}.admonition.seealso>.admonition-title{background-color:var(--color-admonition-title-background--seealso)}.admonition.seealso>.admonition-title:before{background-color:var(--color-admonition-title--seealso);-webkit-mask-image:var(--icon-info);mask-image:var(--icon-info)}.admonition.admonition-todo{border-left-color:var(--color-admonition-title--admonition-todo)}.admonition.admonition-todo>.admonition-title{background-color:var(--color-admonition-title-background--admonition-todo)}.admonition.admonition-todo>.admonition-title:before{background-color:var(--color-admonition-title--admonition-todo);-webkit-mask-image:var(--icon-pencil);mask-image:var(--icon-pencil)}.admonition-todo>.admonition-title{text-transform:uppercase}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd{margin-left:2rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd>:first-child{margin-top:.125rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list,dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dd>:last-child{margin-bottom:.75rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list>dt{font-size:var(--font-size--small);text-transform:uppercase}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd:empty{margin-bottom:.5rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul{margin-left:-1.2rem}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul>li>p:nth-child(2){margin-top:0}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .field-list dd>ul>li>p+p:last-child:empty{margin-bottom:0;margin-top:0}dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{color:var(--color-api-overall)}.sig:not(.sig-inline){background:var(--color-api-background);border-radius:.25rem;font-family:var(--font-stack--monospace);font-size:var(--api-font-size);font-weight:700;margin-left:-.25rem;margin-right:-.25rem;padding:.25rem .5rem .25rem 3em;text-indent:-2.5em;transition:background .1s ease-out}.sig:not(.sig-inline):hover{background:var(--color-api-background-hover)}.sig:not(.sig-inline) a.reference .viewcode-link{font-weight:400;width:3.5rem}em.property{font-style:normal}em.property:first-child{color:var(--color-api-keyword)}.sig-name{color:var(--color-api-name)}.sig-prename{color:var(--color-api-pre-name);font-weight:400}.sig-paren{color:var(--color-api-paren)}.sig-param{font-style:normal}.versionmodified{font-style:italic}div.deprecated p,div.versionadded p,div.versionchanged p{margin-bottom:.125rem;margin-top:.125rem}.viewcode-back,.viewcode-link{float:right;text-align:right}.line-block{margin-bottom:.75rem;margin-top:.5rem}.line-block .line-block{margin-bottom:0;margin-top:0;padding-left:1rem}.code-block-caption,article p.caption,table>caption{font-size:var(--font-size--small);text-align:center}.toctree-wrapper.compound .caption,.toctree-wrapper.compound :not(.caption)>.caption-text{font-size:var(--font-size--small);margin-bottom:0;text-align:initial;text-transform:uppercase}.toctree-wrapper.compound>ul{margin-bottom:0;margin-top:0}.sig-inline,code.literal{background:var(--color-inline-code-background);border-radius:.2em;font-size:var(--font-size--small--2);padding:.1em .2em}pre.literal-block .sig-inline,pre.literal-block code.literal{font-size:inherit;padding:0}p .sig-inline,p code.literal{border:1px solid var(--color-background-border)}.sig-inline{font-family:var(--font-stack--monospace)}div[class*=" highlight-"],div[class^=highlight-]{display:flex;margin:1em 0}div[class*=" highlight-"] .table-wrapper,div[class^=highlight-] .table-wrapper,pre{margin:0;padding:0}pre{overflow:auto}article[role=main] .highlight pre{line-height:1.5}.highlight pre,pre.literal-block{font-size:var(--code-font-size);padding:.625rem .875rem}pre.literal-block{background-color:var(--color-code-background);border-radius:.2rem;color:var(--color-code-foreground);margin-bottom:1rem;margin-top:1rem}.highlight{border-radius:.2rem;width:100%}.highlight .gp,.highlight span.linenos{pointer-events:none;-webkit-user-select:none;-moz-user-select:none;user-select:none}.highlight .hll{display:block;margin-left:-.875rem;margin-right:-.875rem;padding-left:.875rem;padding-right:.875rem}.code-block-caption{background-color:var(--color-code-background);border-bottom:1px solid;border-radius:.25rem;border-bottom-left-radius:0;border-bottom-right-radius:0;border-color:var(--color-background-border);color:var(--color-code-foreground);display:flex;font-weight:300;padding:.625rem .875rem}.code-block-caption+div[class]{margin-top:0}.code-block-caption+div[class] pre{border-top-left-radius:0;border-top-right-radius:0}.highlighttable{display:block;width:100%}.highlighttable tbody{display:block}.highlighttable tr{display:flex}.highlighttable td.linenos{background-color:var(--color-code-background);border-bottom-left-radius:.2rem;border-top-left-radius:.2rem;color:var(--color-code-foreground);padding:.625rem 0 .625rem .875rem}.highlighttable .linenodiv{box-shadow:-.0625rem 0 var(--color-foreground-border) inset;font-size:var(--code-font-size);padding-right:.875rem}.highlighttable td.code{display:block;flex:1;overflow:hidden;padding:0}.highlighttable td.code .highlight{border-bottom-left-radius:0;border-top-left-radius:0}.highlight span.linenos{box-shadow:-.0625rem 0 var(--color-foreground-border) inset;display:inline-block;margin-right:.875rem;padding-left:0;padding-right:.875rem}.footnote-reference{font-size:var(--font-size--small--4);vertical-align:super}dl.footnote.brackets{color:var(--color-foreground-secondary);display:grid;font-size:var(--font-size--small);grid-template-columns:max-content auto}dl.footnote.brackets dt{margin:0}dl.footnote.brackets dt>.fn-backref{margin-left:.25rem}dl.footnote.brackets dt:after{content:":"}dl.footnote.brackets dt .brackets:before{content:"["}dl.footnote.brackets dt .brackets:after{content:"]"}dl.footnote.brackets dd{margin:0;padding:0 1rem}aside.footnote{color:var(--color-foreground-secondary);font-size:var(--font-size--small)}aside.footnote>span,div.citation>span{float:left;font-weight:500;padding-right:.25rem}aside.footnote>p,div.citation>p{margin-left:2rem}img{box-sizing:border-box;height:auto;max-width:100%}article .figure,article figure{border-radius:.2rem;margin:0}article .figure :last-child,article figure :last-child{margin-bottom:0}article .align-left{clear:left;float:left;margin:0 1rem 1rem}article .align-right{clear:right;float:right;margin:0 1rem 1rem}article .align-center,article .align-default{display:block;margin-left:auto;margin-right:auto;text-align:center}article table.align-default{display:table;text-align:initial}.domainindex-jumpbox,.genindex-jumpbox{border-bottom:1px solid var(--color-background-border);border-top:1px solid var(--color-background-border);padding:.25rem}.domainindex-section h2,.genindex-section h2{margin-bottom:.5rem;margin-top:.75rem}.domainindex-section ul,.genindex-section ul{margin-bottom:0;margin-top:0}ol,ul{margin-bottom:1rem;margin-top:1rem;padding-left:1.2rem}ol li>p:first-child,ul li>p:first-child{margin-bottom:.25rem;margin-top:.25rem}ol li>p:last-child,ul li>p:last-child{margin-top:.25rem}ol li>ol,ol li>ul,ul li>ol,ul li>ul{margin-bottom:.5rem;margin-top:.5rem}ol.arabic{list-style:decimal}ol.loweralpha{list-style:lower-alpha}ol.upperalpha{list-style:upper-alpha}ol.lowerroman{list-style:lower-roman}ol.upperroman{list-style:upper-roman}.simple li>ol,.simple li>ul,.toctree-wrapper li>ol,.toctree-wrapper li>ul{margin-bottom:0;margin-top:0}.field-list dt,.option-list dt,dl.footnote dt,dl.glossary dt,dl.simple dt,dl:not([class]) dt{font-weight:500;margin-top:.25rem}.field-list dt+dt,.option-list dt+dt,dl.footnote dt+dt,dl.glossary dt+dt,dl.simple dt+dt,dl:not([class]) dt+dt{margin-top:0}.field-list dt .classifier:before,.option-list dt .classifier:before,dl.footnote dt .classifier:before,dl.glossary dt .classifier:before,dl.simple dt .classifier:before,dl:not([class]) dt .classifier:before{content:":";margin-left:.2rem;margin-right:.2rem}.field-list dd ul,.field-list dd>p:first-child,.option-list dd ul,.option-list dd>p:first-child,dl.footnote dd ul,dl.footnote dd>p:first-child,dl.glossary dd ul,dl.glossary dd>p:first-child,dl.simple dd ul,dl.simple dd>p:first-child,dl:not([class]) dd ul,dl:not([class]) dd>p:first-child{margin-top:.125rem}.field-list dd ul,.option-list dd ul,dl.footnote dd ul,dl.glossary dd ul,dl.simple dd ul,dl:not([class]) dd ul{margin-bottom:.125rem}.math-wrapper{overflow-x:auto;width:100%}div.math{position:relative;text-align:center}div.math .headerlink,div.math:focus .headerlink{display:none}div.math:hover .headerlink{display:inline-block}div.math span.eqno{position:absolute;right:.5rem;top:50%;transform:translateY(-50%);z-index:1}abbr[title]{cursor:help}.problematic{color:var(--color-problematic)}kbd:not(.compound){background-color:var(--color-background-secondary);border:1px solid var(--color-foreground-border);border-radius:.2rem;box-shadow:0 .0625rem 0 rgba(0,0,0,.2),inset 0 0 0 .125rem var(--color-background-primary);color:var(--color-foreground-primary);display:inline-block;font-size:var(--font-size--small--3);margin:0 .2rem;padding:0 .2rem;vertical-align:text-bottom}blockquote{background:var(--color-background-secondary);border-left:4px solid var(--color-background-border);margin-left:0;margin-right:0;padding:.5rem 1rem}blockquote .attribution{font-weight:600;text-align:right}blockquote.highlights,blockquote.pull-quote{font-size:1.25em}blockquote.epigraph,blockquote.pull-quote{border-left-width:0;border-radius:.5rem}blockquote.highlights{background:transparent;border-left-width:0}p .reference img{vertical-align:middle}p.rubric{font-size:1.125em;font-weight:700;line-height:1.25}dd p.rubric{font-size:var(--font-size--small);font-weight:inherit;line-height:inherit;text-transform:uppercase}article .sidebar{background-color:var(--color-background-secondary);border:1px solid var(--color-background-border);border-radius:.2rem;clear:right;float:right;margin-left:1rem;margin-right:0;width:30%}article .sidebar>*{padding-left:1rem;padding-right:1rem}article .sidebar>ol,article .sidebar>ul{padding-left:2.2rem}article .sidebar .sidebar-title{border-bottom:1px solid var(--color-background-border);font-weight:500;margin:0;padding:.5rem 1rem}.table-wrapper{margin-bottom:.5rem;margin-top:1rem;overflow-x:auto;padding:.2rem .2rem .75rem;width:100%}table.docutils{border-collapse:collapse;border-radius:.2rem;border-spacing:0;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .0625rem rgba(0,0,0,.1)}table.docutils th{background:var(--color-table-header-background)}table.docutils td,table.docutils th{border-bottom:1px solid var(--color-table-border);border-left:1px solid var(--color-table-border);border-right:1px solid var(--color-table-border);padding:0 .25rem}table.docutils td p,table.docutils th p{margin:.25rem}table.docutils td:first-child,table.docutils th:first-child{border-left:none}table.docutils td:last-child,table.docutils th:last-child{border-right:none}table.docutils td.text-left,table.docutils th.text-left{text-align:left}table.docutils td.text-right,table.docutils th.text-right{text-align:right}table.docutils td.text-center,table.docutils th.text-center{text-align:center}:target{scroll-margin-top:.5rem}@media(max-width:67em){:target{scroll-margin-top:calc(.5rem + var(--header-height))}section>span:target{scroll-margin-top:calc(.8rem + var(--header-height))}}.headerlink{font-weight:100;-webkit-user-select:none;-moz-user-select:none;user-select:none}.code-block-caption>.headerlink,dl dt>.headerlink,figcaption p>.headerlink,h1>.headerlink,h2>.headerlink,h3>.headerlink,h4>.headerlink,h5>.headerlink,h6>.headerlink,p.caption>.headerlink,table>caption>.headerlink{margin-left:.5rem;visibility:hidden}.code-block-caption:hover>.headerlink,dl dt:hover>.headerlink,figcaption p:hover>.headerlink,h1:hover>.headerlink,h2:hover>.headerlink,h3:hover>.headerlink,h4:hover>.headerlink,h5:hover>.headerlink,h6:hover>.headerlink,p.caption:hover>.headerlink,table>caption:hover>.headerlink{visibility:visible}.code-block-caption>.toc-backref,dl dt>.toc-backref,figcaption p>.toc-backref,h1>.toc-backref,h2>.toc-backref,h3>.toc-backref,h4>.toc-backref,h5>.toc-backref,h6>.toc-backref,p.caption>.toc-backref,table>caption>.toc-backref{color:inherit;text-decoration-line:none}figure:hover>figcaption>p>.headerlink,table:hover>caption>.headerlink{visibility:visible}:target>h1:first-of-type,:target>h2:first-of-type,:target>h3:first-of-type,:target>h4:first-of-type,:target>h5:first-of-type,:target>h6:first-of-type,span:target~h1:first-of-type,span:target~h2:first-of-type,span:target~h3:first-of-type,span:target~h4:first-of-type,span:target~h5:first-of-type,span:target~h6:first-of-type{background-color:var(--color-highlight-on-target)}:target>h1:first-of-type code.literal,:target>h2:first-of-type code.literal,:target>h3:first-of-type code.literal,:target>h4:first-of-type code.literal,:target>h5:first-of-type code.literal,:target>h6:first-of-type code.literal,span:target~h1:first-of-type code.literal,span:target~h2:first-of-type code.literal,span:target~h3:first-of-type code.literal,span:target~h4:first-of-type code.literal,span:target~h5:first-of-type code.literal,span:target~h6:first-of-type code.literal{background-color:transparent}.literal-block-wrapper:target .code-block-caption,.this-will-duplicate-information-and-it-is-still-useful-here li :target,figure:target,table:target>caption{background-color:var(--color-highlight-on-target)}dt:target{background-color:var(--color-highlight-on-target)!important}.footnote-reference:target,.footnote>dt:target+dd{background-color:var(--color-highlight-on-target)}.guilabel{background-color:var(--color-guilabel-background);border:1px solid var(--color-guilabel-border);border-radius:.5em;color:var(--color-guilabel-text);font-size:.9em;padding:0 .3em}footer{display:flex;flex-direction:column;font-size:var(--font-size--small);margin-top:2rem}.bottom-of-page{align-items:center;border-top:1px solid var(--color-background-border);color:var(--color-foreground-secondary);display:flex;justify-content:space-between;line-height:1.5;margin-top:1rem;padding-bottom:1rem;padding-top:1rem}@media(max-width:46em){.bottom-of-page{flex-direction:column-reverse;gap:.25rem;text-align:center}}.bottom-of-page .left-details{font-size:var(--font-size--small)}.bottom-of-page .right-details{display:flex;flex-direction:column;gap:.25rem;text-align:right}.bottom-of-page .icons{display:flex;font-size:1rem;gap:.25rem;justify-content:flex-end}.bottom-of-page .icons a{text-decoration:none}.bottom-of-page .icons img,.bottom-of-page .icons svg{font-size:1.125rem;height:1em;width:1em}.related-pages a{align-items:center;display:flex;text-decoration:none}.related-pages a:hover .page-info .title{color:var(--color-link);text-decoration:underline;text-decoration-color:var(--color-link-underline)}.related-pages a svg.furo-related-icon,.related-pages a svg.furo-related-icon>use{color:var(--color-foreground-border);flex-shrink:0;height:.75rem;margin:0 .5rem;width:.75rem}.related-pages a.next-page{clear:right;float:right;max-width:50%;text-align:right}.related-pages a.prev-page{clear:left;float:left;max-width:50%}.related-pages a.prev-page svg{transform:rotate(180deg)}.page-info{display:flex;flex-direction:column;overflow-wrap:anywhere}.next-page .page-info{align-items:flex-end}.page-info .context{align-items:center;color:var(--color-foreground-muted);display:flex;font-size:var(--font-size--small);padding-bottom:.1rem;text-decoration:none}ul.search{list-style:none;padding-left:0}ul.search li{border-bottom:1px solid var(--color-background-border);padding:1rem 0}[role=main] .highlighted{background-color:var(--color-highlighted-background);color:var(--color-highlighted-text)}.sidebar-brand{display:flex;flex-direction:column;flex-shrink:0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-decoration:none}.sidebar-brand-text{color:var(--color-sidebar-brand-text);font-size:1.5rem;overflow-wrap:break-word}.sidebar-brand-text,.sidebar-logo-container{margin:var(--sidebar-item-spacing-vertical) 0}.sidebar-logo{display:block;margin:0 auto;max-width:100%}.sidebar-search-container{align-items:center;background:var(--color-sidebar-search-background);display:flex;margin-top:var(--sidebar-search-space-above);position:relative}.sidebar-search-container:focus-within,.sidebar-search-container:hover{background:var(--color-sidebar-search-background--focus)}.sidebar-search-container:before{background-color:var(--color-sidebar-search-icon);content:"";height:var(--sidebar-search-icon-size);left:var(--sidebar-item-spacing-horizontal);-webkit-mask-image:var(--icon-search);mask-image:var(--icon-search);position:absolute;width:var(--sidebar-search-icon-size)}.sidebar-search{background:transparent;border:none;border-bottom:1px solid var(--color-sidebar-search-border);border-top:1px solid var(--color-sidebar-search-border);box-sizing:border-box;color:var(--color-sidebar-search-foreground);padding:var(--sidebar-search-input-spacing-vertical) var(--sidebar-search-input-spacing-horizontal) var(--sidebar-search-input-spacing-vertical) calc(var(--sidebar-item-spacing-horizontal) + var(--sidebar-search-input-spacing-horizontal) + var(--sidebar-search-icon-size));width:100%;z-index:10}.sidebar-search:focus{outline:none}.sidebar-search::-moz-placeholder{font-size:var(--sidebar-search-input-font-size)}.sidebar-search::placeholder{font-size:var(--sidebar-search-input-font-size)}#searchbox .highlight-link{margin:0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0;text-align:center}#searchbox .highlight-link a{color:var(--color-sidebar-search-icon);font-size:var(--font-size--small--2)}.sidebar-tree{font-size:var(--sidebar-item-font-size);margin-bottom:var(--sidebar-item-spacing-vertical);margin-top:var(--sidebar-tree-space-above)}.sidebar-tree ul{display:flex;flex-direction:column;list-style:none;margin-bottom:0;margin-top:0;padding:0}.sidebar-tree li{margin:0;position:relative}.sidebar-tree li>ul{margin-left:var(--sidebar-item-spacing-horizontal)}.sidebar-tree .icon,.sidebar-tree .reference{color:var(--color-sidebar-link-text)}.sidebar-tree .reference{box-sizing:border-box;display:inline-block;height:100%;line-height:var(--sidebar-item-line-height);overflow-wrap:anywhere;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-decoration:none;width:100%}.sidebar-tree .reference:hover{background:var(--color-sidebar-item-background--hover)}.sidebar-tree .reference.external:after{color:var(--color-sidebar-link-text);content:url("data:image/svg+xml;charset=utf-8,%3Csvg width='12' height='12' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' stroke-width='1.5' stroke='%23607D8B' fill='none' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M0 0h24v24H0z' stroke='none'/%3E%3Cpath d='M11 7H6a2 2 0 0 0-2 2v9a2 2 0 0 0 2 2h9a2 2 0 0 0 2-2v-5M10 14 20 4M15 4h5v5'/%3E%3C/svg%3E");margin:0 .25rem;vertical-align:middle}.sidebar-tree .current-page>.reference{font-weight:700}.sidebar-tree label{align-items:center;cursor:pointer;display:flex;height:var(--sidebar-item-height);justify-content:center;position:absolute;right:0;top:0;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:var(--sidebar-expander-width)}.sidebar-tree .caption,.sidebar-tree :not(.caption)>.caption-text{color:var(--color-sidebar-caption-text);font-size:var(--sidebar-caption-font-size);font-weight:700;margin:var(--sidebar-caption-space-above) 0 0 0;padding:var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal);text-transform:uppercase}.sidebar-tree li.has-children>.reference{padding-right:var(--sidebar-expander-width)}.sidebar-tree .toctree-l1>.reference,.sidebar-tree .toctree-l1>label .icon{color:var(--color-sidebar-link-text--top-level)}.sidebar-tree label{background:var(--color-sidebar-item-expander-background)}.sidebar-tree label:hover{background:var(--color-sidebar-item-expander-background--hover)}.sidebar-tree .current>.reference{background:var(--color-sidebar-item-background--current)}.sidebar-tree .current>.reference:hover{background:var(--color-sidebar-item-background--hover)}.toctree-checkbox{display:none;position:absolute}.toctree-checkbox~ul{display:none}.toctree-checkbox~label .icon svg{transform:rotate(90deg)}.toctree-checkbox:checked~ul{display:block}.toctree-checkbox:checked~label .icon svg{transform:rotate(-90deg)}.toc-title-container{padding:var(--toc-title-padding);padding-top:var(--toc-spacing-vertical)}.toc-title{color:var(--color-toc-title-text);font-size:var(--toc-title-font-size);padding-left:var(--toc-spacing-horizontal);text-transform:uppercase}.no-toc{display:none}.toc-tree-container{padding-bottom:var(--toc-spacing-vertical)}.toc-tree{border-left:1px solid var(--color-background-border);font-size:var(--toc-font-size);line-height:1.3;padding-left:calc(var(--toc-spacing-horizontal) - var(--toc-item-spacing-horizontal))}.toc-tree>ul>li:first-child{padding-top:0}.toc-tree>ul>li:first-child>ul{padding-left:0}.toc-tree>ul>li:first-child>a{display:none}.toc-tree ul{list-style-type:none;margin-bottom:0;margin-top:0;padding-left:var(--toc-item-spacing-horizontal)}.toc-tree li{padding-top:var(--toc-item-spacing-vertical)}.toc-tree li.scroll-current>.reference{color:var(--color-toc-item-text--active);font-weight:700}.toc-tree .reference{color:var(--color-toc-item-text);overflow-wrap:anywhere;text-decoration:none}.toc-scroll{max-height:100vh;overflow-y:scroll}.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here){background:rgba(255,0,0,.25);color:var(--color-problematic)}.contents:not(.this-will-duplicate-information-and-it-is-still-useful-here):before{content:"ERROR: Adding a table of contents in Furo-based documentation is unnecessary, and does not work well with existing styling.Add a 'this-will-duplicate-information-and-it-is-still-useful-here' class, if you want an escape hatch."}.text-align\:left>p{text-align:left}.text-align\:center>p{text-align:center}.text-align\:right>p{text-align:right} +/*# sourceMappingURL=furo.css.map*/ \ No newline at end of file diff --git a/docs/_build/html/_static/styles/furo.css.map b/docs/_build/html/_static/styles/furo.css.map new file mode 100644 index 0000000..1924b33 --- /dev/null +++ b/docs/_build/html/_static/styles/furo.css.map @@ -0,0 +1 @@ +{"version":3,"file":"styles/furo.css","mappings":"AAAA,2EAA2E,CAU3E,KAEE,6BAA8B,CAD9B,gBAEF,CASA,KACE,QACF,CAMA,KACE,aACF,CAOA,GACE,aAAc,CACd,cACF,CAUA,GACE,sBAAuB,CACvB,QAAS,CACT,gBACF,CAOA,IACE,+BAAiC,CACjC,aACF,CASA,EACE,4BACF,CAOA,YACE,kBAAmB,CACnB,yBAA0B,CAC1B,gCACF,CAMA,SAEE,kBACF,CAOA,cAGE,+BAAiC,CACjC,aACF,CAeA,QAEE,aAAc,CACd,aAAc,CACd,iBAAkB,CAClB,uBACF,CAEA,IACE,aACF,CAEA,IACE,SACF,CASA,IACE,iBACF,CAUA,sCAKE,mBAAoB,CACpB,cAAe,CACf,gBAAiB,CACjB,QACF,CAOA,aAEE,gBACF,CAOA,cAEE,mBACF,CAMA,gDAIE,yBACF,CAMA,wHAIE,iBAAkB,CAClB,SACF,CAMA,4GAIE,6BACF,CAMA,SACE,0BACF,CASA,OACE,qBAAsB,CACtB,aAAc,CACd,aAAc,CACd,cAAe,CACf,SAAU,CACV,kBACF,CAMA,SACE,uBACF,CAMA,SACE,aACF,CAOA,6BAEE,qBAAsB,CACtB,SACF,CAMA,kFAEE,WACF,CAOA,cACE,4BAA6B,CAC7B,mBACF,CAMA,yCACE,uBACF,CAOA,6BACE,yBAA0B,CAC1B,YACF,CASA,QACE,aACF,CAMA,QACE,iBACF,CAiBA,kBACE,YACF,CCvVA,aAcE,kEACE,uBAOF,WACE,iDAMF,gCACE,wBAEF,qCAEE,uBADA,uBACA,CAEF,SACE,wBAtBA,CCpBJ,iBAOE,6BAEA,mBANA,qBAEA,sBACA,0BAFA,oBAHA,4BAOA,6BANA,mBAOA,CAEF,gBACE,aCPF,KCGE,mHAEA,wGAGA,wBAAyB,CACzB,wBAAyB,CACzB,4BAA6B,CAC7B,yBAA0B,CAC1B,2BAA4B,CAG5B,sDAAuD,CACvD,gDAAiD,CACjD,wDAAyD,CAGzD,0CAA2C,CAC3C,gDAAiD,CACjD,gDAAiD,CAKjD,gCAAiC,CACjC,sCAAuC,CAGvC,2CAA4C,CAG5C,uCAAwC,CChCxC,+FAGA,uBAAwB,CAGxB,iCAAkC,CAClC,kCAAmC,CAEnC,+BAAgC,CAChC,sCAAuC,CACvC,sCAAuC,CACvC,qGAIA,mDAAoD,CAEpD,mCAAoC,CACpC,8CAA+C,CAC/C,gDAAiD,CACjD,kCAAmC,CACnC,6DAA8D,CAG9D,6BAA8B,CAC9B,6BAA8B,CAC9B,+BAAgC,CAChC,kCAAmC,CACnC,kCAAmC,CCPjC,ukBCYA,srCAZF,kaCVA,mLAOA,oTAWA,2UAaA,0CACA,gEACA,0CAGA,gEAUA,yCACA,+DAGA,4CACA,CACA,iEAGA,sGACA,uCACA,4DAGA,sCACA,2DAEA,4CACA,kEACA,oGACA,CAEA,0GACA,+CAGA,+MAOA,+EACA,wCAIA,4DACA,sEACA,kEACA,sEACA,gDAGA,+DACA,0CACA,gEACA,gGACA,CAGA,2DACA,qDAGA,0CACA,8CACA,oDACA,oDL7GF,iCAEA,iEAME,oCKyGA,yDAIA,sCACA,kCACA,sDAGA,0CACA,kEACA,oDAEA,sDAGA,oCACA,oEAIA,CAGA,yDAGA,qDACA,oDAGA,6DAIA,iEAGA,2DAEA,2DL9IE,4DAEA,gEAIF,gEKgGA,gFAIA,oNAOA,qDAEA,gFAIA,4DAIA,oEAMA,yEAIA,6DACA,0DAGA,uDAGA,qDAEA,wDLpII,6DAEA,yDACE,2DAMN,uCAIA,yCACE,8CAGF,sDMjDA,6DAKA,oCAIA,4CACA,kBAGF,sBAMA,2BAME,qCAGA,qCAEA,iCAEA,+BAEA,mCAEA,qCAIA,CACA,gCACA,gDAKA,kCAIA,6BAEA,0CAQA,kCAIF,8BAGE,8BACA,uCAGF,sCAKE,kCAEA,sDAGA,iCACE,CACA,2FAGA,gCACE,CACA,+DCzEJ,wCAEA,sBAEF,yDAEE,mCACA,wDAGA,2GAGA,wIACE,gDAMJ,kCAGE,6BACA,0CAGA,gEACA,8BACA,uCAKA,sCAIA,kCACA,sDACA,iCACA,sCAOA,sDAKE,gGAIE,+CAGN,sBAEE,yCAMA,0BAOA,yLAKA,aACA,MAEF,6BACE,mBAEA,wCAEF,wCAIE,kCAGA,SACA,kCAKA,mBAGA,CAJA,eACA,CAHF,gBAEE,CAWA,mBACA,mBACA,mDAIA,YACA,mBACA,CAEE,kBAMF,OAPE,kBAOF,oCACA,yCAEA,wBAEA,cADA,WACA,GACA,oBACA,CAFA,gBAEA,aAGF,+CAEE,UAJE,wBAEJ,CAFI,SAIF,CACA,2BACA,GAGA,uBACE,CAJF,yBAGA,CACE,iDACA,uCAEA,yDACE,cACA,wDAKN,yDAIE,uBAEF,kBACE,uBAEA,kDAKA,0DAEA,CAHA,oBAIA,0GAWA,aAEA,CAHA,YAGA,4HAKF,+CAGE,sBAEF,WAKE,0CAGA,CANA,qCAGA,CAJA,WAOA,SAIA,0CACE,CALF,qCAIA,CACE,wBAEA,mBAEJ,gBACE,gBAIA,+CAKF,CAIE,kDAEA,CANF,8BAIE,CAEA,YAGA,CAfF,2BACE,CAHA,UAEF,CAYE,UAGA,2CACF,iEAOE,iCACA,8BAGA,wCAIA,wBAMI,0CAKF,CATA,6DAGA,CALF,qBAEE,CASA,YACA,yBAGA,CAEE,cAKN,CAPI,sBAOJ,gCAGE,qBAEA,WACA,aACA,sCAEA,mBACA,6BAGA,uEADA,qBACA,6BAIA,yBACA,qCAEE,UAEA,YACA,sBAEF,8BAGA,CAPE,aACA,WAMF,4BACE,sBACA,WAMJ,uBACE,cAYE,mBAXA,qDAKA,qCAGA,CAEA,YACA,CAHA,2BAEA,CACA,oCAEA,4CACA,uBAIA,sBAEJ,eAFI,cAIF,iBACE,CAHJ,kBAGI,yBAEA,oCAIA,qDAMF,mEAGE,+CAKA,gCAEA,qCAGA,oCAGE,sBACA,CAJF,WAEE,CAFF,eAEE,SAEA,mBACA,qCACE,aACA,CAFF,YADA,qBACA,WAEE,sBACA,kEAEN,cAEE,CAFF,YAEE,iDAKA,uCAIA,2DAKA,kBAEA,CAHA,sBAGA,mBACA,0BAEJ,yBAII,aADA,WACA,CAMF,UAFE,kBAEF,CAJF,gBAEI,CAFJ,iBAIE,6CC9ZF,yBACE,WACA,iBAEA,aAFA,iBAEA,6BAEA,kCACA,mBAKA,gCAGA,CARA,QAEA,CAGA,UALA,qBAEA,qDAGA,CALA,OAQA,4BACE,cAGF,2BACE,gCAEJ,CAHE,UAGF,8CAGE,CAHF,UAGE,wCAGA,qBACA,CAFA,UAEA,6CAGA,yCAIA,sBAHA,UAGA,kCACE,OACA,CADA,KACA,cAQF,0CACE,CAFF,kBACA,CACE,wEACA,CARA,YACA,CAKF,mBAFF,MACE,CAIE,gBAJF,iCAJE,cAGJ,CANI,oBAEA,CAKF,SAIE,2BADA,UACA,kBAGF,sCACA,CAFF,WACE,WACA,mBACE,kDACA,0EACA,uDAKJ,aACE,mDAII,CAJJ,6CAII,4BACA,sCACE,kEACA,+CACE,aACA,WADA,+BACA,uEANN,YACE,mDAEE,mBADF,0CACE,CADF,qBACE,0DACA,YACE,4DACA,sEANN,YACE,8CACA,kBADA,UACA,2CACE,2EACA,cACE,kEACA,mEANN,yBACE,4DACA,sBACE,+EAEE,iEACA,qEANN,sCACE,CAGE,iBAHF,gBAGE,qBACE,CAJJ,uBACA,gDACE,wDACA,6DAHF,2CACA,CADA,gBACA,eACE,CAGE,sBANN,8BACE,CAII,iBAFF,4DACA,WACE,YADF,uCACE,6EACA,2BANN,8CACE,kDACA,0CACE,8BACA,yFACE,sBACA,sFALJ,mEACA,sBACE,kEACA,6EACE,uCACA,kEALJ,qGAEE,kEACA,6EACE,uCACA,kEALJ,8CACA,uDACE,sEACA,2EACE,sCACA,iEALJ,mGACA,qCACE,oDACA,0DACE,6GACA,gDAGR,yDCrEA,sEACE,CACA,6GACE,gEACF,iGAIF,wFACE,qDAGA,mGAEE,2CAEF,4FACE,gCACF,wGACE,8DAEE,6FAIA,iJAKN,6GACE,gDAKF,yDACA,qCAGA,6BACA,kBACA,qDAKA,oCAEA,+DAGA,2CAGE,oDAIA,oEAEE,qBAGJ,wDAEE,uCAEF,kEAGA,8CAEA,uDAKA,oCAEA,yDAEE,gEAKF,+CC5FA,0EAGE,CACA,qDCLJ,+DAIE,sCAIA,kEACE,yBACA,2FAMA,gBACA,yGCbF,mBAOA,2MAIA,4HAYA,0DACE,8GAYF,8HAQE,mBAEA,6HAOF,YAGA,mIAME,eACA,CAFF,YAEE,4FAMJ,8BAEE,uBAYA,sCAEE,CAJF,oBAEA,CARA,wCAEA,CAHA,8BACA,CAFA,eACA,CAGA,wCAEA,CAEA,mDAIE,kCACE,6BACA,4CAKJ,kDAIA,eACE,aAGF,8BACE,uDACA,sCACA,cAEA,+BACA,CAFA,eAEA,wCAEF,YACE,iBACA,mCACA,0DAGF,qBAEE,CAFF,kBAEE,+BAIA,yCAEE,qBADA,gBACA,yBAKF,eACA,CAFF,YACE,CACA,iBACA,qDAEA,mDCvIJ,2FAOE,iCACA,CAEA,eACA,CAHA,kBAEA,CAFA,wBAGA,8BACA,eACE,CAFF,YAEE,0BACA,8CAGA,oBACE,oCAGA,kBACE,8DAEA,iBAEN,UACE,8BAIJ,+CAEE,qDAEF,kDAIE,YAEF,CAFE,YAEF,CCjCE,mFAJA,QACA,UAIE,CADF,iBACE,mCAGA,iDACE,+BAGF,wBAEA,mBAKA,6CAEF,CAHE,mBACA,CAEF,kCAIE,CARA,kBACA,CAFF,eASE,YACA,mBAGF,CAJE,UAIF,wCCjCA,oBDmCE,wBCpCJ,uCACE,8BACA,4CACA,oBAGA,2CCAA,6CAGE,CAPF,uBAIA,CDGA,gDACE,6BCVJ,CAWM,2CAEF,CAJA,kCAEE,CDJF,aCLF,gBDKE,uBCMA,gCAGA,gDAGE,wBAGJ,0BAEA,iBACE,aACF,CADE,UACF,uBACE,aACF,oBACE,YACF,4BACE,6CAMA,CAYF,6DAZE,mCAGE,iCASJ,4BAGE,4DADA,+BACA,CAFA,qBAEA,yBACE,aAEF,wBAHA,SAGA,iHACE,2DAKF,CANA,yCACE,CADF,oCAMA,uSAIA,sGACE,oDChEJ,WAEF,yBACE,QACA,eAEA,gBAEE,uCAGA,CALF,iCAKE,uCAGA,0BACA,CACA,oBACA,iCClBJ,gBACE,KAGF,qBACE,YAGF,CAHE,cAGF,gCAEE,mBACA,iEAEA,oCACA,wCAEA,sBACA,WAEA,CAFA,YAEA,8EAEA,mCAFA,iBAEA,6BAIA,wEAKA,sDAIE,CARF,mDAIA,CAIE,cAEF,8CAIA,oBAFE,iBAEF,8CAGE,eAEF,CAFE,YAEF,OAEE,kBAGJ,CAJI,eACA,CAFF,mBAKF,yCCjDE,oBACA,CAFA,iBAEA,uCAKE,iBACA,qCAGA,mBCZJ,CDWI,gBCXJ,6BAEE,eACA,sBAGA,eAEA,sBACA,oDACA,iGAMA,gBAFE,YAEF,8FAME,iJClBF,YACA,gNAUE,6BAEF,oTAcI,kBACF,gHAIA,qBACE,eACF,qDACE,kBACF,6DACE,4BCxCJ,oBAEF,qCAEI,+CAGF,uBACE,uDAGJ,oBAkBE,mDAhBA,+CAaA,CAbA,oBAaA,0FAEE,CAFF,gGAbA,+BAaA,0BAGA,mQAIA,oNAEE,iBAGJ,CAHI,gBADA,gBAIJ,8CAYI,CAZJ,wCAYI,sVACE,iCAGA,uEAHA,QAGA,qXAKJ,iDAGF,CARM,+CACE,iDAIN,CALI,gBAQN,mHACE,gBAGF,2DACE,0EAOA,0EAKA,6EC/EA,iDACA,gCACA,oDAGA,qBACA,oDCFA,cACA,eAEA,yBAGF,sBAEE,iBACA,sNAWA,iBACE,kBACA,wRAgBA,kBAEA,iOAgBA,uCACE,uEAEA,kBAEF,qUAuBE,iDAIJ,CACA,geCxFF,4BAEE,CAQA,6JACA,iDAIA,sEAGA,mDAOF,iDAGE,4DAIA,8CACA,qDAEE,eAFF,cAEE,oBAEF,uBAFE,kCAGA,eACA,iBACA,mBAIA,mDACA,CAHA,uCAEA,CAJA,0CACA,CAIA,gBAJA,gBACA,oBADA,gBAIA,wBAEJ,gBAGE,6BACA,YAHA,iBAGA,gCACA,iEAEA,6CACA,sDACA,0BADA,wBACA,0BACA,oIAIA,mBAFA,YAEA,qBACA,0CAIE,uBAEF,CAHA,yBACE,CAEF,iDACE,mFAKJ,oCACE,CANE,aAKJ,CACE,qEAIA,YAFA,WAEA,CAHA,aACA,CAEA,gBACE,4BACA,sBADA,aACA,gCAMF,oCACA,yDACA,2CAEA,qBAGE,kBAEA,CACA,mCAIF,CARE,YACA,CAOF,iCAEE,CAPA,oBACA,CAQA,oBACE,uDAEJ,sDAGA,CAHA,cAGA,0BACE,oDAIA,oCACA,4BACA,sBAGA,cAEA,oFAGA,sBAEA,yDACE,CAIA,iBAJA,wBAIA,6CAJA,6CAOA,4BAGJ,CAHI,cAGJ,yCAGA,kBACE,CAIA,iDAEA,CATA,YAEF,CACE,4CAGA,kBAIA,wEAEA,wDAIF,kCAOE,iDACA,CARF,WAIE,sCAGA,CANA,2CACA,CAMA,oEARF,iBACE,CACA,qCAMA,iBAuBE,uBAlBF,YAKA,2DALA,uDAKA,CALA,sBAiBA,4CACE,CALA,gRAIF,YACE,UAEN,uBACE,YACA,mCAOE,+CAGA,8BAGF,+CAGA,4BCjNA,SDiNA,qFCjNA,gDAGA,sCACA,qCACA,sDAIF,CAIE,kDAGA,CAPF,0CAOE,kBAEA,kDAEA,CAHA,eACA,CAFA,YACA,CADA,SAIA,mHAIE,CAGA,6CAFA,oCAeE,CAbF,yBACE,qBAEJ,CAGE,oBACA,CAEA,YAFA,2CACF,CACE,uBAEA,mFAEE,CALJ,oBACE,CAEA,UAEE,gCAGF,sDAEA,yCC7CJ,oCAGA,CD6CE,yXAQE,sCCrDJ,wCAGA,oCACE","sources":["webpack:///./node_modules/normalize.css/normalize.css","webpack:///./src/furo/assets/styles/base/_print.sass","webpack:///./src/furo/assets/styles/base/_screen-readers.sass","webpack:///./src/furo/assets/styles/base/_theme.sass","webpack:///./src/furo/assets/styles/variables/_fonts.scss","webpack:///./src/furo/assets/styles/variables/_spacing.scss","webpack:///./src/furo/assets/styles/variables/_icons.scss","webpack:///./src/furo/assets/styles/variables/_admonitions.scss","webpack:///./src/furo/assets/styles/variables/_colors.scss","webpack:///./src/furo/assets/styles/base/_typography.sass","webpack:///./src/furo/assets/styles/_scaffold.sass","webpack:///./src/furo/assets/styles/content/_admonitions.sass","webpack:///./src/furo/assets/styles/content/_api.sass","webpack:///./src/furo/assets/styles/content/_blocks.sass","webpack:///./src/furo/assets/styles/content/_captions.sass","webpack:///./src/furo/assets/styles/content/_code.sass","webpack:///./src/furo/assets/styles/content/_footnotes.sass","webpack:///./src/furo/assets/styles/content/_images.sass","webpack:///./src/furo/assets/styles/content/_indexes.sass","webpack:///./src/furo/assets/styles/content/_lists.sass","webpack:///./src/furo/assets/styles/content/_math.sass","webpack:///./src/furo/assets/styles/content/_misc.sass","webpack:///./src/furo/assets/styles/content/_rubrics.sass","webpack:///./src/furo/assets/styles/content/_sidebar.sass","webpack:///./src/furo/assets/styles/content/_tables.sass","webpack:///./src/furo/assets/styles/content/_target.sass","webpack:///./src/furo/assets/styles/content/_gui-labels.sass","webpack:///./src/furo/assets/styles/components/_footer.sass","webpack:///./src/furo/assets/styles/components/_sidebar.sass","webpack:///./src/furo/assets/styles/components/_table_of_contents.sass","webpack:///./src/furo/assets/styles/_shame.sass"],"sourcesContent":["/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */\n\n/* Document\n ========================================================================== */\n\n/**\n * 1. Correct the line height in all browsers.\n * 2. Prevent adjustments of font size after orientation changes in iOS.\n */\n\nhtml {\n line-height: 1.15; /* 1 */\n -webkit-text-size-adjust: 100%; /* 2 */\n}\n\n/* Sections\n ========================================================================== */\n\n/**\n * Remove the margin in all browsers.\n */\n\nbody {\n margin: 0;\n}\n\n/**\n * Render the `main` element consistently in IE.\n */\n\nmain {\n display: block;\n}\n\n/**\n * Correct the font size and margin on `h1` elements within `section` and\n * `article` contexts in Chrome, Firefox, and Safari.\n */\n\nh1 {\n font-size: 2em;\n margin: 0.67em 0;\n}\n\n/* Grouping content\n ========================================================================== */\n\n/**\n * 1. Add the correct box sizing in Firefox.\n * 2. Show the overflow in Edge and IE.\n */\n\nhr {\n box-sizing: content-box; /* 1 */\n height: 0; /* 1 */\n overflow: visible; /* 2 */\n}\n\n/**\n * 1. Correct the inheritance and scaling of font size in all browsers.\n * 2. Correct the odd `em` font sizing in all browsers.\n */\n\npre {\n font-family: monospace, monospace; /* 1 */\n font-size: 1em; /* 2 */\n}\n\n/* Text-level semantics\n ========================================================================== */\n\n/**\n * Remove the gray background on active links in IE 10.\n */\n\na {\n background-color: transparent;\n}\n\n/**\n * 1. Remove the bottom border in Chrome 57-\n * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.\n */\n\nabbr[title] {\n border-bottom: none; /* 1 */\n text-decoration: underline; /* 2 */\n text-decoration: underline dotted; /* 2 */\n}\n\n/**\n * Add the correct font weight in Chrome, Edge, and Safari.\n */\n\nb,\nstrong {\n font-weight: bolder;\n}\n\n/**\n * 1. Correct the inheritance and scaling of font size in all browsers.\n * 2. Correct the odd `em` font sizing in all browsers.\n */\n\ncode,\nkbd,\nsamp {\n font-family: monospace, monospace; /* 1 */\n font-size: 1em; /* 2 */\n}\n\n/**\n * Add the correct font size in all browsers.\n */\n\nsmall {\n font-size: 80%;\n}\n\n/**\n * Prevent `sub` and `sup` elements from affecting the line height in\n * all browsers.\n */\n\nsub,\nsup {\n font-size: 75%;\n line-height: 0;\n position: relative;\n vertical-align: baseline;\n}\n\nsub {\n bottom: -0.25em;\n}\n\nsup {\n top: -0.5em;\n}\n\n/* Embedded content\n ========================================================================== */\n\n/**\n * Remove the border on images inside links in IE 10.\n */\n\nimg {\n border-style: none;\n}\n\n/* Forms\n ========================================================================== */\n\n/**\n * 1. Change the font styles in all browsers.\n * 2. Remove the margin in Firefox and Safari.\n */\n\nbutton,\ninput,\noptgroup,\nselect,\ntextarea {\n font-family: inherit; /* 1 */\n font-size: 100%; /* 1 */\n line-height: 1.15; /* 1 */\n margin: 0; /* 2 */\n}\n\n/**\n * Show the overflow in IE.\n * 1. Show the overflow in Edge.\n */\n\nbutton,\ninput { /* 1 */\n overflow: visible;\n}\n\n/**\n * Remove the inheritance of text transform in Edge, Firefox, and IE.\n * 1. Remove the inheritance of text transform in Firefox.\n */\n\nbutton,\nselect { /* 1 */\n text-transform: none;\n}\n\n/**\n * Correct the inability to style clickable types in iOS and Safari.\n */\n\nbutton,\n[type=\"button\"],\n[type=\"reset\"],\n[type=\"submit\"] {\n -webkit-appearance: button;\n}\n\n/**\n * Remove the inner border and padding in Firefox.\n */\n\nbutton::-moz-focus-inner,\n[type=\"button\"]::-moz-focus-inner,\n[type=\"reset\"]::-moz-focus-inner,\n[type=\"submit\"]::-moz-focus-inner {\n border-style: none;\n padding: 0;\n}\n\n/**\n * Restore the focus styles unset by the previous rule.\n */\n\nbutton:-moz-focusring,\n[type=\"button\"]:-moz-focusring,\n[type=\"reset\"]:-moz-focusring,\n[type=\"submit\"]:-moz-focusring {\n outline: 1px dotted ButtonText;\n}\n\n/**\n * Correct the padding in Firefox.\n */\n\nfieldset {\n padding: 0.35em 0.75em 0.625em;\n}\n\n/**\n * 1. Correct the text wrapping in Edge and IE.\n * 2. Correct the color inheritance from `fieldset` elements in IE.\n * 3. Remove the padding so developers are not caught out when they zero out\n * `fieldset` elements in all browsers.\n */\n\nlegend {\n box-sizing: border-box; /* 1 */\n color: inherit; /* 2 */\n display: table; /* 1 */\n max-width: 100%; /* 1 */\n padding: 0; /* 3 */\n white-space: normal; /* 1 */\n}\n\n/**\n * Add the correct vertical alignment in Chrome, Firefox, and Opera.\n */\n\nprogress {\n vertical-align: baseline;\n}\n\n/**\n * Remove the default vertical scrollbar in IE 10+.\n */\n\ntextarea {\n overflow: auto;\n}\n\n/**\n * 1. Add the correct box sizing in IE 10.\n * 2. Remove the padding in IE 10.\n */\n\n[type=\"checkbox\"],\n[type=\"radio\"] {\n box-sizing: border-box; /* 1 */\n padding: 0; /* 2 */\n}\n\n/**\n * Correct the cursor style of increment and decrement buttons in Chrome.\n */\n\n[type=\"number\"]::-webkit-inner-spin-button,\n[type=\"number\"]::-webkit-outer-spin-button {\n height: auto;\n}\n\n/**\n * 1. Correct the odd appearance in Chrome and Safari.\n * 2. Correct the outline style in Safari.\n */\n\n[type=\"search\"] {\n -webkit-appearance: textfield; /* 1 */\n outline-offset: -2px; /* 2 */\n}\n\n/**\n * Remove the inner padding in Chrome and Safari on macOS.\n */\n\n[type=\"search\"]::-webkit-search-decoration {\n -webkit-appearance: none;\n}\n\n/**\n * 1. Correct the inability to style clickable types in iOS and Safari.\n * 2. Change font properties to `inherit` in Safari.\n */\n\n::-webkit-file-upload-button {\n -webkit-appearance: button; /* 1 */\n font: inherit; /* 2 */\n}\n\n/* Interactive\n ========================================================================== */\n\n/*\n * Add the correct display in Edge, IE 10+, and Firefox.\n */\n\ndetails {\n display: block;\n}\n\n/*\n * Add the correct display in all browsers.\n */\n\nsummary {\n display: list-item;\n}\n\n/* Misc\n ========================================================================== */\n\n/**\n * Add the correct display in IE 10+.\n */\n\ntemplate {\n display: none;\n}\n\n/**\n * Add the correct display in IE 10.\n */\n\n[hidden] {\n display: none;\n}\n","// This file contains styles for managing print media.\n\n////////////////////////////////////////////////////////////////////////////////\n// Hide elements not relevant to print media.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n // Hide icon container.\n .content-icon-container\n display: none !important\n\n // Hide showing header links if hovering over when printing.\n .headerlink\n display: none !important\n\n // Hide mobile header.\n .mobile-header\n display: none !important\n\n // Hide navigation links.\n .related-pages\n display: none !important\n\n////////////////////////////////////////////////////////////////////////////////\n// Tweaks related to decolorization.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n // Apply a border around code which no longer have a color background.\n .highlight\n border: 0.1pt solid var(--color-foreground-border)\n\n////////////////////////////////////////////////////////////////////////////////\n// Avoid page break in some relevant cases.\n////////////////////////////////////////////////////////////////////////////////\n@media print\n ul, ol, dl, a, table, pre, blockquote\n page-break-inside: avoid\n\n h1, h2, h3, h4, h5, h6, img, figure, caption\n page-break-inside: avoid\n page-break-after: avoid\n\n ul, ol, dl\n page-break-before: avoid\n",".visually-hidden\n position: absolute !important\n width: 1px !important\n height: 1px !important\n padding: 0 !important\n margin: -1px !important\n overflow: hidden !important\n clip: rect(0,0,0,0) !important\n white-space: nowrap !important\n border: 0 !important\n\n:-moz-focusring\n outline: auto\n","// This file serves as the \"skeleton\" of the theming logic.\n//\n// This contains the bulk of the logic for handling dark mode, color scheme\n// toggling and the handling of color-scheme-specific hiding of elements.\n\nbody\n @include fonts\n @include spacing\n @include icons\n @include admonitions\n @include default-admonition(#651fff, \"abstract\")\n @include default-topic(#14B8A6, \"pencil\")\n\n @include colors\n\n.only-light\n display: block !important\nhtml body .only-dark\n display: none !important\n\n// Ignore dark-mode hints if print media.\n@media not print\n // Enable dark-mode, if requested.\n body[data-theme=\"dark\"]\n @include colors-dark\n\n html & .only-light\n display: none !important\n .only-dark\n display: block !important\n\n // Enable dark mode, unless explicitly told to avoid.\n @media (prefers-color-scheme: dark)\n body:not([data-theme=\"light\"])\n @include colors-dark\n\n html & .only-light\n display: none !important\n .only-dark\n display: block !important\n\n//\n// Theme toggle presentation\n//\nbody[data-theme=\"auto\"]\n .theme-toggle svg.theme-icon-when-auto\n display: block\n\nbody[data-theme=\"dark\"]\n .theme-toggle svg.theme-icon-when-dark\n display: block\n\nbody[data-theme=\"light\"]\n .theme-toggle svg.theme-icon-when-light\n display: block\n","// Fonts used by this theme.\n//\n// There are basically two things here -- using the system font stack and\n// defining sizes for various elements in %ages. We could have also used `em`\n// but %age is easier to reason about for me.\n\n@mixin fonts {\n // These are adapted from https://systemfontstack.com/\n --font-stack: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial,\n sans-serif, Apple Color Emoji, Segoe UI Emoji;\n --font-stack--monospace: \"SFMono-Regular\", Menlo, Consolas, Monaco,\n Liberation Mono, Lucida Console, monospace;\n\n --font-size--normal: 100%;\n --font-size--small: 87.5%;\n --font-size--small--2: 81.25%;\n --font-size--small--3: 75%;\n --font-size--small--4: 62.5%;\n\n // Sidebar\n --sidebar-caption-font-size: var(--font-size--small--2);\n --sidebar-item-font-size: var(--font-size--small);\n --sidebar-search-input-font-size: var(--font-size--small);\n\n // Table of Contents\n --toc-font-size: var(--font-size--small--3);\n --toc-font-size--mobile: var(--font-size--normal);\n --toc-title-font-size: var(--font-size--small--4);\n\n // Admonitions\n //\n // These aren't defined in terms of %ages, since nesting these is permitted.\n --admonition-font-size: 0.8125rem;\n --admonition-title-font-size: 0.8125rem;\n\n // Code\n --code-font-size: var(--font-size--small--2);\n\n // API\n --api-font-size: var(--font-size--small);\n}\n","// Spacing for various elements on the page\n//\n// If the user wants to tweak things in a certain way, they are permitted to.\n// They also have to deal with the consequences though!\n\n@mixin spacing {\n // Header!\n --header-height: calc(\n var(--sidebar-item-line-height) + 4 * #{var(--sidebar-item-spacing-vertical)}\n );\n --header-padding: 0.5rem;\n\n // Sidebar\n --sidebar-tree-space-above: 1.5rem;\n --sidebar-caption-space-above: 1rem;\n\n --sidebar-item-line-height: 1rem;\n --sidebar-item-spacing-vertical: 0.5rem;\n --sidebar-item-spacing-horizontal: 1rem;\n --sidebar-item-height: calc(\n var(--sidebar-item-line-height) + 2 *#{var(--sidebar-item-spacing-vertical)}\n );\n\n --sidebar-expander-width: var(--sidebar-item-height); // be square\n\n --sidebar-search-space-above: 0.5rem;\n --sidebar-search-input-spacing-vertical: 0.5rem;\n --sidebar-search-input-spacing-horizontal: 0.5rem;\n --sidebar-search-input-height: 1rem;\n --sidebar-search-icon-size: var(--sidebar-search-input-height);\n\n // Table of Contents\n --toc-title-padding: 0.25rem 0;\n --toc-spacing-vertical: 1.5rem;\n --toc-spacing-horizontal: 1.5rem;\n --toc-item-spacing-vertical: 0.4rem;\n --toc-item-spacing-horizontal: 1rem;\n}\n","// Expose theme icons as CSS variables.\n\n$icons: (\n // Adapted from tabler-icons\n // url: https://tablericons.com/\n \"search\":\n url('data:image/svg+xml;charset=utf-8,'),\n // Factored out from mkdocs-material on 24-Aug-2020.\n // url: https://squidfunk.github.io/mkdocs-material/reference/admonitions/\n \"pencil\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"abstract\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"info\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"flame\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"question\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"warning\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"failure\":\n url('data:image/svg+xml;charset=utf-8,'),\n \"spark\":\n url('data:image/svg+xml;charset=utf-8,')\n);\n\n@mixin icons {\n @each $name, $glyph in $icons {\n --icon-#{$name}: #{$glyph};\n }\n}\n","// Admonitions\n\n// Structure of these is:\n// admonition-class: color \"icon-name\";\n//\n// The colors are translated into CSS variables below. The icons are\n// used directly in the main declarations to set the `mask-image` in\n// the title.\n\n// prettier-ignore\n$admonitions: (\n // Each of these has an reST directives for it.\n \"caution\": #ff9100 \"spark\",\n \"warning\": #ff9100 \"warning\",\n \"danger\": #ff5252 \"spark\",\n \"attention\": #ff5252 \"warning\",\n \"error\": #ff5252 \"failure\",\n \"hint\": #00c852 \"question\",\n \"tip\": #00c852 \"info\",\n \"important\": #00bfa5 \"flame\",\n \"note\": #00b0ff \"pencil\",\n \"seealso\": #448aff \"info\",\n \"admonition-todo\": #808080 \"pencil\"\n);\n\n@mixin default-admonition($color, $icon-name) {\n --color-admonition-title: #{$color};\n --color-admonition-title-background: #{rgba($color, 0.2)};\n\n --icon-admonition-default: var(--icon-#{$icon-name});\n}\n\n@mixin default-topic($color, $icon-name) {\n --color-topic-title: #{$color};\n --color-topic-title-background: #{rgba($color, 0.2)};\n\n --icon-topic-default: var(--icon-#{$icon-name});\n}\n\n@mixin admonitions {\n @each $name, $values in $admonitions {\n --color-admonition-title--#{$name}: #{nth($values, 1)};\n --color-admonition-title-background--#{$name}: #{rgba(\n nth($values, 1),\n 0.2\n )};\n }\n}\n","// Colors used throughout this theme.\n//\n// The aim is to give the user more control. Thus, instead of hard-coding colors\n// in various parts of the stylesheet, the approach taken is to define all\n// colors as CSS variables and reusing them in all the places.\n//\n// `colors-dark` depends on `colors` being included at a lower specificity.\n\n@mixin colors {\n --color-problematic: #b30000;\n\n // Base Colors\n --color-foreground-primary: black; // for main text and headings\n --color-foreground-secondary: #5a5c63; // for secondary text\n --color-foreground-muted: #646776; // for muted text\n --color-foreground-border: #878787; // for content borders\n\n --color-background-primary: white; // for content\n --color-background-secondary: #f8f9fb; // for navigation + ToC\n --color-background-hover: #efeff4ff; // for navigation-item hover\n --color-background-hover--transparent: #efeff400;\n --color-background-border: #eeebee; // for UI borders\n --color-background-item: #ccc; // for \"background\" items (eg: copybutton)\n\n // Announcements\n --color-announcement-background: #000000dd;\n --color-announcement-text: #eeebee;\n\n // Brand colors\n --color-brand-primary: #2962ff;\n --color-brand-content: #2a5adf;\n\n // API documentation\n --color-api-background: var(--color-background-hover--transparent);\n --color-api-background-hover: var(--color-background-hover);\n --color-api-overall: var(--color-foreground-secondary);\n --color-api-name: var(--color-problematic);\n --color-api-pre-name: var(--color-problematic);\n --color-api-paren: var(--color-foreground-secondary);\n --color-api-keyword: var(--color-foreground-primary);\n --color-highlight-on-target: #ffffcc;\n\n // Inline code background\n --color-inline-code-background: var(--color-background-secondary);\n\n // Highlighted text (search)\n --color-highlighted-background: #ddeeff;\n --color-highlighted-text: var(--color-foreground-primary);\n\n // GUI Labels\n --color-guilabel-background: #ddeeff80;\n --color-guilabel-border: #bedaf580;\n --color-guilabel-text: var(--color-foreground-primary);\n\n // Admonitions!\n --color-admonition-background: transparent;\n\n //////////////////////////////////////////////////////////////////////////////\n // Everything below this should be one of:\n // - var(...)\n // - *-gradient(...)\n // - special literal values (eg: transparent, none)\n //////////////////////////////////////////////////////////////////////////////\n\n // Tables\n --color-table-header-background: var(--color-background-secondary);\n --color-table-border: var(--color-background-border);\n\n // Cards\n --color-card-border: var(--color-background-secondary);\n --color-card-background: transparent;\n --color-card-marginals-background: var(--color-background-secondary);\n\n // Header\n --color-header-background: var(--color-background-primary);\n --color-header-border: var(--color-background-border);\n --color-header-text: var(--color-foreground-primary);\n\n // Sidebar (left)\n --color-sidebar-background: var(--color-background-secondary);\n --color-sidebar-background-border: var(--color-background-border);\n\n --color-sidebar-brand-text: var(--color-foreground-primary);\n --color-sidebar-caption-text: var(--color-foreground-muted);\n --color-sidebar-link-text: var(--color-foreground-secondary);\n --color-sidebar-link-text--top-level: var(--color-brand-primary);\n\n --color-sidebar-item-background: var(--color-sidebar-background);\n --color-sidebar-item-background--current: var(\n --color-sidebar-item-background\n );\n --color-sidebar-item-background--hover: linear-gradient(\n 90deg,\n var(--color-background-hover--transparent) 0%,\n var(--color-background-hover) var(--sidebar-item-spacing-horizontal),\n var(--color-background-hover) 100%\n );\n\n --color-sidebar-item-expander-background: transparent;\n --color-sidebar-item-expander-background--hover: var(\n --color-background-hover\n );\n\n --color-sidebar-search-text: var(--color-foreground-primary);\n --color-sidebar-search-background: var(--color-background-secondary);\n --color-sidebar-search-background--focus: var(--color-background-primary);\n --color-sidebar-search-border: var(--color-background-border);\n --color-sidebar-search-icon: var(--color-foreground-muted);\n\n // Table of Contents (right)\n --color-toc-background: var(--color-background-primary);\n --color-toc-title-text: var(--color-foreground-muted);\n --color-toc-item-text: var(--color-foreground-secondary);\n --color-toc-item-text--hover: var(--color-foreground-primary);\n --color-toc-item-text--active: var(--color-brand-primary);\n\n // Actual page contents\n --color-content-foreground: var(--color-foreground-primary);\n --color-content-background: transparent;\n\n // Links\n --color-link: var(--color-brand-content);\n --color-link--hover: var(--color-brand-content);\n --color-link-underline: var(--color-background-border);\n --color-link-underline--hover: var(--color-foreground-border);\n}\n\n@mixin colors-dark {\n --color-problematic: #ee5151;\n\n // Base Colors\n --color-foreground-primary: #ffffffcc; // for main text and headings\n --color-foreground-secondary: #9ca0a5; // for secondary text\n --color-foreground-muted: #81868d; // for muted text\n --color-foreground-border: #666666; // for content borders\n\n --color-background-primary: #131416; // for content\n --color-background-secondary: #1a1c1e; // for navigation + ToC\n --color-background-hover: #1e2124ff; // for navigation-item hover\n --color-background-hover--transparent: #1e212400;\n --color-background-border: #303335; // for UI borders\n --color-background-item: #444; // for \"background\" items (eg: copybutton)\n\n // Announcements\n --color-announcement-background: #000000dd;\n --color-announcement-text: #eeebee;\n\n // Brand colors\n --color-brand-primary: #2b8cee;\n --color-brand-content: #368ce2;\n\n // Highlighted text (search)\n --color-highlighted-background: #083563;\n\n // GUI Labels\n --color-guilabel-background: #08356380;\n --color-guilabel-border: #13395f80;\n\n // API documentation\n --color-api-keyword: var(--color-foreground-secondary);\n --color-highlight-on-target: #333300;\n\n // Admonitions\n --color-admonition-background: #18181a;\n\n // Cards\n --color-card-border: var(--color-background-secondary);\n --color-card-background: #18181a;\n --color-card-marginals-background: var(--color-background-hover);\n}\n","// This file contains the styling for making the content throughout the page,\n// including fonts, paragraphs, headings and spacing among these elements.\n\nbody\n font-family: var(--font-stack)\npre,\ncode,\nkbd,\nsamp\n font-family: var(--font-stack--monospace)\n\n// Make fonts look slightly nicer.\nbody\n -webkit-font-smoothing: antialiased\n -moz-osx-font-smoothing: grayscale\n\n// Line height from Bootstrap 4.1\narticle\n line-height: 1.5\n\n//\n// Headings\n//\nh1,\nh2,\nh3,\nh4,\nh5,\nh6\n line-height: 1.25\n font-weight: bold\n\n border-radius: 0.5rem\n margin-top: 0.5rem\n margin-bottom: 0.5rem\n margin-left: -0.5rem\n margin-right: -0.5rem\n padding-left: 0.5rem\n padding-right: 0.5rem\n\n + p\n margin-top: 0\n\nh1\n font-size: 2.5em\n margin-top: 1.75rem\n margin-bottom: 1rem\nh2\n font-size: 2em\n margin-top: 1.75rem\nh3\n font-size: 1.5em\nh4\n font-size: 1.25em\nh5\n font-size: 1.125em\nh6\n font-size: 1em\n\nsmall\n opacity: 75%\n font-size: 80%\n\n// Paragraph\np\n margin-top: 0.5rem\n margin-bottom: 0.75rem\n\n// Horizontal rules\nhr.docutils\n height: 1px\n padding: 0\n margin: 2rem 0\n background-color: var(--color-background-border)\n border: 0\n\n.centered\n text-align: center\n\n// Links\na\n text-decoration: underline\n\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline)\n\n &:hover\n color: var(--color-link--hover)\n text-decoration-color: var(--color-link-underline--hover)\n &.muted-link\n color: inherit\n &:hover\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline--hover)\n","// This file contains the styles for the overall layouting of the documentation\n// skeleton, including the responsive changes as well as sidebar toggles.\n//\n// This is implemented as a mobile-last design, which isn't ideal, but it is\n// reasonably good-enough and I got pretty tired by the time I'd finished this\n// to move the rules around to fix this. Shouldn't take more than 3-4 hours,\n// if you know what you're doing tho.\n\n// HACK: Not all browsers account for the scrollbar width in media queries.\n// This results in horizontal scrollbars in the breakpoint where we go\n// from displaying everything to hiding the ToC. We accomodate for this by\n// adding a bit of padding to the TOC drawer, disabling the horizontal\n// scrollbar and allowing the scrollbars to cover the padding.\n// https://www.456bereastreet.com/archive/201301/media_query_width_and_vertical_scrollbars/\n\n// HACK: Always having the scrollbar visible, prevents certain browsers from\n// causing the content to stutter horizontally between taller-than-viewport and\n// not-taller-than-viewport pages.\n\nhtml\n overflow-x: hidden\n overflow-y: scroll\n scroll-behavior: smooth\n\n.sidebar-scroll, .toc-scroll, article[role=main] *\n // Override Firefox scrollbar style\n scrollbar-width: thin\n scrollbar-color: var(--color-foreground-border) transparent\n\n // Override Chrome scrollbar styles\n &::-webkit-scrollbar\n width: 0.25rem\n height: 0.25rem\n &::-webkit-scrollbar-thumb\n background-color: var(--color-foreground-border)\n border-radius: 0.125rem\n\n//\n// Overalls\n//\nhtml,\nbody\n height: 100%\n color: var(--color-foreground-primary)\n background: var(--color-background-primary)\n\narticle\n color: var(--color-content-foreground)\n background: var(--color-content-background)\n overflow-wrap: break-word\n\n.page\n display: flex\n // fill the viewport for pages with little content.\n min-height: 100%\n\n.mobile-header\n width: 100%\n height: var(--header-height)\n background-color: var(--color-header-background)\n color: var(--color-header-text)\n border-bottom: 1px solid var(--color-header-border)\n\n // Looks like sub-script/super-script have this, and we need this to\n // be \"on top\" of those.\n z-index: 10\n\n // We don't show the header on large screens.\n display: none\n\n // Add shadow when scrolled\n &.scrolled\n border-bottom: none\n box-shadow: 0 0 0.2rem rgba(0, 0, 0, 0.1), 0 0.2rem 0.4rem rgba(0, 0, 0, 0.2)\n\n .header-center\n a\n color: var(--color-header-text)\n text-decoration: none\n\n.main\n display: flex\n flex: 1\n\n// Sidebar (left) also covers the entire left portion of screen.\n.sidebar-drawer\n box-sizing: border-box\n\n border-right: 1px solid var(--color-sidebar-background-border)\n background: var(--color-sidebar-background)\n\n display: flex\n justify-content: flex-end\n // These next two lines took me two days to figure out.\n width: calc((100% - #{$full-width}) / 2 + #{$sidebar-width})\n min-width: $sidebar-width\n\n// Scroll-along sidebars\n.sidebar-container,\n.toc-drawer\n box-sizing: border-box\n width: $sidebar-width\n\n.toc-drawer\n background: var(--color-toc-background)\n // See HACK described on top of this document\n padding-right: 1rem\n\n.sidebar-sticky,\n.toc-sticky\n position: sticky\n top: 0\n height: min(100%, 100vh)\n height: 100vh\n\n display: flex\n flex-direction: column\n\n.sidebar-scroll,\n.toc-scroll\n flex-grow: 1\n flex-shrink: 1\n\n overflow: auto\n scroll-behavior: smooth\n\n// Central items.\n.content\n padding: 0 $content-padding\n width: $content-width\n\n display: flex\n flex-direction: column\n justify-content: space-between\n\n.icon\n display: inline-block\n height: 1rem\n width: 1rem\n svg\n width: 100%\n height: 100%\n\n//\n// Accommodate announcement banner\n//\n.announcement\n background-color: var(--color-announcement-background)\n color: var(--color-announcement-text)\n\n height: var(--header-height)\n display: flex\n align-items: center\n overflow-x: auto\n & + .page\n min-height: calc(100% - var(--header-height))\n\n.announcement-content\n box-sizing: border-box\n padding: 0.5rem\n min-width: 100%\n white-space: nowrap\n text-align: center\n\n a\n color: var(--color-announcement-text)\n text-decoration-color: var(--color-announcement-text)\n\n &:hover\n color: var(--color-announcement-text)\n text-decoration-color: var(--color-link--hover)\n\n////////////////////////////////////////////////////////////////////////////////\n// Toggles for theme\n////////////////////////////////////////////////////////////////////////////////\n.no-js .theme-toggle-container // don't show theme toggle if there's no JS\n display: none\n\n.theme-toggle-container\n vertical-align: middle\n\n.theme-toggle\n cursor: pointer\n border: none\n padding: 0\n background: transparent\n\n.theme-toggle svg\n vertical-align: middle\n height: 1rem\n width: 1rem\n color: var(--color-foreground-primary)\n display: none\n\n.theme-toggle-header\n float: left\n padding: 1rem 0.5rem\n\n////////////////////////////////////////////////////////////////////////////////\n// Toggles for elements\n////////////////////////////////////////////////////////////////////////////////\n.toc-overlay-icon, .nav-overlay-icon\n display: none\n cursor: pointer\n\n .icon\n color: var(--color-foreground-secondary)\n height: 1rem\n width: 1rem\n\n.toc-header-icon, .nav-overlay-icon\n // for when we set display: flex\n justify-content: center\n align-items: center\n\n.toc-content-icon\n height: 1.5rem\n width: 1.5rem\n\n.content-icon-container\n float: right\n display: flex\n margin-top: 1.5rem\n margin-left: 1rem\n margin-bottom: 1rem\n gap: 0.5rem\n\n .edit-this-page svg\n color: inherit\n height: 1rem\n width: 1rem\n\n.sidebar-toggle\n position: absolute\n display: none\n// \n.sidebar-toggle[name=\"__toc\"]\n left: 20px\n.sidebar-toggle:checked\n left: 40px\n// \n\n.overlay\n position: fixed\n top: 0\n width: 0\n height: 0\n\n transition: width 0ms, height 0ms, opacity 250ms ease-out\n\n opacity: 0\n background-color: rgba(0, 0, 0, 0.54)\n.sidebar-overlay\n z-index: 20\n.toc-overlay\n z-index: 40\n\n// Keep things on top and smooth.\n.sidebar-drawer\n z-index: 30\n transition: left 250ms ease-in-out\n.toc-drawer\n z-index: 50\n transition: right 250ms ease-in-out\n\n// Show the Sidebar\n#__navigation:checked\n & ~ .sidebar-overlay\n width: 100%\n height: 100%\n opacity: 1\n & ~ .page\n .sidebar-drawer\n top: 0\n left: 0\n // Show the toc sidebar\n#__toc:checked\n & ~ .toc-overlay\n width: 100%\n height: 100%\n opacity: 1\n & ~ .page\n .toc-drawer\n top: 0\n right: 0\n\n////////////////////////////////////////////////////////////////////////////////\n// Back to top\n////////////////////////////////////////////////////////////////////////////////\n.back-to-top\n text-decoration: none\n\n display: none\n position: fixed\n left: 0\n top: 1rem\n padding: 0.5rem\n padding-right: 0.75rem\n border-radius: 1rem\n font-size: 0.8125rem\n\n background: var(--color-background-primary)\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), #6b728080 0px 0px 1px 0px\n\n z-index: 10\n\n margin-left: 50%\n transform: translateX(-50%)\n svg\n height: 1rem\n width: 1rem\n fill: currentColor\n display: inline-block\n\n span\n margin-left: 0.25rem\n\n .show-back-to-top &\n display: flex\n align-items: center\n\n////////////////////////////////////////////////////////////////////////////////\n// Responsive layouting\n////////////////////////////////////////////////////////////////////////////////\n// Make things a bit bigger on bigger screens.\n@media (min-width: $full-width + $sidebar-width)\n html\n font-size: 110%\n\n@media (max-width: $full-width)\n // Collapse \"toc\" into the icon.\n .toc-content-icon\n display: flex\n .toc-drawer\n position: fixed\n height: 100vh\n top: 0\n right: -$sidebar-width\n border-left: 1px solid var(--color-background-muted)\n .toc-tree\n border-left: none\n font-size: var(--toc-font-size--mobile)\n\n // Accomodate for a changed content width.\n .sidebar-drawer\n width: calc((100% - #{$full-width - $sidebar-width}) / 2 + #{$sidebar-width})\n\n@media (max-width: $full-width - $sidebar-width)\n // Collapse \"navigation\".\n .nav-overlay-icon\n display: flex\n .sidebar-drawer\n position: fixed\n height: 100vh\n width: $sidebar-width\n\n top: 0\n left: -$sidebar-width\n\n // Swap which icon is visible.\n .toc-header-icon\n display: flex\n .toc-content-icon, .theme-toggle-content\n display: none\n .theme-toggle-header\n display: block\n\n // Show the header.\n .mobile-header\n position: sticky\n top: 0\n display: flex\n justify-content: space-between\n align-items: center\n\n .header-left,\n .header-right\n display: flex\n height: var(--header-height)\n padding: 0 var(--header-padding)\n label\n height: 100%\n width: 100%\n user-select: none\n\n .nav-overlay-icon .icon,\n .theme-toggle svg\n height: 1.25rem\n width: 1.25rem\n\n // Add a scroll margin for the content\n :target\n scroll-margin-top: var(--header-height)\n\n // Show back-to-top below the header\n .back-to-top\n top: calc(var(--header-height) + 0.5rem)\n\n // Center the page, and accommodate for the header.\n .page\n flex-direction: column\n justify-content: center\n .content\n margin-left: auto\n margin-right: auto\n\n@media (max-width: $content-width + 2* $content-padding)\n // Content should respect window limits.\n .content\n width: 100%\n overflow-x: auto\n\n@media (max-width: $content-width)\n .content\n padding: 0 $content-padding--small\n // Don't float sidebars to the right.\n article aside.sidebar\n float: none\n width: 100%\n margin: 1rem 0\n","//\n// The design here is strongly inspired by mkdocs-material.\n.admonition, .topic\n margin: 1rem auto\n padding: 0 0.5rem 0.5rem 0.5rem\n\n background: var(--color-admonition-background)\n\n border-radius: 0.2rem\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n font-size: var(--admonition-font-size)\n\n overflow: hidden\n page-break-inside: avoid\n\n // First element should have no margin, since the title has it.\n > :nth-child(2)\n margin-top: 0\n\n // Last item should have no margin, since we'll control that w/ padding\n > :last-child\n margin-bottom: 0\n\n.admonition p.admonition-title,\np.topic-title\n position: relative\n margin: 0 -0.5rem 0.5rem\n padding-left: 2rem\n padding-right: .5rem\n padding-top: .4rem\n padding-bottom: .4rem\n\n font-weight: 500\n font-size: var(--admonition-title-font-size)\n line-height: 1.3\n\n // Our fancy icon\n &::before\n content: \"\"\n position: absolute\n left: 0.5rem\n width: 1rem\n height: 1rem\n\n// Default styles\np.admonition-title\n background-color: var(--color-admonition-title-background)\n &::before\n background-color: var(--color-admonition-title)\n mask-image: var(--icon-admonition-default)\n mask-repeat: no-repeat\n\np.topic-title\n background-color: var(--color-topic-title-background)\n &::before\n background-color: var(--color-topic-title)\n mask-image: var(--icon-topic-default)\n mask-repeat: no-repeat\n\n//\n// Variants\n//\n.admonition\n border-left: 0.2rem solid var(--color-admonition-title)\n\n @each $type, $value in $admonitions\n &.#{$type}\n border-left-color: var(--color-admonition-title--#{$type})\n > .admonition-title\n background-color: var(--color-admonition-title-background--#{$type})\n &::before\n background-color: var(--color-admonition-title--#{$type})\n mask-image: var(--icon-#{nth($value, 2)})\n\n.admonition-todo > .admonition-title\n text-transform: uppercase\n","// This file stylizes the API documentation (stuff generated by autodoc). It's\n// deeply nested due to how autodoc structures the HTML without enough classes\n// to select the relevant items.\n\n// API docs!\ndl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)\n // Tweak the spacing of all the things!\n dd\n margin-left: 2rem\n > :first-child\n margin-top: 0.125rem\n > :last-child\n margin-bottom: 0.75rem\n\n // This is used for the arguments\n .field-list\n margin-bottom: 0.75rem\n\n // \"Headings\" (like \"Parameters\" and \"Return\")\n > dt\n text-transform: uppercase\n font-size: var(--font-size--small)\n\n dd:empty\n margin-bottom: 0.5rem\n dd > ul\n margin-left: -1.2rem\n > li\n > p:nth-child(2)\n margin-top: 0\n // When the last-empty-paragraph follows a paragraph, it doesn't need\n // to augument the existing spacing.\n > p + p:last-child:empty\n margin-top: 0\n margin-bottom: 0\n\n // Colorize the elements\n > dt\n color: var(--color-api-overall)\n\n.sig:not(.sig-inline)\n font-weight: bold\n\n font-size: var(--api-font-size)\n font-family: var(--font-stack--monospace)\n\n margin-left: -0.25rem\n margin-right: -0.25rem\n padding-top: 0.25rem\n padding-bottom: 0.25rem\n padding-right: 0.5rem\n\n // These are intentionally em, to properly match the font size.\n padding-left: 3em\n text-indent: -2.5em\n\n border-radius: 0.25rem\n\n background: var(--color-api-background)\n transition: background 100ms ease-out\n\n &:hover\n background: var(--color-api-background-hover)\n\n // adjust the size of the [source] link on the right.\n a.reference\n .viewcode-link\n font-weight: normal\n width: 3.5rem\n\nem.property\n font-style: normal\n &:first-child\n color: var(--color-api-keyword)\n.sig-name\n color: var(--color-api-name)\n.sig-prename\n font-weight: normal\n color: var(--color-api-pre-name)\n.sig-paren\n color: var(--color-api-paren)\n.sig-param\n font-style: normal\n\n.versionmodified\n font-style: italic\ndiv.versionadded, div.versionchanged, div.deprecated\n p\n margin-top: 0.125rem\n margin-bottom: 0.125rem\n\n// Align the [docs] and [source] to the right.\n.viewcode-link, .viewcode-back\n float: right\n text-align: right\n",".line-block\n margin-top: 0.5rem\n margin-bottom: 0.75rem\n .line-block\n margin-top: 0rem\n margin-bottom: 0rem\n padding-left: 1rem\n","// Captions\narticle p.caption,\ntable > caption,\n.code-block-caption\n font-size: var(--font-size--small)\n text-align: center\n\n// Caption above a TOCTree\n.toctree-wrapper.compound\n .caption, :not(.caption) > .caption-text\n font-size: var(--font-size--small)\n text-transform: uppercase\n\n text-align: initial\n margin-bottom: 0\n\n > ul\n margin-top: 0\n margin-bottom: 0\n","// Inline code\ncode.literal, .sig-inline\n background: var(--color-inline-code-background)\n border-radius: 0.2em\n // Make the font smaller, and use padding to recover.\n font-size: var(--font-size--small--2)\n padding: 0.1em 0.2em\n\n pre.literal-block &\n font-size: inherit\n padding: 0\n\n p &\n border: 1px solid var(--color-background-border)\n\n.sig-inline\n font-family: var(--font-stack--monospace)\n\n// Code and Literal Blocks\n$code-spacing-vertical: 0.625rem\n$code-spacing-horizontal: 0.875rem\n\n// Wraps every literal block + line numbers.\ndiv[class*=\" highlight-\"],\ndiv[class^=\"highlight-\"]\n margin: 1em 0\n display: flex\n\n .table-wrapper\n margin: 0\n padding: 0\n\npre\n margin: 0\n padding: 0\n overflow: auto\n\n // Needed to have more specificity than pygments' \"pre\" selector. :(\n article[role=\"main\"] .highlight &\n line-height: 1.5\n\n &.literal-block,\n .highlight &\n font-size: var(--code-font-size)\n padding: $code-spacing-vertical $code-spacing-horizontal\n\n // Make it look like all the other blocks.\n &.literal-block\n margin-top: 1rem\n margin-bottom: 1rem\n\n border-radius: 0.2rem\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n\n// All code is always contained in this.\n.highlight\n width: 100%\n border-radius: 0.2rem\n\n // Make line numbers and prompts un-selectable.\n .gp, span.linenos\n user-select: none\n pointer-events: none\n\n // Expand the line-highlighting.\n .hll\n display: block\n margin-left: -$code-spacing-horizontal\n margin-right: -$code-spacing-horizontal\n padding-left: $code-spacing-horizontal\n padding-right: $code-spacing-horizontal\n\n/* Make code block captions be nicely integrated */\n.code-block-caption\n display: flex\n padding: $code-spacing-vertical $code-spacing-horizontal\n\n border-radius: 0.25rem\n border-bottom-left-radius: 0\n border-bottom-right-radius: 0\n font-weight: 300\n border-bottom: 1px solid\n\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n border-color: var(--color-background-border)\n\n + div[class]\n margin-top: 0\n pre\n border-top-left-radius: 0\n border-top-right-radius: 0\n\n// When `html_codeblock_linenos_style` is table.\n.highlighttable\n width: 100%\n display: block\n tbody\n display: block\n\n tr\n display: flex\n\n // Line numbers\n td.linenos\n background-color: var(--color-code-background)\n color: var(--color-code-foreground)\n padding: $code-spacing-vertical $code-spacing-horizontal\n padding-right: 0\n border-top-left-radius: 0.2rem\n border-bottom-left-radius: 0.2rem\n\n .linenodiv\n padding-right: $code-spacing-horizontal\n font-size: var(--code-font-size)\n box-shadow: -0.0625rem 0 var(--color-foreground-border) inset\n\n // Actual code\n td.code\n padding: 0\n display: block\n flex: 1\n overflow: hidden\n\n .highlight\n border-top-left-radius: 0\n border-bottom-left-radius: 0\n\n// When `html_codeblock_linenos_style` is inline.\n.highlight\n span.linenos\n display: inline-block\n padding-left: 0\n padding-right: $code-spacing-horizontal\n margin-right: $code-spacing-horizontal\n box-shadow: -0.0625rem 0 var(--color-foreground-border) inset\n","// Inline Footnote Reference\n.footnote-reference\n font-size: var(--font-size--small--4)\n vertical-align: super\n\n// Definition list, listing the content of each note.\n// docutils <= 0.17\ndl.footnote.brackets\n font-size: var(--font-size--small)\n color: var(--color-foreground-secondary)\n\n display: grid\n grid-template-columns: max-content auto\n dt\n margin: 0\n > .fn-backref\n margin-left: 0.25rem\n\n &:after\n content: \":\"\n\n .brackets\n &:before\n content: \"[\"\n &:after\n content: \"]\"\n\n dd\n margin: 0\n padding: 0 1rem\n\n// docutils >= 0.18\naside.footnote\n font-size: var(--font-size--small)\n color: var(--color-foreground-secondary)\n\naside.footnote > span,\ndiv.citation > span\n float: left\n font-weight: 500\n padding-right: 0.25rem\n\naside.footnote > p,\ndiv.citation > p\n margin-left: 2rem\n","//\n// Figures\n//\nimg\n box-sizing: border-box\n max-width: 100%\n height: auto\n\narticle\n figure, .figure\n border-radius: 0.2rem\n\n margin: 0\n :last-child\n margin-bottom: 0\n\n .align-left\n float: left\n clear: left\n margin: 0 1rem 1rem\n\n .align-right\n float: right\n clear: right\n margin: 0 1rem 1rem\n\n .align-default,\n .align-center\n display: block\n text-align: center\n margin-left: auto\n margin-right: auto\n\n // WELL, table needs to be stylised like a table.\n table.align-default\n display: table\n text-align: initial\n",".genindex-jumpbox, .domainindex-jumpbox\n border-top: 1px solid var(--color-background-border)\n border-bottom: 1px solid var(--color-background-border)\n padding: 0.25rem\n\n.genindex-section, .domainindex-section\n h2\n margin-top: 0.75rem\n margin-bottom: 0.5rem\n ul\n margin-top: 0\n margin-bottom: 0\n","ul,\nol\n padding-left: 1.2rem\n\n // Space lists out like paragraphs\n margin-top: 1rem\n margin-bottom: 1rem\n // reduce margins within li.\n li\n > p:first-child\n margin-top: 0.25rem\n margin-bottom: 0.25rem\n\n > p:last-child\n margin-top: 0.25rem\n\n > ul,\n > ol\n margin-top: 0.5rem\n margin-bottom: 0.5rem\n\nol\n &.arabic\n list-style: decimal\n &.loweralpha\n list-style: lower-alpha\n &.upperalpha\n list-style: upper-alpha\n &.lowerroman\n list-style: lower-roman\n &.upperroman\n list-style: upper-roman\n\n// Don't space lists out when they're \"simple\" or in a `.. toctree::`\n.simple,\n.toctree-wrapper\n li\n > ul,\n > ol\n margin-top: 0\n margin-bottom: 0\n\n// Definition Lists\n.field-list,\n.option-list,\ndl:not([class]),\ndl.simple,\ndl.footnote,\ndl.glossary\n dt\n font-weight: 500\n margin-top: 0.25rem\n + dt\n margin-top: 0\n\n .classifier::before\n content: \":\"\n margin-left: 0.2rem\n margin-right: 0.2rem\n\n dd\n > p:first-child,\n ul\n margin-top: 0.125rem\n\n ul\n margin-bottom: 0.125rem\n",".math-wrapper\n width: 100%\n overflow-x: auto\n\ndiv.math\n position: relative\n text-align: center\n\n .headerlink,\n &:focus .headerlink\n display: none\n\n &:hover .headerlink\n display: inline-block\n\n span.eqno\n position: absolute\n right: 0.5rem\n top: 50%\n transform: translate(0, -50%)\n z-index: 1\n","// Abbreviations\nabbr[title]\n cursor: help\n\n// \"Problematic\" content, as identified by Sphinx\n.problematic\n color: var(--color-problematic)\n\n// Keyboard / Mouse \"instructions\"\nkbd:not(.compound)\n margin: 0 0.2rem\n padding: 0 0.2rem\n border-radius: 0.2rem\n border: 1px solid var(--color-foreground-border)\n color: var(--color-foreground-primary)\n vertical-align: text-bottom\n\n font-size: var(--font-size--small--3)\n display: inline-block\n\n box-shadow: 0 0.0625rem 0 rgba(0, 0, 0, 0.2), inset 0 0 0 0.125rem var(--color-background-primary)\n\n background-color: var(--color-background-secondary)\n\n// Blockquote\nblockquote\n border-left: 4px solid var(--color-background-border)\n background: var(--color-background-secondary)\n\n margin-left: 0\n margin-right: 0\n padding: 0.5rem 1rem\n\n .attribution\n font-weight: 600\n text-align: right\n\n &.pull-quote,\n &.highlights\n font-size: 1.25em\n\n &.epigraph,\n &.pull-quote\n border-left-width: 0\n border-radius: 0.5rem\n\n &.highlights\n border-left-width: 0\n background: transparent\n\n// Center align embedded-in-text images\np .reference img\n vertical-align: middle\n","p.rubric\n line-height: 1.25\n font-weight: bold\n font-size: 1.125em\n\n // For Numpy-style documentation that's got rubrics within it.\n // https://github.com/pradyunsg/furo/discussions/505\n dd &\n line-height: inherit\n font-weight: inherit\n\n font-size: var(--font-size--small)\n text-transform: uppercase\n","article .sidebar\n float: right\n clear: right\n width: 30%\n\n margin-left: 1rem\n margin-right: 0\n\n border-radius: 0.2rem\n background-color: var(--color-background-secondary)\n border: var(--color-background-border) 1px solid\n\n > *\n padding-left: 1rem\n padding-right: 1rem\n\n > ul, > ol // lists need additional padding, because bullets.\n padding-left: 2.2rem\n\n .sidebar-title\n margin: 0\n padding: 0.5rem 1rem\n border-bottom: var(--color-background-border) 1px solid\n\n font-weight: 500\n\n// TODO: subtitle\n// TODO: dedicated variables?\n",".table-wrapper\n width: 100%\n overflow-x: auto\n margin-top: 1rem\n margin-bottom: 0.5rem\n padding: 0.2rem 0.2rem 0.75rem\n\ntable.docutils\n border-radius: 0.2rem\n border-spacing: 0\n border-collapse: collapse\n\n box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.05), 0 0 0.0625rem rgba(0, 0, 0, 0.1)\n\n th\n background: var(--color-table-header-background)\n\n td,\n th\n // Space things out properly\n padding: 0 0.25rem\n\n // Get the borders looking just-right.\n border-left: 1px solid var(--color-table-border)\n border-right: 1px solid var(--color-table-border)\n border-bottom: 1px solid var(--color-table-border)\n\n p\n margin: 0.25rem\n\n &:first-child\n border-left: none\n &:last-child\n border-right: none\n\n // MyST-parser tables set these classes for control of column alignment\n &.text-left\n text-align: left\n &.text-right\n text-align: right\n &.text-center\n text-align: center\n",":target\n scroll-margin-top: 0.5rem\n\n@media (max-width: $full-width - $sidebar-width)\n :target\n scroll-margin-top: calc(0.5rem + var(--header-height))\n\n // When a heading is selected\n section > span:target\n scroll-margin-top: calc(0.8rem + var(--header-height))\n\n// Permalinks\n.headerlink\n font-weight: 100\n user-select: none\n\nh1,\nh2,\nh3,\nh4,\nh5,\nh6,\ndl dt,\np.caption,\nfigcaption p,\ntable > caption,\n.code-block-caption\n > .headerlink\n margin-left: 0.5rem\n visibility: hidden\n &:hover > .headerlink\n visibility: visible\n\n // Don't change to link-like, if someone adds the contents directive.\n > .toc-backref\n color: inherit\n text-decoration-line: none\n\n// Figure and table captions are special.\nfigure:hover > figcaption > p > .headerlink,\ntable:hover > caption > .headerlink\n visibility: visible\n\n:target >, // Regular section[id] style anchors\nspan:target ~ // Non-regular span[id] style \"extra\" anchors\n h1,\n h2,\n h3,\n h4,\n h5,\n h6\n &:nth-of-type(1)\n background-color: var(--color-highlight-on-target)\n // .headerlink\n // visibility: visible\n code.literal\n background-color: transparent\n\ntable:target > caption,\nfigure:target\n background-color: var(--color-highlight-on-target)\n\n// Inline page contents\n.this-will-duplicate-information-and-it-is-still-useful-here li :target\n background-color: var(--color-highlight-on-target)\n\n// Code block permalinks\n.literal-block-wrapper:target .code-block-caption\n background-color: var(--color-highlight-on-target)\n\n// When a definition list item is selected\n//\n// There isn't really an alternative to !important here, due to the\n// high-specificity of API documentation's selector.\ndt:target\n background-color: var(--color-highlight-on-target) !important\n\n// When a footnote reference is selected\n.footnote > dt:target + dd,\n.footnote-reference:target\n background-color: var(--color-highlight-on-target)\n",".guilabel\n background-color: var(--color-guilabel-background)\n border: 1px solid var(--color-guilabel-border)\n color: var(--color-guilabel-text)\n\n padding: 0 0.3em\n border-radius: 0.5em\n font-size: 0.9em\n","// This file contains the styles used for stylizing the footer that's shown\n// below the content.\n\nfooter\n font-size: var(--font-size--small)\n display: flex\n flex-direction: column\n\n margin-top: 2rem\n\n// Bottom of page information\n.bottom-of-page\n display: flex\n align-items: center\n justify-content: space-between\n\n margin-top: 1rem\n padding-top: 1rem\n padding-bottom: 1rem\n\n color: var(--color-foreground-secondary)\n border-top: 1px solid var(--color-background-border)\n\n line-height: 1.5\n\n @media (max-width: $content-width)\n text-align: center\n flex-direction: column-reverse\n gap: 0.25rem\n\n .left-details\n font-size: var(--font-size--small)\n\n .right-details\n display: flex\n flex-direction: column\n gap: 0.25rem\n text-align: right\n\n .icons\n display: flex\n justify-content: flex-end\n gap: 0.25rem\n font-size: 1rem\n\n a\n text-decoration: none\n\n svg,\n img\n font-size: 1.125rem\n height: 1em\n width: 1em\n\n// Next/Prev page information\n.related-pages\n a\n display: flex\n align-items: center\n\n text-decoration: none\n &:hover .page-info .title\n text-decoration: underline\n color: var(--color-link)\n text-decoration-color: var(--color-link-underline)\n\n svg.furo-related-icon,\n svg.furo-related-icon > use\n flex-shrink: 0\n\n color: var(--color-foreground-border)\n\n width: 0.75rem\n height: 0.75rem\n margin: 0 0.5rem\n\n &.next-page\n max-width: 50%\n\n float: right\n clear: right\n text-align: right\n\n &.prev-page\n max-width: 50%\n\n float: left\n clear: left\n\n svg\n transform: rotate(180deg)\n\n.page-info\n display: flex\n flex-direction: column\n overflow-wrap: anywhere\n\n .next-page &\n align-items: flex-end\n\n .context\n display: flex\n align-items: center\n\n padding-bottom: 0.1rem\n\n color: var(--color-foreground-muted)\n font-size: var(--font-size--small)\n text-decoration: none\n","// This file contains the styles for the contents of the left sidebar, which\n// contains the navigation tree, logo, search etc.\n\n////////////////////////////////////////////////////////////////////////////////\n// Brand on top of the scrollable tree.\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-brand\n display: flex\n flex-direction: column\n flex-shrink: 0\n\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n text-decoration: none\n\n.sidebar-brand-text\n color: var(--color-sidebar-brand-text)\n overflow-wrap: break-word\n margin: var(--sidebar-item-spacing-vertical) 0\n font-size: 1.5rem\n\n.sidebar-logo-container\n margin: var(--sidebar-item-spacing-vertical) 0\n\n.sidebar-logo\n margin: 0 auto\n display: block\n max-width: 100%\n\n////////////////////////////////////////////////////////////////////////////////\n// Search\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-search-container\n display: flex\n align-items: center\n margin-top: var(--sidebar-search-space-above)\n\n position: relative\n\n background: var(--color-sidebar-search-background)\n &:hover,\n &:focus-within\n background: var(--color-sidebar-search-background--focus)\n\n &::before\n content: \"\"\n position: absolute\n left: var(--sidebar-item-spacing-horizontal)\n width: var(--sidebar-search-icon-size)\n height: var(--sidebar-search-icon-size)\n\n background-color: var(--color-sidebar-search-icon)\n mask-image: var(--icon-search)\n\n.sidebar-search\n box-sizing: border-box\n\n border: none\n border-top: 1px solid var(--color-sidebar-search-border)\n border-bottom: 1px solid var(--color-sidebar-search-border)\n\n padding-top: var(--sidebar-search-input-spacing-vertical)\n padding-bottom: var(--sidebar-search-input-spacing-vertical)\n padding-right: var(--sidebar-search-input-spacing-horizontal)\n padding-left: calc(var(--sidebar-item-spacing-horizontal) + var(--sidebar-search-input-spacing-horizontal) + var(--sidebar-search-icon-size))\n\n width: 100%\n\n color: var(--color-sidebar-search-foreground)\n background: transparent\n z-index: 10\n\n &:focus\n outline: none\n\n &::placeholder\n font-size: var(--sidebar-search-input-font-size)\n\n//\n// Hide Search Matches link\n//\n#searchbox .highlight-link\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal) 0\n margin: 0\n text-align: center\n\n a\n color: var(--color-sidebar-search-icon)\n font-size: var(--font-size--small--2)\n\n////////////////////////////////////////////////////////////////////////////////\n// Structure/Skeleton of the navigation tree (left)\n////////////////////////////////////////////////////////////////////////////////\n.sidebar-tree\n font-size: var(--sidebar-item-font-size)\n margin-top: var(--sidebar-tree-space-above)\n margin-bottom: var(--sidebar-item-spacing-vertical)\n\n ul\n padding: 0\n margin-top: 0\n margin-bottom: 0\n\n display: flex\n flex-direction: column\n\n list-style: none\n\n li\n position: relative\n margin: 0\n\n > ul\n margin-left: var(--sidebar-item-spacing-horizontal)\n\n .icon\n color: var(--color-sidebar-link-text)\n\n .reference\n box-sizing: border-box\n color: var(--color-sidebar-link-text)\n\n // Fill the parent.\n display: inline-block\n line-height: var(--sidebar-item-line-height)\n text-decoration: none\n\n // Don't allow long words to cause wrapping.\n overflow-wrap: anywhere\n\n height: 100%\n width: 100%\n\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n\n &:hover\n background: var(--color-sidebar-item-background--hover)\n\n // Add a nice little \"external-link\" arrow here.\n &.external::after\n content: url('data:image/svg+xml,')\n margin: 0 0.25rem\n vertical-align: middle\n color: var(--color-sidebar-link-text)\n\n // Make the current page reference bold.\n .current-page > .reference\n font-weight: bold\n\n label\n position: absolute\n top: 0\n right: 0\n height: var(--sidebar-item-height)\n width: var(--sidebar-expander-width)\n\n cursor: pointer\n user-select: none\n\n display: flex\n justify-content: center\n align-items: center\n\n .caption, :not(.caption) > .caption-text\n font-size: var(--sidebar-caption-font-size)\n color: var(--color-sidebar-caption-text)\n\n font-weight: bold\n text-transform: uppercase\n\n margin: var(--sidebar-caption-space-above) 0 0 0\n padding: var(--sidebar-item-spacing-vertical) var(--sidebar-item-spacing-horizontal)\n\n // If it has children, add a bit more padding to wrap the content to avoid\n // overlapping with the +:hidden: + +example-file-1 +example-file-2 +example-dir/index +... +\`\`\` +``` + +- `:maxdepth:` limits the depth of nesting +- `:caption:` title for the group of pages +- `:hidden:` if provided, links will only show in the sidebar (hidden on the page) +- Constituent files: listed files will be rendered as a link directly. If a listed file + has a `{toctree}` directive, this tree will be rendered in place of the page's link as a + dropdown. The dropdown will be named according to the file's top-level heading, and + clicking directly on the dropdown header will show that page's content. Files found in + the tree will be placed as links under the dropdown, recursively subject to same rules + described here. + +**Include files**: the following will include file content +pages: + +``` +\`\`\`{include} README.md +\`\`\` +``` + +**Reference directives** + + +[1]: https://pradyunsg.me/furo/ +[2]: https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html +[3]: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html# + diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..c5e7a78 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,27 @@ +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" + +[project] +name = "co3" +version = "0.1.1" +authors = [ + { name="Sam Griesemer", email="samgriesemer@gmail.com" }, +] +description = "Lightweight ORM" +readme = "README.md" +requires-python = ">=3.11" +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", +] +dependencies = [ + "tqdm" +] + +[tool.setuptools.packages.find] +#where = ["localsys"] # this is too deeply nested, need to remain at root level & use +#include; by default, `where` is `.` +include = ["co3*"] # pattern to match package names + diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..f05ce5b --- /dev/null +++ b/requirements.txt @@ -0,0 +1,8 @@ +# -- sphinx docs -- +sphinx +sphinx-togglebutton +furo +myst-parser + +sqlalchemy +numpy diff --git a/tests/co4_example.py b/tests/co4_example.py new file mode 100644 index 0000000..1758a6b --- /dev/null +++ b/tests/co4_example.py @@ -0,0 +1,47 @@ +''' +content -> converted +state -> transformed +''' + +from co3 import CO3, collate +from co3.databases import SQLiteDatabase +from co3 import Mapper + + +class Tomato(CO3): + def __init__(self, size, ripe): + self.size = size + self.ripe = ripe + + @property + def attributes(self): + return vars(self) + + @collate('diced') + def dice(self): + return self.size / 2 + + @collate('roasted') + def roast(self): + return self.size / 2 + + +tomato_table = sa.Table() + +mapper = Mapper() +mapper.attach( + Tomato, + tomato_table +) + + +tomato = Tomato(5, False) +mapper.collect(tomato, for='diced') + +db = SQLiteDatabse('resource.sqlite') +db.sync(mapper) + +dict_results = db.select( + mapper.compose(Tomato), + tomato_table.c.size == 5 +) diff --git a/tests/imports.py b/tests/imports.py new file mode 100644 index 0000000..d8a7813 --- /dev/null +++ b/tests/imports.py @@ -0,0 +1,20 @@ +from co3 import Accessor +from co3 import CO3 +from co3 import Collector +from co3 import Composer +from co3 import Database +from co3 import Indexer +from co3 import Manager +from co3 import Mapper +from co3 import Relation + + +from co3.accessors import SQLAccessor + +from co3.databases import SQLDatabase +from co3.databases import SQLiteDatabase + +from co3.managers import SQLManager + +from co3.relations import TabularRelation +from co3.relations import SQLTable