ParallelBuilder¶
- class disseminate.builders.composite_builders.parallel_builder.ParallelBuilder(env, subbuilders=None, **kwargs)¶
A composite builder that runs subbuilders in parallell (i.e. run the subbuilders together at the same time)
- add_build(parameters, outfilepath=None, target=None, context=None, in_ext=None, out_ext=None, builder_cls=None, **kwargs)¶
Add a subbuilder to the ParallelBuilder.
- Parameters
- parameters, argsTuple[
pathlib.Path
, str, tuple, list] The input parameters (dependencies), including filepaths, for the build
- outfilepathOptional[str,
pathlib.Path
] The path for the output file.
- targetOptional[str]
The document target for the build. ex: ‘html’ or ‘tex’
- contextOptional[
context.BaseContext
] The document context dict that owns the parallel builder.
- in_extOptional[str]
The extension for the input file. This is used to find the correct builder with the find_builder_cls method. If this is not specified, an filepath in the parameters should be specified.
- out_extOptional[str]
The extension for the input file. This is used to find the correct builder with the find_builder_cls method. If this is not specified, the outfilepath should be specified.
- builder_clsOptional[
builders.Builder
] The builder class to use in create a new build.
- **kwargs
Optional keyword arguments to use in creating the builder.
- parameters, argsTuple[
- Returns
- builder
builders.Builder
The newly created builder.
- builder
- build_needed(reset=False)¶
Decide whether a build is needed