mirror of
https://github.com/iluvcapra/pycmx.git
synced 2025-12-31 08:50:54 +00:00
documentation
This commit is contained in:
@@ -14,6 +14,8 @@ The `pycmx` package parses a CMX 3600 EDL and its most most common variations.
|
||||
read. Event number field and source name field sizes are determined
|
||||
dynamically for each statement for a high level of compliance at the expense
|
||||
of strictness.
|
||||
* An more relaxed "tolerant" mode allows parsing of an EDL file where columns
|
||||
use non-standard widths.
|
||||
* Preserves relationship between events and individual edits/clips.
|
||||
* Remark or comment fields with common recognized forms are read and
|
||||
available to the client, including clip name and source file data.
|
||||
|
||||
@@ -16,6 +16,8 @@ The `pycmx` package parses a CMX 3600 EDL and its most most common variations.
|
||||
read. Event number field and source name field sizes are determined
|
||||
dynamically for each statement for a high level of compliance at the expense
|
||||
of strictness.
|
||||
* An more relaxed "tolerant" mode allows parsing of an EDL file where columns
|
||||
use non-standard widths.
|
||||
* Preserves relationship between events and individual edits/clips.
|
||||
* Remark or comment fields with common recognized forms are read and
|
||||
available to the client, including clip name and source file data.
|
||||
|
||||
@@ -12,8 +12,8 @@ def parse_cmx3600(f: TextIO, tolerant: bool = False) -> EditList:
|
||||
Parse a CMX 3600 EDL.
|
||||
|
||||
:param TextIO f: a file-like object, an opened CMX 3600 .EDL file.
|
||||
:param bool tolerant: If `True`, a relaxed event line recognition method
|
||||
will be used in the case the stricter default method fails.
|
||||
:param bool tolerant: If `True`, a relaxed event line parsing method will
|
||||
be used, in the case the default method fails.
|
||||
:returns: An :class:`pycmx.edit_list.EditList`.
|
||||
"""
|
||||
statements = parse_cmx3600_statements(f, tolerant)
|
||||
|
||||
Reference in New Issue
Block a user