API Reference

• law.task
  • law.task.base
    • Class BaseRegister
    • Class BaseTask
    • Class Register
    • Class Task
    • Class WrapperTask
    • Class ExternalTask
  • law.task.proxy
    • Class ProxyTask
    • Class ProxyCommand
    • Functions
  • law.task.base
    • Functions
• law.target
  • law.target.base
    • Class Target
  • law.target.file
    • Class FileSystem
    • Class FileSystemTarget
    • Class FileSystemFileTarget
    • Class FileSystemDirectoryTarget
    • Functions
  • law.target.local
    • Class LocalFileSystem
    • Class LocalTarget
    • Class LocalFileTarget
    • Class LocalDirectoryTarget
  • law.target.remote
    • Class RemoteFileSystem
    • Class RemoteTarget
    • Class RemoteFileTarget
    • Class RemoteDirectoryTarget
    • Class RemoteFileInterface
    • Class RemoteCache
  • law.target.collection
    • Class TargetCollection
    • Class SiblingFileCollection
    • Class NestedSiblingFileCollection
  • law.target.mirrored
    • Class MirroredTarget
    • Class MirroredFileTarget
    • Class MirroredDirectoryTarget
  • law.target.formatter
    • Class FormatterRegister
    • Class Formatter
    • Functions
    • Formatters
    • Class TextFormatter
    • Class JSONFormatter
    • Class YAMLFormatter
    • Class ZipFormatter
    • Class TarFormatter
• law.workflow
  • law.workflow.base
    • Class BaseWorkflow
    • Class BaseWorkflowProxy
    • Functions
  • law.workflow.local
    • Class LocalWorkflow
    • Class LocalWorkflowProxy
  • law.workflow.remote
    • Class BaseRemoteWorkflow
    • Class BaseRemoteWorkflowProxy
    • Class JobData
• law.sandbox
  • law.sandbox.base
    • Class Sandbox
    • Class SandboxProxy
    • Class SandboxTask
    • Class StageInfo
  • law.sandbox.bash
    • Class BashSandbox
  • law.sandbox.venv
    • Class VenvSandbox
• law.job
  • law.job.base
    • Class BaseJobManager
    • Class BaseJobFileFactory
    • Class JobInputFile
    • Class JobArguments
  • law.job.dashboard
    • Class BaseJobDashboard
    • Class NoJobDashboard
• law.cli
  • law.cli.cli
    • run()
  • law.cli.run
    • setup_parser()
    • execute()
    • read_task_from_index()
  • law.cli.index
    • setup_parser()
    • execute()
    • get_global_parameters()
  • law.cli.completion
    • setup_parser()
    • execute()
  • law.cli.config
    • setup_parser()
    • execute()
  • law.cli.software
    • setup_parser()
    • execute()
    • build_software_cache()
    • remove_software_cache()
    • reload_dependencies()
    • use_software_cache()
    • get_sw_dir()
  • law.cli.quickstart
    • setup_parser()
    • execute()
  • law.cli.luigid
    • setup_parser()
    • execute()
• law.config
  • Config
    • Config._instance
    • Config._default_config
    • Config._config_files
    • Config.Deferred
    • Config.instance()
    • Config.options()
    • Config.keys()
    • Config.items()
    • Config.set()
    • Config.update()
    • Config.include()
    • Config.get_default()
    • Config.get_expanded()
    • Config.get_expanded_int()
    • Config.get_expanded_float()
    • Config.get_expanded_bool()
    • Config.get_expanded_boolean()
    • Config.is_missing_or_none()
    • Config.find_option()
    • Config.sync_env()
    • Config.sync_luigi_config()
    • Config.resolve_deferred_defaults()
  • sections()
  • options()
  • keys()
  • items()
  • update()
  • include()
  • get()
  • getint()
  • getfloat()
  • getboolean()
  • get_default()
  • get_expanded()
  • get_expanded_int()
  • get_expanded_float()
  • get_expanded_bool()
  • get_expanded_boolean()
  • is_missing_or_none()
  • find_option()
  • add_section()
  • has_section()
  • remove_section()
  • set()
  • has_option()
  • remove_option()
