tremors 0.3.4__py3-none-any.whl → 0.4.0__py3-none-any.whl

tremors/__init__.py

@@ -5,6 +5,6 @@ from tremors.logger import EXTRA_KEY, Collector, Logger
 
 __authors__ = ["Narvin Singh"]
 __project__ = "Tremors"
-__version__ = "0.3.4"
+__version__ = "0.4.0"
 
 __all__ = ["EXTRA_KEY", "Collector", "Logger", "__version__", "from_logged", "logged"]

tremors/collector.py

@@ -93,10 +93,11 @@ class IndentifierState(NamedTuple):
 
 
 def _identifier_collect(
-    state: IndentifierState | None, logger: tremors.logger.Logger
+    state: IndentifierState | None, log_item: tremors.logger.LogItem
 ) -> IndentifierState | None:
     if state:
         return state
+    logger = log_item.logger
     if not logger.group_id or not logger.path:
         return None
     return IndentifierState(group_id=logger.group_id, parent=logger.parent, path=logger.path)
@@ -284,7 +285,7 @@ class CounterState:
     step: int
 
 
-def _counter_collect(state: CounterState, _: tremors.logger.Logger) -> CounterState:
+def _counter_collect(state: CounterState, _: tremors.logger.LogItem) -> CounterState:
     state.count += state.step
     return state
 
@@ -430,7 +431,7 @@ class ElapsedState:
     t: int | None
 
 
-def _collect_elapsed(state: ElapsedState, _: tremors.logger.Logger) -> ElapsedState:
+def _collect_elapsed(state: ElapsedState, _: tremors.logger.LogItem) -> ElapsedState:
     t = time.perf_counter_ns()
     if state.t0 is None:
         state.t0 = t

tremors/logger.py

@@ -61,6 +61,29 @@ _current_logger: contextvars.ContextVar[Logger | None] = contextvars.ContextVar(
 )
 
 
+class LogItem(NamedTuple):
+    """The properties of a logged message.
+
+    This is essentially the arguments passed to :meth:`Logger.log`.
+    """
+
+    logger: Logger
+    level: int
+    msg: object
+    args: tuple[object, ...]
+    exc_info: (
+        bool
+        | tuple[type[BaseException], BaseException, TracebackType | None]
+        | tuple[None, None, None]
+        | BaseException
+        | None
+    )
+    stack_info: bool
+    stacklevel: int
+    extra: Mapping[str, object] | None
+    kwargs: dict[str, object]
+
+
 class Collector[TState](NamedTuple):
     """The collector specification.
 
@@ -73,26 +96,26 @@ class Collector[TState](NamedTuple):
         state: The initial state of the collector. Each time the collector
             runs, it may update this state.
         collect: When the collector runs, this function is called with the
-            current state, and the logger. It returns the new state.
+            current state, and the LogItem. It returns the new state.
     """
 
     name: str
     level: int
     state: TState
-    collect: Callable[[TState, Logger], TState]
+    collect: Callable[[TState, LogItem], TState]
 
 
 def _collectors_reducer[T](
     acc: tuple[MutableMapping[str, Collector[T]], MutableMapping[str, T]],
-    curr: tuple[tuple[Logger, int], tuple[str, Collector[T]]],
+    curr: tuple[LogItem, tuple[str, Collector[T]]],
 ) -> tuple[MutableMapping[str, Collector[T]], MutableMapping[str, T]]:
     acc_collectors, acc_extra = acc
-    (logger, level), (name, curr_c) = curr
-    if curr_c.level != logging.NOTSET and level < curr_c.level:
+    log_item, (name, curr_c) = curr
+    if curr_c.level != logging.NOTSET and log_item.level < curr_c.level:
         acc_collectors[name] = curr_c
         acc_extra[name] = curr_c.state
         return acc_collectors, acc_extra
-    state = curr_c.collect(curr_c.state, logger)
+    state = curr_c.collect(curr_c.state, log_item)
     acc_collectors[name] = Collector(curr_c.name, curr_c.level, state, curr_c.collect)
     acc_extra[name] = state
     return acc_collectors, acc_extra
