Skip to content

taps.run.env

taps/run/env.py

Environment

Bases: NamedTuple

Named tuple representing collected environment information.

To view the current environment: 

$ python -m taps.run.env
Host: ...
OS: linux (...)
CPU: x86_64 (8 cores / 16 logical)
RAM: 15.66 GB
Python version: 3.11.5
Python build: CPython (64-bit runtime) [GCC 11.4.0]
TaPS version: 0.2.0

collect() classmethod 

collect() -> Self

Collect information on the current environment.

Source code in taps/run/env.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
@classmethod
def collect(cls) -> Self:
    """Collect information on the current environment."""
    return cls(
        platform=sys.platform,
        platform_ext=platform.platform(),
        host=platform.node(),
        cpu_architecture=platform.machine(),
        cpu_physical_cores=psutil.cpu_count(logical=False),
        cpu_logical_cores=psutil.cpu_count(logical=True),
        memory_gb=round(psutil.virtual_memory().available / 1e9, 2),
        python_version=platform.python_version(),
        python_implementation=platform.python_implementation(),
        python_compiler=platform.python_compiler(),
        python_bit_length=sys.maxsize.bit_length() + 1,
        taps_version=taps.__version__,
    )

format() 

format() -> str

Format environment as a human-readable string.

Source code in taps/run/env.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
    def format(self) -> str:
        """Format environment as a human-readable string."""
        pcores, lcores = self.cpu_physical_cores, self.cpu_logical_cores
        impl = self.python_implementation
        compiler = self.python_compiler
        bit_length = self.python_bit_length

        return f"""\
host: {self.host}
  os: {self.platform} ({self.platform_ext})
  cpu: {self.cpu_architecture} ({pcores} cores / {lcores} logical)
  memory: {self.memory_gb} GB
python:
  version: {self.python_version}
  build: {impl} ({bit_length}-bit runtime) [{compiler}]
  taps: {self.taps_version}
""".strip()