Add testing for Pydantic 1/2 (#42)

* Add testing for Pydantic 1/2

* Clean up for pydantic cross-compatibility

* Update tox.ini

* Update tests.yml

* set environment for building docs

---------

Co-authored-by: Owen Lynch <[email protected]>

.github/workflows/tests.yml

@@ -36,7 +36,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.11"]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
@@ -60,6 +60,7 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         python-version: ["3.9", "3.10", "3.11"]
+        pydantic: [ "1", "2" ]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
@@ -69,7 +70,7 @@ jobs:
       - name: Install dependencies
         run: pip install tox
       - name: Test with pytest and generate coverage file
-        run: tox run -e py
+        run: tox run -e py-pydantic${{ matrix.pydantic }}
       - name: Upload coverage report to codecov
         uses: codecov/codecov-action@v3
         if: success()

setup.cfg

@@ -49,7 +49,7 @@ keywords =
 
 [options]
 install_requires =
-    pydantic<2.0
+    pydantic
 
 # Random options
 zip_safe = false

src/acsets/acsets.py

@@ -32,8 +32,12 @@ class Ob(HashableBaseModel):
     """
 
     name: str = Field(..., description="The name of the object")
-    title: Optional[str] = Field(description="The human-readable label for the object")
-    description: Optional[str] = Field(description="A long-form description of the object")
+    title: Optional[str] = Field(
+        default=None, description="The human-readable label for the object"
+    )
+    description: Optional[str] = Field(
+        default=None, description="A long-form description of the object"
+    )
 
     class Config:
         """pydantic config"""
@@ -52,11 +56,15 @@ class Hom(HashableBaseModel):
     and `Hom("tgt", E, V)`.
     """
 
-    name: str = Field(description="The name of the morphism.")
-    dom: str = Field(title="domain", description="The object of the domain.")
-    codom: str = Field(title="codomain", description="The object of the codomain.")
-    title: Optional[str] = Field(description="The human-readable label for the morphism")
-    description: Optional[str] = Field(description="A long-form description of the morphism")
+    name: str = Field(..., description="The name of the morphism.")
+    dom: str = Field(..., title="domain", description="The object of the domain.")
+    codom: str = Field(..., title="codomain", description="The object of the codomain.")
+    title: Optional[str] = Field(
+        default=None, description="The human-readable label for the morphism"
+    )
+    description: Optional[str] = Field(
+        default=None, description="A long-form description of the morphism"
+    )
 
     @validator("dom", pre=True)
     def dom_string(cls, ob: Union[str, Ob]):
@@ -110,9 +118,10 @@ class AttrType(HashableBaseModel):
     transition, for instance, has a tuple of strings as its name.
     """
 
-    name: str = Field(description="The name of the attribute type.")
+    name: str = Field(..., description="The name of the attribute type.")
     ty: type = Field(
-        description="The type assigned to the attribute type. Use a string referring to the Python type"
+        ...,
+        description="The type assigned to the attribute type. Use a string referring to the Python type",
     )
     title: Optional[str] = None
     description: Optional[str] = None
@@ -140,9 +149,9 @@ class Attr(HashableBaseModel):
     which is the attribute that stores the name of a species in a Petri net.
     """
 
-    name: str = Field(title="name", description="The name of the attribute.")
-    dom: str = Field(title="domain", description="The object in the domain.")
-    codom: str = Field(title="codomain", description="The attribute type in the codomain")
+    name: str = Field(..., title="name", description="The name of the attribute.")
+    dom: str = Field(..., title="domain", description="The object in the domain.")
+    codom: str = Field(..., title="codomain", description="The attribute type in the codomain")
     title: Optional[str] = None
     description: Optional[str] = None
 
@@ -279,7 +288,11 @@ def valtype(self, prop: Property):
         Returns:
             The Property value type
         """
-        return int if isinstance(prop, Hom) else next(at for at in self.schema.AttrType if at.name == prop.codom).ty
+        return (
+            int
+            if isinstance(prop, Hom)
+            else next(at for at in self.schema.AttrType if at.name == prop.codom).ty
+        )
 
     def valid_value(self, prop: Property, val):
         """Verify if a given value is valid for a given property

src/acsets/schemas/catlab_to_jsonschema.py

@@ -1,6 +1,7 @@
 """This script turns all the catlab schemata into json schemata"""
 
 from pathlib import Path
+
 from acsets import (
     CATLAB_SCHEMAS_DIRECTORY,
     ACSet,
@@ -9,8 +10,8 @@
     CatlabSchema,
     Hom,
     Ob,
-    petris,
     Schema,
+    petris,
 )
 
 HERE = Path(__file__).parent.resolve()

tests/test_examples.py

@@ -4,7 +4,8 @@
 import unittest
 
 import jsonschema
-from acsets.schemas import EXAMPLES, CATLAB, JSONSCHEMA
+
+from acsets.schemas import CATLAB, EXAMPLES, JSONSCHEMA
 
 
 class TestExamples(unittest.TestCase):

tests/test_petri.py

@@ -2,12 +2,15 @@
 
 """Test serialization."""
 
+import importlib
 import os
 import tempfile
 import unittest
 
 from acsets import ACSet, Attr, AttrType, Hom, Ob, mira, petris
 
+PYDANTIC_1 = importlib.metadata.version("pydantic").startswith("1.")
+
 
 class TestSerialization(unittest.TestCase):
     """A test case for testing serialization."""
@@ -55,6 +58,9 @@ def test_ob(self):
         self.assertIsInstance(hom1.dom, str)
         self.assertIsInstance(hom1.codom, str)
 
+    @unittest.skipUnless(
+        PYDANTIC_1, reason="This functionality can not be made cross-compatible AFAIK"
+    )
     def test_write_schema(self):
         """Test writing the schema does not error."""
         with tempfile.TemporaryDirectory() as directory:

tox.ini

@@ -23,7 +23,8 @@ envlist =
     docstr-coverage
     docs-test
     # the actual tests
-    py
+    py-pydantic1
+    py-pydantic2
     # always keep coverage-report last
     # coverage-report
 
@@ -34,6 +35,9 @@ commands =
     coverage run -p -m pytest --durations=20 {posargs:tests}
     coverage combine
     coverage xml
+deps =
+    pydantic1: pydantic<2.0
+    pydantic2: pydantic>=2.0
 extras =
     # See the [options.extras_require] entry in setup.cfg for "tests"
     tests
@@ -80,7 +84,7 @@ description = Check that the MANIFEST.in is written properly and give feedback o
 skip_install = true
 deps =
     darglint
-    flake8
+    flake8<5.0.0
     flake8-black
     flake8-bandit
     flake8-bugbear
@@ -137,6 +141,9 @@ commands =
 [testenv:docs-test]
 description = Test building the documentation in an isolated environment.
 changedir = docs
+setenv =
+  LC_ALL = C.UTF-8
+  LANG = C.UTF-8
 extras =
     {[testenv:docs]extras}
 commands =