@@ -276,9 +299,20 @@ class Logger(logging.LoggerAdapter[logging.Logger]):
         """
         initial_collectors: MutableMapping[str, Collector[Any]] = {}
         initial_extra: MutableMapping[str, Any] = {}
+        log_item = LogItem(
+            logger=self,
+            level=level,
+            msg=msg,
+            args=args,
+            exc_info=exc_info,
+            stack_info=stack_info,
+            stacklevel=stacklevel,
+            extra=extra,
+            kwargs=kwargs,
+        )
         self._collectors, own_extra = functools.reduce(
             _collectors_reducer,
-            zip(itertools.repeat((self, level)), self._collectors.items(), strict=False),
+            zip(itertools.repeat(log_item), self._collectors.items(), strict=False),
             (initial_collectors, initial_extra),
         )
         return self.logger.log(

{tremors-0.3.4.dist-info → tremors-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tremors
-Version: 0.3.4
+Version: 0.4.0
 Summary: Tremors is a library for logging while collecting metrics.
 Author-email: Narvin Singh <Narvin.A.Singh@gmail.com>
 License: Tremors is a library for logging with metrics.
@@ -282,5 +282,8 @@ single logger used in both function calls maintains its state between calls.
     errors=2 ERROR:root:uh-ho!
     errors=2 INFO:root:exited: context
 
-See the ``tremors.collector`` module for how you can define your own
-collectors, and bundles.
+See the `collector module`_ in the full `documentation`_ for how you can
+define your own collectors, and bundles.
+
+.. _documentation: https://tremors.readthedocs.io/en/latest
+.. _collector module: https://tremors.readthedocs.io/en/latest/#module-tremors.collector

tremors-0.4.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+tremors/__init__.py,sha256=O_T_I0E105fnpKsuLIJncFRuzDR66qojUUFLAVthTiE,300
+tremors/collector.py,sha256=ThaFhfh6kpIxauvlRJUi9iEzKcj_lVFJb62PNzAR654,18557
+tremors/decorator.py,sha256=nWHwwdQBIRBU9j-zxMApLWVkqP6lrLte1-dOLhY4INY,3741
+tremors/logger.py,sha256=kqeDEUfwVwCYgLLfftLH63onnVnVz4a7BFhNzw_36XU,12626
+tremors/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tremors-0.4.0.dist-info/licenses/LICENSE,sha256=X__qS-gpV601TSYqaoqkV5YKHLJlfyJ1IHbjOJbdXCw,694
+tremors-0.4.0.dist-info/METADATA,sha256=ffaGA4qoNXPPm2ZfVryqmqdM67oS7xOeE_CZQ7CbvcQ,9823
+tremors-0.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+tremors-0.4.0.dist-info/top_level.txt,sha256=j9lADjMU0C4UHY94-9FAQD7MHtuGDzZgSxtl_iN2kDI,8
+tremors-0.4.0.dist-info/RECORD,,

tremors-0.3.4.dist-info/RECORD

@@ -1,10 +0,0 @@
-tremors/__init__.py,sha256=3aigNRypwpHd0WDnNe7ENZw14ncu50FszuvrFaLo7Ko,300
-tremors/collector.py,sha256=YwC5xeuovFwPoVFUD14LFmm397ypK9QlszBVpYUvcbQ,18523
-tremors/decorator.py,sha256=nWHwwdQBIRBU9j-zxMApLWVkqP6lrLte1-dOLhY4INY,3741
-tremors/logger.py,sha256=mnIiyHKrTtOY-1rpZF-wteB7ZlwEyeOVKKJ2E8Mnal4,11830
-tremors/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tremors-0.3.4.dist-info/licenses/LICENSE,sha256=X__qS-gpV601TSYqaoqkV5YKHLJlfyJ1IHbjOJbdXCw,694
-tremors-0.3.4.dist-info/METADATA,sha256=yohMn_JIo3ecdt-b9VJBRYNTzf44TuQbIH0x1mcAEYk,9653
-tremors-0.3.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-tremors-0.3.4.dist-info/top_level.txt,sha256=j9lADjMU0C4UHY94-9FAQD7MHtuGDzZgSxtl_iN2kDI,8
-tremors-0.3.4.dist-info/RECORD,,