colour_clf_io.ProcessList#

class colour_clf_io.ProcessList(id: str | None, compatible_CLF_version: str | None, name: str | None, inverse_of: str | None, description: list[str], input_descriptor: str | None, output_descriptor: str | None, process_nodes: list[ProcessNode], info: Info | None)[source]#

Bases: object

Represent a ProcessList, the root element for any CLF file. It is composed of one or more colour_clf_io.ProcessNodes class instances.

Attributes

id
compatible_CLF_version
name
inverse_of
description
input_descriptor
output_descriptor
info
process_nodes

Methods

from_xml()

References

https://docs.acescentral.com/specifications/clf/#processList

Parameters:

id (str | None)
compatible_CLF_version (str | None)
name (str | None)
inverse_of (str | None)
description (list[str])
input_descriptor (str | None)
output_descriptor (str | None)
process_nodes (list[ProcessNode])
info (Info | None)

id: str | None#: A string to serve as a unique identifier of the ProcessList.

compatible_CLF_version: str | None#: A string indicating the minimum compatible CLF specification version required to read this file. The compCLFversion corresponding to this version of the specification is be “3.0”.

name: str | None#: A concise string used as a text name of the ProcessList for display or selection from an application’s user interface.

inverse_of: str | None#: A string for linking to another ProcessList id (unique) which is the inverse of this one.

description: list[str]#: A list for comments describing the function, usage, or any notes about the ProcessList.

__eq__(other)#: Return self==value.

__hash__ = None#

__init__(id: str | None, compatible_CLF_version: str | None, name: str | None, inverse_of: str | None, description: list[str], input_descriptor: str | None, output_descriptor: str | None, process_nodes: list[ProcessNode], info: Info | None) → None#

Parameters:

id (str | None)
compatible_CLF_version (str | None)
name (str | None)
inverse_of (str | None)
description (list[str])
input_descriptor (str | None)
output_descriptor (str | None)
process_nodes (list[ProcessNode])
info (Info | None)

Return type:

None

__repr__()#: Return repr(self).

__weakref__#: list of weak references to the object

input_descriptor: str | None#: An arbitrary string used to describe the intended source code values of the ProcessList.

output_descriptor: str | None#: An arbitrary string used to describe the intended output target of the ProcessList (e.g., target display).

process_nodes: list[ProcessNode]#: A list of colour operators. The ProcessList must contain at least one ProcessNode.

info: Info | None#: Optional element for including additional custom metadata not needed to interpret the transforms.

static from_xml(xml: _Element | None) → ProcessList | None[source]#

Parse and return a colour_clf_io.ProcessList class instance from the given XML element. Returns None if the given XML element is None.

Expects the XML element to be a valid element, according to the CLF specification.

Parameters:: xml (_Element | None) – XML element to parse.
Returns:: class – Parsed XML node.
Return type:: colour_clf_io.ProcessList or None
Raises:: colour_clf_io.errors.ParsingError – If the node does not conform to the specification, a ParsingError exception will be raised. The error message will indicate the details of the issue that was encountered.

to_xml(name_space: Namespaces = Namespaces.AMPAS) → _Element[source]#

Serialise this object as an XML object.

Parameters:: name_space (Namespaces) – colour_clf_io.Namespaces instance to be used for the namespace of the document.
Return type:: lxml.etree._Element