Nudged version

Added support for Adobe Premiere EDLs > 999 events

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+per-file-ignores =
+    pycmx/__init__.py: F401
+    tests/__init__.py: F401
+    

.github/workflows/bsky_test.yml

@@ -0,0 +1,25 @@
+name: Test Post to Bluesky
+
+on:
+  workflow_dispatch:
+    
+# permissions:
+#   contents: read
+#   id-token: write
+  
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+    steps:
+    - name: Send Bluesky Post
+      uses: myConsciousness/bluesky-post@v5
+      with:
+        text: |
+          This is a test post!
+        link-preview-url: ${{ github.server_url }}/${{ github.repository }}
+        identifier: ${{ secrets.BLUESKY_APP_USER }}  
+        password: ${{ secrets.BLUESKY_APP_PASSWORD }}
+        service: bsky.social    
+        retry-count: 1

.github/workflows/python-package.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: Python package
+name: Lint and Test
 
 on:
   push:
@@ -16,8 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
-
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
@@ -28,13 +27,12 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        python -m pip install -e .
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+        flake8 . --count --max-line-length=79 --statistics
     - name: Test with pytest
       run: |
         pytest

.github/workflows/pythonpublish.yml

@@ -2,25 +2,41 @@ name: Upload Python Package
 
 on:
   release:
-    types: [created]
-
+    types: [published]
+    
+permissions:
+  contents: read
+  id-token: write
+  
 jobs:
   deploy:
     runs-on: ubuntu-latest
+    environment:
+      name: release
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v4.2.2
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v5.3.0
       with:
         python-version: '3.x'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_APIKEY }}
-      run: |
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
+        pip install build
+    - name: Build package
+      run: python -m build .
+    - name: Publish to Pypi
+      uses: pypa/gh-action-pypi-publish@v1.12.2
+      with:
+        password: ${{ secrets.PYPI_APIKEY }}
+    - name: Send Bluesky Post
+      uses: myConsciousness/bluesky-post@v5
+      with:
+        text: |
+          I've released a new version of pycmx, my python module for 
+          reading CMX EDLs.
+        link-preview-url: ${{ github.server_url }}/${{ github.repository }}
+        identifier: ${{ secrets.BLUESKY_APP_USER }}  
+        password: ${{ secrets.BLUESKY_APP_PASSWORD }}
+        service: bsky.social    
+        retry-count: 1

.gitignore

@@ -11,3 +11,12 @@
 # Vim Swapfiles
 *.swp
 .DS_Store
+
+venv/
+
+.coverage
+lcov.info
+
+
+# venv
+venv/

.idea/.gitignore

@@ -1,3 +0,0 @@
-
-# Default ignored files
-/workspace.xml

.idea/inspectionProfiles/profiles_settings.xml

@@ -1,6 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <settings>
-    <option name="USE_PROJECT_PROFILE" value="false" />
-    <version value="1.0" />
-  </settings>
-</component>

.idea/misc.xml

@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.7" project-jdk-type="Python SDK" />
-</project>

.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/pycmx.iml" filepath="$PROJECT_DIR$/.idea/pycmx.iml" />
-    </modules>
-  </component>
-</project>

.idea/pycmx.iml

@@ -1,11 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="PYTHON_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="jdk" jdkName="Python 3.7" jdkType="Python SDK" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-  <component name="TestRunnerService">
-    <option name="PROJECT_TEST_RUNNER" value="Unittests" />
-  </component>
-</module>

.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.10"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+#If using Sphinx, optionally build your docs in additional formats such as PDF
+formats:
+   - pdf
+
+#Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc

.travis.yml

