pycmx 1.4.0__tar.gz → 1.5.0__tar.gz

{pycmx-1.4.0 → pycmx-1.5.0}/PKG-INFO

@@ -1,16 +1,16 @@
 Metadata-Version: 2.4
 Name: pycmx
-Version: 1.4.0
+Version: 1.5.0
 Summary: Python CMX 3600 Edit Decision List Parser
-License: MIT
-License-File: LICENSE
 Keywords: parser,film,broadcast
 Author: Jamie Hardt
-Author-email: jamiehardt@me.com
-Requires-Python: >=3.8,<4.0
+Author-email: Jamie Hardt <jamiehardt@me.com>
+License-File: LICENSE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Text Processing
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -18,16 +18,17 @@ 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
-Classifier: Topic :: Multimedia :: Video
-Classifier: Topic :: Text Processing
-Provides-Extra: doc
-Requires-Dist: sphinx (>=5.3.0) ; extra == "doc"
-Requires-Dist: sphinx_rtd_theme (>=1.1.1) ; extra == "doc"
-Project-URL: Documentation, https://pycmx.readthedocs.io/
+Requires-Dist: pytest ; extra == 'dev'
+Requires-Dist: ruff>=0.14.10 ; extra == 'dev'
+Requires-Dist: sphinx>=5.3.0 ; extra == 'doc'
+Requires-Dist: sphinx-rtd-theme>=1.1.1 ; extra == 'doc'
+Requires-Python: >3.8
 Project-URL: Homepage, https://github.com/iluvcapra/pycmx
+Project-URL: Documentation, https://pycmx.readthedocs.io/
 Project-URL: Repository, https://github.com/iluvcapra/pycmx.git
 Project-URL: Tracker, https://github.com/iluvcapra/pycmx/issues
