dcc_qc package

Submodules

dcc_qc.abs_runner module

class dcc_qc.abs_runner.AbsRunner(entry_path)

Bases: object

run()

Execute the commands in the task manager

setup()

Configure and queue of the tasks that need to be run but the task manager

dcc_qc.cli module

class dcc_qc.cli.ListProfilesAction(option_strings, dest, nargs=0, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

Bases: argparse.Action

dcc_qc.cli.find_arg_errors(args)
dcc_qc.cli.get_args(parser)
dcc_qc.cli.get_parser()
dcc_qc.cli.main()
dcc_qc.cli.report_results(runner, file=None)

dcc_qc.configure_logging module

dcc_qc.configure_logging.configure_logger(debug_mode=False, log_file=None)

dcc_qc.hathi_qc_runner module

This will become a script but for now it’s just a sample implementation. I’m using it to check that my validators work and my package API make sense when it is consumed by a script.

class dcc_qc.hathi_qc_runner.HathiQCRunner(entry_path)

Bases: dcc_qc.abs_runner.AbsRunner

static get_package_folders(path) → typing.Generator[[str, NoneType], NoneType]
run()
setup()
dcc_qc.hathi_qc_runner.get_package_folders(path) → typing.Generator[[dcc_qc.packages.abs_package.AbsPackage, NoneType], NoneType]
dcc_qc.hathi_qc_runner.get_packages(path)

dcc_qc.process module

class dcc_qc.process.AbsProcess

Bases: object

Implement this abstract class to to use a process with the task manager.

errors
name
run()
setup()
suite = None
class dcc_qc.process.AbsProcessInput

Bases: object

Abstract class to be used with AbsProcess. Implement if the process has an input

set_input(value)
class dcc_qc.process.AbsProcessorResults

Bases: object

Abstract class to be uses with AbsProcess. Implement if the process has a return data

result

dcc_qc.task_manager module

class dcc_qc.task_manager.TaskManager

Bases: collections.abc.MutableSequence

insert(index, value)
push(task: dcc_qc.tasks.Task)

dcc_qc.tasks module

class dcc_qc.tasks.Task(description='Generic task')

Bases: object

add_process(p)
errors

List of any errors produced during the run() method, if any.

name

Short and human-readable result_type explaining what the task does.

reset()
results

List of public result produced during the run() method, if any.

run()
status

dcc_qc.validation_processors module

dcc_qc.validation_processors.AccessFileNaming

alias of Wrapper

dcc_qc.validation_processors.PackageAccessComplete

alias of Wrapper

dcc_qc.validation_processors.PackageComponentComplete

alias of Wrapper

dcc_qc.validation_processors.PackagePreservationComplete

alias of Wrapper

dcc_qc.validation_processors.PackageStructureComplete

alias of Wrapper

dcc_qc.validation_processors.PreservationFileNaming

alias of Wrapper

dcc_qc.validation_processors.add_suite(cls)

Module contents