Merge pull request #11 from coherent-oss/feature/GH-10-add-pydantic-support

GH-10: Adding Pydantic v2 support

Author: diogobaeder

NEWS.rst

@@ -1,5 +1,5 @@
-v0.5.1
-======
+0.5.1
+=====
 
 Bugfixes
 --------

README.rst

@@ -20,7 +20,7 @@
 Build your Kubernetes manifests for Kustomize in Python!
 
 * PyPI: https://pypi.org/project/kustomize/
-* Repository: https://github.com/yougov/python-kustomize
+* Repository: https://github.com/coherent-oss/python-kustomize
 * Documentation: https://python-kustomize.readthedocs.io/en/latest/
 
 Overview
@@ -55,6 +55,7 @@ supports a number of object definition types:
 
 * ``dict``
 * ``dataclasses``
+* ``BaseModel`` (from Pydantic)
 * ``attr`` (needs the library installed)
 * ``kubernetes`` (needs the library installed)
 

kustomize/generators.py

@@ -160,6 +160,15 @@ def is_attr_class(obj) -> bool:
     return attr.has(type(obj))
 
 
+def is_pydantic_model(obj) -> bool:
+    try:
+        from pydantic import BaseModel
+    except ImportError:  # pragma: no cover
+        return False
+
+    return isinstance(obj, BaseModel)
+
+
 def _is_kubernetes(obj):
     return (
         hasattr(obj, 'to_dict')
@@ -227,6 +236,9 @@ def to_dict_or_dicts(obj):
         import attr
 
         obj = attr.asdict(obj, recurse=True)
+    elif is_pydantic_model(obj):
+        logger.debug('Object is a Pydantic model, using it for conversion')
+        obj = obj.model_dump()
     elif hasattr(obj, '__dict__'):
         obj = obj.__dict__
 

newsfragments/10.feature

@@ -0,0 +1 @@
+Adding Pydantic v2 support.

pyproject.toml

@@ -37,6 +37,8 @@ testing = [
 	"coverage",
 	"PyYAML",
 	"types-PyYAML",
+	"attrs",
+	"Pydantic >= 2.0",
 ]
 docs = [
 	# upstream

tests/fixtures/attrs/python/configMap.py

@@ -1,13 +1,11 @@
-import attr
+from pydantic import BaseModel
 
 
-@attr.s(auto_attribs=True)
-class Metadata:
+class Metadata(BaseModel):
     name: str
 
 
-@attr.s(auto_attribs=True)
-class ConfigMap:
+class ConfigMap(BaseModel):
     metadata: Metadata
     data: dict
     apiVersion: str = 'v1'

tests/fixtures/attrs/python/deployment.py

@@ -1,5 +1,8 @@
-class CustomDeployment:
-    def to_dict(self) -> dict:
+from pydantic import BaseModel
+
+
+class CustomDeployment(BaseModel):
+    def model_dump(self) -> dict:
         return {
             'apiVersion': 'apps/v1',
             'kind': 'Deployment',

tests/fixtures/attrs/python/kustomization.py

@@ -1,14 +1,13 @@
-from dataclasses import dataclass
 from typing import List
 
+from pydantic import BaseModel
 
-@dataclass
-class CommonLabels:
+
+class CommonLabels(BaseModel):
     app: str
 
 
-@dataclass
-class MyKustomization:
+class MyKustomization(BaseModel):
     commonLabels: CommonLabels
     resources: List[str]