annotated-logger 1.2.1__py3-none-any.whl

annotated_logger/filter.py

@@ -0,0 +1,58 @@
+from __future__ import annotations
+
+import logging
+from copy import copy
+from typing import Any
+
+import annotated_logger
+
+Annotations = dict[str, Any]
+
+
+class AnnotatedFilter(logging.Filter):
+    """Filter class that stores the annotations and plugins."""
+
+    def __init__(
+        self,
+        annotations: Annotations | None = None,
+        class_annotations: Annotations | None = None,
+        plugins: list[annotated_logger.BasePlugin] | None = None,
+    ) -> None:
+        """Store the annotations, attributes and plugins."""
+        self.annotations = annotations or {}
+        self.class_annotations = class_annotations or {}
+        self.plugins = plugins or [annotated_logger.BasePlugin()]
+
+        # This allows plugins to determine what fields were added by the user
+        # vs the ones native to the log record
+        # TODO(crimsonknave): Make a test for this # noqa: TD003, FIX002
+        self.base_attributes = logging.makeLogRecord({}).__dict__  # pragma: no mutate
+
+    def _all_annotations(self) -> Annotations:
+        annotations = {}
+        annotations.update(copy(self.class_annotations))
+        annotations.update(copy(self.annotations))
+        annotations["annotated"] = True
+        return annotations
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        """Add the annotations to the record and allow plugins to filter the record.
+
+        The `filter` method is called on each plugin in the order they are listed.
+        The plugin is then able to maniuplate the record object before the next plugin
+        sees it. Returning False from the filter method will stop the evaluation and
+        the log record won't be emitted.
+        """
+        record.__dict__.update(self._all_annotations())
+        for plugin in self.plugins:
+            try:
+                result = plugin.filter(record)
+            except Exception:  # noqa: BLE001
+                failed_plugins = record.__dict__.get("failed_plugins", [])
+                failed_plugins.append(str(plugin.__class__))
+                record.__dict__["failed_plugins"] = failed_plugins
+                result = True
+
+            if not result:
+                return False
+        return True

annotated_logger/mocks.py

