lor.generators.workspace package

Submodules

lor.generators.workspace.workspace_generator module

class lor.generators.workspace.workspace_generator.WorkspaceGenerator(destination_root=None)

Bases: lor.generator.Generator

description()

Returns a human-readable description of the generator as a string.

Returns:A human-readable description of the generator as a string.

destination_root()

Returns the destination root directory.

Relative destination paths are resolved relative to this root. By default, the destination root is the current workspace if a current workspace can be established; otherwise, an AssertionError is raised.

Returns:The destination root directory as a string

run(argv)

Run the generator.

Parameters:argv – Command-line arguments for the generator

:raises Exception For a wide variety of reasons (CLI parsing, cannot copy file, cannot create file, invaild args, etc.)

lor.generators.workspace.workspace_generator.create(output_path)

Create a new workspace at output path, returns the workspace’s path.

Parameters:

output_path – Full path to the workspace to create

Raises:

• FileNotFoundError – if output_path does not exist
• NotADirectoryError – if output_path is not a directory

Module contents