imflib.opl

st2067-100a-2014: Output Profile List

class imflib.opl.Alias(handle: str, alias: str)

Bases: object

An OPL Alias

alias: str

TODO: Given the Alias element “<Alias handle=’macros/image-scaler-1/outputs/images’>MainImage</Alias>”, the Handle “alias/MainImage” is synonymous with the Handle “macros/image-scaler-1/outputs/images”.

classmethod from_xml(xml: Element, ns: Optional[dict] = None) → Alias

Capture an alias from XML

handle: str
class imflib.opl.ExtensionProperty(raw_xml: str)

Bases: object

An OPL Extension Property

classmethod from_xml(xml: Element, ns: Optional[dict] = None) → ExtensionProperty

Capture an extention property from the list

raw_xml: str
class imflib.opl.Handle

Bases: object

TODO

classmethod from_xml(xml: Element, ns: Optional[dict] = False) → Handle
class imflib.opl.Macro(name: MacroName, annotation_text: Optional[UserText] = None)

Bases: ABC

An abstract OPL Macro

annotation_text: Optional[UserText] = None

Optional description of this macro

abstract classmethod from_xml(xml: Element, ns: Optional[dict] = None) → Macro

Parse Macro from XML

name: MacroName

The unique name of the macro instance

class imflib.opl.MacroName(input_string: str)

Bases: str

A string restricted confined to the opl:MacroNameType schema

PAT_MACRO_NAME_TYPE = re.compile('^[a-zA-Z][a-zA-Z0-9-]*$')
class imflib.opl.Opl(cpl_id: ~uuid.UUID, id: ~uuid.UUID = <factory>, issue_date: ~datetime.datetime = <factory>, aliases: set[imflib.opl.Alias] = <factory>, macros: list[imflib.opl.Macro] = <factory>, issuer: ~typing.Optional[~imflib.UserText] = None, extension_properties: list[imflib.opl.ExtensionProperty] = <factory>, creator: ~typing.Optional[~imflib.UserText] = None, annotation_text: ~typing.Optional[~imflib.UserText] = None, security: ~typing.Optional[~imflib.Security] = None)

Bases: object

An IMF Output Profile List

aliases: set[imflib.opl.Alias]

A set of unique Alias elements which define additional synonyms for Handle s

annotation_text: Optional[UserText] = None

Optional description of this OPL

cpl_id: UUID

Existing UUID of the CPL upon which this OPL operates; encoded as a urn:UUID [RFC 4122]

creator: Optional[UserText] = None

The facility or system that created this OPL

extension_properties: list[imflib.opl.ExtensionProperty]

An unordered list of ExtensionProperty s which may be used by applications to add descriptive metadata to the OPL

classmethod from_file(path: str) → Opl

Parse an existing OPL from a given file path.

classmethod from_xml(xml: Element, ns: Optional[dict] = None) → Opl

Parse an existing OPL from a given root XMLElementTree Element Intended to be called from Opl.from_file(), but you do you.

id: UUID

Unique identifier for this OPL; encoded as a urn:UUID [RFC 4122]

issue_date: datetime

Datetime this OPL was issued

issuer: Optional[UserText] = None

The person or company that issued this OPL

macros: list[imflib.opl.Macro]

An ordered list of Macro elements

security: Optional[Security] = None

Signer and signature of authenticity

class imflib.opl.PresetMacro(name: MacroName, annotation_text: Optional[UserText] = None, preset: str = '')

Bases: Macro

A Preset Macro

classmethod from_xml(xml: Element, ns: Optional[dict] = None) → PresetMacro

Parse Macro from XML

preset: str = ''