linkedset 0.1.0__tar.gz

linkedset-0.1.0/.github/dependabot.yml

@@ -0,0 +1,19 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      python-dependencies:
+        patterns:
+          - "*"

linkedset-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: python -m pip install -e ".[dev]"
+      - name: Test
+        run: python -m pytest -q
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - name: Install ruff
+        run: python -m pip install ruff
+      - name: Ruff check
+        run: python -m ruff check .
+      - name: Ruff format check
+        run: python -m ruff format --check .

linkedset-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,43 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - name: Install
+        run: python -m pip install -e ".[docs]"
+      - name: Build docs
+        run: python -m sphinx -b html -W --keep-going docs docs/_build/html
+      - name: Upload Pages artifact
+        if: github.ref == 'refs/heads/main'
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: docs/_build/html
+
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

linkedset-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - name: Build sdist and wheel
+        run: |
+          python -m pip install --upgrade build
+          python -m build
+      - name: Check metadata
+        run: |
+          python -m pip install --upgrade twine
+          python -m twine check dist/*
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/linkedset/
+    permissions:
+      id-token: write  # Required for Trusted Publishing (OIDC)
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

linkedset-0.1.0/.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

linkedset-0.1.0/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "python-envs.defaultEnvManager": "ms-python.python:conda",
+    "python-envs.defaultPackageManager": "ms-python.python:conda"
+}

linkedset-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Justin Chu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

linkedset-0.1.0/PKG-INFO

@@ -0,0 +1,199 @@
+Metadata-Version: 2.4
+Name: linkedset
+Version: 0.1.0
+Summary: Ordered set robust against mutation during iteration in Python
+Project-URL: Homepage, https://github.com/justinchuby/linkedset
+Project-URL: Documentation, https://justinchuby.github.io/linkedset/
+Project-URL: Repository, https://github.com/justinchuby/linkedset
+Project-URL: Issues, https://github.com/justinchuby/linkedset/issues
+Author: Justin Chu
+License-Expression: MIT
+License-File: LICENSE
+Keywords: data-structure,iteration,linked-list,ordered-set
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo; extra == 'docs'
+Requires-Dist: myst-parser; extra == 'docs'
+Requires-Dist: sphinx>=7; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# linkedset
+
+An ordered set that is robust against mutation during iteration, implemented in pure Python.
+
+`DoublyLinkedSet` behaves like an ordered set backed by a doubly linked list. Inserting
+and removing elements is `O(1)`, and — unlike Python's built-in `list` or `set` — you can
+safely add, remove, or move elements *while iterating over the container*.
+
+It implements both `collections.abc.Sequence` (ordered, indexable) and
+`collections.abc.MutableSet` (set algebra and in-place updates).
+
+📖 **Documentation**: <https://justinchuby.github.io/linkedset/>
+
+## Installation
+
+```bash
+pip install linkedset
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/justinchuby/linkedset
+cd linkedset
+pip install -e ".[dev]"
+```
+
+## Usage
+
+```python
+from linkedset import DoublyLinkedSet
+
+s = DoublyLinkedSet(["a", "b", "c"])
+
+s.append("d")                 # -> a, b, c, d
+s.insert_after("a", ["x"])    # -> a, x, b, c, d
+s.insert_before("b", ["y"])   # -> a, x, y, b, c, d
+s.remove("c")                 # -> a, x, y, b, d
+
+print(s[0])    # "a"  (O(1))
+print(s[-1])   # "d"  (O(1))
+print(list(s)) # ['a', 'x', 'y', 'b', 'd']
+```
+
+### Safe mutation during iteration
+
+```python
+s = DoublyLinkedSet(["a", "b", "c"])
+for x in s:
+    if x == "a":
+        s.insert_after("a", ["d"])  # inserted after current -> iterated
+        s.remove("b")               # removed before reached -> skipped
+# Iterated: a, d, c
+```
+
+Iteration rules:
+
+- Elements inserted **after** the current node **are** iterated over.
+- Elements inserted **before** the current node are **not** iterated over in the current pass.
+- If the current node is moved to a different location, iteration continues from the node
+  that followed it at its *original* location.
+
+Per-element mutation (`add`, `remove`, `discard`, `append`, `insert`, `clear`, …) is safe
+during iteration. The **global reorders** `reverse()` and `rotate()` are *not* — calling them
+mid-iteration may cause an in-progress iterator to skip or repeat elements.
+
+### Set operations
+
+Because it is a `MutableSet`, the usual set algebra works and returns a new
+`DoublyLinkedSet` (order preserved):
+
+```python
+a = DoublyLinkedSet(["a", "b", "c"])
+b = DoublyLinkedSet(["c", "d"])
+
+a | b   # union        -> a, b, c, d
+a & b   # intersection -> c
+a - b   # difference   -> a, b
+a ^ b   # symmetric    -> a, b, d
+
+a.add("x")        # idempotent add (no-op if already present)
+a.discard("z")    # remove if present, never raises
+a.pop()           # remove and return the last element (list-style; pass an index too)
+a |= b            # in-place update
+
+# `==` is order-sensitive, because the set is ordered:
+DoublyLinkedSet(["a", "b"]) == DoublyLinkedSet(["a", "b"])  # True
+DoublyLinkedSet(["a", "b"]) == DoublyLinkedSet(["b", "a"])  # False
+```
+
+### Deque- and list-style methods
+
+Because it is ordered, it also offers the familiar `deque`/`list` mutators (all keeping the
+set's uniqueness and identity semantics):
+
+```python
+s = DoublyLinkedSet(["a", "b", "c"])
+
+s.appendleft("z")       # -> z, a, b, c
+s.extendleft(["x", "y"])# -> y, x, z, a, b, c  (prepended, reversed like deque)
+s.popleft()             # removes and returns "y"
+s.pop()                 # removes and returns the last element ("c")
+s.pop(1)                # removes and returns the element at index 1
+s.insert(1, "q")        # insert before index 1 (index clamped like list.insert)
+s.rotate(1)             # rotate right; negative rotates left
+s.reverse()             # reverse in place
+s2 = s.copy()           # shallow copy, order preserved
+```
+
+## Semantics
+
+- Membership and set operations are based on object **identity** (`id(value)`), not equality.
+  Two distinct objects that compare equal are treated as different elements.
+- `==` is **order-sensitive** (it is an *ordered* set): equal only when the same elements, by
+  identity, appear in the same order. Instances are **not hashable** (mutable set).
+  Ordering/subset comparisons (`<`, `<=`, `>`, `>=`) are **not supported** (they raise
+  `TypeError`), since a subset relation would be ambiguous next to order-sensitive equality;
+  use the set algebra (`&`, `|`, `-`, `^`) or `isdisjoint()` instead.
+- `None` is not a valid value.
+- Accessing by index is `O(n)`, except the ends (`s[0]`, `s[-1]`) which are `O(1)`.
+
+## Complexity
+
+`DoublyLinkedSet` is a doubly linked list paired with a `dict` mapping each element's
+`id()` to its list node. That combination gives set-like `O(1)` membership and endpoint
+mutation, while preserving order and safe mutation during iteration.
+
+Let `n` be the size of the set (and `m` the size of the other operand for binary set
+operations).
+
+| Operation | Complexity | Notes |
+| --- | --- | --- |
+| `x in s`, `s.count(x)` | `O(1)` | `dict` lookup by `id(x)` |
+| `len(s)` | `O(1)` | length is tracked, not counted |
+| `s.append(x)`, `s.add(x)`, `s.appendleft(x)` | `O(1)` | insert at a known end |
+| `s.remove(x)`, `s.discard(x)` | `O(1)` | unlink the node, no shifting |
+| `s.extend(xs)`, `s.extendleft(xs)` | `O(k)` | `k = len(xs)`; `O(1)` per element |
+| `s.insert_after(v, xs)`, `s.insert_before(v, xs)` | `O(k)` | `k = len(xs)`; `O(1)` per element |
+| `s.pop()`, `s.popleft()` | `O(1)` | remove from an end |
+| `s.pop(i)`, `s.insert(i, x)` | `O(\|i\|)` | walks to the index from the nearer end |
+| `s[0]`, `s[-1]` | `O(1)` | endpoints are reachable directly |
+| `s[i]` | `O(\|i\|)` | walks from the nearer end |
+| `s.index(x)` | `O(n)` | linear scan for position |
+| `s.rotate(n)` | `O(n mod len(s))` | relink only, no node churn |
+| `s.reverse()`, `s.copy()`, `s.clear()` | `O(n)` | |
+| iteration, `reversed(s)`, `s == other` | `O(n)` | |
+| `s[a:b]` (slice) | `O(n)` | materialises a tuple |
+| `s \| t`, `s & t`, `s - t`, `s ^ t` | `O(n + m)` | each membership test is `O(1)` |
+| `s.isdisjoint(t)` | `O(n)` | one pass with `O(1)` lookups |
+
+Space is `O(n)`: every element is wrapped in a small link node and referenced once from the
+`id`-keyed index.
+
+Mutating during iteration stays `O(1)` per operation. Removed nodes are unlinked from their
+neighbours immediately, so a traversal never pays to skip over dead nodes — the only cost is
+following the `next` pointer you already hold.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+python -m pytest      # run tests
+python -m ruff check  # lint
+```
+
+## License
+
+MIT. Portions derived from the ONNX Project Contributors (Apache-2.0); see `linkedset/__init__.py`.