pathseq 0.1.0__tar.gz

pathseq-0.1.0/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.3
+Name: pathseq
+Version: 0.1.0
+Summary: A pathlib-like library for working with file sequences.
+Author: Ashley Whetter
+Author-email: Ashley Whetter <ashley@awhetter.co.uk>
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Plugins
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.14
+Requires-Dist: lark
+Requires-Dist: python-statemachine
+Requires-Dist: typing-extensions
+Requires-Python: >=3.10
+Project-URL: Documentation, https://pathseq.readthedocs.org
+Project-URL: Source, https://github.com/AWhetter/pathseq
+Description-Content-Type: text/x-rst
+
+pathseq
+=======
+
+.. image:: https://readthedocs.org/projects/pathseq/badge/?version=latest
+    :target: https://pathseq.readthedocs.org
+    :alt: Documentation
+
+.. image:: https://github.com/AWhetter/pathseq/actions/workflows/main.yml/badge.svg?branch=main
+    :target: https://github.com/AWhetter/pathseq/actions/workflows/main.yml?query=branch%3Amain
+    :alt: Github Build Status
+
+.. image:: https://img.shields.io/pypi/v/pathseq.svg
+    :target: https://pypi.org/project/pathseq/
+    :alt: PyPI Version
+
+.. image:: https://img.shields.io/pypi/pyversions/pathseq.svg
+    :target: https://pypi.org/project/pathseq/
+    :alt: Supported Python Versions
+
+A pathlib-first library for working with file sequences.
+
+TODO: Note special features
+
+* Multi-dimension ranges (eg animated udims)
+* pathlib-first API
+* Support for UDIM tokens
+* Sequence compression?
+
+Getting Started
+---------------
+
+The following section demonstrates how to install ``pathseq`` and some basic usage.
+Full documentation is available here: https://pathseq.readthedocs.io/en/latest/
+
+
+Installation
+~~~~~~~~~~~~
+
+``pathseq`` can be installed through pip:
+
+.. code-block:: bash
+
+    pip install pathseq
+
+Usage
+~~~~~
+
+TODO
+
+For more detailed usage, see the documentation:
+https://pathseq.readthedocs.io/en/latest/
+
+
+Contributing
+------------
+
+Running the tests
+~~~~~~~~~~~~~~~~~
+
+Tests are executed through `tox <https://tox.readthedocs.io/en/latest/>`_.
+
+.. code-block:: bash
+
+    tox
+
+
+Code Style
+~~~~~~~~~~
+
+Code is formatted using `black <https://github.com/python/black>`_.
+
+You can check your formatting using black's check mode:
+
+.. code-block:: bash
+
+    tox -e format
+
+You can also get black to format your changes for you:
+
+.. code-block:: bash
+
+    tox -e format -- src/ tests/
+
+
+Release Notes
+~~~~~~~~~~~~~
+
+Release notes are managed through `towncrier <https://towncrier.readthedocs.io/en/stable/index.html>`_.
+When making a pull request you will need to create a news fragment to document your change:
+
+.. code-block:: bash
+
+    tox -e release_notes -- create --help
+
+
+Versioning
+----------
+
+We use `SemVer <https://semver.org/>`_ for versioning.
+For the versions available, see the `tags on this repository <https://github.com/AWhetter/pathseq/tags>`_.
+
+
+License
+-------
+
+This project is licensed under the MIT License.
+See the `LICENSE.rst <LICENSE.rst>`_ file for details.

pathseq-0.1.0/README.rst

@@ -0,0 +1,107 @@
+pathseq
+=======
+
+.. image:: https://readthedocs.org/projects/pathseq/badge/?version=latest
+    :target: https://pathseq.readthedocs.org
+    :alt: Documentation
+
+.. image:: https://github.com/AWhetter/pathseq/actions/workflows/main.yml/badge.svg?branch=main
+    :target: https://github.com/AWhetter/pathseq/actions/workflows/main.yml?query=branch%3Amain
+    :alt: Github Build Status
+
+.. image:: https://img.shields.io/pypi/v/pathseq.svg
+    :target: https://pypi.org/project/pathseq/
+    :alt: PyPI Version
+
+.. image:: https://img.shields.io/pypi/pyversions/pathseq.svg
+    :target: https://pypi.org/project/pathseq/
+    :alt: Supported Python Versions
+
+A pathlib-first library for working with file sequences.
+
+TODO: Note special features
+
+* Multi-dimension ranges (eg animated udims)
+* pathlib-first API
+* Support for UDIM tokens
+* Sequence compression?
+
+Getting Started
+---------------
+
+The following section demonstrates how to install ``pathseq`` and some basic usage.
+Full documentation is available here: https://pathseq.readthedocs.io/en/latest/
+
+
+Installation
+~~~~~~~~~~~~
+
+``pathseq`` can be installed through pip:
+
+.. code-block:: bash
+
+    pip install pathseq
+
+Usage
+~~~~~
+
+TODO
+
+For more detailed usage, see the documentation:
+https://pathseq.readthedocs.io/en/latest/
+
+
+Contributing
+------------
+
+Running the tests
+~~~~~~~~~~~~~~~~~
+
+Tests are executed through `tox <https://tox.readthedocs.io/en/latest/>`_.
+
+.. code-block:: bash
+
+    tox
+
+
+Code Style
+~~~~~~~~~~
+
+Code is formatted using `black <https://github.com/python/black>`_.
+
+You can check your formatting using black's check mode:
+
+.. code-block:: bash
+
+    tox -e format
+
+You can also get black to format your changes for you:
+
+.. code-block:: bash
+
+    tox -e format -- src/ tests/
+
+
+Release Notes
+~~~~~~~~~~~~~
+
+Release notes are managed through `towncrier <https://towncrier.readthedocs.io/en/stable/index.html>`_.
+When making a pull request you will need to create a news fragment to document your change:
+
+.. code-block:: bash
+
+    tox -e release_notes -- create --help
+
+
+Versioning
+----------
+
+We use `SemVer <https://semver.org/>`_ for versioning.
+For the versions available, see the `tags on this repository <https://github.com/AWhetter/pathseq/tags>`_.
+
+
+License
+-------
+
+This project is licensed under the MIT License.
+See the `LICENSE.rst <LICENSE.rst>`_ file for details.

