pysequitur 0.1.2__tar.gz

pysequitur-0.1.2/LICENCE

@@ -0,0 +1,7 @@
+Copyright (c) 2024 Alex Harding (alexharding.ooo)
+
+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.

pysequitur-0.1.2/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: pysequitur
+Version: 0.1.2
+Summary: parsing and manipulation tool for file sequences
+License: MIT
+License-File: LICENCE
+Keywords: vfx,file-sequence,image-sequence,file-management
+Author: arcadeperfect
+Author-email: alex.harding.info@gmail.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: docformatter (>=1.7.5,<2.0.0)
+Project-URL: Repository, https://github.com/arcadeperfect/pysequitur
+Description-Content-Type: text/markdown
+
+# PySequitur
+
+Library for identifying and manipulating sequences of files. It is geared towards visual effects and animation related scenarios, although it can be used with any sequence of files. Emphasis on file system manipulation and flexible handing of anomalous sequences is the main differentiating feature from other similar libraries.
+
+CLI and integration for Nuke coming soon.
+
+No external dependencies, easy to use in VFX pipeline with no privileges.
+
+## Features
+
+- **File Sequence Handling**
+  - Parse and manage frame-based file sequences
+  - Support for many naming conventions and patterns
+  - Handle missing or duplicate frames, inconsistent padding
+
+- **Flexible Component System**
+  - Parse filenames into components (prefix, delimiter, frame number, suffix, extension)
+  - Modify individual components while preserving others
+  - Match sequences against optionally specified components
+  
+- **Sequence Operations**
+  - Rename sequences
+  - Move sequences around
+  - Delete sequences
+  - Copy sequences
+  - Offset frame numbers
+  - Adjust or repair frame number padding
+
+## Installation
+
+```bash
+# TODO: Add installation instructions once package is published
+```
+
+## Quick Start
+
+```python
+from pathlib import Path
+from pysequitur import FileSequence, Components
+
+# Parse sequences from a directory
+sequences = FileSequence.find_sequences_in_path(Path("/path/to/files"))
+
+# Create a virtual sequence from a list of file names
+file_list = ["render_001.exr", "render_002.exr", "render_003.exr"]
+sequence = FileSequence.find_sequences_in_filename_list(file_list)[0]
+
+# Basic sequence operations
+sequence.move_to(Path("/new/directory"))
+sequence.rename_to(Components(prefix="new_name"))
+sequence.offset_frames(100)  # Shift all frame numbers by 100
+sequence.delete_files()
+new_sequence = sequence.copy_to(Components(prefix="new_name"), Path("/new/directory"))
+
+# Match sequences by components
+components = Components(prefix="render", extension="exr")
+matches = FileSequence.match_components_in_path(components, Path("/path/to/files"))
+
+# Match sequence by pattern string
+sequence = FileSequence.match_sequence_string_in_directory("render_####.exr", Path("/path/to/files"))
+```
+
+## Core Classes
+
+### Components
+
+Configuration class for specifying filename components during operations. Any parameter can be None.
+
+```python
+components = Components(
+    prefix="file_name",
+    delimiter=".",
+    padding=4,
+    suffix="_final",
+    extension="exr",
+    frame_number=None  # Optional frame number for specific frame operations
+)
+```
+Equals: "file_name.####_final.exr"
+
+### FileSequence
+Main class.
+Manages collections of related Items as a single unit, where Items represent single files.
+
+Key Features:
+- Static methods for finding sequences in directories or filename lists
+- Match sequences against Components or sequence string patterns
+- Sequence manipulation operations (rename, move, copy, delete)
+- Frame operations (offset, padding adjustment)
+- Sequence analysis (missing frames, duplicates, problems detection)
+- Existence status checking (TRUE, FALSE, PARTIAL)
+
+## File Naming Convention
+
+The library parses filenames into the following components:
+```
+<prefix><delimiter><frame><suffix>.<extension>
+```
+
+Example: `render_001_final.exr`
+- prefix: "render"
+- delimiter: "_"
+- frame: "001"
+- suffix: "_final"
+- extension: "exr"
+
+---
+
+See examples folder for more usage scenarios
+

pysequitur-0.1.2/README.md

