|
| 1 | +# pylint: disable=missing-function-docstring |
| 2 | + |
| 3 | +### IMPORTS |
| 4 | +### ============================================================================ |
| 5 | +## Future |
| 6 | +from __future__ import annotations |
| 7 | + |
| 8 | +## Standard Library |
| 9 | +import base64 |
| 10 | +import dataclasses |
| 11 | +import datetime |
| 12 | +import enum |
| 13 | +import sys |
| 14 | +from types import TracebackType |
| 15 | +from typing import Any |
| 16 | +import traceback |
| 17 | +import uuid |
| 18 | + |
| 19 | +if sys.version_info >= (3, 10): |
| 20 | + from typing import TypeGuard |
| 21 | +else: |
| 22 | + from typing_extensions import TypeGuard |
| 23 | + |
| 24 | +## Installed |
| 25 | + |
| 26 | +## Application |
| 27 | + |
| 28 | + |
| 29 | +### FUNCTIONS |
| 30 | +### ============================================================================ |
| 31 | +def unknown_default(obj: Any) -> str: |
| 32 | + try: |
| 33 | + return str(obj) |
| 34 | + except Exception: # pylint: disable=broad-exception-caught |
| 35 | + pass |
| 36 | + try: |
| 37 | + return repr(obj) |
| 38 | + except Exception: # pylint: disable=broad-exception-caught |
| 39 | + pass |
| 40 | + return "__could_not_encode__" |
| 41 | + |
| 42 | + |
| 43 | +## Types |
| 44 | +## ----------------------------------------------------------------------------- |
| 45 | +def use_type_default(obj: Any) -> TypeGuard[type]: |
| 46 | + return isinstance(obj, type) |
| 47 | + |
| 48 | + |
| 49 | +def type_default(obj: type) -> str: |
| 50 | + return obj.__name__ |
| 51 | + |
| 52 | + |
| 53 | +## Dataclasses |
| 54 | +## ----------------------------------------------------------------------------- |
| 55 | +def use_dataclass_default(obj: Any) -> bool: |
| 56 | + return dataclasses.is_dataclass(obj) and not isinstance(obj, type) |
| 57 | + |
| 58 | + |
| 59 | +def dataclass_default(obj) -> dict[str, Any]: |
| 60 | + return dataclasses.asdict(obj) |
| 61 | + |
| 62 | + |
| 63 | +## Dates and Times |
| 64 | +## ----------------------------------------------------------------------------- |
| 65 | +def use_time_default(obj: Any) -> TypeGuard[datetime.time]: |
| 66 | + return isinstance(obj, datetime.time) |
| 67 | + |
| 68 | + |
| 69 | +def time_default(obj: datetime.time) -> str: |
| 70 | + return obj.isoformat() |
| 71 | + |
| 72 | + |
| 73 | +def use_date_default(obj: Any) -> TypeGuard[datetime.date]: |
| 74 | + return isinstance(obj, datetime.date) |
| 75 | + |
| 76 | + |
| 77 | +def date_default(obj: datetime.date) -> str: |
| 78 | + return obj.isoformat() |
| 79 | + |
| 80 | + |
| 81 | +def use_datetime_default(obj: Any) -> TypeGuard[datetime.datetime]: |
| 82 | + return isinstance(obj, datetime.datetime) |
| 83 | + |
| 84 | + |
| 85 | +def datetime_default(obj: datetime.datetime) -> str: |
| 86 | + return obj.isoformat() |
| 87 | + |
| 88 | + |
| 89 | +def use_datetime_any(obj: Any) -> TypeGuard[datetime.time | datetime.date | datetime.datetime]: |
| 90 | + return isinstance(obj, (datetime.time, datetime.date, datetime.datetime)) |
| 91 | + |
| 92 | + |
| 93 | +def datetime_any(obj: datetime.time | datetime.date | datetime.date) -> str: |
| 94 | + return obj.isoformat() |
| 95 | + |
| 96 | + |
| 97 | +## Exception and Tracebacks |
| 98 | +## ----------------------------------------------------------------------------- |
| 99 | +def use_exception_default(obj: Any) -> TypeGuard[BaseException]: |
| 100 | + return isinstance(obj, BaseException) |
| 101 | + |
| 102 | + |
| 103 | +def exception_default(obj: BaseException) -> str: |
| 104 | + return f"{obj.__class__.__name__}: {obj}" |
| 105 | + |
| 106 | + |
| 107 | +def use_traceback_default(obj: Any) -> TypeGuard[TracebackType]: |
| 108 | + return isinstance(obj, TracebackType) |
| 109 | + |
| 110 | + |
| 111 | +def traceback_default(obj: TracebackType) -> str: |
| 112 | + return "".join(traceback.format_tb(obj)).strip() |
| 113 | + |
| 114 | + |
| 115 | +## Enums |
| 116 | +## ----------------------------------------------------------------------------- |
| 117 | +def use_enum_default(obj: Any) -> TypeGuard[enum.Enum | enum.EnumMeta]: |
| 118 | + return isinstance(obj, (enum.Enum, enum.EnumMeta)) |
| 119 | + |
| 120 | + |
| 121 | +def enum_default(obj: enum.Enum | enum.EnumMeta) -> Any | list[Any]: |
| 122 | + if isinstance(obj, enum.Enum): |
| 123 | + return obj.value |
| 124 | + return [e.value for e in obj] # type: ignore[var-annotated] |
| 125 | + |
| 126 | + |
| 127 | +## UUIDs |
| 128 | +## ----------------------------------------------------------------------------- |
| 129 | +def use_uuid_default(obj: Any) -> TypeGuard[uuid.UUID]: |
| 130 | + return isinstance(obj, uuid.UUID) |
| 131 | + |
| 132 | + |
| 133 | +def uuid_default(obj: uuid.UUID) -> str: |
| 134 | + return str(obj) |
| 135 | + |
| 136 | + |
| 137 | +## Bytes |
| 138 | +## ----------------------------------------------------------------------------- |
| 139 | +def use_bytes_default(obj: Any) -> TypeGuard[bytes | bytearray]: |
| 140 | + return isinstance(obj, (bytes, bytearray)) |
| 141 | + |
| 142 | + |
| 143 | +def bytes_default(obj: bytes | bytearray, url_safe: bool = True) -> str: |
| 144 | + if url_safe: |
| 145 | + return base64.urlsafe_b64encode(obj).decode("utf8") |
| 146 | + return base64.b64encode(obj).decode("utf8") |
0 commit comments