culebra.tools.abc.Script class

class Script(args: list[str] | None = None)

Bases: Base

Construct the generator.

Generate an empty argument parser. Subclasses should add arguments to the parser.

Parameters:

args (list[str] | None) – Sequence of command-line arguments to parse. If None (default), arguments are read from sys.argv. This parameter is mainly intended for testing, allowing command-line arguments to be supplied programmatically.

Static methods

static Script.load(filename: str) → Base

Load a serialized object from a file.

Parameters:

filename (str) – The file name.

Returns:

The loaded object

Raises:

• TypeError – If filename is not a valid file name

• ValueError – If the filename extension is not SERIALIZED_FILE_EXTENSION

Methods

Script.dump(filename: str) → None

Serialize this object and save it to a file.

Parameters:

filename (str) – The file name.

Raises:

• TypeError – If filename is not a valid file name

• ValueError – If the filename extension is not SERIALIZED_FILE_EXTENSION

Script.parse_args() → None

Parse command-line arguments.

Subclasses should validate the arguments.

Raises:

SystemExit – If the command-line arguments are invalid or --help is requested.

abstract Script.process() → None

Execute the main processing logic of the script.

Private methods

Script._get_repr_properties() → dict[str, object]

Return the subset of properties used for __repr__.

Filters and evaluates all class-level @property attributes, returning only those intended for representation purposes. Private properties (names starting with _) are excluded.

Returns:

Mapping of property names to their corresponding values.

Return type:

dict[str, object]