pytket.config¶

The config module defines a userspace pytket configuration. The configuration is saved to and loaded from file.

pytket.config.pytket_config.get_config_file_path()[source]¶

Get a path to the config file on this machine.

pytket.config.pytket_config.load_config_file()[source]¶

Load config from default file path.

pytket.config.pytket_config.write_config_file(config)[source]¶

Write config to default file path.

class pytket.config.pytket_config.PytketConfig(extensions=None)[source]¶

PytketConfig represents a loaded config file for pytket and extension packages.

__init__(extensions=None)[source]¶

Construct a PytketConfig object with inital config parameter values.

Parameters:: extensions (dict[str, Any] | None) – Dictionary holding parameter values for extension packages, defaults to None

classmethod default()[source]¶

Construct a default PytketConfig

classmethod read_file(config_file_path)[source]¶

Construct a PytketConfig from reading a file with a given Path.

write_file(config_file_path)[source]¶

Write a PytketConfig to a file with a given Path.

class pytket.config.pytket_config.PytketExtConfig[source]¶

Abstract base class for pytket extension config classes.

classmethod from_default_config_file()[source]¶

Load from default config file.

abstract classmethod from_extension_dict(ext_dict)[source]¶

Abstract method to build PytketExtConfig from dictionary serialized form.

classmethod from_pytketconfig(p_config)[source]¶

Build from PytketConfig instance.

Serialize to dictionary.

update_default_config_file()[source]¶

Update default config file with current parameters in this extension config.

update_pytket_config(pytket_config)[source]¶

Update a PytketConfig instance from this extension config.