@@ -1,18 +0,0 @@
-language: python
-python:
-  - "3.8"
-  - "3.7"
-  - "3.6"
-  - "3.5"
-  - "2.7"
-script:
-  - "python setup.py test"
-  - "py.test tests/ -v --cov pycmx --cov-report term-missing"
-install:
-  - "pip install setuptools"
-before_install:
-  - "pip install coverage"
-  - "pip install codecov"
-  - "pip install pytest-cov==2.5.0"
-after_success:
-  - "codecov"

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+Contributions to this project are welcome!
+
+The best way to contribute code to this project is to find this project on [Github][github] and submit a pull request.
+
+## Call for EDLs
+
+If you have EDLs you are having trouble working with becuase of unusual formatting, please send me a copy! Contact us
+through [Github].
+
+
+[github]: https://github.com/iluvcapra/pycmx

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Jamie Hardt.
+Copyright (c) 2022 Jamie Hardt.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,16 +1,18 @@
-[![Build Status](https://travis-ci.com/iluvcapra/pycmx.svg?branch=master)](https://travis-ci.com/iluvcapra/pycmx)
-[![codecov](https://codecov.io/gh/iluvcapra/pycmx/branch/master/graph/badge.svg)](https://codecov.io/gh/iluvcapra/pycmx)
 [![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)
+![GitHub last commit](https://img.shields.io/github/last-commit/iluvcapra/pycmx)
+[![Lint and Test](https://github.com/iluvcapra/pycmx/actions/workflows/python-package.yml/badge.svg)](https://github.com/iluvcapra/pycmx/actions/workflows/python-package.yml)
 
 
 # pycmx
 
-The `pycmx` package provides a basic interface for parsing a CMX 3600 EDL and its most most common variations.
+The `pycmx` package provides a basic interface for parsing a CMX 3600 EDL and 
+its most most common variations.
 
 ## Features
 
-* The major variations of the CMX 3600: the standard, "File32" and "File128" 
-  formats are automatically detected and properly read.
+* The major variations of the CMX 3600: the standard, "File32", "File128" and 
+  long Adobe Premiere event numbers are automatically detected and properly
+  read.
 * 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.
@@ -83,5 +85,3 @@ Audio channel 7 is present
 >>> events[2].edits[0].channels.video
 False
 ```
-
-

bin/edl2scenelist.py

@@ -12,6 +12,7 @@ logging.basicConfig(format=FORMAT)
 
 log = logging.getLogger(__name__)
 
+
 def all_video_edits(edl):
     for event in edl.events:
         for edit in event.edits:
@@ -30,46 +31,49 @@ def get_scene_name(edit, pattern):
         else:
             return edit.clip_name
 
+
 def output_cmx(outfile, out_list):
     outfile.write("TITLE:  SCENE LIST\r\n")
     outfile.write("FCM: NON-DROP FRAME\r\n")
 
-    for o in out_list:
-        line = "%03i  AX       V     C        00:00:00:00 00:00:00:00 %s %s\r\n" % (0, o['start'],o['end'])
+    for i, o in enumerate(out_list):
+        line = '%03i  AX       V     C        ' % (i)
+        line += '00:00:00:00 00:00:00:00 %s %s\r\n' % (o['start'], o['end'])
         outfile.write(line)
-        outfile.write("* FROM CLIP NAME: %s\r\n" % (o['scene']) )
+        outfile.write("* FROM CLIP NAME: %s\r\n" % (o['scene']))
 
 
 def output_cols(outfile, out_list):
     for o in out_list:
-        outfile.write("%-12s\t%-12s\t%s\n" % (o['start'], o['end'], o['scene'] ))
+        outfile.write("%-12s\t%-12s\t%s\n" %
+                      (o['start'], o['end'], o['scene']))
 
 
 def scene_list(infile, outfile, out_format, pattern):
-    
+
     edl = pycmx.parse_cmx3600(infile)
 
     current_scene_name = None
-    
-    grouped_edits = [ ]
+
+    grouped_edits = []
 
     for edit in all_video_edits(edl):
         this_scene_name = get_scene_name(edit, pattern)
         if this_scene_name is not None:
             if current_scene_name != this_scene_name:
-                grouped_edits.append([ ])
+                grouped_edits.append([])
                 current_scene_name = this_scene_name
 
             grouped_edits[-1].append(edit)
-    
-    out_list = [ ]
+
+    out_list = []
     for group in grouped_edits:
-        out_list.append({ 
-            'start': group[0].record_in, 
+        out_list.append({
+            'start': group[0].record_in,
             'end': group[-1].record_out,
-            'scene': get_scene_name(group[0], pattern ) }
-            )
-    
+            'scene': get_scene_name(group[0], pattern)}
+        )
+
     if out_format == 'cmx':
         output_cmx(outfile, out_list)
     if out_format == 'cols':
@@ -80,23 +84,29 @@ def scene_list(infile, outfile, out_format, pattern):
 
 
 def scene_list_cli():
-    parser = argparse.ArgumentParser(description=
-            'Read video events from an input CMX EDL and output events merged into scenes.')
-    parser.add_argument('-o','--outfile', default=sys.stdout, type=argparse.FileType('w'), 
-            help='Output file. Default is stdout.')
-    parser.add_argument('-f','--format', default='cmx', type=str, 
-            help='Output format. Options are cols and cmx, cmx is the default.')
-    parser.add_argument('-p','--pattern', default='V?([A-Z]*[0-9]+)',
-            help='RE pattern for extracting scene name from clip name. The default is "V?([A-Z]*[0-9]+)". ' + \
-                    'This pattern will be matched case-insensitively.')
-    parser.add_argument('input_edl', default=sys.stdin, type=argparse.FileType('r'), nargs='?', 
-            help='Input file. Default is stdin.')
+    parser = argparse.ArgumentParser(
+        description='Read video events from an input CMX EDL and output '
+        'events merged into scenes.')
+    parser.add_argument('-o', '--outfile', default=sys.stdout,
+                        type=argparse.FileType('w'),
+                        help='Output file. Default is stdout.')
+    parser.add_argument('-f', '--format', default='cmx', type=str,
+                        help='Output format. Options are cols and cmx, cmx '
+                        'is the default.')
+    parser.add_argument('-p', '--pattern', default='V?([A-Z]*[0-9]+)',
+                        help='RE pattern for extracting scene name from clip '
+                        'name. The default is "V?([A-Z]*[0-9]+)". ' +
+                        'This pattern will be matched case-insensitively.')
+    parser.add_argument('input_edl', default=sys.stdin,
+                        type=argparse.FileType('r'), nargs='?',
+                        help='Input file. Default is stdin.')
     args = parser.parse_args()
-    
+
     infile = args.input_edl
 
-    scene_list(infile=infile, outfile=args.outfile , out_format=args.format, pattern=args.pattern)
+    scene_list(infile=infile, outfile=args.outfile,
+               out_format=args.format, pattern=args.pattern)
 
 
 if __name__ == '__main__':
-   scene_list_cli()
+    scene_list_cli()

docs/make.bat

@@ -1,35 +0,0 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=source
-set BUILDDIR=build
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-
-:end
-popd

docs/source/classes.rst

@@ -0,0 +1,24 @@
+pycmx Classes
+=============
+
+.. autoclass:: pycmx.edit_list.EditList 
+   :members:
+
+
+.. autoclass:: pycmx.event.Event 
+   :members:
+
+
+.. autoclass:: pycmx.edit.Edit  
+   :members:
+
+
+.. autoclass:: pycmx.transition.Transition
+   :members:
+
+
+.. autoclass:: pycmx.channel_map.ChannelMap
+   :members:
+
+
+

docs/source/conf.py

@@ -12,21 +12,22 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
+import importlib
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../../pycmx'))
+sys.path.insert(0, os.path.abspath('../..'))
 
 
 # -- Project information -----------------------------------------------------
 
 project = u'pycmx'
-copyright = u'2018, Jamie Hardt'
+copyright = u'(c) 2025, Jamie Hardt'
 author = u'Jamie Hardt'
 
+release = importlib.metadata.version("pycmx")
+version = release
 # The short X.Y version
-version = u''
 # The full version, including alpha/beta/rc tags
-release = u''
 
 
 # -- General configuration ---------------------------------------------------
@@ -63,7 +64,7 @@ master_doc = 'index'
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'em'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -144,7 +145,7 @@ latex_documents = [
 # (source start file, name, description, authors, manual section).
 man_pages = [
     (master_doc, 'pycmx', u'pycmx Documentation',
-     [author], 1)
+     [author], "3p")
 ]
 
 

docs/source/function.rst

@@ -0,0 +1,7 @@
+Parse Function
+==============
+
+
+.. autofunction:: pycmx.parse_cmx_events.parse_cmx3600
+
+

docs/source/index.rst

@@ -8,13 +8,13 @@ Welcome to pycmx's documentation!
 
 .. toctree::
    :maxdepth: 5
-   :caption: API Reference:
-   
-   pycmx
+   :caption: API Reference
+
+   function
+   classes
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`

docs/source/modules.rst

@@ -1,7 +0,0 @@
-pycmx
-=====
-
-.. toctree::
-   :maxdepth: 4
-
-   pycmx

docs/source/pycmx.rst

@@ -1,46 +0,0 @@
-pycmx package
-=============
-
-Submodules
-----------
-
-pycmx.channel\_map module
--------------------------
-
-.. automodule:: pycmx.channel_map
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pycmx.parse\_cmx\_events module
--------------------------------
-
-.. automodule:: pycmx.parse_cmx_events
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pycmx.parse\_cmx\_statements module
------------------------------------
-
-.. automodule:: pycmx.parse_cmx_statements
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-pycmx.util module
------------------
-
-.. automodule:: pycmx.util
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: pycmx
-    :members:
-    :undoc-members:
-    :show-inheritance:

pycmx/__init__.py

@@ -1,16 +1,12 @@
 # -*- coding: utf-8 -*-
 """
-pycmx is a module for parsing CMX 3600-style EDLs. For more information and
-examples see README.md
+pycmx is a parser for CMX 3600-style EDLs.
 
-This module (c) 2018 Jamie Hardt. For more information on your rights to
+This module (c) 2025 Jamie Hardt. For more information on your rights to
 copy and reuse this software, refer to the LICENSE file included with the
 distribution.
 """
 
-__version__ = '1.1.1'
-__author__  = 'Jamie Hardt'
-
 from .parse_cmx_events import parse_cmx3600
 from .transition import Transition
 from .event import Event

pycmx/channel_map.py

@@ -2,89 +2,91 @@
 # (c) 2018 Jamie Hardt
 
 from re import (compile, match)
+from typing import Dict, Tuple, Generator
+
 
 class ChannelMap:
     """
     Represents a set of all the channels to which an event applies.
     """
 
-    _chan_map = {     
-                "V" :    (True,   False,   False),
-                "A" :    (False,  True,    False),
-                "A2" :   (False,  False,   True),
-                "AA" :   (False,  True,    True),
-                "B" :    (True,   True,    False),
-                "AA/V" : (True,   True,    True),
-                "A2/V" : (True,   False,   True)
-        }
+    _chan_map: Dict[str, Tuple] = {
+        "V":    (True,   False,   False),
+        "A":    (False,  True,    False),
+        "A2":   (False,  False,   True),
+        "AA":   (False,  True,    True),
+        "B":    (True,   True,    False),
+        "AA/V": (True,   True,    True),
+        "A2/V": (True,   False,   True)
+    }
 
     def __init__(self, v=False, audio_channels=set()):
-        self._audio_channel_set = audio_channels 
+        self._audio_channel_set = audio_channels
         self.v = v
 
     @property
-    def video(self):
+    def video(self) -> bool:
         'True if video is included'
         return self.v
 
     @property
-    def audio(self):
+    def audio(self) -> bool:
         'True if an audio channel is included'
         return len(self._audio_channel_set) > 0
 
     @property
-    def channels(self):
+    def channels(self) -> Generator[int, None, None]:
         'A generator for each audio channel'
         for c in self._audio_channel_set:
             yield c
 
     @property
-    def a1(self):
-        """True if A1 is included."""
+    def a1(self) -> bool:
+        """True if A1 is included"""
         return self.get_audio_channel(1)
 
     @a1.setter
-    def a1(self,val):
-        self.set_audio_channel(1,val)
+    def a1(self, val: bool):
+        self.set_audio_channel(1, val)
 
     @property
-    def a2(self):
-        """True if A2 is included."""
+    def a2(self) -> bool:
+        """True if A2 is included"""
         return self.get_audio_channel(2)
 
     @a2.setter
-    def a2(self,val):
-        self.set_audio_channel(2,val)
+    def a2(self, val: bool):
+        self.set_audio_channel(2, val)
 
     @property
-    def a3(self):
-        """True if A3 is included."""
+    def a3(self) -> bool:
+        """True if A3 is included"""
         return self.get_audio_channel(3)
 
     @a3.setter
-    def a3(self,val):
-        self.set_audio_channel(3,val)
-    
+    def a3(self, val: bool):
+        self.set_audio_channel(3, val)
+
     @property
-    def a4(self):
-        """True if A4 is included."""
+    def a4(self) -> bool:
+        """True if A4 is included"""
         return self.get_audio_channel(4)
 
     @a4.setter
-    def a4(self,val):
-        self.set_audio_channel(4,val)
+    def a4(self, val: bool):
+        self.set_audio_channel(4, val)
 
-    def get_audio_channel(self,chan_num):
-        """True if chan_num is included."""
+    def get_audio_channel(self, chan_num) -> bool:
+        """True if chan_num is included"""
         return (chan_num in self._audio_channel_set)
 
-    def set_audio_channel(self,chan_num,enabled):
-        """If enabled is true, chan_num will be included."""
+    def set_audio_channel(self, chan_num, enabled: bool):
+        """If enabled is true, chan_num will be included"""
         if enabled:
             self._audio_channel_set.add(chan_num)
         elif self.get_audio_channel(chan_num):
             self._audio_channel_set.remove(chan_num)
-    
+
     def _append_event(self, event_str):
         alt_channel_re = compile(r'^A(\d+)')
         if event_str in self._chan_map:
@@ -95,7 +97,7 @@ class ChannelMap:
         else:
             matchresult = match(alt_channel_re, event_str)
             if matchresult:
-                self.set_audio_channel(int( matchresult.group(1)), True )
+                self.set_audio_channel(int(matchresult.group(1)), True)
 
     def _append_ext(self, audio_ext):
         self.a3 = audio_ext.audio3
@@ -103,9 +105,9 @@ class ChannelMap:
 
     def __or__(self, other):
         """
-        Return the logical union of this channel map with another
+        the logical union of this channel map with another
         """
         out_v = self.video | other.video
         out_a = self._audio_channel_set | other._audio_channel_set
 
-        return ChannelMap(v=out_v,audio_channels = out_a)
+        return ChannelMap(v=out_v, audio_channels=out_a)

pycmx/edit.py

@@ -3,59 +3,68 @@
 
 from .transition import Transition
 from .channel_map import ChannelMap
-from .parse_cmx_statements import StmtEffectsName
+# from .parse_cmx_statements import StmtEffectsName
+
+from typing import Optional
+
 
 class Edit:
     """
-    An individual source-to-record operation, with a source roll, source and 
+    An individual source-to-record operation, with a source roll, source and
     recorder timecode in and out, a transition and channels.
     """
-    def __init__(self, edit_statement, audio_ext_statement, clip_name_statement, source_file_statement, trans_name_statement = None):
+
+    def __init__(self, edit_statement, audio_ext_statement,
+                 clip_name_statement, source_file_statement,
+                 trans_name_statement=None):
         self.edit_statement = edit_statement
         self.audio_ext = audio_ext_statement
         self.clip_name_statement = clip_name_statement
         self.source_file_statement = source_file_statement
-        self.trans_name_statement = trans_name_statement 
+        self.trans_name_statement = trans_name_statement
 
     @property
-    def line_number(self):
+    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 
+        this edit. Line numbers a zero-indexed, such that the
         "TITLE:" record is line zero.
         """
         return self.edit_statement.line_number
 
     @property
-    def channels(self):
+    def channels(self) -> ChannelMap:
         """
         Get the :obj:`ChannelMap` object associated with this Edit.
         """
         cm = ChannelMap()
         cm._append_event(self.edit_statement.channels)
-        if self.audio_ext != None:
+        if self.audio_ext is not None:
             cm._append_ext(self.audio_ext)
         return cm
 
     @property
-    def transition(self):
+    def transition(self) -> Transition:
         """
         Get the :obj:`Transition` object associated with this edit.
         """
         if self.trans_name_statement:
-            return Transition(self.edit_statement.trans, self.edit_statement.trans_op, self.trans_name_statement.name)
+            return Transition(self.edit_statement.trans,
+                              self.edit_statement.trans_op,
+                              self.trans_name_statement.name)
         else:
-            return Transition(self.edit_statement.trans, self.edit_statement.trans_op, None)
-    
+            return Transition(self.edit_statement.trans,
+                              self.edit_statement.trans_op, None)
+
     @property
-    def source_in(self):
+    def source_in(self) -> str:
         """
         Get the source in timecode.
         """
         return self.edit_statement.source_in
 
     @property
-    def source_out(self):
+    def source_out(self) -> str:
         """
         Get the source out timecode.
         """
@@ -63,7 +72,7 @@ class Edit:
         return self.edit_statement.source_out
 
     @property
-    def record_in(self):
+    def record_in(self) -> str:
         """
         Get the record in timecode.
         """
@@ -71,7 +80,7 @@ class Edit:
         return self.edit_statement.record_in
 
     @property
-    def record_out(self):
+    def record_out(self) -> str:
         """
         Get the record out timecode.
         """
@@ -79,7 +88,7 @@ class Edit:
         return self.edit_statement.record_out
 
     @property
-    def source(self):
+    def source(self) -> str:
         """
         Get the source column. This is the 8, 32 or 128-character string on the
         event record line, this usually references the tape name of the source.
@@ -87,21 +96,21 @@ class Edit:
         return self.edit_statement.source
 
     @property
-    def black(self):
+    def black(self) -> bool:
         """
         Black video or silence should be used as the source for this event.
         """
         return self.source == "BL"
 
     @property
-    def aux_source(self):
+    def aux_source(self) -> bool:
         """
         An auxiliary source is the source of this event.
         """
         return self.source == "AX"
 
     @property
-    def source_file(self):
+    def source_file(self) -> Optional[str]:
         """
         Get the source file, as attested by a "* SOURCE FILE" remark on the
         EDL. This will return None if the information is not present.
@@ -112,9 +121,9 @@ class Edit:
             return self.source_file_statement.filename
 
     @property
-    def clip_name(self):
+    def clip_name(self) -> Optional[str]:
         """
-        Get the clip name, as attested by a "* FROM CLIP NAME" or "* TO CLIP 
+        Get the clip name, as attested by a "* FROM CLIP NAME" or "* TO CLIP
         NAME" remark on the EDL. This will return None if the information is
         not present.
         """
@@ -122,5 +131,3 @@ class Edit:
             return None
         else:
             return self.clip_name_statement.name
-
-

pycmx/edit_list.py

@@ -1,27 +1,34 @@
 # pycmx
 # (c) 2018 Jamie Hardt
 
-from .parse_cmx_statements import (StmtUnrecognized, StmtFCM, StmtEvent, StmtSourceUMID)
+from .parse_cmx_statements import (
+    StmtUnrecognized, StmtEvent, StmtSourceUMID)
 from .event import Event
 from .channel_map import ChannelMap
 
+from typing import Generator
+
+
 class EditList:
     """
-    Represents an entire edit decision list as returned by `parse_cmx3600()`.
-    
+    Represents an entire edit decision list as returned by
+    :func:`~pycmx.parse_cmx3600()`.
     """
+
     def __init__(self, statements):
         self.title_statement = statements[0]
         self.event_statements = statements[1:]
 
-    
     @property
-    def format(self):
+    def format(self) -> str:
         """
-        The detected format of the EDL. Possible values are: `3600`,`File32`,
-        `File128`, and `unknown`
+        The detected format of the EDL. Possible values are: "3600", "File32",
+        "File128", and "unknown".
+
+        Adobe EDLs with more than 999 events will be reported as "3600".
         """
-        first_event = next( (s for s in self.event_statements if type(s) is StmtEvent), None)
+        first_event = next(
+            (s for s in self.event_statements if type(s) is StmtEvent), None)
 
         if first_event:
             if first_event.format == 8:
@@ -34,10 +41,9 @@ class EditList:
                 return 'unknown'
         else:
             return 'unknown'
-        
 
     @property
-    def channels(self):
+    def channels(self) -> ChannelMap:
         """
         Return the union of every channel channel.
         """
@@ -48,38 +54,31 @@ class EditList:
                 retval = retval | edit.channels
 
         return retval
-        
 
     @property
-    def title(self):
+    def title(self) -> str:
         """
-        The title of this edit list, as attensted by the 'TITLE:' statement on 
-        the first line.
+        The title of this edit list.
         """
-        'The title of the edit list'
         return self.title_statement.title
 
-    
     @property
-    def unrecognized_statements(self):
+    def unrecognized_statements(self) -> Generator[StmtUnrecognized,
+                                                   None, None]:
         """
         A generator for all the unrecognized statements in the list.
         """
         for s in self.event_statements:
             if type(s) is StmtUnrecognized:
                 yield s
-        
 
     @property
-    def events(self):
+    def events(self) -> Generator[Event, None, None]:
         'A generator for all the events in the edit list'
-        is_drop = None
         current_event_num = None
         event_statements = []
         for stmt in self.event_statements:
-            if type(stmt) is StmtFCM:
-                is_drop = stmt.drop
-            elif type(stmt) is StmtEvent:
+            if type(stmt) is StmtEvent:
                 if current_event_num is None:
                     current_event_num = stmt.event
                     event_statements.append(stmt)
@@ -99,13 +98,11 @@ class EditList:
         yield Event(statements=event_statements)
 
     @property
-    def sources(self):
+    def sources(self) -> Generator[StmtSourceUMID, None, None]:
         """
         A generator for all of the sources in the list
         """
-        
+
         for stmt in self.event_statements:
             if type(stmt) is StmtSourceUMID:
                 yield stmt
-
-

pycmx/event.py

@@ -1,97 +1,108 @@
 # pycmx
-# (c) 2018 Jamie Hardt
+# (c) 2023 Jamie Hardt
 
-from .parse_cmx_statements import (StmtEvent, StmtClipName, StmtSourceFile, StmtAudioExt, StmtUnrecognized, StmtEffectsName)
+from .parse_cmx_statements import (
+    StmtEvent, StmtClipName, StmtSourceFile, StmtAudioExt, StmtUnrecognized,
+    StmtEffectsName)
 from .edit import Edit
 
+from typing import List, Generator, Optional, Tuple, Any
+
+
 class Event:
     """
-    Represents a collection of :class:`Edit`s, all with the same event number.
-    """
+    Represents a collection of :class:`~pycmx.edit.Edit` s, all with the same
+    event number. """
 
     def __init__(self, statements):
         self.statements = statements
-    
+
     @property
-    def number(self):
+    def number(self) -> int:
         """
         Return the event number.
         """
         return int(self._edit_statements()[0].event)
 
     @property
-    def edits(self):
+    def edits(self) -> List[Edit]:
         """
         Returns the edits. Most events will have a single edit, a single event
         will have multiple edits when a dissolve, wipe or key transition needs
         to be performed.
         """
-        edits_audio = list( self._statements_with_audio_ext() )
-        clip_names  = self._clip_name_statements()
-        source_files= self._source_file_statements()
-         
-        the_zip = [edits_audio]
+        edits_audio = list(self._statements_with_audio_ext())
+        clip_names = self._clip_name_statements()
+        source_files = self._source_file_statements()
+
+        the_zip: List[List[Any]] = [edits_audio]
 
         if len(edits_audio) == 2:
-            cn = [None, None]
+            start_name: Optional[StmtClipName] = None
+            end_name: Optional[StmtClipName] = None
+
             for clip_name in clip_names:
                 if clip_name.affect == 'from':
-                    cn[0] = clip_name
+                    start_name = clip_name
                 elif clip_name.affect == 'to':
-                    cn[1] = clip_name
+                    end_name = clip_name
 
-            the_zip.append(cn)
-        else:    
+            the_zip.append([start_name, end_name])
+        else:
             if len(edits_audio) == len(clip_names):
                 the_zip.append(clip_names)
             else:
-                the_zip.append([None] * len(edits_audio) )
+                the_zip.append([None] * len(edits_audio))
 
         if len(edits_audio) == len(source_files):
             the_zip.append(source_files)
         elif len(source_files) == 1:
-            the_zip.append( source_files * len(edits_audio) )
+            the_zip.append(source_files * len(edits_audio))
         else:
-            the_zip.append([None] * len(edits_audio) )
-        
+            the_zip.append([None] * len(edits_audio))
+
         # attach trans name to last event
         try:
             trans_statement = self._trans_name_statements()[0]
-            trans_names = [None] * (len(edits_audio) - 1)
+            trans_names: List[Optional[Any]] = [None] * (len(edits_audio) - 1)
             trans_names.append(trans_statement)
             the_zip.append(trans_names)
         except IndexError:
-            the_zip.append([None] * len(edits_audio) )
+            the_zip.append([None] * len(edits_audio))
 
+        return [Edit(edit_statement=e1[0],
+                     audio_ext_statement=e1[1],
+                     clip_name_statement=n1,
+                     source_file_statement=s1,
+                     trans_name_statement=u1)
+                for (e1, n1, s1, u1) in zip(*the_zip)]
 
-        return [ Edit(e1[0],e1[1],n1,s1,u1) for (e1,n1,s1,u1) in zip(*the_zip) ]
-            
     @property
-    def unrecognized_statements(self):
+    def unrecognized_statements(self) -> Generator[StmtUnrecognized, None,
+                                                   None]:
         """
         A generator for all the unrecognized statements in the event.
         """
         for s in self.statements:
             if type(s) is StmtUnrecognized:
                 yield s
-    
-    def _trans_name_statements(self):
+
+    def _trans_name_statements(self) -> List[StmtEffectsName]:
         return [s for s in self.statements if type(s) is StmtEffectsName]
 
-    def _edit_statements(self):
+    def _edit_statements(self) -> List[StmtEvent]:
         return [s for s in self.statements if type(s) is StmtEvent]
 
-    def _clip_name_statements(self):
+    def _clip_name_statements(self) -> List[StmtClipName]:
         return [s for s in self.statements if type(s) is StmtClipName]
-    
-    def _source_file_statements(self):
+
+    def _source_file_statements(self) -> List[StmtSourceFile]:
         return [s for s in self.statements if type(s) is StmtSourceFile]
-    
-    def _statements_with_audio_ext(self):
+
+    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)
+                yield (s1, s2)
             elif type(s1) is StmtEvent:
                 yield (s1, None)
-
- 

pycmx/parse_cmx_events.py

@@ -1,21 +1,20 @@
 # pycmx
 # (c) 2018 Jamie Hardt
 
-from collections import namedtuple
+# from collections import namedtuple
 
-from .parse_cmx_statements import (parse_cmx3600_statements, StmtEvent,StmtFCM )
+from .parse_cmx_statements import (parse_cmx3600_statements)
 from .edit_list import EditList
 
-def parse_cmx3600(f):
+from typing import TextIO
+
+
+def parse_cmx3600(f: TextIO) -> EditList:
     """
     Parse a CMX 3600 EDL.
 
-    Args:
-        f : a file-like object, anything that's readlines-able.
-
-    Returns:
-        An :class:`EditList`.
+    :param TextIO f: a file-like object, an opened CMX 3600 .EDL file.
+    :returns: An :class:`pycmx.edit_list.EditList`.
     """
     statements = parse_cmx3600_statements(f)
     return EditList(statements)
-    

pycmx/parse_cmx_statements.py

@@ -2,102 +2,121 @@
 # (c) 2018 Jamie Hardt
 
 import re
-import sys
 from collections import namedtuple
-from itertools import count
+from typing import TextIO, List
+
 
 from .util import collimate
 
-StmtTitle =     namedtuple("Title",["title","line_number"])
-StmtFCM =       namedtuple("FCM",["drop","line_number"])
-StmtEvent =     namedtuple("Event",["event","source","channels","trans",\
-        "trans_op","source_in","source_out","record_in","record_out","format","line_number"])
-StmtAudioExt =  namedtuple("AudioExt",["audio3","audio4","line_number"])
-StmtClipName =  namedtuple("ClipName",["name","affect","line_number"])
-StmtSourceFile = namedtuple("SourceFile",["filename","line_number"])
-StmtRemark =    namedtuple("Remark",["text","line_number"])
-StmtEffectsName = namedtuple("EffectsName",["name","line_number"])
-StmtSourceUMID =   namedtuple("Source",["name","umid","line_number"])
-StmtSplitEdit = namedtuple("SplitEdit",["video","magnitue", "line_number"])
-StmtMotionMemory = namedtuple("MotionMemory",["source","fps"]) # FIXME needs more fields
-StmtUnrecognized = namedtuple("Unrecognized",["content","line_number"])
+StmtTitle = namedtuple("Title", ["title", "line_number"])
+StmtFCM = namedtuple("FCM", ["drop", "line_number"])
+StmtEvent = namedtuple("Event", ["event", "source", "channels", "trans",
+                                 "trans_op", "source_in", "source_out",
+                                 "record_in", "record_out", "format",
+                                 "line_number"])
+StmtAudioExt = namedtuple("AudioExt", ["audio3", "audio4", "line_number"])
+StmtClipName = namedtuple("ClipName", ["name", "affect", "line_number"])
+StmtSourceFile = namedtuple("SourceFile", ["filename", "line_number"])
+StmtRemark = namedtuple("Remark", ["text", "line_number"])
+StmtEffectsName = namedtuple("EffectsName", ["name", "line_number"])
+StmtSourceUMID = namedtuple("Source", ["name", "umid", "line_number"])
+StmtSplitEdit = namedtuple("SplitEdit", ["video", "magnitude", "line_number"])
+StmtMotionMemory = namedtuple(
+    "MotionMemory", ["source", "fps"])  # FIXME needs more fields
+StmtUnrecognized = namedtuple("Unrecognized", ["content", "line_number"])
 
 
-def parse_cmx3600_statements(file):
+def parse_cmx3600_statements(file: TextIO) -> List[object]:
     """
     Return a list of every statement in the file argument.
     """
     lines = file.readlines()
-    line_numbers = count() 
-    return [_parse_cmx3600_line(line.strip(), line_number) \
-            for (line, line_number) in zip(lines,line_numbers)]
-    
-def _edl_column_widths(event_field_length, source_field_length):
-    return [event_field_length,2, source_field_length,1,
-                            4,2, # chans
-                            4,1, # trans
-                            3,1, # trans op
-                            11,1,
-                            11,1,
-                            11,1,
-                            11]
-
-def _edl_m2_column_widths():
-    return [2, # "M2"
-            3,3, #
-            8,8,1,4,2,1,4,13,3,1,1]
+    return [_parse_cmx3600_line(line.strip(), line_number)
+            for (line_number, line) in enumerate(lines)]
 
 
-def _parse_cmx3600_line(line, line_number):
-    long_event_num_p  = re.compile("^[0-9]{6} ")
+def _edl_column_widths(event_field_length, source_field_length) -> List[int]:
+    return [event_field_length, 2, source_field_length, 1,
+            4, 2,  # chans
+            4, 1,  # trans
+            3, 1,  # trans op
+            11, 1,
+            11, 1,
+            11, 1,
+            11]
+
+# def _edl_m2_column_widths():
+#     return [2, # "M2"
+#             3,3, #
+#             8,8,1,4,2,1,4,13,3,1,1]
+
+
+def _parse_cmx3600_line(line: str, line_number: int) -> object:
+    """
+    Parses a single CMX EDL line.
+
+    :param line: A single EDL line.
+    :param line_number: The index of this line in the file.
+    """
+    long_event_num_p = re.compile("^[0-9]{6} ")
     short_event_num_p = re.compile("^[0-9]{3} ")
-    
-    if isinstance(line,str):
-        if line.startswith("TITLE:"):
-            return _parse_title(line,line_number)
-        elif line.startswith("FCM:"):
-            return _parse_fcm(line, line_number)
-        elif long_event_num_p.match(line) != None:
-            length_file_128 = sum(_edl_column_widths(6,128))
-            if len(line) < length_file_128:
-                return _parse_long_standard_form(line, 32, line_number)
-            else:
-                return _parse_long_standard_form(line, 128, line_number)
-        elif short_event_num_p.match(line) != None:
-            return _parse_standard_form(line, line_number)
-        elif line.startswith("AUD"):
-            return _parse_extended_audio_channels(line,line_number)
-        elif line.startswith("*"):
-            return _parse_remark( line[1:].strip(), line_number)
-        elif line.startswith(">>> SOURCE"):
-            return _parse_source_umid_statement(line, line_number)
-        elif line.startswith("EFFECTS NAME IS"):
-            return _parse_effects_name(line, line_number)
-        elif line.startswith("SPLIT:"):
-            return _parse_split(line, line_number)
-        elif line.startswith("M2"):
-            return _parse_motion_memory(line, line_number)
+    x_event_form_p = re.compile("^([0-9]{4,5}) ")
+
+    if line.startswith("TITLE:"):
+        return _parse_title(line, line_number)
+    elif line.startswith("FCM:"):
+        return _parse_fcm(line, line_number)
+    elif long_event_num_p.match(line) is not None:
+        length_file_128 = sum(_edl_column_widths(6, 128))
+        if len(line) < length_file_128:
+            return _parse_long_standard_form(line, 32, line_number)
         else:
-            return _parse_unrecognized(line, line_number)
+            return _parse_long_standard_form(line, 128, line_number)
+    elif (m := x_event_form_p.match(line)) is not None:
+        assert m is not None
+        event_field_length = len(m[1])
+        return _parse_columns_for_standard_form(line, event_field_length,
+                                                8, line_number)
+    elif short_event_num_p.match(line) is not None:
+        return _parse_standard_form(line, line_number)
+    elif line.startswith("AUD"):
+        return _parse_extended_audio_channels(line, line_number)
+    elif line.startswith("*"):
+        return _parse_remark(line[1:].strip(), line_number)
+    elif line.startswith(">>> SOURCE"):
+        return _parse_source_umid_statement(line, line_number)
+    elif line.startswith("EFFECTS NAME IS"):
+        return _parse_effects_name(line, line_number)
+    elif line.startswith("SPLIT:"):
+        return _parse_split(line, line_number)
+    elif line.startswith("M2"):
+        return _parse_motion_memory(line, line_number)
+    else:
+        return _parse_unrecognized(line, line_number)
 
-    
-def _parse_title(line, line_num):
+
+def _parse_title(line, line_num) -> StmtTitle:
     title = line[6:].strip()
-    return StmtTitle(title=title,line_number=line_num)
+    return StmtTitle(title=title, line_number=line_num)
 
-def _parse_fcm(line, line_num):
+
+def _parse_fcm(line, line_num) -> StmtFCM:
     val = line[4:].strip()
     if val == "DROP FRAME":
-        return StmtFCM(drop= True, line_number=line_num)
+        return StmtFCM(drop=True, line_number=line_num)
     else:
-        return StmtFCM(drop= False, line_number=line_num)
+        return StmtFCM(drop=False, line_number=line_num)
+
+
+def _parse_long_standard_form(line, source_field_length, line_number):
+    return _parse_columns_for_standard_form(line, 6, source_field_length,
+                                            line_number)
+
 
-def _parse_long_standard_form(line,source_field_length, line_number):
-    return _parse_columns_for_standard_form(line, 6, source_field_length, line_number)
-    
 def _parse_standard_form(line, line_number):
     return _parse_columns_for_standard_form(line, 3, 8, line_number)
-    
+
+
 def _parse_extended_audio_channels(line, line_number):
     content = line.strip()
     if content == "AUD   3":
@@ -108,60 +127,67 @@ def _parse_extended_audio_channels(line, line_number):
         return StmtAudioExt(audio3=True, audio4=True, line_number=line_number)
     else:
         return StmtUnrecognized(content=line, line_number=line_number)
-    
-def _parse_remark(line, line_number):
+
+
+def _parse_remark(line, line_number) -> object:
     if line.startswith("FROM CLIP NAME:"):
-        return StmtClipName(name=line[15:].strip() , affect="from", line_number=line_number)
+        return StmtClipName(name=line[15:].strip(), affect="from",
+                            line_number=line_number)
     elif line.startswith("TO CLIP NAME:"):
-        return StmtClipName(name=line[13:].strip(), affect="to", line_number=line_number)
+        return StmtClipName(name=line[13:].strip(), affect="to",
+                            line_number=line_number)
     elif line.startswith("SOURCE FILE:"):
-        return StmtSourceFile(filename=line[12:].strip() , line_number=line_number)
+        return StmtSourceFile(filename=line[12:].strip(),
+                              line_number=line_number)
     else:
         return StmtRemark(text=line, line_number=line_number)
 
-def _parse_effects_name(line, line_number):
+
+def _parse_effects_name(line, line_number) -> StmtEffectsName:
     name = line[16:].strip()
     return StmtEffectsName(name=name, line_number=line_number)
 
+
 def _parse_split(line, line_number):
     split_type = line[10:21]
     is_video = False
     if split_type.startswith("VIDEO"):
         is_video = True
 
-    split_mag  = line[24:35]
-    return StmtSplitEdit(video=is_video, magnitude=split_mag, line_number=line_number)
+    split_mag = line[24:35]
+    return StmtSplitEdit(video=is_video, magnitude=split_mag,
+                         line_number=line_number)
 
 
 def _parse_motion_memory(line, line_number):
-    return StmtMotionMemory(source = "", fps="")
+    return StmtMotionMemory(source="", fps="")
 
 
 def _parse_unrecognized(line, line_number):
     return StmtUnrecognized(content=line, line_number=line_number)
 
-def _parse_columns_for_standard_form(line, event_field_length, source_field_length, line_number):
+
+def _parse_columns_for_standard_form(line, event_field_length,
+                                     source_field_length, line_number):
     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)
-    
-    column_strings = collimate(line,col_widths)
-        
-    return StmtEvent(event=column_strings[0], 
-                    source=column_strings[2].strip(), 
-                    channels=column_strings[4].strip(),
-                    trans=column_strings[6].strip(),
+
+    column_strings = collimate(line, col_widths)
+
+    return StmtEvent(event=column_strings[0],
+                     source=column_strings[2].strip(),
+                     channels=column_strings[4].strip(),
+                     trans=column_strings[6].strip(),
                      trans_op=column_strings[8].strip(),
                      source_in=column_strings[10].strip(),
                      source_out=column_strings[12].strip(),
                      record_in=column_strings[14].strip(),
                      record_out=column_strings[16].strip(),
-		    line_number=line_number,
-                    format=source_field_length)
+                     line_number=line_number, format=source_field_length)
 
 
 def _parse_source_umid_statement(line, line_number):
-    trimmed = line[3:].strip()
+    # trimmed = line[3:].strip()
     return StmtSourceUMID(name=None, umid=None, line_number=line_number)
-

pycmx/transition.py

@@ -1,11 +1,14 @@
 # pycmx
-# (c) 2018 Jamie Hardt
+# (c) 2023 Jamie Hardt
+
+from typing import Optional
+
 
 class Transition:
     """
     A CMX transition: a wipe, dissolve or cut.
     """
-    
+
     Cut = "C"
     Dissolve = "D"
     Wipe = "W"
@@ -19,7 +22,7 @@ class Transition:
         self.name = name
 
     @property
-    def kind(self):
+    def kind(self) -> Optional[str]:
         """
         Return the kind of transition: Cut, Wipe, etc
         """
@@ -37,30 +40,30 @@ class Transition:
             return Transition.KeyOut
 
     @property
-    def cut(self):
+    def cut(self) -> bool:
         "`True` if this transition is a cut."
-        return self.transition == 'C' 
+        return self.transition == 'C'
 
     @property
-    def dissolve(self):
+    def dissolve(self) -> bool:
         "`True` if this traansition is a dissolve."
         return self.transition == 'D'
 
     @property
-    def wipe(self):
+    def wipe(self) -> bool:
         "`True` if this transition is a wipe."
         return self.transition.startswith('W')
 
     @property
-    def effect_duration(self):
+    def effect_duration(self) -> int:
         """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.
         """
         return int(self.operand)
 
     @property
-    def wipe_number(self):
+    def wipe_number(self) -> Optional[int]:
         "Wipes are identified by a particular number."
         if self.wipe:
             return int(self.transition[1:])
@@ -68,17 +71,17 @@ class Transition:
             return None
 
     @property
-    def key_background(self):
+    def key_background(self) -> bool:
         "`True` if this edit is a key background."
         return self.transition == Transition.KeyBackground
 
     @property
-    def key_foreground(self):
+    def key_foreground(self) -> bool:
         "`True` if this edit is a key foreground."
         return self.transition == Transition.Key
 
     @property
-    def key_out(self):
+    def key_out(self) -> bool:
         """
         `True` if this edit is a key out. This material will removed from
         the key foreground and replaced with the key background.

pycmx/util.py

@@ -3,29 +3,28 @@
 
 # Utility functions
 
-def collimate(a_string, column_widths): 
+def collimate(a_string, column_widths):
     """
-    Split a list-type thing, like a string, into slices that are column_widths 
+    Split a list-type thing, like a string, into slices that are column_widths
     length.
-    
+
     >>> collimate("a b1 c2345",[2,3,3,2])
     ['a ','b1 ','c23','45']
 
     Args:
         a_string: The string to split. This parameter can actually be anything
             sliceable.
-        column_widths: A list of integers, each one is the length of a column. 
+        column_widths: A list of integers, each one is the length of a column.
 
     Returns:
-        A list of slices. The len() of the returned list will *always* equal 
-        len(:column_widths:). 
+        A list of slices. The len() of the returned list will *always* equal
+        len(:column_widths:).
     """
-    
+
     if len(column_widths) == 0:
         return []
-    
+
     width = column_widths[0]
     element = a_string[:width]
     rest = a_string[width:]
-    return [element] + collimate(rest, column_widths[1:]) 
-
+    return [element] + collimate(rest, column_widths[1:])

pyproject.toml

@@ -0,0 +1,56 @@
+[tool.poetry]
+name = "pycmx"
+version = "1.3.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"

setup.py

@@ -1,25 +0,0 @@
-from setuptools import setup
-
-with open("README.md", "r") as fh:
-    long_description = fh.read()
-
-setup(name='pycmx',
-      version='1.1.4',
-      author='Jamie Hardt',
-      author_email='jamiehardt@me.com',
-      description='CMX 3600 Edit Decision List Parser',
-      long_description_content_type="text/markdown",
-      long_description=long_description,
-      url='https://github.com/iluvcapra/pycmx',
-      classifiers=['Development Status :: 5 - Production/Stable',
-          'License :: OSI Approved :: MIT License',
-          'Topic :: Multimedia',
-          'Topic :: Multimedia :: Video',
-          'Topic :: Text Processing',
-          'Programming Language :: Python :: 3.6',
-          'Programming Language :: Python :: 3.7',
-          'Programming Language :: Python :: 3.8',
-          'Programming Language :: Python :: 3.9',
-          'Programming Language :: Python :: 3.10'
-          ],
-      packages=['pycmx'])

tests/test_parse.py

@@ -2,112 +2,121 @@ from unittest import TestCase
 
 import pycmx
 
+
 class TestParse(TestCase):
 
-    files = ["INS4_R1_010417.edl" ,
-        "INS4_R1_DX_092117.edl",
-          "STP R1 v082517.edl",
-          "ToD_R4_LOCK3.1_030618_Video.edl",
-          "TEST.edl",
-          "test_edl_cdl.edl",
-          "INS4_R1_DX_092117.edl"
-        ]
+    files = ["INS4_R1_010417.edl",
+             "INS4_R1_DX_092117.edl",
+             "STP R1 v082517.edl",
+             "ToD_R4_LOCK3.1_030618_Video.edl",
+             "TEST.edl",
+             "test_edl_cdl.edl",
+             "INS4_R1_DX_092117.edl"
+             ]
 
     def test_event_counts(self):
 
-        counts = [ 287, 466, 250 , 376, 120 , 3 , 466 ]
+        counts = [287, 466, 250, 376, 120, 3, 466]
 
         for fn, count in zip(type(self).files, counts):
-            with open("tests/edls/" + fn ,'r') as f:
+            with open("tests/edls/" + fn, 'r') as f:
                 edl = pycmx.parse_cmx3600(f)
-                actual = len( list( edl.events ))
-                self.assertTrue( actual == count ,
-                        "expected %i in file %s but found %i" % (count, fn, actual))
+                actual = len(list(edl.events))
+                self.assertTrue(actual == count,
+                                "expected %i in file %s but found %i"
+                                % (count, fn, actual))
 
     def test_list_sanity(self):
         for fn in type(self).files:
-            with open("tests/edls/" + fn ,'r') as f:
+            with open("tests/edls/" + fn, 'r') as f:
                 edl = pycmx.parse_cmx3600(f)
-                self.assertTrue( type(edl.title) is str )
-                self.assertTrue( len(edl.title) > 0 )
-
+                self.assertTrue(type(edl.title) is str)
+                self.assertTrue(len(edl.title) > 0)
 
     def test_event_sanity(self):
         for fn in type(self).files:
             path = "tests/edls/" + fn
-            with open(path ,'r') as f:
+            with open(path, 'r') as f:
                 edl = pycmx.parse_cmx3600(f)
                 for index, event in enumerate(edl.events):
-                    self.assertTrue( len(event.edits) > 0 )
-                    self.assertTrue( event.number == index + 1 )
-
-
+                    self.assertTrue(len(event.edits) > 0)
+                    self.assertTrue(event.number == index + 1)
 
     def test_events(self):
-        with open("tests/edls/TEST.edl",'r') as f:
+        with open("tests/edls/TEST.edl", 'r') as f:
             edl = pycmx.parse_cmx3600(f)
-            events = list( edl.events  )
+            events = list(edl.events)
 
-            self.assertEqual( events[0].number , 1)
-            self.assertEqual( events[0].edits[0].source , "OY_HEAD_")
-            self.assertEqual( events[0].edits[0].clip_name , "HEAD LEADER MONO")
-            self.assertEqual( events[0].edits[0].source_file , "OY_HEAD_LEADER.MOV")
-            self.assertEqual( events[0].edits[0].source_in , "00:00:00:00")
-            self.assertEqual( events[0].edits[0].source_out , "00:00:00:00")
-            self.assertEqual( events[0].edits[0].record_in , "01:00:00:00")
-            self.assertEqual( events[0].edits[0].record_out , "01:00:08:00")
-            self.assertTrue( events[0].edits[0].transition.kind == pycmx.Transition.Cut)
+            self.assertEqual(events[0].number, 1)
+            self.assertEqual(events[0].edits[0].source, "OY_HEAD_")
+            self.assertEqual(events[0].edits[0].clip_name, "HEAD LEADER MONO")
+            self.assertEqual(
+                events[0].edits[0].source_file, "OY_HEAD_LEADER.MOV")
+            self.assertEqual(events[0].edits[0].source_in, "00:00:00:00")
+            self.assertEqual(events[0].edits[0].source_out, "00:00:00:00")
+            self.assertEqual(events[0].edits[0].record_in, "01:00:00:00")
+            self.assertEqual(events[0].edits[0].record_out, "01:00:08:00")
+            self.assertTrue(
+                events[0].edits[0].transition.kind == pycmx.Transition.Cut)
 
     def test_channel_map(self):
-        with open("tests/edls/TEST.edl",'r') as f:
+        with open("tests/edls/TEST.edl", 'r') as f:
             edl = pycmx.parse_cmx3600(f)
-            events = list( edl.events  )
-            self.assertFalse( events[0].edits[0].channels.video)
-            self.assertFalse( events[0].edits[0].channels.a1)
-            self.assertTrue( events[0].edits[0].channels.a2)
-            self.assertTrue( events[2].edits[0].channels.get_audio_channel(7) )
-            self.assertTrue( events[2].edits[0].channels.audio)
-
+            events = list(edl.events)
+            self.assertFalse(events[0].edits[0].channels.video)
+            self.assertFalse(events[0].edits[0].channels.a1)
+            self.assertTrue(events[0].edits[0].channels.a2)
+            self.assertTrue(events[2].edits[0].channels.get_audio_channel(7))
+            self.assertTrue(events[2].edits[0].channels.audio)
 
     def test_multi_edit_events(self):
-        with open("tests/edls/TEST.edl",'r') as f:
+        with open("tests/edls/TEST.edl", 'r') as f:
             edl = pycmx.parse_cmx3600(f)
-            events = list( edl.events )
+            events = list(edl.events)
 
-            self.assertEqual( events[42].number , 43)
-            self.assertEqual( len(events[42].edits), 2)
+            self.assertEqual(events[42].number, 43)
+            self.assertEqual(len(events[42].edits), 2)
 
-            self.assertEqual( events[42].edits[0].source , "TC_R1_V1")
-            self.assertEqual( events[42].edits[0].clip_name , "TC R1 V1.2 TEMP1 FX ST.WAV")
-            self.assertEqual( events[42].edits[0].source_in , "00:00:00:00")
-            self.assertEqual( events[42].edits[0].source_out , "00:00:00:00")
-            self.assertEqual( events[42].edits[0].record_in , "01:08:56:09")
-            self.assertEqual( events[42].edits[0].record_out , "01:08:56:09")
-            self.assertTrue( events[42].edits[0].transition.kind == pycmx.Transition.Cut)
+            self.assertEqual(events[42].edits[0].source, "TC_R1_V1")
+            self.assertEqual(events[42].edits[0].clip_name,
+                             "TC R1 V1.2 TEMP1 FX ST.WAV")
+            self.assertEqual(events[42].edits[0].source_in, "00:00:00:00")
+            self.assertEqual(events[42].edits[0].source_out, "00:00:00:00")
+            self.assertEqual(events[42].edits[0].record_in, "01:08:56:09")
+            self.assertEqual(events[42].edits[0].record_out, "01:08:56:09")
+            self.assertTrue(
+                events[42].edits[0].transition.kind == pycmx.Transition.Cut)
 
-            self.assertEqual( events[42].edits[1].source , "TC_R1_V6")
-            self.assertEqual( events[42].edits[1].clip_name , "TC R1 V6 TEMP2 ST FX.WAV")
-            self.assertEqual( events[42].edits[1].source_in , "00:00:00:00")
-            self.assertEqual( events[42].edits[1].source_out , "00:00:00:00")
-            self.assertEqual( events[42].edits[1].record_in , "01:08:56:09")
-            self.assertEqual( events[42].edits[1].record_out , "01:08:56:11")
-            self.assertTrue( events[42].edits[1].transition.kind == pycmx.Transition.Dissolve)
+            self.assertEqual(events[42].edits[1].source, "TC_R1_V6")
+            self.assertEqual(events[42].edits[1].clip_name,
+                             "TC R1 V6 TEMP2 ST FX.WAV")
+            self.assertEqual(events[42].edits[1].source_in, "00:00:00:00")
+            self.assertEqual(events[42].edits[1].source_out, "00:00:00:00")
+            self.assertEqual(events[42].edits[1].record_in, "01:08:56:09")
+            self.assertEqual(events[42].edits[1].record_out, "01:08:56:11")
+            self.assertTrue(
+                events[42].edits[1].transition.kind ==
+                pycmx.Transition.Dissolve)
 
     def test_line_numbers(self):
         with open("tests/edls/ToD_R4_LOCK3.1_030618_Video.edl") as f:
             edl = pycmx.parse_cmx3600(f)
 
-            events = list( edl.events )
-            self.assertEqual( events[0].edits[0].line_number, 2)
-            self.assertEqual( events[14].edits[0].line_number, 45)
-            self.assertEqual( events[180].edits[0].line_number, 544)
+            events = list(edl.events)
+            self.assertEqual(events[0].edits[0].line_number, 2)
+            self.assertEqual(events[14].edits[0].line_number, 45)
+            self.assertEqual(events[180].edits[0].line_number, 544)
 
     def test_transition_name(self):
-        with open("tests/edls/test_25.edl","r") as f:
+        with open("tests/edls/test_25.edl", "r") as f:
             edl = pycmx.parse_cmx3600(f)
             events = list(edl.events)
-            self.assertEqual( events[4].edits[1].transition.name ,  "CROSS DISSOLVE" )
-
-
-    # add test for edit_list.channels
+            self.assertEqual(
+                events[4].edits[1].transition.name,  "CROSS DISSOLVE")
 
+    def test_adobe_wide(self):
+        with open("tests/edls/adobe_dai109_test.txt", 'r',
+                  encoding='ISO-8859-1') as f:
+            edl = pycmx.parse_cmx3600(f)
+            events = list(edl.events)
+            self.assertEqual(len(events), 2839)