Simplify interface (#6)

Remove the not-so-useful StructLog class in favor of a simpler builder function
Remove useless __call__

Author: multani

README.md

@@ -41,9 +41,8 @@ provides:
 import structlog
 import structlog_gcp
 
-gcp_logs = structlog_gcp.StructlogGCP()
-
-structlog.configure(processors=gcp_logs.build_processors())
+processors = structlog_gcp.build_processors()
+structlog.configure(processors=processors)
 ```
 
 Then, you can use `structlog` as usual:

examples/cloud-function/main.py

@@ -7,8 +7,8 @@
 
 import structlog_gcp
 
-gcp_logs = structlog_gcp.StructlogGCP()
-structlog.configure(processors=gcp_logs.build_processors())
+processors = structlog_gcp.build_processors()
+structlog.configure(processors=processors)
 
 
 @functions_framework.http

structlog_gcp/__init__.py

@@ -1 +1,5 @@
-from .base import StructlogGCP  # noqa: F401
+from .base import build_processors  # noqa: F401
+
+__all__ = [
+    "build_processors",
+]

structlog_gcp/base.py

@@ -3,19 +3,15 @@
 from . import errors, processors
 
 
-class StructlogGCP:
-    def __init__(self) -> None:
-        pass
+def build_processors() -> list[Processor]:
+    procs = []
 
-    def build_processors(self) -> list[Processor]:
-        procs = []
+    procs.extend(processors.CoreCloudLogging().setup())
+    procs.extend(processors.LogSeverity().setup())
+    procs.extend(processors.CodeLocation().setup())
+    procs.extend(errors.ReportException().setup())
+    procs.extend(errors.ReportError(["CRITICAL"]).setup())
+    procs.append(errors.add_service_context)
+    procs.extend(processors.FormatAsCloudLogging().setup())
 
-        procs.extend(processors.CoreCloudLogging().setup())
-        procs.extend(processors.LogSeverity().setup())
-        procs.extend(processors.CodeLocation().setup())
-        procs.extend(errors.ReportException().setup())
-        procs.extend(errors.ReportError(["CRITICAL"]).setup())
-        procs.append(errors.add_service_context)
-        procs.extend(processors.FormatAsCloudLogging().setup())
-
-        return procs
+    return procs

structlog_gcp/errors.py

@@ -40,11 +40,7 @@ def __init__(self, log_level: str = "CRITICAL") -> None:
         self.log_level = log_level
 
     def setup(self) -> list[Processor]:
-        return [
-            # structlog.processors.ExceptionRenderer(self.format_exception),
-            structlog.processors.format_exc_info,
-            self.__call__,
-        ]
+        return [structlog.processors.format_exc_info, self]
 
     def __call__(
         self, logger: WrappedLogger, method_name: str, event_dict: EventDict
@@ -77,7 +73,7 @@ def __init__(self, severities: list[str]) -> None:
         self.severities = severities
 
     def setup(self) -> list[Processor]:
-        return [self.__call__]
+        return [self]
 
     def _build_service_context(self) -> dict[str, str]:
         # https://cloud.google.com/error-reporting/reference/rest/v1beta1/ServiceContext

structlog_gcp/processors.py

@@ -18,7 +18,7 @@ def setup(self) -> list[Processor]:
             structlog.processors.UnicodeDecoder(),
             # Add a timestamp in ISO 8601 format.
             structlog.processors.TimeStamper(fmt="iso"),
-            self.__call__,
+            self,
         ]
 
     def __call__(
@@ -37,10 +37,7 @@ class FormatAsCloudLogging:
     """Finalize the Google Cloud Logging event message and replace the logging event"""
 
     def setup(self) -> list[Processor]:
-        return [
-            self.__call__,
-            structlog.processors.JSONRenderer(),
-        ]
+        return [self, structlog.processors.JSONRenderer()]
 
     def __call__(
         self, logger: WrappedLogger, method_name: str, event_dict: EventDict
@@ -74,11 +71,8 @@ def __init__(self) -> None:
         }
 
     def setup(self) -> list[Processor]:
-        return [
-            # Add log level to event dict.
-            structlog.processors.add_log_level,
-            self.__call__,
-        ]
+        # Add log level to event dict.
+        return [structlog.processors.add_log_level, self]
 
     def __call__(
         self, logger: WrappedLogger, method_name: str, event_dict: EventDict
@@ -108,7 +102,7 @@ def setup(self) -> list[Processor]:
                 structlog.processors.CallsiteParameter.LINENO,
             ]
         )
-        return [call_site_proc, self.__call__]
+        return [call_site_proc, self]
 
     def __call__(
         self, logger: WrappedLogger, method_name: str, event_dict: EventDict

tests/conftest.py

@@ -22,8 +22,8 @@ def logger():
             "structlog.processors.format_exc_info", side_effect=fakes.format_exc_info
         ),
     ):
-        gcp_logs = structlog_gcp.StructlogGCP()
-        structlog.configure(processors=gcp_logs.build_processors())
+        processors = structlog_gcp.build_processors()
+        structlog.configure(processors=processors)
         logger = structlog.get_logger()
         yield logger