Skip to content

resource_tracker.report #

Helper class to browser and save HTML reports.

Classes:

Name Description
Report

A string subclass representing an HTML report with methods to view and save it.

Functions:

Name Description
round_memory

Round a number to the nearest meaningful memory amount.

Report #

Bases: str

A string subclass representing an HTML report with methods to view and save it.

Methods:

Name Description
browse

Open the report in the default web browser.
save

Save the report to a file.
Source code in resource_tracker/report.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
class Report(str):
    """A string subclass representing an HTML report with methods to view and save it."""

    def browse(self) -> "Report":
        """Open the report in the default web browser.

        Creates a temporary HTML file and opens it in the default web browser.

        Returns:
            self: Returns the Report object for method chaining
        """
        with tempfile.NamedTemporaryFile(suffix=".html", delete=False) as f:
            f.write(self.encode("utf-8"))
            temp_path = f.name

        webbrowser.open("file://" + temp_path)
        return self

    def save(self, filepath: str) -> "Report":
        """Save the report to a file.

        Args:
            filepath: The path where to save the HTML report

        Returns:
            self: Returns the Report object for method chaining
        """
        with open(filepath, "w", encoding="utf-8") as f:
            f.write(self)
        return self

browse #

browse()

Open the report in the default web browser.

Creates a temporary HTML file and opens it in the default web browser.

Returns:

Name Type Description
self Report

Returns the Report object for method chaining
Source code in resource_tracker/report.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def browse(self) -> "Report":
    """Open the report in the default web browser.

    Creates a temporary HTML file and opens it in the default web browser.

    Returns:
        self: Returns the Report object for method chaining
    """
    with tempfile.NamedTemporaryFile(suffix=".html", delete=False) as f:
        f.write(self.encode("utf-8"))
        temp_path = f.name

    webbrowser.open("file://" + temp_path)
    return self

save #

save(filepath)

Save the report to a file.

Parameters:

Name Type Description Default
filepath str

The path where to save the HTML report

 required

Returns:

Name Type Description
self Report

Returns the Report object for method chaining
Source code in resource_tracker/report.py 
48
49
50
51
52
53
54
55
56
57
58
59
def save(self, filepath: str) -> "Report":
    """Save the report to a file.

    Args:
        filepath: The path where to save the HTML report

    Returns:
        self: Returns the Report object for method chaining
    """
    with open(filepath, "w", encoding="utf-8") as f:
        f.write(self)
    return self

round_memory #

round_memory(mb)

Round a number to the nearest meaningful memory amount.

Parameters:

Name Type Description Default
mb Union[int, float]

The value in MB to round.

 required

Returns:

Type Description
int

The rounded value in MB as an integer.

Example:

>>> round_memory(68)
128
>>> round_memory(896)
1024
>>> round_memory(3863)
4096
Source code in resource_tracker/report.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
def round_memory(mb: Union[int, float]) -> int:
    """Round a number to the nearest meaningful memory amount.

    Args:
        mb: The value in MB to round.

    Returns:
        The rounded value in MB as an integer.

    Example:

        >>> round_memory(68)
        128
        >>> round_memory(896)
        1024
        >>> round_memory(3863)
        4096
    """
    if mb <= 128:
        rounded = 128
    elif mb <= 256:
        rounded = 256
    elif mb <= 512:
        rounded = 512
    elif mb <= 1024:
        rounded = 1024
    elif mb <= 2048:
        rounded = 2048
    else:
        # round up to the next GB
        rounded_gb = mb / 1024
        rounded = int(1024 * (rounded_gb // 1 + (1 if rounded_gb % 1 > 0 else 0)))
    return rounded