from __future__ import division
+import itertools
import os
import re
from collections import OrderedDict
'files_walker',
'replace',
'sanitize',
- 'compact']
+ 'compact',
+ 'colorspace_prefixed_name',
+ 'unpack_default']
class ColorSpace(object):
def __init__(self,
name,
- aliases=[],
+ aliases=None,
description=None,
bit_depth=ocio.Constants.BIT_DEPTH_F32,
equality_group='',
family=None,
is_data=False,
- to_reference_transforms=[],
- from_reference_transforms=[],
+ to_reference_transforms=None,
+ from_reference_transforms=None,
allocation_type=ocio.Constants.ALLOCATION_UNIFORM,
- allocation_vars=[0, 1],
+ allocation_vars=None,
aces_transform_id=None):
"""
- Object description.
+ Constructor for ColorSpace container class
Parameters
----------
- parameter : type
- Parameter description.
+ name : str or unicode
+ Name of the colorspace
+ All other arguments are optional
Returns
-------
- type
- Return value description.
+ None
"""
+ if aliases is None:
+ aliases = []
+
+ if to_reference_transforms is None:
+ to_reference_transforms = []
+
+ if from_reference_transforms is None:
+ from_reference_transforms = []
+
+ if allocation_vars is None:
+ allocation_vars = [0, 1]
+
self.name = name
self.aliases = aliases
self.bit_depth = bit_depth
self.allocation_vars = allocation_vars
self.aces_transform_id = aces_transform_id
+
def mat44_from_mat33(mat33):
"""
Creates a 4x4 matrix from given 3x3 matrix.
Parameters
----------
- parameter : type
- Parameter description.
+ mat33 : array of float
+ A 3x3 matrix
Returns
-------
- type
- Return value description.
+ array of float
+ A 4x4 matrix
"""
return [mat33[0], mat33[1], mat33[2], 0,
def filter_words(words, filters_in=None, filters_out=None, flags=0):
"""
- Object description.
+ A function to filter strings in an array
Parameters
----------
- parameter : type
- Parameter description.
+ words : array of str or unicode
+ Array of strings
+ filters_in : array of str or unicode, optional
+ Words to match
+ filters_out : array of str or unicode, optional
+ Words to NOT match
+ flags : int, optional
+ Flags for re.search
Returns
-------
- type
- Return value description.
+ array of str or unicode
+ An array of matched or unmatched strings
"""
filtered_words = []
def files_walker(directory, filters_in=None, filters_out=None, flags=0):
"""
- Object description.
+ A function to walk a directory hierarchy, only returning items that do or
+ do not match the specified filters
Parameters
----------
- parameter : type
- Parameter description.
+ directory : str or unicode
+ The starting point for directory walking
+ filters_in : array of str or unicode, optional
+ File or directory names to match
+ filters_out : array of str or unicode, optional
+ File or directory names to NOT match
+ flags : int, optional
+ Flags for re.search
Returns
-------
- type
- Return value description.
+ iterable
+ The next matching file or directory name
"""
for parent_directory, directories, files in os.walk(
Examples
--------
- >>> patterns = {"John" : "Luke",
- ... "Jane" : "Anakin",
- ... "Doe" : "Skywalker",
- ... "Z6PO" : "R2D2"}
- >>> data = "Users are: John Doe, Jane Doe, Z6PO."
+ >>> patterns = {'John' : 'Luke',
+ ... 'Jane' : 'Anakin',
+ ... 'Doe' : 'Skywalker',
+ ... 'Z6PO' : 'R2D2'}
+ >>> data = 'Users are: John Doe, Jane Doe, Z6PO.'
>>> replace(data,patterns )
u'Users are: Luke Skywalker, Anakin Skywalker, R2D2.'
"""
def sanitize(path):
"""
- Object description.
+ Replaces occurrences of ' ', '(', or ')' in the string with an underscore.
Parameters
----------
- parameter : type
- Parameter description.
+ path : str or unicode
+ Path string to manipulate.
Returns
-------
- type
- Return value description.
+ unicode
+ Manipulated string.
"""
return replace(path, {' ': '_', ')': '_', '(': '_'})
('___', '_'),
('__', '_'),
('_', ''))))
+
+
+def colorspace_prefixed_name(colorspace):
+ """
+ Returns given *OCIO* colorspace prefixed name with its family name.
+
+ Parameters
+ ----------
+ colorspace : Colorspace
+ Colorspace to prefix.
+
+ Returns
+ -------
+ str or unicode
+ Family prefixed *OCIO* colorspace name.
+ """
+ prefix = colorspace.family.replace('/', ' - ')
+
+ return '%s - %s' % (prefix, colorspace.name)
+
+
+def unpack_default(iterable, length=3, default=None):
+ """
+ Unpacks given iterable maintaining given length and filling missing
+ entries with given default.
+
+ Parameters
+ ----------
+ iterable : object
+ Iterable.
+ length : int
+ Iterable length.
+ default : object
+ Filling default object.
+
+ Returns
+ -------
+ iterable
+ """
+
+ return itertools.islice(
+ itertools.chain(iter(iterable), itertools.repeat(default)), length)
projects / OpenColorIO-Configs.git / blobdiff