pysequitur 0.1.2__py3-none-any.whl

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/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/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()
+