Skip to content

Stats object

Wordcab API Stats object.

Stats dataclass

Stats object for the Wordcab API.

Source code in src/wordcab/core_objects/stats.py 
28
29
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
60
61
62
63
64
65
66
67
@dataclass
class Stats:
    """Stats object for the Wordcab API."""

    account_email: str
    plan: str
    monthly_request_limit: str
    request_count: int
    minutes_summarized: int
    transcripts_summarized: int
    metered_charge: str
    min_created: str
    max_created: str
    tags: Optional[List[str]] = field(default=None)

    def __post_init__(self) -> None:
        """Post-init method."""
        if self.plan not in AVAILABLE_PLAN:
            raise ValueError(f"Plan must be one of {AVAILABLE_PLAN}, not {self.plan}")

        if not validators.email(self.account_email):
            raise ValueError(
                f"Please provide a valid email address, not {self.account_email}"
            )

        # Check if metered charge is in the right format $X or $X.XX
        if not self.metered_charge.startswith("$"):
            raise ValueError(
                f"Metered charge must start with $, not {self.metered_charge}"
            )
        if not self.metered_charge[1:].replace(".", "", 1).isdigit():
            raise ValueError(
                f"Metered charge must be a number, not {self.metered_charge}"
            )

        if self.min_created > self.max_created:
            raise ValueError(
                f"min_created must be before max_created, not {self.min_created} and"
                f" {self.max_created}"
            )

__post_init__()

Post-init method.

Source code in src/wordcab/core_objects/stats.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def __post_init__(self) -> None:
    """Post-init method."""
    if self.plan not in AVAILABLE_PLAN:
        raise ValueError(f"Plan must be one of {AVAILABLE_PLAN}, not {self.plan}")

    if not validators.email(self.account_email):
        raise ValueError(
            f"Please provide a valid email address, not {self.account_email}"
        )

    # Check if metered charge is in the right format $X or $X.XX
    if not self.metered_charge.startswith("$"):
        raise ValueError(
            f"Metered charge must start with $, not {self.metered_charge}"
        )
    if not self.metered_charge[1:].replace(".", "", 1).isdigit():
        raise ValueError(
            f"Metered charge must be a number, not {self.metered_charge}"
        )

    if self.min_created > self.max_created:
        raise ValueError(
            f"min_created must be before max_created, not {self.min_created} and"
            f" {self.max_created}"
        )
Last update: 2023-09-25
Created: 2023-09-25