taps.run.config

taps/run/config.py

LoggingConfig

Bases: BaseModel

Logging configuration.

Attributes:

• level (Union[int, str]) –

  Logging level for stdout.

• file_level (Union[int, str]) –

  Logging level for the log file.

• file_name (Optional[str]) –

  Logging file name. If None, only logging to stdout is used.

RunConfig

Bases: BaseModel

Run configuration.

Attributes:

• dir_format (str) –

  Run directory format.

• env_vars (Dict[str, str]) –

  Dictionary mapping environment variables to values. The environment variables will be set once the benchmark starts.

Config

Bases: BaseSettings

Application benchmark configuration.

Attributes:

• app (AppConfig) –

  Application configuration.

• engine (EngineConfig) –

  Engine configuration.

• logging (LoggingConfig) –

  Logging configuration.

• run (RunConfig) –

  Run configuration.

• version (str) –

  TaPS version used to create the config. Loading a config with a version that does not match the current version will log a warning that behavior could be different.

from_toml() classmethod

from_toml(filepath: str | Path) -> Config

Load a configuration from a TOML file.

Source code in taps/run/config.py

@classmethod
def from_toml(cls, filepath: str | pathlib.Path) -> Config:
    """Load a configuration from a TOML file."""
    with open(filepath, 'rb') as f:
        options = tomllib.load(f)

    flat_options = flatten_mapping(options)
    config_cls = _make_config_cls(flat_options)

    return config_cls(**options)

write_toml()

write_toml(filepath: str | Path) -> None

Write the configuration to a TOML file.

Source code in taps/run/config.py

def write_toml(self, filepath: str | pathlib.Path) -> None:
    """Write the configuration to a TOML file."""
    model = self.model_dump(
        exclude_unset=False,
        exclude_defaults=False,
        exclude_none=True,
    )

    filepath = pathlib.Path(filepath)
    filepath.parent.mkdir(parents=True, exist_ok=True)
    with open(filepath, 'wb') as f:
        tomli_w.dump(model, f)

make_run_dir()

make_run_dir(config: Config) -> Path

Create and return the run directory path created from the config.

Source code in taps/run/config.py

def make_run_dir(config: Config) -> pathlib.Path:
    """Create and return the run directory path created from the config."""
    timestamp = datetime.now().strftime('%Y-%m-%d-%H-%M-%S')
    run_dir = pathlib.Path(
        config.run.dir_format.format(
            executor=config.engine.executor.name,
            name=config.app.name,
            timestamp=timestamp,
        ),
    )
    run_dir.mkdir(parents=True, exist_ok=True)
    return run_dir