• law.decorator
  • factory()
  • log()
  • safe_output()
  • delay()
  • notify()
  • timeit()
  • localize()
  • require_sandbox()
• law.parameter
  • NO_STR
  • NO_INT
  • NO_FLOAT
  • is_no_param()
  • get_param()
  • Parameter
    • Parameter.parse_empty
  • TaskInstanceParameter
  • OptionalBoolParameter
  • DurationParameter
  • BytesParameter
  • CSVParameter
    • CSVParameter._inst
  • MultiCSVParameter
    • MultiCSVParameter._inst
  • RangeParameter
    • RangeParameter.RANGE_SEP
    • RangeParameter.OPEN
    • RangeParameter.expand()
  • MultiRangeParameter
    • MultiRangeParameter.MULTI_RANGE_SEP
    • MultiRangeParameter.expand()
  • NotifyParameter
    • NotifyParameter.get_transport()
  • NotifyMultiParameter
  • NotifyMailParameter
• law.notification
  • notify_mail()
  • notify_custom()
• law.logger
  • get_logger()
  • setup_logging()
  • setup_logger()
  • create_stream_handler()
  • is_tty_handler()
  • get_tty_handlers()
  • Logger
  • LogFormatter
    • LogFormatter.LOG_TEMPLATE
    • LogFormatter.ERR_TEMPLATE
    • LogFormatter.LEVEL_STYLES
    • LogFormatter.NAME_STYLES
    • LogFormatter.MSG_STYLES
    • LogFormatter.FORMAT_LEVEL
    • LogFormatter.FORMAT_NAME
    • LogFormatter.FORMAT_MSG
• law.parser
  • root_task_cls()
  • root_task()
  • full_parser()
  • root_task_parser()
  • global_cmdline_args()
  • global_cmdline_values()
• law.patches
  • before_run()
  • patch_all()
  • before_run()
  • patch_all()
  • patch_default_retcodes()
  • patch_worker_add_task()
  • patch_worker_add()
  • patch_worker_run_task()
  • patch_worker_get_work()
  • patch_worker_factory()
  • patch_keepalive_run()
  • patch_cmdline_parser()
  • patch_schedule_and_run()
  • patch_interface_logging()
• law.util
  • no_value
  • rel_path()
  • law_src_path()
  • law_home_path()
  • law_run()
  • print_err()
  • abort()
  • import_file()
  • get_terminal_width()
  • is_classmethod()
  • is_number()
  • is_float()
  • try_int()
  • round_discrete()
  • str_to_int()
  • flag_to_bool()
  • empty_context()
  • common_task_params()
  • colored()
  • uncolored()
  • query_choice()
  • is_pattern()
  • brace_expand()
  • range_expand()
  • range_join()
  • multi_match()
  • is_iterable()
  • is_lazy_iterable()
  • make_list()
  • make_tuple()
  • make_set()
  • make_unique()
  • is_nested()
  • flatten()
  • merge_dicts()
  • unzip()
  • which()
  • map_verbose()
  • map_struct()
  • mask_struct()
  • tmp_file()
  • perf_counter()
  • interruptable_popen()
  • send_signal_silent()
  • kill_process()
  • get_subprocess_pids()
  • readable_popen()
  • create_hash()
  • create_random_string()
  • copy_no_perm()
  • makedirs()
  • user_owns_file()
  • increment_path()
  • iter_chunks()
  • chunk_slice_ranges()
  • human_bytes()
  • parse_bytes()
  • human_duration()
  • parse_duration()
  • is_file_exists_error()
  • send_mail()
  • DotDict
    • DotDict.wrap()
  • ShorthandDict
  • open_compat()
  • patch_object()
  • join_generators()
  • quote_cmd()
  • escape_markdown()
  • classproperty()
  • TeeStream
  • FilteredStream