Prep to Open Source

.github/workflows/coverage.yaml

@@ -0,0 +1,35 @@
+
+name: Post Coverage Commit
+
+on: 
+workflow_run:
+  workflows: ["Pytest"]
+  types: 
+    - completed
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    if: github.event.workflow_run.event == "pull_request" && github.event.workflow_run.conclusion == "success"
+    permissions:
+      pull-requests: write
+      contents: write
+      actions: read
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: actions/download-artifact@v4
+      id: download
+      with:
+        pattern: coverage-*
+        merge-multiple: true
+    - name: Re-add relative so the action is happy
+      run: |
+        echo "[run]" >> .coveragerc
+        echo "relative_files = true" >> .coveragerc
+    - name: Python Coverage Comment
+      uses: py-cov-action/[email protected]
+      with:
+        GITHUB_TOKEN: ${{ github.token }}
+        MERGE_COVERAGE_FILES: true
+        GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }}

.github/workflows/matchers/ruff.json

@@ -0,0 +1,14 @@
+{
+  "problemMatcher": [
+    {
+      "owner": "ruff",
+      "pattern": [
+        {
+          "regexp": "^(Would reformat): (.+)$",
+          "message": 1,
+          "file": 2
+        }
+      ]
+    }
+  ]
+}

.github/workflows/pytest.yaml

@@ -10,6 +10,7 @@ jobs:
   pytest:
 
     runs-on: ${{ matrix.os }}
+    permissions: 
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
@@ -40,32 +41,10 @@ jobs:
         hatch run dev:pytest
       env:
         COVERAGE_FILE: ".coverage.${{ matrix.os }}.${{ matrix.python-version }}"
-    - name: Store coverage file
-      uses: actions/upload-artifact@v4
-      with:
-        name: coverage-${{ matrix.os }}-${{ matrix.python-version }}
-        path: .coverage.${{ matrix.os }}.${{ matrix.python-version }}
+    - name: Store Pull Request comment to be posted
+        uses: actions/upload-artifact@v4
+          if: steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true'
+          with:
+            name: python-coverage-comment-action
+            path: python-coverage-comment-action.txt
 
-  coverage:
-    runs-on: ubuntu-latest
-    needs: pytest
-    permissions:
-      pull-requests: write
-      contents: write
-    steps:
-    - uses: actions/checkout@v4
-
-    - uses: actions/download-artifact@v4
-      id: download
-      with:
-        pattern: coverage-*
-        merge-multiple: true
-    - name: Re-add relative so the action is happy
-      run: |
-        echo "[run]" >> .coveragerc
-        echo "relative_files = true" >> .coveragerc
-    - name: Python Coverage Comment
-      uses: py-cov-action/[email protected]
-      with:
-        GITHUB_TOKEN: ${{ github.token }}
-        MERGE_COVERAGE_FILES: true

.github/workflows/ruff.yaml

@@ -17,6 +17,11 @@ jobs:
       run: |
         python -m pip install hatch
         hatch env create dev
-    - name: Lint with Ruff
+    - name: Lint with Ruff (check)
       run: |
-        hatch run dev:ruff --output-format=github .
+        hatch run dev:ruff check --output-format=github .
+    - name: Register problem matcher for ruff format
+      run: echo "::add-matcher::.github/workflows/matchers/ruff.json"
+    - name: Lint with Ruff (format)
+      run: |
+        hatch run dev:ruff format --check .

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.

annotated_logger/__init__.py

