v0.1.4 💧

Author: RobertoPrevato

CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.4] - 2021-06-19 :droplet:
+- Restores support for enums on examples `@dataclasses`, after the fix
+  implemented in `0.1.3`
+- Adds support for built-in `UUID`, `time`, `date`, `datetime`, `bytes`,
+  handling in examples for `YAML` format
+- Adds `partial-time` ValueFormat for `time` (see
+  https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)
+
 ## [0.1.3] - 2021-06-17 :droplet:
 
 - Corrects a bug forcing `camelCase` on examples objects handled as dataclasses

openapidocs/common.py

@@ -1,8 +1,12 @@
+import base64
 import copy
 import json
-from dataclasses import fields, is_dataclass, asdict
+from abc import ABC, abstractmethod
+from dataclasses import asdict, fields, is_dataclass
+from datetime import date, datetime, time
 from enum import Enum
 from typing import Any, List, Tuple
+from uuid import UUID
 
 import yaml
 from essentials.json import FriendlyEncoder
@@ -21,6 +25,38 @@ class OpenAPIRoot(OpenAPIElement):
     """Base class for a root OpenAPI Documentation"""
 
 
+class ValueTypeHandler(ABC):
+    @abstractmethod
+    def normalize(self, value: Any) -> Any:
+        """Normalizes a value of the given type into another type."""
+
+
+class CommonBuiltInTypesHandler(ValueTypeHandler):
+    def normalize(self, value: Any) -> Any:
+        if isinstance(value, UUID):
+            return str(value)
+
+        if isinstance(value, Enum):
+            return value.value
+
+        if isinstance(value, time):
+            return value.strftime("%H:%M:%S")
+
+        if isinstance(value, datetime):
+            return value.isoformat()
+
+        if isinstance(value, date):
+            return value.strftime("%Y-%m-%d")
+
+        if isinstance(value, bytes):
+            return base64.urlsafe_b64encode(value).decode("utf8")
+
+        return value
+
+
+TYPES_HANDLERS = [CommonBuiltInTypesHandler()]
+
+
 def normalize_key(key: Any) -> str:
     if isinstance(key, Enum):
         return key.value
@@ -43,12 +79,23 @@ def normalize_dict_factory(items: List[Tuple[Any, Any]]) -> Any:
             data["$ref"] = value
             continue
 
-        if isinstance(value, Enum):
-            value = value.value
+        for handler in TYPES_HANDLERS:
+            value = handler.normalize(value)
+
         data[normalize_key(key)] = value
     return data
 
 
+def regular_dict_factory(items: List[Tuple[Any, Any]]) -> Any:
+    data = {}
+    for key, value in items:
+        for handler in TYPES_HANDLERS:
+            value = handler.normalize(value)
+
+        data[key] = value
+    return data
+
+
 # replicates the asdict method from dataclasses module, to support
 # bypassing "asdict" on child properties when they implement a `to_obj`
 # method: some entities require a specific shape when represented
@@ -62,7 +109,7 @@ def _asdict_inner(obj, dict_factory):
             result.append((f.name, value))
         return dict_factory(result)
     if is_dataclass(obj):
-        return asdict(obj)
+        return asdict(obj, dict_factory=regular_dict_factory)
     elif isinstance(obj, (list, tuple)):
         return type(obj)(_asdict_inner(v, dict_factory) for v in obj)
     elif isinstance(obj, dict):
@@ -79,7 +126,7 @@ def normalize_dict(obj):
         return obj.to_obj()
     if isinstance(obj, OpenAPIElement):
         return _asdict_inner(obj, dict_factory=normalize_dict_factory)
-    return asdict(obj)
+    return asdict(obj, dict_factory=regular_dict_factory)
 
 
 class Serializer:

openapidocs/v3.py

@@ -40,6 +40,7 @@ class ValueFormat(Enum):
     PASSWORD = "password"
     EMAIL = "email"
     UUID = "uuid"
+    PARTIALTIME = "partial-time"
 
 
 class SecuritySchemeType(Enum):

setup.py

@@ -8,7 +8,7 @@ def readme():
 
 setup(
     name="essentials-openapi",
-    version="0.1.3",
+    version="0.1.4",
     description="Classes to generate OpenAPI Documentation v3 and v2, in JSON and YAML",
     long_description=readme(),
     long_description_content_type="text/markdown",