avid.common.artefact

This module offers methods for correct generation ore adding of artefact entries tis responsible to add new dict entries in the flat file data container

Module Attributes

logger

List of properties that should be checked to determine the similarity of two artifacts.

Functions

ensureCaseInstanceValidity(checkedArtefact, ...)	Checks if the checkedArtefact has a valid case instance compared to all other artefacts.
ensureSimilarityRelevantProperty(propertyName)	Helper that ensures that the passed propertyName is contained in similarityRelevantProperties and therefore will be used to discriminate artifacts.
ensureValidPath(unsafePath)	Normalizes string, removes non-alpha characters, and converts spaces to hyphens.
generateArtefactPath(workflow, workflowArtefact)	Public method that should be used to get an artefact path.
generateDefaultArtefactPath(workflow, ...)	Generates the path derived from the workflow informations and the properties of the artefact.
generateFlatArtefactPath(workflow, ...)	Using this function will write all artefacts directly into the content directory of the workflow.
generateVerboseArtefactPath(workflow, ...)	Generates the path derived from the workflow informations and the properties of the artefact.
getArtefactProperty(artefact, key)	Helper function that returns the value of an artefact property indicated by key.
getArtefactShortName(workflowArtefact)	Public method that should be used to get a "nick name" for the passed artefact.
get_all_values_of_a_property(workflow_data, ...)	Helper function that returns a list of all values found for a certain property in the passed collection of artefact.
pathGenerationDelegate(workflow, ...)	Generates the path derived from the workflow informations and the properties of the artefact.
shortNameGenerationDelegate(workflowArtefact)	Default strategy for the short name.
update_artefacts(destination_collection, ...)	Helper function that updates the content of the destination list with the content of the source list.

Classes

Artefact([defaultP, additionalP])
ArtefactCollection([initial_artefacts])

Modules

avid.common.artefact.crawler
avid.common.artefact.defaultProps	This module is the central unit to store the default artefact propertie keys To ensure an easier maintenance and upgrade all autoprocessing modules,
avid.common.artefact.fileHelper
avid.common.artefact.generator	This module offers methods for correct generation ore adding of artefact entries tis responsible to add new dict entries in the flat file data container