@@ -340,6 +340,7 @@ def __init__(  # noqa: PLR0913
         self.formatter = formatter or JsonFormatter(
             "%(created)s %(levelname)s %(name)s %(message)s"  # pragma: no mutate
         )
+        self.handlers = [handler]
         handler.setFormatter(self.formatter)
         self.max_length = max_length
 
@@ -356,7 +357,8 @@ def _generate_logger(
             f"{self.logger_root_name}.{uuid.uuid4()}"  # pragma: no mutate
         )
 
-        logger.addHandler(handler)
+        for handler_item in self.handlers:
+            logger.addHandler(handler_item)
 
         annotated_filter = self.generate_filter(function=function, cls=cls)
 

annotated_logger/mocks.py

@@ -244,8 +244,9 @@
 
 
 @pytest.fixture()
-def annotated_logger_mock(mocker: MagicMock) -> AnnotatedLogMock:
+def annotated_logger_mock(mocker: MagicMock, annotated_logger_object: AnnotatedLogger) -> AnnotatedLogMock:
     """Fixture for a mock of the annotated logger."""
+    import pdb;pdb.set_trace()
     return mocker.patch(
         "annotated_logger.handler",
         new_callable=AnnotatedLogMock,

example/calculator.py

@@ -19,7 +19,7 @@
     return "this function is called every time"
 
 
-annotated_logger = AnnotatedLogger(
+ann_logger = AnnotatedLogger(
     annotations={
         "extra": "new data",
         "nested_extra": {"nested_key": {"double_nested_key": "value"}},
@@ -32,10 +32,10 @@
         RemoverPlugin("taskName"),
         NestedRemoverPlugin(["double_nested_key"]),
     ],
-    name="annotated_logger.example",
+    name="annotated_logger.calculator",
 )
 
-annotate_logs = annotated_logger.annotate_logs
+annotate_logs = ann_logger.annotate_logs
 
 Number = int | float
 
@@ -90,7 +90,7 @@
             "Prediction result", extra={"result": success != prediction}
         )
 
-    @annotated_logger.annotate_logs(
+    @ann_logger.annotate_logs(
         success_info=False,
         pre_call=check_zero_division,
         _typing_requested=True,
@@ -102,6 +102,7 @@
             "If you divide by zero you'll create a singularity in the fabric of space-time!",  # noqa: E501
             extra={"joke": True},
         )
+        import pdb;pdb.set_trace()
         try:
             return self.first / self.second
         except ZeroDivisionError:

notes.md

@@ -0,0 +1,10 @@
+Should support the ability to configure via a logging config.
+
+The AnnotatedLogger class would take params that let it build/override parts of the config.
+
+Need to sort out how we do the mock on the handler then. Have the mock fixture pull in a fixture for what handler to do and then if you don't do that you can override that fixture? How does it work with multiple handlers?
+
+
+The overall goal is to be able to support the case where you want to configure multiple output streams (handlers) with different filters. AKA, output with a different log level that filters/formats for actions notifications at the same time as a normal logger
+
+Also, move base_attribute support into the plugin base and also store the values we add in the annotated (annotated, action and so on). Then make a function that lets a plugin ask for the bits of a record that were added by the caller or the caller and the annotated_logger.

test/test_decorator.py

@@ -4,7 +4,7 @@
 import test.demo
 from annotated_logger.mocks import AnnotatedLogMock
 from example.api import ApiClient
-from example.calculator import BoomError, Calculator, annotated_logger
+from example.calculator import BoomError, Calculator, ann_logger
 from example.default import DefaultExample, var_args_and_kwargs_provided_outer
 
 
@@ -209,8 +209,8 @@ def test_debug(self, annotated_logger_mock):
     def test_runtime_not_cached(self, annotated_logger_mock, mocker):
         runtime_mock = mocker.Mock(name="runtime_not_cached")
         runtime_mock.side_effect = ["first", "second", "third", "fourth"]
-        runtime_annotations = annotated_logger.runtime_annotations
-        annotated_logger.runtime_annotations = {"runtime": runtime_mock}
+        runtime_annotations = ann_logger.runtime_annotations
+        ann_logger.runtime_annotations = {"runtime": runtime_mock}
         calc = Calculator(12, 13)
         calc.subtract()
         annotated_logger_mock.assert_logged(
@@ -231,7 +231,7 @@ def test_runtime_not_cached(self, annotated_logger_mock, mocker):
                 "runtime": "second",
             },
         )
-        annotated_logger.runtime_annotations = runtime_annotations
+        ann_logger.runtime_annotations = runtime_annotations
 
     def test_raises_type_error_with_too_few_args(self):
         calc = Calculator(12, 13)
@@ -364,7 +364,7 @@ class Weird:
             def __len__(self):
                 return 999
 
-        @annotated_logger.annotate_logs(_typing_self=False)
+        @ann_logger.annotate_logs(_typing_self=False)
         def test_me():
             return Weird()