Merge pull request #8 from iluvcapra/master

Merging changes for v1.2.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,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
     steps:
     - uses: actions/checkout@v3
@@ -28,7 +28,8 @@ 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
+        python3 -m pip install -e .
+        # if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

.github/workflows/pythonpublish.yml

@@ -2,25 +2,39 @@ name: Upload Python Package
 
 on:
   release:
-    types: [created]
-
+    types: [published]
+  workflow_dispatch:
+    
+permissions:
+  contents: read
+  id-token: write
+  
 jobs:
   deploy:
     runs-on: ubuntu-latest
+    environment:
+      name: release
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3.5.2
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4.6.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
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: pypi-publish
+      uses: pypa/gh-action-pypi-publish@v1.8.6
+    - name: Report to Mastodon
+      uses: cbrgm/mastodon-github-action@v1.0.1
+      with:
+        message: |
+          I just released a new version of pycmx, my library for reading CMX EDLs!
+          #sounddesign #filmmaking #python
+          ${{ github.server_url }}/${{ github.repository }}
       env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_APIKEY }}
-      run: |
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
+        MASTODON_URL: ${{ secrets.MASTODON_URL }}
+        MASTODON_ACCESS_TOKEN: ${{ secrets.MASTODON_ACCESS_TOKEN }}

.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>

.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,6 +1,6 @@
-[![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

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

@@ -14,19 +14,20 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../../pycmx'))
+sys.path.insert(0, os.path.abspath('../..'))
 
+import pycmx
 
 # -- Project information -----------------------------------------------------
 
 project = u'pycmx'
-copyright = u'2018, Jamie Hardt'
+copyright = u'(c) 2023, Jamie Hardt'
 author = u'Jamie Hardt'
 
 # The short X.Y version
-version = u''
+version = pycmx.__version__
 # The full version, including alpha/beta/rc tags
-release = u''
+release = pycmx.__version__
 
 
 # -- 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.

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,15 +1,13 @@
 # -*- 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) 2023 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'
+__version__ = '1.2.1'
 
 from .parse_cmx_events import parse_cmx3600
 from .transition import Transition

pycmx/channel_map.py

@@ -2,13 +2,14 @@
 # (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 = {     
+    _chan_map : Dict[str, Tuple] = {     
                 "V" :    (True,   False,   False),
                 "A" :    (False,  True,    False),
                 "A2" :   (False,  False,   True),
@@ -23,63 +24,63 @@ class ChannelMap:
         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):
+    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):
+    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):
+    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):
+    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):
@@ -103,9 +104,10 @@ 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)
+

pycmx/edit.py

@@ -3,7 +3,9 @@
 
 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:
     """
@@ -18,7 +20,7 @@ class Edit:
         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 
@@ -27,7 +29,7 @@ class Edit:
         return self.edit_statement.line_number
 
     @property
-    def channels(self):
+    def channels(self) -> ChannelMap:
         """
         Get the :obj:`ChannelMap` object associated with this Edit.
         """
@@ -38,7 +40,7 @@ class Edit:
         return cm
 
     @property
-    def transition(self):
+    def transition(self) -> Transition:
         """
         Get the :obj:`Transition` object associated with this edit.
         """
@@ -48,14 +50,14 @@ class Edit:
             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 +65,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 +73,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 +81,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 +89,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,7 +114,7 @@ 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 
         NAME" remark on the EDL. This will return None if the information is

pycmx/edit_list.py

@@ -5,21 +5,21 @@ from .parse_cmx_statements import (StmtUnrecognized, StmtFCM, StmtEvent, StmtSou
 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".
         """
         first_event = next( (s for s in self.event_statements if type(s) is StmtEvent), None)
 
@@ -37,7 +37,7 @@ class EditList:
         
 
     @property
-    def channels(self):
+    def channels(self) -> ChannelMap:
         """
         Return the union of every channel channel.
         """
@@ -51,17 +51,15 @@ class EditList:
         
 
     @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.
         """
@@ -71,7 +69,7 @@ class EditList:
         
 
     @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
@@ -99,7 +97,7 @@ 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
         """

pycmx/event.py

@@ -1,26 +1,28 @@
 # pycmx
