wellmap.Meta

class wellmap.Meta(extras: Dict[str, Any], dependencies: Set[Path], style: Style)

Miscellaneous information that was present in the TOML file(s) but not part of the layout itself.

The only way to get an instance of this class is by calling load with the meta=True argument. You should never instantiate this class directly.

Methods

__init__(extras, dependencies, style)

Attributes

extras	A dictionary containing any key/value pairs present in the TOML file but not part of the layout.
dependencies	A set containing absolute paths to every layout file that was referenced by toml_path.
style	A Style object describing how the layout requests to be plotted.

---

__eq__(other)

Return self==value.

__init__(extras: Dict[str, Any], dependencies: Set[Path], style: Style) → None

__repr__()

Return repr(self).

dependencies: Set[Path]

A set containing absolute paths to every layout file that was referenced by toml_path. This includes toml_path itself, and the paths to any included or concatenated layout files. It does not include paths to data files, as these are already listed in the path column of the loaded data frame. You can use this information in analysis scripts, in conjunction with os.path.getmtime, to reliably determine whether or not the layout could have changed, e.g. before repeating an expensive analysis.

extras: Dict[str, Any]

A dictionary containing any key/value pairs present in the TOML file but not part of the layout. See the file format reference for more information.

style: Style

A Style object describing how the layout requests to be plotted. The information in this object comes from meta.style and meta.param_styles.