You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
64 lines
2.1 KiB
Python
64 lines
2.1 KiB
Python
"""JSON Formatter using [`msgspec`](https://github.com/jcrist/msgspec)"""
|
|
|
|
### IMPORTS
|
|
### ============================================================================
|
|
## Future
|
|
from __future__ import annotations
|
|
|
|
## Standard Library
|
|
from typing import Any, Optional, Callable
|
|
|
|
## Installed
|
|
|
|
## Application
|
|
from . import core
|
|
from . import defaults as d
|
|
from .utils import package_is_available
|
|
|
|
# We import msgspec after checking it is available
|
|
package_is_available("msgspec", throw_error=True)
|
|
import msgspec.json # pylint: disable=wrong-import-position,wrong-import-order
|
|
|
|
|
|
### FUNCTIONS
|
|
### ============================================================================
|
|
def msgspec_default(obj: Any) -> Any:
|
|
"""msgspec default encoder function for non-standard types"""
|
|
if d.use_exception_default(obj):
|
|
return d.exception_default(obj)
|
|
if d.use_traceback_default(obj):
|
|
return d.traceback_default(obj)
|
|
if d.use_enum_default(obj):
|
|
return d.enum_default(obj)
|
|
if d.use_type_default(obj):
|
|
return d.type_default(obj)
|
|
return d.unknown_default(obj)
|
|
|
|
|
|
### CLASSES
|
|
### ============================================================================
|
|
class MsgspecFormatter(core.BaseJsonFormatter):
|
|
"""JSON formatter using [`msgspec.json.Encoder`](https://jcristharif.com/msgspec/api.html#msgspec.json.Encoder) for encoding."""
|
|
|
|
def __init__(
|
|
self,
|
|
*args,
|
|
json_default: Optional[Callable] = msgspec_default,
|
|
**kwargs,
|
|
) -> None:
|
|
"""
|
|
Args:
|
|
args: see [BaseJsonFormatter][pythonjsonlogger.core.BaseJsonFormatter]
|
|
json_default: a function for encoding non-standard objects
|
|
kwargs: see [BaseJsonFormatter][pythonjsonlogger.core.BaseJsonFormatter]
|
|
"""
|
|
super().__init__(*args, **kwargs)
|
|
|
|
self.json_default = json_default
|
|
self._encoder = msgspec.json.Encoder(enc_hook=self.json_default)
|
|
return
|
|
|
|
def jsonify_log_record(self, log_data: core.LogData) -> str:
|
|
"""Returns a json string of the log data."""
|
|
return self._encoder.encode(log_data).decode("utf8")
|