-# (c) 2018 Jamie Hardt
+# (c) 2023 Jamie Hardt
 
 from .parse_cmx_statements import (StmtEvent, StmtClipName, StmtSourceFile, StmtAudioExt, StmtUnrecognized, StmtEffectsName)
-from .edit import Edit
+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
@@ -30,17 +32,19 @@ class Event:
         clip_names  = self._clip_name_statements()
         source_files= self._source_file_statements()
          
-        the_zip = [edits_audio]
+        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)
+            the_zip.append([start_name, end_name])
         else:    
             if len(edits_audio) == len(clip_names):
                 the_zip.append(clip_names)
@@ -57,17 +61,20 @@ class Event:
         # 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) )
 
-
-        return [ Edit(e1[0],e1[1],n1,s1,u1) for (e1,n1,s1,u1) in zip(*the_zip) ]
+        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) ]
             
     @property
-    def unrecognized_statements(self):
+    def unrecognized_statements(self) -> Generator[StmtUnrecognized, None, None]:
         """
         A generator for all the unrecognized statements in the event.
         """
@@ -75,19 +82,19 @@ class Event:
             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)

pycmx/parse_cmx_events.py

@@ -1,20 +1,19 @@
 # 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):
     """
     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, anything that's readlines-able.
+    :returns: An :class:`pycmx.edit_list.EditList`.
     """
     statements = parse_cmx3600_statements(f)
     return EditList(statements)

pycmx/parse_cmx_statements.py

@@ -5,6 +5,8 @@ import re
 import sys
 from collections import namedtuple
 from itertools import count
+from typing import TextIO, List
+
 
 from .util import collimate
 
@@ -18,12 +20,12 @@ 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"])
+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.
     """
@@ -109,7 +111,7 @@ def _parse_extended_audio_channels(line, 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)
     elif line.startswith("TO CLIP NAME:"):
@@ -119,7 +121,7 @@ def _parse_remark(line, 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)
 

pycmx/transition.py

@@ -1,5 +1,7 @@
 # pycmx
-# (c) 2018 Jamie Hardt
+# (c) 2023 Jamie Hardt
+
+from typing import Optional
 
 class Transition:
     """
@@ -19,7 +21,7 @@ class Transition:
         self.name = name
 
     @property
-    def kind(self):
+    def kind(self) -> Optional[str]:
         """
         Return the kind of transition: Cut, Wipe, etc
         """
@@ -37,22 +39,22 @@ class Transition:
             return Transition.KeyOut
 
     @property
-    def cut(self):
+    def cut(self) -> bool:
         "`True` if this transition is a cut."
         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.
@@ -60,7 +62,7 @@ class Transition:
         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,19 +70,21 @@ 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.
         """
         return self.transition == Transition.KeyOut
+
+

pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "pycmx"
+authors = [{name = "Jamie Hardt", email = "jamiehardt@me.com"}]
+readme = "README.md"
+dynamic = ["version", "description"]
+requires-python = "~=3.7"
+classifiers = [
+  'Development Status :: 5 - Production/Stable',
+  'License :: OSI Approved :: MIT License',
+  'Topic :: Multimedia',
+  'Topic :: Multimedia :: Video',
+  'Topic :: Text Processing',
+  'Programming Language :: Python :: 3.7',
+  'Programming Language :: Python :: 3.8',
+  'Programming Language :: Python :: 3.9',
+  'Programming Language :: Python :: 3.10',
+  'Programming Language :: Python :: 3.11'
+]
+dependencies = [
+
+]
+keywords = [
+  'parser',
+  'film', 
+  'broadcast' 
+]
+
+[tool.flit.module]
+name = "pycmx"
+
+[project.optional-dependencies]
+doc = [
+    'sphinx >= 5.3.0',
+    'sphinx_rtd_theme >= 1.1.1',
+]
+
+[project.urls]
+Home = "https://github.com/iluvcapra/pycmx"
+Documentation = "https://pycmx.readthedocs.io/"
+Source = "https://github.com/iluvcapra/pycmx.git"
+Issues = "https://github.com/iluvcapra/pycmx/issues" 
+
+[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)
+]

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.3',
-      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'])