v0.1.5 🏰

- Applies `isort` and enforces `isort` and `black` checks in CI pipeline
- Adds support for examples defined using any class declaring a `dict` callable
  method, thus including `pydantic` models
- Marks the package as `Production/Stable`

Author: RobertoPrevato

.github/workflows/build.yml

@@ -46,11 +46,23 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -U --no-index --find-links=deps deps/*
+          pip install black==20.8b1 isort==5.9.1
 
       - name: Run tests
         run: |
           flake8 && pytest --doctest-modules --junitxml=junit/pytest-results-${{ matrix.python-version }}.xml --cov=$PROJECT_NAME --cov-report=xml tests/
 
+      - name: Run linters
+        run: |
+          echo "Running linters - if build fails here, please be patient!"
+
+          flake8 openapidocs
+          flake8 tests
+          isort --check-only openapidocs 2>&1
+          isort --check-only tests 2>&1
+          black --check openapidocs 2>&1
+          black --check tests 2>&1
+
       - name: Upload pytest test results
         uses: actions/upload-artifact@master
         with:

.isort.cfg

@@ -0,0 +1,3 @@
+[settings]
+profile = black
+multi_line_output = 3

CHANGELOG.md

@@ -5,6 +5,12 @@ 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.5] - 2021-06-27 :european_castle:
+- Applies `isort` and enforces `isort` and `black` checks in CI pipeline
+- Adds support for examples defined using any class declaring a `dict` callable
+  method, thus including `pydantic` models
+- Marks the package as `Production/Stable`
+
 ## [0.1.4] - 2021-06-19 :droplet:
 - Restores support for enums on examples `@dataclasses`, after the fix
   implemented in `0.1.3`

Makefile

@@ -39,3 +39,10 @@ test-cov-unit:
 
 test-cov:
 	pytest --cov-report html --cov=openapidocs
+
+
+format:
+	isort openapidocs
+	isort tests
+	black openapidocs
+	black tests

openapidocs/common.py

@@ -100,6 +100,8 @@ def regular_dict_factory(items: List[Tuple[Any, Any]]) -> Any:
 # bypassing "asdict" on child properties when they implement a `to_obj`
 # method: some entities require a specific shape when represented
 def _asdict_inner(obj, dict_factory):
+    if hasattr(obj, "dict") and callable(obj.dict):
+        return obj.dict()
     if hasattr(obj, "to_obj"):
         return obj.to_obj()
     if isinstance(obj, OpenAPIElement):
@@ -122,6 +124,8 @@ def _asdict_inner(obj, dict_factory):
 
 
 def normalize_dict(obj):
+    if hasattr(obj, "dict") and callable(obj.dict):
+        return obj.dict()
     if hasattr(obj, "to_obj"):
         return obj.to_obj()
     if isinstance(obj, OpenAPIElement):

openapidocs/v2.py

@@ -4,10 +4,12 @@
 https://swagger.io/specification/v2/
 """
 from abc import ABC
-from enum import Enum
 from dataclasses import dataclass
+from enum import Enum
+from typing import Any, Dict, List, Optional, Type, Union
+
 from openapidocs.common import OpenAPIRoot
-from typing import Any, List, Optional, Dict, Type, Union
+
 from .common import OpenAPIElement
 
 

openapidocs/v3.py

@@ -4,10 +4,12 @@
 https://swagger.io/specification/
 """
 from abc import ABC
-from enum import Enum
 from dataclasses import dataclass
+from enum import Enum
+from typing import Any, Dict, List, Optional, Union
+
 from openapidocs.common import OpenAPIRoot, normalize_dict
-from typing import Any, List, Optional, Dict, Union
+
 from .common import OpenAPIElement
 
 

requirements.txt

@@ -20,3 +20,4 @@ toml==0.10.1
 typed-ast==1.4.1
 typing-extensions==3.7.4.3
 dataclasses==0.7;python_version<'3.7'
+pydantic==1.8.2

setup.py

@@ -8,12 +8,12 @@ def readme():
 
 setup(
     name="essentials-openapi",
-    version="0.1.4",
+    version="0.1.5",
     description="Classes to generate OpenAPI Documentation v3 and v2, in JSON and YAML",
     long_description=readme(),
     long_description_content_type="text/markdown",
     classifiers=[
-        "Development Status :: 4 - Beta",
+        "Development Status :: 5 - Production/Stable",
         "License :: OSI Approved :: MIT License",
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3.6",

tests/common.py

@@ -1,5 +1,6 @@
 import os
 from typing import Any
+
 from openapidocs.common import Format