@@ -0,0 +1,253 @@
+from __future__ import annotations
+
+import logging
+from typing import Any, Literal
+
+import pychoir
+import pytest
+
+
+class AssertLogged:
+    """Stores the data from a call to `assert_logged` and checks if there is a match."""
+
+    def __init__(
+        self,
+        level: str | pychoir.core.Matcher,
+        message: str | pychoir.core.Matcher,
+        present: dict[str, str],
+        absent: set[str] | Literal["ALL"],
+        *,
+        count: int | pychoir.core.Matcher,
+    ) -> None:
+        """Store the arguments that were passed to `assert_logged` and set defaults."""
+        self.level = level
+        self.message = message
+        self.present = present
+        self.absent = absent
+        self.count = count
+        self.found = 0
+        self.failed_matches: dict[str, int] = {}
+
+    def check(self, mock: AnnotatedLogMock) -> None:
+        """Loop through calls in passed mock and check for matches."""
+        for record in mock.records:
+            differences = self._check_record_matches(record)
+            if len(differences) == 0:
+                self.found = self.found + 1
+            diff_str = str(differences)
+            if diff_str in self.failed_matches:
+                self.failed_matches[diff_str] += 1
+            else:
+                self.failed_matches[diff_str] = 1
+
+        fail_message = self.build_message()
+        if len(fail_message) > 0:
+            pytest.fail("\n".join(fail_message))
+
+    def _failed_sort_key(self, failed_tuple: tuple[str, int]) -> str:
+        failed, count = failed_tuple
+        message_match = failed.count("Desired message")
+        count_diff = 0  # pragma: no mutate
+        if isinstance(self.count, int):
+            count_diff = abs(count - self.count)
+        number = (
+            failed.count("Desired")
+            + failed.count("Missing key")
+            + failed.count("Unwanted key")
+        )
+        length = len(failed)
+        # This will order by if the message matched then how the count differs
+        # then number of incorrect bits and finally the length
+        return f"{message_match}-{count_diff:04d}-{number:04d}-{length:04d}"  # pragma: no mutate # noqa: E501
+
+    def build_message(self) -> list[str]:
+        """Create failure message."""
+        if self.count == 0 and self.found == 0:
+            return []
+        if self.found == 0:
+            fail_message = [
+                f"No matching log record found. There were {sum(self.failed_matches.values())} log messages.",  # noqa: E501
+            ]
+
+            fail_message.append("Desired:")
+            if isinstance(self.count, int):
+                fail_message.append(f"Count: {self.count}")
+            fail_message.append(f"Message: '{self.message}'")
+            fail_message.append(f"Level: '{self.level}'")
+            # only put in these if they were specified
+            fail_message.append(f"Present: '{self.present}'")
+            fail_message.append(f"Absent: '{self.absent}'")
+            fail_message.append("")
+
+            if len(self.failed_matches) == 0:
+                return fail_message
+            fail_message.append(
+                "Below is a list of the values for the selected extras for those failed matches.",  # noqa: E501
+            )
+            for match, count in sorted(
+                self.failed_matches.items(), key=self._failed_sort_key
+            ):
+                msg = match
+                if self.count and self.count != count:
+                    msg = (
+                        match[:-1]
+                        + f', "Desired {self.count} call{"" if self.count == 1 else "s"}, actual {count} call{"" if count == 1 else "s"}"'  # noqa: E501
+                        + match[-1:]
+                    )
+                fail_message.append(msg)
+            return fail_message
+
+        if self.count != self.found:
+            return [f"Found {self.found} matching messages, {self.count} were desired"]
+        return []
+
+    def _check_record_matches(
+        self,
+        record: logging.LogRecord,
+    ) -> list[str]:
+        differences = []
+        # `levelname` is often renamed. But, `levelno` shouldn't be touched as often
+        # So, don't try to guess what the level name is, just use the levelno.
+        level = {
+            logging.DEBUG: "DEBUG",
+            logging.INFO: "INFO",
+            logging.WARNING: "WARNING",
+            logging.ERROR: "ERROR",
+        }[record.levelno]
+        actual = {
+            "level": level,
+            "msg": record.msg,
+            # The extras are already added as attributes, so this is the easiest way
+            # to get them. There are more things in here, but that should be fine
+            "extra": record.__dict__,
+        }
+
+        if self.level != actual["level"]:
+            differences.append(
+                f"Desired level: {self.level}, actual level: {actual['level']}",
+            )
+        # TODO @<crimsonknave>: Do a better string diff here  # noqa: FIX002, TD003
+        if self.message != actual["msg"]:
+            differences.append(
+                f"Desired message: '{self.message}', actual message: '{actual['msg']}'",
+            )
+
+        actual_keys = set(actual["extra"].keys())
+        desired_keys = set(self.present.keys())
+
+        missing = desired_keys - actual_keys
+        unwanted = set()
+        if self.absent == AnnotatedLogMock.ALL:
+            unwanted = actual_keys - AnnotatedLogMock.DEFAULT_LOG_KEYS
+        elif isinstance(self.absent, set):
+            unwanted = actual_keys & self.absent
+        shared = desired_keys & actual_keys
+        differences.extend([f"Missing key: `{key}`" for key in sorted(missing)])
+
+        differences.extend([f"Unwanted key: `{key}`" for key in sorted(unwanted)])
+
+        differences.extend(
+            [
+                f"Extra `{key}` value is incorrect. Desired `{self.present[key]}` ({self.present[key].__class__}) , actual `{actual['extra'][key]}` ({actual['extra'][key].__class__})"  # noqa: E501
+                for key in sorted(shared)
+                if self.present[key] != actual["extra"][key]
+            ]
+        )
+        return differences
+
+
+class AnnotatedLogMock(logging.Handler):
+    """Mock that captures logs and provides extra assertion logic."""
+
+    ALL = "ALL"
+    DEFAULT_LOG_KEYS = frozenset(
+        [
+            "action",
+            "annotated",
+            "args",
+            "created",
+            "exc_info",
+            "exc_text",
+            "filename",
+            "funcName",
+            "levelname",
+            "levelno",
+            "lineno",
+            "message",
+            "module",
+            "msecs",
+            "msg",
+            "name",
+            "pathname",
+            "process",
+            "processName",
+            "relativeCreated",
+            "stack_info",
+            "thread",
+            "threadName",
+        ]
+    )
+
+    def __init__(self, handler: logging.Handler) -> None:
+        """Store the handler and initialize the messages and records lists."""
+        self.messages = []
+        self.records = []
+        self.handler = handler
+
+    def __getattr__(self, name: str) -> Any:  # noqa: ANN401
+        """Fall back to the real handler object."""
+        return getattr(self.handler, name)
+
+    def handle(self, record: logging.LogRecord) -> bool:
+        """Wrap the real handle method, store the formatted message and log record."""
+        self.messages.append(self.handler.format(record))
+        self.records.append(record)
+        return self.handler.handle(record)
+
+    def assert_logged(
+        self,
+        level: str | pychoir.core.Matcher | None = None,
+        message: str | pychoir.core.Matcher | None = None,
+        present: dict[str, Any] | None = None,
+        absent: str | set[str] | list[str] | None = None,
+        count: int | pychoir.core.Matcher | None = None,
+    ) -> None:
+        """Check if the mock received a log call that matches the arguments."""
+        if level is None:
+            level = pychoir.existential.Anything()
+        elif isinstance(level, str):
+            level = level.upper()
+        if message is None:
+            message = pychoir.existential.Anything()
+        if present is None:
+            present = {}
+        if absent is None:
+            absent = []
+        if isinstance(absent, list):
+            absent = set(absent)
+        if isinstance(absent, str) and absent != "ALL":
+            absent = {absent}
+        if count is None:
+            count = pychoir.numeric.IsPositive()
+        __tracebackhide__ = True  # pragma: no mutate
+        assert_logged = AssertLogged(level, message, present, absent, count=count)
+        assert_logged.check(self)
+
+
+@pytest.fixture
+def annotated_logger_object() -> logging.Logger:
+    """Logger to wrap with the `annotated_logger_mock` fixture."""
+    return logging.getLogger("annotated_logger")
+
+
+@pytest.fixture
+def annotated_logger_mock(annotated_logger_object: logging.Logger) -> AnnotatedLogMock:
+    """Fixture for a mock of the annotated logger."""
+    handler = annotated_logger_object.handlers[0]
+    annotated_logger_object.removeHandler(handler)
+    mock_handler = AnnotatedLogMock(
+        handler=handler,
+    )
+
+    annotated_logger_object.addHandler(mock_handler)
+    return mock_handler

