The centralised logging module for the project.
get_logger(name: str | None = None) -> Logger
Return a logger namespaced under turtle_quant_1.
Parameters:
| Name |
Type |
Description |
Default |
name
|
str | None
|
Typically the calling module's __name__. If provided, the
returned logger is named turtle_quant_1.<suffix> where
<suffix> is name with the leading turtle_quant_1.
stripped (so passing __name__ directly always works). If
None, the root turtle_quant_1 logger is returned.
|
None
|
Source code in src/turtle_quant_1/logging.py
| def get_logger(name: str | None = None) -> logging.Logger:
"""Return a logger namespaced under ``turtle_quant_1``.
Args:
name: Typically the calling module's ``__name__``. If provided, the
returned logger is named ``turtle_quant_1.<suffix>`` where
``<suffix>`` is ``name`` with the leading ``turtle_quant_1.``
stripped (so passing ``__name__`` directly always works). If
``None``, the root ``turtle_quant_1`` logger is returned.
"""
if name is None:
return _root_logger
suffix = name.removeprefix("turtle_quant_1.")
return logging.getLogger(f"turtle_quant_1.{suffix}")
|