1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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
|
from __future__ import annotations
from abc import ABC, abstractmethod
from typing import Any, TypeAlias
StatNum: TypeAlias = int | float
class StatCollector(ABC):
"""Base class for web-poet to implement the storing of data written through
:class:`~web_poet.page_inputs.stats.Stats`."""
@abstractmethod
def set(self, key: str, value: Any) -> None:
"""Set the value of stat *key* to *value*."""
@abstractmethod
def inc(self, key: str, value: StatNum = 1) -> None:
"""Increment the value of stat *key* by *value*, or set it to *value*
if *key* has no value."""
class DummyStatCollector(StatCollector):
""":class:`~web_poet.page_inputs.stats.StatCollector` implementation that
does not persist stats. It is used when running automatic tests, where stat
storage is not necessary."""
def __init__(self) -> None:
self._stats: dict[str, Any] = {}
def set(self, key: str, value: Any) -> None: # noqa: D102
self._stats[key] = value
def inc(self, key: str, value: StatNum = 1) -> None: # noqa: D102
if key in self._stats:
assert isinstance(self._stats[key], (int, float))
self._stats[key] += value
else:
self._stats[key] = value
class Stats:
"""Page input class to write key-value data pairs during parsing that you
can inspect later. See :ref:`stats`.
Stats can be set to a fixed value or, if numeric, incremented.
Stats are write-only.
Storage and read access of stats depends on the web-poet framework that you
are using. Check the documentation of your web-poet framework to find out
if it supports stats, and if so, how to read stored stats.
"""
def __init__(self, stat_collector: StatCollector | None = None):
self._stats = stat_collector or DummyStatCollector()
def set(self, key: str, value: Any) -> None:
"""Set the value of stat *key* to *value*."""
self._stats.set(key, value)
def inc(self, key: str, value: StatNum = 1) -> None:
"""Increment the value of stat *key* by *value*, or set it to *value*
if *key* has no value."""
self._stats.inc(key, value)
|