@@ -0,0 +1,109 @@
+# PySequitur
+
+Library for identifying and manipulating sequences of files. It is geared towards visual effects and animation related scenarios, although it can be used with any sequence of files. Emphasis on file system manipulation and flexible handing of anomalous sequences is the main differentiating feature from other similar libraries.
+
+CLI and integration for Nuke coming soon.
+
+No external dependencies, easy to use in VFX pipeline with no privileges.
+
+## Features
+
+- **File Sequence Handling**
+  - Parse and manage frame-based file sequences
+  - Support for many naming conventions and patterns
+  - Handle missing or duplicate frames, inconsistent padding
+
+- **Flexible Component System**
+  - Parse filenames into components (prefix, delimiter, frame number, suffix, extension)
+  - Modify individual components while preserving others
+  - Match sequences against optionally specified components
+  
+- **Sequence Operations**
+  - Rename sequences
+  - Move sequences around
+  - Delete sequences
+  - Copy sequences
+  - Offset frame numbers
+  - Adjust or repair frame number padding
+
+## Installation
+
+```bash
+# TODO: Add installation instructions once package is published
+```
+
+## Quick Start
+
+```python
+from pathlib import Path
+from pysequitur import FileSequence, Components
+
+# Parse sequences from a directory
+sequences = FileSequence.find_sequences_in_path(Path("/path/to/files"))
+
+# Create a virtual sequence from a list of file names
+file_list = ["render_001.exr", "render_002.exr", "render_003.exr"]
+sequence = FileSequence.find_sequences_in_filename_list(file_list)[0]
+
+# Basic sequence operations
+sequence.move_to(Path("/new/directory"))
+sequence.rename_to(Components(prefix="new_name"))
+sequence.offset_frames(100)  # Shift all frame numbers by 100
+sequence.delete_files()
+new_sequence = sequence.copy_to(Components(prefix="new_name"), Path("/new/directory"))
+
+# Match sequences by components
+components = Components(prefix="render", extension="exr")
+matches = FileSequence.match_components_in_path(components, Path("/path/to/files"))
+
+# Match sequence by pattern string
+sequence = FileSequence.match_sequence_string_in_directory("render_####.exr", Path("/path/to/files"))
+```
+
+## Core Classes
+
+### Components
+
+Configuration class for specifying filename components during operations. Any parameter can be None.
+
+```python
+components = Components(
+    prefix="file_name",
+    delimiter=".",
+    padding=4,
+    suffix="_final",
+    extension="exr",
+    frame_number=None  # Optional frame number for specific frame operations
+)
+```
+Equals: "file_name.####_final.exr"
+
+### FileSequence
+Main class.
+Manages collections of related Items as a single unit, where Items represent single files.
+
+Key Features:
+- Static methods for finding sequences in directories or filename lists
+- Match sequences against Components or sequence string patterns
+- Sequence manipulation operations (rename, move, copy, delete)
+- Frame operations (offset, padding adjustment)
+- Sequence analysis (missing frames, duplicates, problems detection)
+- Existence status checking (TRUE, FALSE, PARTIAL)
+
+## File Naming Convention
+
+The library parses filenames into the following components:
+```
+<prefix><delimiter><frame><suffix>.<extension>
+```
+
+Example: `render_001_final.exr`
+- prefix: "render"
+- delimiter: "_"
+- frame: "001"
+- suffix: "_final"
+- extension: "exr"
+
+---
+
+See examples folder for more usage scenarios

pysequitur-0.1.2/pyproject.toml

@@ -0,0 +1,84 @@
+[tool.poetry]
+name = "pysequitur"
+version = "0.1.2"
+description = "parsing and manipulation tool for file sequences"
+authors = ["arcadeperfect <alex.harding.info@gmail.com>"]
+readme = "README.md"
+packages = [{include = "pysequitur", from = "src"}]
+license = "MIT"
+repository = "https://github.com/arcadeperfect/pysequitur"  # Add this
+keywords = ["vfx", "file-sequence", "image-sequence", "file-management"]  # Add this
+classifiers = [  # Add this
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Multimedia :: Graphics",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.9",
+]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+docformatter = "^1.7.5"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.3"
+pytest-cov = "^4.1.0"  # Add this for coverage reports
+pyyaml = "^6.0.2"
+mypy = "^1.0"
+black = "^24.10.0"
+flake8 = "^7.0.0"  # Moved to correct section
+pylint = "^3.1.0"
+isort = "^5.13.2"
+docformatter = "^1.7.5"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+pysequitur = "pysequitur.main:main"
+lint = "pylint src/pysequitur"
+format = "black src/pysequitur"
+typecheck = "mypy src/pysequitur"
+sort-imports = "isort src/pysequitur"
+check = "flake8 src/pysequitur"
+
+# Tool configurations
+[tool.black]
+line-length = 88
+target-version = ['py312']
+include = '\.pyi?$'
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+line_length = 88
+
+[tool.mypy]
+python_version = "3.12"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+check_untyped_defs = true
+exclude = '^tests/'
+
+[tool.pylint.MASTER]
+ignore = ["tests", "test_*.py"]
+
+[tool.pylint.messages_control]
+disable = [
+    "C0301",  # line-too-long
+#     "C0111",  # missing-docstring
+#     "C0103",  # invalid-name
+#     "C0330",  # bad-continuation
+#     "C0326",  # bad-whitespace
+]
+
+[tool.pylint.format]
+max-line-length = 88
+
+[tool.pytest.ini_options]  # Add this section
+testpaths = ["tests"]
+addopts = "--cov=pysequitur --cov-report=xml --cov-report=term-missing"
+python_files = "test_*.py"

