Merge pull request #46 from Materials-Data-Science-and-Informatics/pydantic2

Migration to Pydantic 2 + codemetapy update

Author: mustafasoylu

.gitignore

@@ -164,4 +164,5 @@ Thumbs.db
 
 # SonarQube files
 .sonarqube
-.scannerwork
+.scannerwork
+.idea

.pre-commit-config.yaml

@@ -50,11 +50,6 @@ repos:
           - id: pydocstyle
             additional_dependencies: ['tomli==2.0.1']
             files: '^src/'
-    - repo: https://github.com/econchick/interrogate
-      rev: '1.5.0'
-      hooks:
-          - id: interrogate
-            files: '^src/'
     - repo: https://github.com/pre-commit/mirrors-mypy
       rev: 'v1.1.1'
       hooks:

.somesy.toml

@@ -1,6 +1,6 @@
 [project]
 name = "somesy"
-version = "0.1.0"
+version = "0.1.1"
 description = "A CLI tool for synchronizing software project metadata."
 keywords = ["metadata", "FAIR"]
 license = "MIT"

.sourcery.yaml

@@ -3,7 +3,7 @@ type: software
 message: If you use this software, please cite it using this metadata.
 
 title: somesy
-version: 0.1.0
+version: 0.1.1
 abstract: A CLI tool for synchronizing software project metadata.
 repository-code: https://github.com/Materials-Data-Science-and-Informatics/somesy
 license: MIT

CITATION.cff

@@ -68,14 +68,14 @@
             "identifier": "'version':",
             "name": "'version':",
             "runtimePlatform": "Python 3",
-            "version": "'^1.9.2'}"
+            "version": "'^0.7.0'}"
         },
         {
             "@type": "SoftwareApplication",
             "identifier": "'version':",
             "name": "'version':",
             "runtimePlatform": "Python 3",
-            "version": "'^0.7.0'}"
+            "version": "'^2.4.2'}"
         },
         {
             "@type": "SoftwareApplication",
@@ -89,7 +89,7 @@
             "identifier": "codemetapy",
             "name": "codemetapy",
             "runtimePlatform": "Python 3",
-            "version": "^2.5.0"
+            "version": "^2.5.1"
         },
         {
             "@type": "SoftwareApplication",
@@ -170,5 +170,5 @@
         "runtimePlatform": "Python 3"
     },
     "url": "https://materials-data-science-and-informatics.github.io/somesy",
-    "version": "0.1.0"
+    "version": "0.1.1"
 }

codemeta.json

@@ -66,12 +66,21 @@ Here is an overview of the schemas used in somesy.
 import json
 from io import StringIO
 from somesy.core.models import SomesyInput, ProjectMetadata, Person, SomesyConfig
+from pydantic_core import PydanticUndefined
+from typing_extensions import get_args
+
+def pp_type(th):
+    # NOTE: this does not work correctly with non-trivial unions!
+    while args := get_args(th):
+        th = args[0]
+    return th.__name__
 
 def fmt_desc(desc, pref=""):
     if not desc:
         return ""
     return "\n".join(map(lambda x: pref + x.strip(), desc.split("\n")))
 
+
 def model2md(m, out = None):
     out = out or StringIO()
 
@@ -80,20 +89,15 @@ def model2md(m, out = None):
     out.write("\t\n\n")
     out.write("\t| Field | Type | Required? | Default | Description |\n")
     out.write("\t| ----- | ---- | --------- | ------- | ----------- |\n")
-    for fld in m.__fields__.values():
-        n = fld.name
-
-        t = fld.type_.__name__
-        if t == "ConstrainedStrValue":
-            t = "str"
-        if t == "AnyUrl":
-            t = "URL"
-        if fld.field_info.min_items:
-            t = f"list[{t}]"
-
-        r = "**yes**" if fld.required else "no"
-        v = json.dumps(fld.default, default=str) if fld.default is not None else ""
-        d = fmt_desc(fld.field_info.description)
+    for n, fld in m.model_fields.items():
+        t = pp_type(fld.annotation)
+        r = "**yes**" if fld.is_required() else "no"
+        dv = fld.default
+        if dv is not None and dv != PydanticUndefined:
+            v = json.dumps(fld.default, default=str)
+        else:
+            v = ""
+        d = fmt_desc(fld.description)
         out.write(f"\t| {n} | {t} | {r} | {v} | {d} |\n")
     out.write("\n")