Documentation

environment

Test environment documentation models.

Classes

class

HardwareInfo

(BaseModel)

Hardware specification.

Attributes

NameTypeDescription
cpu_coresint
cpu_modelstr
cpu_threadsint
ram_total_gbfloat
storage_typestr

Methods

to_dict(self) dict

Convert to JSON-serializable dictionary.

class

SoftwareInfo

(BaseModel)

Software versions.

Attributes

NameTypeDescription
context_fabric_versionstr
numpy_versionstr
psutil_versionstr
python_versionstr
text_fabric_versionstr

Methods

from_environment(cls) SoftwareInfo

Create SoftwareInfo from the current environment.

Parameters
  • cls
to_dict(self) dict

Convert to JSON-serializable dictionary.

class

TestEnvironment

(BaseModel)

Complete test environment documentation.

Attributes

NameTypeDescription
architecturestr
hardwareHardwareInfo
os_namestr
os_versionstr
softwareSoftwareInfo
timestampdatetime

Methods

from_system(cls) TestEnvironment

Create TestEnvironment from the current system.

Parameters
  • cls
to_dict(self) dict

Convert to JSON-serializable dictionary.

to_json(self) str

Serialize to JSON string.

Functions