+Provides-Extra: dev
+Provides-Extra: doc
 Description-Content-Type: text/markdown
 
 [![Documentation Status](https://readthedocs.org/projects/pycmx/badge/?version=latest)](https://pycmx.readthedocs.io/en/latest/?badge=latest) ![](https://img.shields.io/github/license/iluvcapra/pycmx.svg) ![](https://img.shields.io/pypi/pyversions/pycmx.svg) [![](https://img.shields.io/pypi/v/pycmx.svg)](https://pypi.org/project/pycmx/) ![](https://img.shields.io/pypi/wheel/pycmx.svg)
@@ -46,6 +47,8 @@ The `pycmx` package parses a CMX 3600 EDL and its most most common variations.
   read. Event number field and source name field sizes are determined
   dynamically for each statement for a high level of compliance at the expense
   of strictness.
+* A more relaxed "tolerant" mode allows parsing of an EDL file where columns
+  use non-standard widths.
 * Preserves relationship between events and individual edits/clips.
 * Remark or comment fields with common recognized forms are read and 
   available to the client, including clip name and source file data.
@@ -67,7 +70,7 @@ The `pycmx` package parses a CMX 3600 EDL and its most most common variations.
 ### Opening and Parsing EDL Files
 ```
 >>> import pycmx
->>> with open("tests/edls/TEST.edl") as f
+>>> with open("tests/edls/TEST.edl") as f:
 ... 	edl = pycmx.parse_cmx3600(f)
 ...
 >>> edl.title
@@ -122,4 +125,3 @@ Audio channel 7 is present
 >>> events[2].edits[0].channels.video
 False
 ```
-

{pycmx-1.4.0 → pycmx-1.5.0}/README.md

@@ -14,6 +14,8 @@ The `pycmx` package parses a CMX 3600 EDL and its most most common variations.
   read. Event number field and source name field sizes are determined
   dynamically for each statement for a high level of compliance at the expense
   of strictness.
+* A more relaxed "tolerant" mode allows parsing of an EDL file where columns
+  use non-standard widths.
 * Preserves relationship between events and individual edits/clips.
 * Remark or comment fields with common recognized forms are read and 
   available to the client, including clip name and source file data.
@@ -35,7 +37,7 @@ The `pycmx` package parses a CMX 3600 EDL and its most most common variations.
 ### Opening and Parsing EDL Files
 ```
 >>> import pycmx
->>> with open("tests/edls/TEST.edl") as f
+>>> with open("tests/edls/TEST.edl") as f:
 ... 	edl = pycmx.parse_cmx3600(f)
 ...
 >>> edl.title

pycmx-1.5.0/pyproject.toml

@@ -0,0 +1,80 @@
+[project]
+name = "pycmx"
+version = "1.5.0"
+description = "Python CMX 3600 Edit Decision List Parser"
+authors = [{name = "Jamie Hardt", email= "jamiehardt@me.com"}]
+license-files = ["LICENSE"]
+readme = "README.md"
+keywords = [
+  'parser',
+  'film', 
+  'broadcast' 
+]
+requires-python = '>3.8'
+classifiers = [
+  'Development Status :: 5 - Production/Stable',
+  'License :: OSI Approved :: MIT License',
+  'Topic :: Multimedia',
+  'Topic :: Multimedia :: Video',
+  'Topic :: Text Processing',
+  'Programming Language :: Python :: 3.8',
+  'Programming Language :: Python :: 3.9',
+  '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'
+]
+
+[project.optional-dependencies]
+doc = [
+  'sphinx >= 5.3.0',
+  'sphinx_rtd_theme >= 1.1.1',
+]
+dev = [
+  'pytest',
+  'ruff>=0.14.10'
+]
+
+[project.urls]
+Homepage = "https://github.com/iluvcapra/pycmx"
+Documentation = "https://pycmx.readthedocs.io/"
+Repository = "https://github.com/iluvcapra/pycmx.git"
+Tracker = "https://github.com/iluvcapra/pycmx/issues" 
+
+[dependency-groups]
+dev = ['ruff', 'pytest']
+doc = ['sphinx', 'sphinx_rtd_theme']
+
+
+[tool.pyright]
+typeCheckingMode = "basic"
+
+[tool.ruff]
+line-length = 88
+indent-width = 4
+
+[tool.ruff.lint]
+select = ["E", "F", "W"]
+
+[tool.ruff.format]
+docstring-code-line-length = 88
+
+# [tool.pylint]
+# max-line-length = 88
+# disable = [
+#     "C0103", # (invalid-name)
+#     "C0114", # (missing-module-docstring)
+#     "C0115", # (missing-class-docstring)
+#     "C0116", # (missing-function-docstring)
+#     "R0903", # (too-few-public-methods)
+#     "R0913", # (too-many-arguments)
+#     "W0105", # (pointless-string-statement)
+# ]
+#
+
+
+
+[build-system]
+requires = ["uv_build>=0.9.18,<0.10.0"]
+build-backend = "uv_build"

{pycmx-1.4.0 → pycmx-1.5.0/src}/pycmx/__init__.py

@@ -11,3 +11,5 @@ from .parse_cmx_events import parse_cmx3600
 from .transition import Transition
 from .event import Event
 from .edit import Edit
+
+__all__ = ("parse_cmx3600", "Transition", "Event", "Edit")

{pycmx-1.4.0 → pycmx-1.5.0/src}/pycmx/edit.py

@@ -35,7 +35,6 @@ class Edit:
         asc_sat_statement: Optional[StmtCdlSat] = None,
         frmc_statement: Optional[StmtFrmc] = None,
     ) -> None:
-        # Assigning types for the attributes explicitly
         self._edit_statement: StmtEvent = edit_statement
         self._audio_ext: Optional[StmtAudioExt] = audio_ext_statement
         self._clip_name_statement: Optional[StmtClipName] = clip_name_statement
@@ -51,8 +50,8 @@ class Edit:
     def line_number(self) -> int:
         """
         Get the line number for the "standard form" statement associated with
-        this edit. Line numbers a zero-indexed, such that the
-        "TITLE:" record is line zero.
+        this edit. Line numbers a zero-indexed, such that the "TITLE:" record
+        is line zero.
         """
         return self._edit_statement.line_number
 
@@ -180,7 +179,7 @@ class Edit:
     @property
     def asc_sop_raw(self) -> Optional[str]:
         """
-        ASC CDL Slope-Offset-Power statement raw line
+        ASC CDL Slope-Offset-Power statement raw line.
         """
         if self._asc_sop_statement is None:
             return None
@@ -190,7 +189,7 @@ class Edit:
     @property
     def asc_sat(self) -> Optional[float]:
         """
-        Get ASC CDL saturation value for clip, if present
+        Get ASC CDL saturation value for clip, if present.
         """
         if self._asc_sat_statement is None:
             return None

{pycmx-1.4.0 → pycmx-1.5.0/src}/pycmx/edit_list.py

@@ -12,10 +12,10 @@ from typing import Any, Generator
 class EditList:
     """
     Represents an entire edit decision list as returned by
-    :func:`~pycmx.parse_cmx3600()`.
+    :func:`~pycmx.parse_cmx_events.parse_cmx3600()`.
     """
 
-    def __init__(self, statements):
+    def __init__(self, statements: list):
         self.title_statement: StmtTitle = statements[0]
         self.event_statements = statements[1:]
 

{pycmx-1.4.0 → pycmx-1.5.0/src}/pycmx/event.py

@@ -31,12 +31,27 @@ class Event:
         will have multiple edits when a dissolve, wipe or key transition needs
         to be performed.
         """
+
+        # FTR this is a totall bonkers way of doing this, I wrote this when
+        # I was still learning Python and I'm sure there's easier ways to do
+        # it. The job is complicated because multiple edits can occur in one
+        # event and then other statements can modify the event in different
+        # ways.
+
         edits_audio = list(self._statements_with_audio_ext())
         clip_names = self._clip_name_statements()
         source_files = self._source_file_statements()
 
+        # We first get the edit events combined with their extra audio
+        # channel statements, if any.
+
+        # The list the_zip contains one element for each initialization
+        # parameter in Edit()
         the_zip: List[List[Any]] = [edits_audio]
 
+        # If there are two Clip Name statements and two edits, we look for
+        # "FROM" and "TO" clip name lines. Otherwise we just look for on
+        # each per edit.
         if len(edits_audio) == 2:
             start_name: Optional[StmtClipName] = None
             end_name: Optional[StmtClipName] = None
@@ -54,6 +69,10 @@ class Event:
             else:
                 the_zip.append([None] * len(edits_audio))
 
+        # if there's one source file statemnent per clip, we allocate them to
+        # each edit in order. Otherwise if there's only one, we assign the one
+        # to all the edits. If there's no source_file statements, we provide
+        # None.
         if len(edits_audio) == len(source_files):
             the_zip.append(source_files)
         elif len(source_files) == 1:
@@ -61,7 +80,7 @@ class Event:
         else:
             the_zip.append([None] * len(edits_audio))
 
-        # attach trans name to last event
+        # attach effects name to last event
         try:
             trans_statement = self._trans_name_statements()[0]
             trans_names: List[Optional[Any]] = [None] * (len(edits_audio) - 1)
@@ -104,11 +123,16 @@ class Event:
 
     def _statements_with_audio_ext(self) -> Generator[
             Tuple[StmtEvent, Optional[StmtAudioExt]], None, None]:
-        for (s1, s2) in zip(self.statements, self.statements[1:]):
-            if type(s1) is StmtEvent and type(s2) is StmtAudioExt:
-                yield (s1, s2)
-            elif type(s1) is StmtEvent:
-                yield (s1, None)
+
+        if len(self.statements) == 1 and type(self.statements[0]) is StmtEvent:
+            yield (self.statements[0], None)
+
+        else:
+            for (s1, s2) in zip(self.statements, self.statements[1:]):
+                if type(s1) is StmtEvent and type(s2) is StmtAudioExt:
+                    yield (s1, s2)
+                elif type(s1) is StmtEvent:
+                    yield (s1, None)
 
     def _asc_sop_statement(self) -> Optional[StmtCdlSop]:
         return next((s for s in self.statements if type(s) is StmtCdlSop),

{pycmx-1.4.0 → pycmx-1.5.0/src}/pycmx/parse_cmx_events.py

@@ -7,12 +7,14 @@ from .parse_cmx_statements import (parse_cmx3600_statements)
 from .edit_list import EditList
 
 
-def parse_cmx3600(f: TextIO) -> EditList:
+def parse_cmx3600(f: TextIO, tolerant: bool = False) -> EditList:
     """
     Parse a CMX 3600 EDL.
 
     :param TextIO f: a file-like object, an opened CMX 3600 .EDL file.
+    :param bool tolerant: If `True`, a relaxed event line parsing method will
+        be used, in the case the default method fails.
     :returns: An :class:`pycmx.edit_list.EditList`.
     """
-    statements = parse_cmx3600_statements(f)
+    statements = parse_cmx3600_statements(f, tolerant)
     return EditList(statements)

{pycmx-1.4.0 → pycmx-1.5.0/src}/pycmx/parse_cmx_statements.py

@@ -13,12 +13,13 @@ from .statements import (StmtCdlSat, StmtCdlSop, StmtCorruptRemark, StmtFrmc,
 from .util import collimate
 
 
-def parse_cmx3600_statements(file: TextIO) -> List[object]:
+def parse_cmx3600_statements(file: TextIO,
+                             tolerant: bool = False) -> List[object]:
     """
     Return a list of every statement in the file argument.
     """
     lines = file.readlines()
-    return [_parse_cmx3600_line(line.strip(), line_number)
+    return [_parse_cmx3600_line(line.strip(), line_number, tolerant)
             for (line_number, line) in enumerate(lines)]
 
 
@@ -38,7 +39,8 @@ def _edl_column_widths(event_field_length, source_field_length) -> List[int]:
 #             8,8,1,4,2,1,4,13,3,1,1]
 
 
-def _parse_cmx3600_line(line: str, line_number: int) -> object:
+def _parse_cmx3600_line(line: str, line_number: int,
+                        tolerant: bool = False) -> object:
     """
     Parses a single CMX EDL line.
 
@@ -54,9 +56,19 @@ def _parse_cmx3600_line(line: str, line_number: int) -> object:
         return _parse_fcm(line, line_number)
     if line_matcher is not None:
         event_field_len = len(line_matcher.group(1))
+
         source_field_len = len(line) - (event_field_len + 65)
-        return _parse_columns_for_standard_form(line, event_field_len,
-                                                source_field_len, line_number)
+
+        try:
+            return _parse_columns_for_standard_form(
+                    line, event_field_len, source_field_len, line_number)
+
+        except EventFormError:
+            if tolerant:
+                return _parse_columns_tolerant(line, line_number)
+            else:
+                return StmtUnrecognized(line, line_number)
+
     if line.startswith("AUD"):
         return _parse_extended_audio_channels(line, line_number)
     if line.startswith("*"):
@@ -190,6 +202,10 @@ def _parse_split(line: str, line_number):
 #     return StmtMotionMemory(source="", fps="")
 #
 
+class EventFormError(RuntimeError):
+    pass
+
+
 def _parse_unrecognized(line, line_number):
     return StmtUnrecognized(content=line, line_number=line_number)
 
@@ -197,17 +213,24 @@ def _parse_unrecognized(line, line_number):
 def _parse_columns_for_standard_form(line: str, event_field_length: int,
                                      source_field_length: int,
                                      line_number: int):
+    # breakpoint()
     col_widths = _edl_column_widths(event_field_length, source_field_length)
 
     if sum(col_widths) > len(line):
-        return StmtUnrecognized(content=line, line_number=line_number)
+        raise EventFormError()
 
     column_strings = collimate(line, col_widths)
 
+    channels = column_strings[4].strip()
+    trans = column_strings[6].strip()
+
+    if len(channels) == 0 or len(trans) == 0:
+        raise EventFormError()
+
     return StmtEvent(event=column_strings[0],
                      source=column_strings[2].strip(),
-                     channels=column_strings[4].strip(),
-                     trans=column_strings[6].strip(),
+                     channels=channels,
+                     trans=trans,
                      trans_op=column_strings[8].strip(),
                      source_in=column_strings[10].strip(),
                      source_out=column_strings[12].strip(),
@@ -217,6 +240,26 @@ def _parse_columns_for_standard_form(line: str, event_field_length: int,
                      source_field_size=source_field_length)
 
 
+def _parse_columns_tolerant(line: str, line_number: int):
+    pattern = re.compile(r'^\s*(\d+)\s+(.{8,128}?)\s+'
+                         r'(V|A|A2|AA|NONE|AA/V|A2/V|B)\s+'
+                         r'(C|D|W|KB|K|KO)\s+(\d*)\s+(\d\d.\d\d.\d\d.\d\d)\s'
+                         r'(\d\d.\d\d.\d\d.\d\d)\s(\d\d.\d\d.\d\d.\d\d)\s'
+                         r'(\d\d.\d\d.\d\d.\d\d)'
+                         )
+
+    match = pattern.match(line)
+    if match:
+        return StmtEvent(event=int(match.group(1)), source=match.group(2),
+                         channels=match.group(3), trans=match.group(4),
+                         trans_op=match.group(5), source_in=match.group(6),
+                         source_out=match.group(7), record_in=match.group(8),
+                         record_out=match.group(9), line_number=line_number,
+                         source_field_size=len(match.group(2)))
+    else:
+        return StmtUnrecognized(line, line_number)
+
+
 def _parse_source_umid_statement(line, line_number):
     # trimmed = line[3:].strip()
     # return StmtSourceUMID(name=None, umid=None, line_number=line_number)

{pycmx-1.4.0 → pycmx-1.5.0/src}/pycmx/statements.py

@@ -5,8 +5,6 @@ from typing import Any, NamedTuple
 
 from .cdl import AscSopComponents
 
-# type str = str
-
 
 class StmtTitle(NamedTuple):
     title: str

{pycmx-1.4.0 → pycmx-1.5.0/src}/pycmx/transition.py

@@ -24,7 +24,7 @@ class Transition:
     @property
     def kind(self) -> Optional[str]:
         """
-        Return the kind of transition: Cut, Wipe, etc
+        Return the kind of transition: Cut, Wipe, etc.
         """
         if self.cut:
             return Transition.Cut
@@ -56,7 +56,8 @@ class Transition:
 
     @property
     def effect_duration(self) -> int:
-        """The duration of this transition, in frames of the record target.
+        """
+        The duration of this transition, in frames of the record target.
 
         In the event of a key event, this is the duration of the fade in.
         """

pycmx-1.4.0/pyproject.toml

@@ -1,56 +0,0 @@
-[tool.poetry]
-name = "pycmx"
-version = "1.4.0"
-description = "Python CMX 3600 Edit Decision List Parser"
-authors = ["Jamie Hardt <jamiehardt@me.com>"]
-license = "MIT"
-readme = "README.md"
-keywords = [
-  'parser',
-  'film', 
-  'broadcast' 
-]
-classifiers = [
-  'Development Status :: 5 - Production/Stable',
-  'License :: OSI Approved :: MIT License',
-  'Topic :: Multimedia',
-  'Topic :: Multimedia :: Video',
-  'Topic :: Text Processing',
-  'Programming Language :: Python :: 3.8',
-  'Programming Language :: Python :: 3.9',
-  'Programming Language :: Python :: 3.10',
-  'Programming Language :: Python :: 3.11',
-  'Programming Language :: Python :: 3.12',
-  'Programming Language :: Python :: 3.13'
-]
-homepage = "https://github.com/iluvcapra/pycmx"
-documentation = "https://pycmx.readthedocs.io/"
-repository = "https://github.com/iluvcapra/pycmx.git"
-urls.Tracker = "https://github.com/iluvcapra/pycmx/issues" 
-
-[tool.poetry.extras]
-doc = ['sphinx', 'sphinx_rtd_theme']
-
-[tool.poetry.dependencies]
-python = "^3.8"
-sphinx = { version='>= 5.3.0', optional=true}
-sphinx_rtd_theme = {version ='>= 1.1.1', optional=true}
-
-[tool.pyright]
-typeCheckingMode = "basic"
-
-[tool.pylint]
-max-line-length = 88
-disable = [
-    "C0103", # (invalid-name)
-    "C0114", # (missing-module-docstring)
-    "C0115", # (missing-class-docstring)
-    "C0116", # (missing-function-docstring)
-    "R0903", # (too-few-public-methods)
-    "R0913", # (too-many-arguments)
-    "W0105", # (pointless-string-statement)
-]
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"