cwltool.mutation

Support for InplaceUpdateRequirement.

Classes

MutationManager

Lock manager for checking correctness of in-place update of files.

Module Contents

class cwltool.mutation.MutationManager

Lock manager for checking correctness of in-place update of files.

Used to validate that in-place file updates happen sequentially, and that a file which is registered for in-place update cannot be read or updated by any other steps.

generations: dict[str, _MutationState]
register_reader(stepname, obj)

Register a file as being read by a particular step.

Parameters:

  • stepname (str)

  • obj (cwl_utils.types.CWLFileType | cwl_utils.types.CWLDirectoryType)

Return type:

None

release_reader(stepname, obj)

Unregister a file as being read by a particular step.

Parameters:

  • stepname (str)

  • obj (cwl_utils.types.CWLFileType | cwl_utils.types.CWLDirectoryType)

Return type:

None

register_mutation(stepname, obj)

Register a file as being modified by a particular step.

Parameters:

  • stepname (str)

  • obj (cwl_utils.types.CWLFileType | cwl_utils.types.CWLDirectoryType)

Return type:

None

set_generation(obj)

Register a File for mutation tracking.

Parameters:

obj (cwl_utils.types.CWLFileType)

Return type:

None

unset_generation(obj)

Remove the mutation tracking metadata from a File.

Parameters:

obj (cwl_utils.types.CWLFileType)

Return type:

None