pathseq-0.1.0/pyproject.toml

@@ -0,0 +1,92 @@
+[project]
+name = "pathseq"
+version = "0.1.0"
+description = "A pathlib-like library for working with file sequences."
+authors = [
+    {name = "Ashley Whetter", email = "ashley@awhetter.co.uk"},
+]
+readme = "README.rst"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Plugins",
+    "Framework :: Sphinx :: Extension",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "lark",
+    "python-statemachine",
+    "typing_extensions",
+]
+
+[project.urls]
+Source = "https://github.com/AWhetter/pathseq"
+Documentation = "https://pathseq.readthedocs.org"
+
+[dependency-groups]
+dev = [
+  {include-group = "test"},
+  {include-group = "format"},
+  {include-group = "lint"},
+  {include-group = "typecheck"},
+  {include-group = "doc"},
+]
+test = [
+    "fileseq",
+    "hypothesis",
+    "pytest",
+]
+format = [
+    "ruff",
+]
+lint = [
+    "ruff",
+]
+typecheck = [
+    "mypy",
+]
+doc = [
+    "furo",
+    "sphinx",
+    "sphinx-design",
+]
+release_notes = [
+    "towncrier",
+]
+
+[build-system]
+requires = ["uv_build>=0.8.5,<0.9.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "pathseq"
+
+[tool.pylint]
+disable = "R,unused-argument"
+
+[tool.towncrier]
+directory = "doc/changes"
+filename = "CHANGELOG.rst"
+package = "pathseq"
+title_format = "pathseq v{version} ({project_date})"
+
+[tool.pytest.ini_options]
+markers = [
+    "todo",
+]
+addopts = "--doctest-glob='[!0]*.rst' --doctest-modules --ignore=doc/source/conf.py"
+doctest_optionflags = "ELLIPSIS"
+testpaths = [
+    "tests",
+    "doc/source",
+    "src",
+]

pathseq-0.1.0/src/pathseq/__init__.py

@@ -0,0 +1,44 @@
+"""A pathlib-first library for working with file sequences."""
+
+from ._ast import (
+    FileNumT,
+    PaddedRange,
+    ParsedLooseSequence,
+    ParsedSequence,
+    Ranges,
+    RangesEndName,
+    RangesInName,
+    RangesStartName,
+)
+from ._base import BasePathSequence, BasePurePathSequence, PathT_co, PurePathT_co
+from ._error import IncompleteDimensionError, NotASequenceError, ParseError
+from ._file_num_seq import FileNumSequence
+from ._loose_path_sequence import LoosePathSequence
+from ._loose_pure_path_sequence import LoosePurePathSequence
+from ._path_sequence import PathSequence
+from ._pure_path_sequence import PurePathSequence
+
+__version__ = "0.1.0"
+
+__all__ = (
+    "BasePathSequence",
+    "BasePurePathSequence",
+    "FileNumSequence",
+    "FileNumT",
+    "IncompleteDimensionError",
+    "LoosePathSequence",
+    "LoosePurePathSequence",
+    "NotASequenceError",
+    "PaddedRange",
+    "ParsedLooseSequence",
+    "ParseError",
+    "ParsedSequence",
+    "PathSequence",
+    "PathT_co",
+    "PurePathSequence",
+    "PurePathT_co",
+    "Ranges",
+    "RangesEndName",
+    "RangesInName",
+    "RangesStartName",
+)

pathseq-0.1.0/src/pathseq/_arithmetic_sequence.py

@@ -0,0 +1,154 @@
+from collections.abc import Iterator, Sequence
+import decimal
+from typing import overload, Protocol, TypeVar
+
+from typing_extensions import Self  # PY311
+
+from ._ast import FileNumT
+from ._decimal_range import DecimalRange
+
+
+FileNumT_cov = TypeVar("FileNumT_cov", covariant=True)
+
+
+class RangeProtocol(Protocol[FileNumT_cov]):
+    @property
+    def start(self) -> FileNumT_cov: ...
+    @property
+    def step(self) -> FileNumT_cov: ...
+
+    def __iter__(self) -> Iterator[FileNumT_cov]: ...
+
+    def __len__(self) -> int: ...
+
+
+def remove_exponent(d: decimal.Decimal) -> decimal.Decimal:
+    """Remove the exponent and trailing zeros from the given decimal."""
+    return d.quantize(decimal.Decimal(1)) if d == d.to_integral() else d.normalize()
+
+
+class ArithmeticSequence(Sequence[FileNumT]):
+    def __init__(
+        self, start: FileNumT, end: FileNumT | None = None, step: FileNumT | None = None
+    ) -> None:
+        end = end if end is not None else start
+        step = step if step is not None else start.__class__(1)
+
+        # Normalise to a positive step value
+        if step < 0:
+            start, end = (end, start)
+            step = -step
+
+        stop: FileNumT
+        if start < end:
+            # Normalise the end value to match the step
+            remainder = divmod(end - start, step)[1]
+            if remainder:
+                stop = end + (step - remainder)
+                end -= remainder
+            else:
+                stop = end + step
+        elif start == end:
+            # We treat the end as inclusive, ranges don't.
+            stop = end + step
+            # Normalise to a step of 1
+            step = start.__class__(1)
+        else:
+            stop = end
+
+        self._range: RangeProtocol[FileNumT]
+        self._end: FileNumT
+        if isinstance(start, int):
+            self._range = range(start, stop, step)
+            self._end = end
+        else:
+            self._range = DecimalRange(
+                remove_exponent(start), remove_exponent(stop), remove_exponent(step)
+            )
+            self._end = remove_exponent(end)
+
+    @property
+    def start(self) -> FileNumT:
+        return self._range.start
+
+    @property
+    def end(self) -> FileNumT:
+        return self._end
+
+    @property
+    def step(self) -> FileNumT:
+        return self._range.step
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, ArithmeticSequence):
+            return NotImplemented
+
+        return (
+            isinstance(self.start, other.start.__class__)
+            and self.start == other.start
+            and self.end == other.end
+            and self.step == other.step
+        )
+
+    def __hash__(self) -> int:
+        return hash((type(self), self.start, self.end, self.step))
+
+    def __contains__(self, item: object) -> bool:
+        return any(item == x for x in self._range)
+
+    def __iter__(self) -> Iterator[FileNumT]:
+        return iter(self._range)
+
+    def __len__(self) -> int:
+        return len(self._range)
+
+    def __str__(self) -> str:
+        if len(self) == 1:
+            return str(self.start)
+
+        result = f"{self.start}-{self.end}"
+        if self.step != 1:
+            result += f"x{self.step}"
+        elif len(self) == 2:
+            return ",".join(str(x) for x in self)
+
+        return result
+
+    def __repr__(self) -> str:
+        if self.step == 1:
+            return f"{self.__class__.__name__}({self.start}, {self.end})"
+
+        return f"{self.__class__.__name__}({self.start}, {self.end}, {self.step})"
+
+    @overload
+    def __getitem__(self, index: int) -> FileNumT: ...
+
+    @overload
+    def __getitem__(self, index: slice) -> Self: ...
+
+    def __getitem__(self, index: int | slice) -> FileNumT | Self:
+        if isinstance(index, slice):
+            start_i, stop_i, step = index.indices(len(self))
+            if step > 0:
+                if start_i >= stop_i:
+                    raise IndexError("slice creates an empty arithemtic sequence")
+            else:
+                if start_i <= stop_i:
+                    raise IndexError("slice creates an empty arithemtic sequence")
+
+            start = self[index.start]
+            try:
+                stop = self[index.stop + 1]
+            except IndexError:
+                stop = self.end
+
+            return self.__class__(start, stop, self.step * index.step)
+
+        if index < 0:
+            index += len(self)
+            if index < 0:
+                raise IndexError("index out of range")
+        elif index >= len(self):
+            raise IndexError("index out of range")
+
+        return self._range.start + index * self._range.step

pathseq-0.1.0/src/pathseq/_ast/__init__.py

@@ -0,0 +1,22 @@
+from ._base import FileNum, FileNumT, PaddedRange, Ranges
+from ._formatter import Formatter
+from ._loose_type import (
+    ParsedLooseSequence,
+    RangesStartName,
+    RangesInName,
+    RangesEndName,
+)
+from ._type import ParsedSequence
+
+__all__ = [
+    "FileNum",
+    "FileNumT",
+    "Formatter",
+    "PaddedRange",
+    "ParsedLooseSequence",
+    "ParsedSequence",
+    "Ranges",
+    "RangesStartName",
+    "RangesInName",
+    "RangesEndName",
+]