annotated_logger/plugins.py

@@ -0,0 +1,208 @@
+from __future__ import annotations
+
+import contextlib
+import logging
+from typing import TYPE_CHECKING, Any, Callable
+
+from requests.exceptions import HTTPError
+
+from annotated_logger.filter import AnnotatedFilter
+
+if TYPE_CHECKING:  # pragma: no cover
+    from annotated_logger import AnnotatedAdapter
+
+
+class BasePlugin:
+    """Base class for plugins."""
+
+    def filter(self, _record: logging.LogRecord) -> bool:
+        """Determine if the record should be sent."""
+        return True
+
+    def uncaught_exception(
+        self, exception: Exception, logger: AnnotatedAdapter
+    ) -> AnnotatedAdapter:
+        """Handle an uncaught excaption."""
+        if "success" not in logger.filter.annotations:
+            logger.annotate(success=False)
+        if "exception_title" not in logger.filter.annotations:
+            logger.annotate(exception_title=str(exception))
+        return logger
+
+
+class RuntimeAnnotationsPlugin(BasePlugin):
+    """Plugin that sets annotations dynamically."""
+
+    def __init__(
+        self, runtime_annotations: dict[str, Callable[[logging.LogRecord], Any]]
+    ) -> None:
+        """Store the runtime annotations."""
+        self.runtime_annotations = runtime_annotations
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        """Add any configured runtime annotations."""
+        for key, function in self.runtime_annotations.items():
+            record.__dict__[key] = function(record)
+        return True
+
+
+class RequestsPlugin(BasePlugin):
+    """Plugin for the requests library."""
+
+    def uncaught_exception(
+        self, exception: Exception, logger: AnnotatedAdapter
+    ) -> AnnotatedAdapter:
+        """Add the status code if possible."""
+        if isinstance(exception, HTTPError) and exception.response is not None:
+            logger.annotate(status_code=exception.response.status_code)
+            logger.annotate(exception_title=exception.response.reason)
+        return logger
+
+
+class RenamerPlugin(BasePlugin):
+    """Plugin that prevents name collisions."""
+
+    class FieldNotPresentError(Exception):
+        """Exception for a field that is supposed to be renamed, but is not present."""
+
+    def __init__(self, *, strict: bool = False, **kwargs: str) -> None:
+        """Store the list of names to rename and pre/post fixs."""
+        self.targets = kwargs
+        self.strict = strict
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        """Adjust the name of any fields that match a provided list if they exist."""
+        for new, old in self.targets.items():
+            if old in record.__dict__:
+                record.__dict__[new] = record.__dict__[old]
+                del record.__dict__[old]
+            elif self.strict:
+                raise RenamerPlugin.FieldNotPresentError(old)
+        return True
+
+
+class RemoverPlugin(BasePlugin):
+    """Plugin that removed fields."""
+
+    def __init__(self, targets: list[str] | str) -> None:
+        """Store the list of names to remove."""
+        if isinstance(targets, str):
+            targets = [targets]
+        self.targets = targets
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        """Remove the specified fields."""
+        for target in self.targets:
+            with contextlib.suppress(KeyError):
+                del record.__dict__[target]
+        return True
+
+
+class NameAdjusterPlugin(BasePlugin):
+    """Plugin that prevents name collisions with splunk field names."""
+
+    def __init__(self, names: list[str], prefix: str = "", postfix: str = "") -> None:
+        """Store the list of names to rename and pre/post fixs."""
+        self.names = names
+        self.prefix = prefix
+        self.postfix = postfix
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        """Adjust the name of any fields that match a provided list."""
+        for name in self.names:
+            if name in record.__dict__:
+                value = record.__dict__[name]
+                del record.__dict__[name]
+                record.__dict__[f"{self.prefix}{name}{self.postfix}"] = value
+        return True
+
+
+class NestedRemoverPlugin(BasePlugin):
+    """Plugin that removes nested fields."""
+
+    def __init__(self, keys_to_remove: list[str]) -> None:
+        """Store the list of keys to remove."""
+        self.keys_to_remove = keys_to_remove
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        """Remove the specified fields."""
+
+        def delete_keys_nested(
+            target: dict,  # pyright: ignore[reportMissingTypeArgument]
+            keys_to_remove: list,  # pyright: ignore[reportMissingTypeArgument]
+        ) -> dict:  # pyright: ignore[reportMissingTypeArgument]
+            for key in keys_to_remove:
+                with contextlib.suppress(KeyError):
+                    del target[key]
+            for value in target.values():
+                if isinstance(value, dict):
+                    delete_keys_nested(value, keys_to_remove)
+            return target
+
+        record.__dict__ = delete_keys_nested(record.__dict__, self.keys_to_remove)
+        return True
+
+
+class GitHubActionsPlugin(BasePlugin):
+    """Plugin that will format log messages for actions annotations."""
+
+    def __init__(self, annotation_level: int) -> None:
+        """Save the annotation level."""
+        self.annotation_level = annotation_level
+        self.base_attributes = logging.makeLogRecord({}).__dict__  # pragma: no mutate
+        self.attributes_to_exclude = {"annotated"}
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        """Set the actions command to be an annotation if desired."""
+        if record.levelno < self.annotation_level:
+            return False
+
+        added_attributes = {
+            k: v
+            for k, v in record.__dict__.items()
+            if k not in self.base_attributes and k not in self.attributes_to_exclude
+        }
+        record.added_attributes = added_attributes
+        name = record.levelname.lower()
+        if name == "info":  # pragma: no cover
+            name = "notice"
+        record.github_annotation = f"{name}::"
+
+        return True
+
+    def logging_config(self) -> dict[str, dict[str, object]]:
+        """Generate the default logging config for the plugin."""
+        return {
+            "handlers": {
+                "actions_handler": {
+                    "class": "logging.StreamHandler",
+                    "filters": ["actions_filter"],
+                    "formatter": "actions_formatter",
+                },
+            },
+            "filters": {
+                "actions_filter": {
+                    "()": AnnotatedFilter,
+                    "plugins": [
+                        BasePlugin(),
+                        self,
+                    ],
+                },
+            },
+            "formatters": {
+                "actions_formatter": {
+                    "format": "{github_annotation} {message} - {added_attributes}",
+                    "style": "{",
+                },
+            },
+            "loggers": {
+                "annotated_logger.actions": {
+                    "level": "DEBUG",
+                    "handlers": [
+                        # This is from the default logging config
+                        #  "annotated_handler",
+                        "actions_handler",
+                    ],
+                },
+            },
+        }