pysequitur-0.1.2/src/pysequitur/__init__.py

@@ -0,0 +1,31 @@
+# Copyright (c) 2024 Alex Harding (alexharding.ooo)
+# This file is part of PySequitur which is released under MIT license.
+# See file LICENSE for full license details.
+"""
+PySequitur - A tool for parsing and manipulating file sequences.
+
+This package provides tools for working with frame-based file sequences,
+commonly used in VFX and animation pipelines.
+
+Classes:
+    Item: Represents a single item in a file sequence
+    FileSequence: Manages collections of related files as a sequence
+    Components: Configuration class for specifying filename components
+"""
+
+from typing import List, Type
+
+__version__ = "0.1.0"
+
+from .file_sequence import Item, FileSequence, Components  # type: ignore
+
+# Type definitions for better IDE support
+ItemType = Type[Item]
+FileSequenceType = Type[FileSequence]
+ComponentsType = Type[Components]
+
+__all__: List[str] = [
+    "Item",
+    "FileSequence",
+    "Components",
+]

pysequitur-0.1.2/src/pysequitur/examples/examples.py

@@ -0,0 +1,66 @@
+from pysequitur import Components, FileSequence
+from pysequitur.examples.utils import create_some_sequences
+import os
+
+
+def run_examples():
+
+    # generate some empty files
+    temp_files_directory = create_some_sequences()
+
+    print("\n\nGenerated these files:\n")
+
+    for file in sorted(os.listdir(temp_files_directory)):
+        print(file)
+
+    
+    ## Parse a directory of files
+
+    parsed_sequences = FileSequence.from_directory(temp_files_directory)
+
+    print("\n\nFound sequences:\n")
+    for seq in parsed_sequences:
+        print(seq)
+
+
+    ## Parse by components:
+
+    sequences = FileSequence.from_components_in_directory(Components(prefix="render"), temp_files_directory)
+
+    print("\n\nParser found one sequence with prefix 'render':\n")
+    for seq in sequences:
+        print(seq)
+
+    sequences = FileSequence.from_components_in_directory(Components(extension="exr"), temp_files_directory)
+
+    print("\n\nParser found two sequence with extension 'exr':\n")
+    for seq in sequences:
+        print(seq)
+
+    sequences = FileSequence.from_components_in_directory(Components(prefix="render", extension="exr"), temp_files_directory)
+
+    print("\n\nParser found one sequence with prefix 'render' and extension 'exr':\n")
+    for seq in sequences:
+        print(seq)
+
+
+    ## Parse by filename
+
+    seq = FileSequence.from_sequence_string_in_directory("render_###_final.exr", temp_files_directory)
+
+    print("\n\nParsed a single sequence:\n")
+    print(seq)
+
+
+
+    ## Operations:
+
+    seq = FileSequence.from_sequence_string_in_directory("render_###_final.exr", temp_files_directory)
+
+    seq.move_to("/new/directory")
+    seq.rename_to("new_name")
+    seq.offset_frames(100)  # Shift all frame numbers by 100
+    new_sequence = seq.copy_to("/new/directory")
+
+    print("\n\nRenamed sequence:\n")
+    print(new_sequence)

pysequitur-0.1.2/src/pysequitur/examples/utils.py

@@ -0,0 +1,62 @@
+from pysequitur import Components, FileSequence
+import os
+from pathlib import Path
+
+seq1 = Components(
+    prefix="render",
+    delimiter=".",
+    padding=4,
+    suffix="exr",
+    extension="exr",
+)
+
+
+def create_some_sequences():
+    
+    components_1 = Components(
+        prefix="render",
+        delimiter="_",
+        padding=3,
+        suffix="_final",
+        extension="exr",
+    )
+
+    components_2 = Components(
+        prefix="plate",
+        delimiter=".",
+        padding=5,
+        extension="dpx",
+    )
+
+    components_3 = Components(
+        prefix="shot",
+        delimiter="-",
+        padding=4,
+        extension="exr",
+    )
+
+    directory = os.path.dirname(os.path.abspath(__file__)) + "/files"
+
+    generate_file_sequence(components_1, 1, 10,directory )
+    generate_file_sequence(components_2, 1001, 1010, directory)
+    generate_file_sequence(components_3, 100, 110, directory)
+
+    return directory
+
+
+def generate_file_sequence(
+    components: Components, first_frame: int, last_frame: int, directory
+) -> None:
+
+    padding = max(len(str(last_frame)), components.padding)
+
+    
+
+    if components.suffix == None:
+        components.suffix = ""
+
+    for frame_number in range(first_frame, last_frame + 1):
+        this_frame = f"{components.prefix}{components.delimiter}{str(frame_number).zfill(padding)}{components.suffix}.{components.extension}"
+        p = Path(Path(directory) / this_frame)
+        p.touch()
+