René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Add support to custom `JSONEncoder`","articleBody":" **Is your feature request related to a problem? Please describe.**\r\nMy company is moving out from [structlog](https://www.structlog.org/en/stable/) to start using this package, as it is intended to have better integration with google products. We're using `StructuredLogHandler` to send the log records to google cloud logging. But something structlog used to do out-of-the-box was the ability to automatically convert the extra data we provide to the logger to be sent to the stream, and therefore, we need to check all the calls we're making to `logger.info()`, `debug()`, `warning()`, etc. to check if the data type is supported by JSONEncoder, otherwise the call to `hadler.format()` will raise `TypeError`, stating that `Object of type PosixPath is not JSON serializable` (this is one example of error we're getting, because the default encoder cannot encode `pathlib.Path` instances) and the log record will not be pushed to gcloud logging\r\n **Describe the solution you'd like**\r\nI'd like to be able to specify a custom class to encode the message to JSON, so the formatting is handled by the encoder, not the caller of `logger.info()` and its siblings\r\n **Describe alternatives you've considered**\r\nAn alternative would be having a filter that prepares the data to be used by the handler, I'm even wrote a filter to handle that:\r\n```python\r\nclass JsonableConverterFilter(logging.Filter):\r\n    \"\"\"Prepare log record to be JSON encoded\r\n\r\n    :class:`google.cloud.logging_v2.handlers.StructuredLogHandler` encodes directly to default JSON encoder without\r\n    the possibility to set up a custom encoder, so we need to hydrate the log record to not break when emitting\r\n    (because broken logs break silently)\r\n\r\n    The ideal solution would be to have a LogFormatter, but as GCloud's log handler formats to JSON inside the handler,\r\n    we need to circumvent this issue with a :class:`logging.Filter`\r\n    \"\"\"\r\n\r\n    def filter(self, record: logging.LogRecord) -\u003e bool:\r\n        fields: Dict[str, Any] = getattr(record, \"json_fields\", {})\r\n\r\n        for key, value in fields.items():\r\n            fields[key] = JsonableConverterFilter.prepare_field(value)\r\n\r\n        return True\r\n\r\n    @classmethod\r\n    def prepare_field(cls, value: Any) -\u003e TypeJSON:\r\n        \"\"\"Converts the provided type into a plain JSON type\"\"\"\r\n        # basic types\r\n        if isinstance(value, (int, str, float, bool)) or value is None:\r\n            return value\r\n\r\n        try:\r\n            iterator = iter(value)\r\n        except TypeError:\r\n            # probably a custom class\r\n            if not hasattr(value, \"__dict__\"):\r\n                return str(value)\r\n\r\n            iterator = iter(value.__dict__)\r\n\r\n        # hashmaps\r\n        if hasattr(value, \"keys\") and hasattr(value, \"values\"):\r\n            return {key: cls.prepare_field(val) for key, val in value.items()}\r\n\r\n        # sequences\r\n        return [cls.prepare_field(item) for item in iterator]\r\n\r\n```\r\nbut it seems to me I'm deviating the purpose of log filters by doing that\r\n **Additional context**\r\nn/a for now\r\n","author":{"url":"https://github.com/thiromi","@type":"Person","name":"thiromi"},"datePublished":"2022-10-25T11:03:01.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/656/python-logging/issues/656"}