annotated_logger-1.2.1.dist-info/METADATA

@@ -0,0 +1,65 @@
+Metadata-Version: 2.3
+Name: annotated-logger
+Version: 1.2.1
+Summary: A decorator that logs the start and end of a function as well as providing an optional logger with annotations
+Project-URL: Homepage, https://github.com/github/annotated_logger
+Author-email: Vuln Mgmt Eng <security+vulnmgmteng@github.com>
+License: MIT
+Keywords: annotation,decorator,logging
+Requires-Python: >=3.6
+Requires-Dist: makefun
+Requires-Dist: pychoir
+Requires-Dist: python-json-logger
+Requires-Dist: requests
+Description-Content-Type: text/markdown
+
+# Annotated Logger
+
+[contribution]: https://github.com/github/annotated-logger/blob/main/CONTRIBUTING.md
+
+[![Coverage badge](https://github.com/github/annotated-logger/raw/python-coverage-comment-action-data/badge.svg)](https://github.com/github/annotated-logger/tree/python-coverage-comment-action-data) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
+
+The `annotated-logger` package provides a decorator that can inject a annotatable logger object into a method or class. This logger object is a drop in replacement for `logging.logger` with additional functionality.
+
+## Background
+
+Annotated Logger is actively used by GitHub's Vulnerability Management team to help to easily add context to our logs in splunk. It is more or less feature complete for our current use cases, but we will add additional features/fixes as we discover a need for them. But, we'd love feature requests, bug report and or PRs for either (see our [contribution guidelines][contribution] for more information if you wish to contribute).
+
+## Requirements
+Annotated Logger is a Python package. It should work on any version of Python 3, but it is currently tested on 3.9 and higher.
+
+## Usage
+
+The `annotated-logger` package allows you to decorate a function so that the start and end of that function is logged as well as allowing that function to request an `annotated_logger` object which can be used as if it was a standard python `logger`. Additionally, the `annotated_logger` object will have added annotations based on the method it requested from, any other annotations that were configured ahead of time and any annotations that were added prior to a log being made. Finally, any uncaught exceptions in a decorated method will be logged and re-raised, which allows you to when and how a method ended regardless of if it was successful or not.
+
+```python
+from annotated_logger import AnnotatedLogger
+
+annotated_logger = AnnotatedLogger(
+    annotations={"this": "will show up in every log"},
+)
+annotate_logs = annotated_logger.annotate_logs
+
+@annotate_logs()
+def foo(annotated_logger, bar):
+    annotated_logger.annotate(bar=bar)
+    annotated_logger.info("Hi there!", extra={"mood": "happy"})
+
+foo("this is the bar parameter")
+
+{"created": 1708476277.102495, "levelname": "INFO", "name": "annotated_logger.fe18537a-d293-45d7-83c9-51dab3a4c436", "message": "Hi there!", "mood": "happy", "action": "__main__:foo", "this": "will show up in every log", "bar": "this is the bar parameter", "annotated": true}
+{"created": 1708476277.1026022, "levelname": "INFO", "name": "annotated_logger.fe18537a-d293-45d7-83c9-51dab3a4c436", "message": "success", "action": "__main__:foo", "this": "will show up in every log", "bar": "this is the bar parameter", "run_time": "0.0", "success": true, "annotated": true}
+```
+
+The example directory has a few files that exercise all of the features of the annotated-logger package. The `Calculator` class is the most fully featured example (but not a fully featured calculator :wink:). The `logging_config` example shows how to configure a logger via a dictConfig, like django uses. It also shows some of the interactions that can exist between a `logging` logger and an `annotated_logger` if `logging` is configured to use the annotated logger filter.
+
+## License
+
+This project is licensed under the terms of the MIT open source license. Please refer to MIT for the full terms.
+
+## Maintainers
+This project is primarily maintained by `crimsonknave` on behalf of GitHub's Vulnerability Management team as it was initially developed for our internal use.
+
+## Support
+
+Reported bugs will be addressed, pull requests are welcome, but there is limited bandwidth for work on new features.

annotated_logger-1.2.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+annotated_logger/__init__.py,sha256=CNxhBSz5FC1GgfpTn1_PtDpI-PppaE2hx5LINS2D8wo,33616
+annotated_logger/filter.py,sha256=FuE8XNsE6NqCeg5C0_O23BsTMCtauJIv2zdrLnsaqQc,2199
+annotated_logger/mocks.py,sha256=ko_6jACn_mX7J7gEJKVAjQAfsyhMW-RVr5AivyzDwSY,9252
+annotated_logger/plugins.py,sha256=AqwchYVQ5GOCblZQozE6LLQabWGoJxHBmSsL9IKG-ok,7339
+annotated_logger/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+annotated_logger-1.2.1.dist-info/METADATA,sha256=hdBG3WF7pyRazHaqGVRorkwoFGvDk3H50gmA4_eoLLU,4456
+annotated_logger-1.2.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+annotated_logger-1.2.1.dist-info/entry_points.txt,sha256=qEfPZaQTtLU05XwiqGoKdVrqTnfJyBWzUXeHjwGv3I0,53
+annotated_logger-1.2.1.dist-info/licenses/LICENSE.txt,sha256=JRC0RrwfDPlwJFMHXSDNiGMeIOVkJljttzJdnB61NPc,1060
+annotated_logger-1.2.1.dist-info/RECORD,,

annotated_logger-1.2.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.26.3
+Root-Is-Purelib: true
+Tag: py3-none-any

annotated_logger-1.2.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+annotated_logger = annotated_logger.mocks

annotated_logger-1.2.1.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright GitHub, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.