feat: implement rdfproxy.ConfigDict for model config

README.md

@@ -47,8 +47,8 @@ The result set can be mapped to a nested Pydantic model like so:
 from typing import Annotated
 
 from fastapi import FastAPI, Query
-from pydantic import BaseModel, ConfigDict
-from rdfproxy import Page, QueryParameters, SPARQLBinding, SPARQLModelAdapter
+from pydantic import BaseModel
+from rdfproxy import ConfigDict, Page, QueryParameters, SPARQLBinding, SPARQLModelAdapter
 
 class Work(BaseModel):
     model_config = ConfigDict(group_by="name")

examples/full_static_fastapi_example.py

@@ -3,8 +3,14 @@
 from typing import Annotated
 
 from fastapi import FastAPI, Query
-from pydantic import BaseModel, ConfigDict
-from rdfproxy import Page, QueryParameters, SPARQLBinding, SPARQLModelAdapter
+from pydantic import BaseModel
+from rdfproxy import (
+    ConfigDict,
+    Page,
+    QueryParameters,
+    SPARQLBinding,
+    SPARQLModelAdapter,
+)
 
 
 query = """

examples/wikidata_grouped_person_fastapi_example.py

@@ -3,8 +3,14 @@
 from typing import Annotated
 
 from fastapi import FastAPI, Query
-from pydantic import BaseModel, ConfigDict
-from rdfproxy import Page, QueryParameters, SPARQLBinding, SPARQLModelAdapter
+from pydantic import BaseModel
+from rdfproxy import (
+    ConfigDict,
+    Page,
+    QueryParameters,
+    SPARQLBinding,
+    SPARQLModelAdapter,
+)
 
 
 query = """

rdfproxy/__init__.py

@@ -1,4 +1,4 @@
 from rdfproxy.adapter import SPARQLModelAdapter  # noqa: F401
 from rdfproxy.mapper import ModelBindingsMapper  # noqa: F401
-from rdfproxy.utils._types import SPARQLBinding  # noqa: F401
+from rdfproxy.utils._types import ConfigDict, SPARQLBinding  # noqa: F401
 from rdfproxy.utils.models import Page, QueryParameters  # noqa: F401

rdfproxy/utils/_types.py

@@ -3,7 +3,7 @@
 from collections.abc import Iterable
 from typing import Protocol, TypeAlias, TypeVar, runtime_checkable
 
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict as PydanticConfigDict
 
 
 _TModelInstance = TypeVar("_TModelInstance", bound=BaseModel)
@@ -42,3 +42,10 @@ def __call__(self, model: BaseModel) -> bool: ...
 
 
 _TModelBoolValue: TypeAlias = ModelBoolPredicate | str | Iterable[str]
+
+
+class ConfigDict(PydanticConfigDict, total=False):
+    """pydantic.ConfigDict extension for RDFProxy model_config options."""
+
+    group_by: str
+    model_bool: _TModelBoolValue

tests/data/models/author_array_collection_model.py

@@ -1,6 +1,7 @@
 from typing import Annotated
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel
+from rdfproxy import ConfigDict
 from rdfproxy.utils._types import SPARQLBinding
 
 

tests/data/models/author_work_title_model.py

@@ -2,7 +2,8 @@
 
 from typing import Annotated
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel
+from rdfproxy import ConfigDict
 from rdfproxy.utils._types import SPARQLBinding
 
 

tests/data/models/dummy_model.py

@@ -1,6 +1,7 @@
 """Simple dummy models e.g. for count query constructor testing."""
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel
+from rdfproxy import ConfigDict
 
 
 class Dummy(BaseModel):

tests/data/models/grouping_model.py

@@ -1,6 +1,7 @@
 """Grouping model for RDFProxy testing."""
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, Field
+from rdfproxy import ConfigDict
 
 
 class GroupingSimpleModel(BaseModel):

tests/data/models/nested_grouping_model.py

@@ -1,6 +1,7 @@
 """Nested grouping model for RDFProxy testing."""
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, Field
+from rdfproxy import ConfigDict
 
 
 class NestedGroupingSimpleModel(BaseModel):

tests/data/parameters/model_bindings_mapper_model_bool_parameters.py

@@ -3,7 +3,8 @@
 The test cover all cases discussed in https://github.com/acdh-oeaw/rdfproxy/issues/110.
 """
 
-from pydantic import BaseModel, ConfigDict, Field, create_model
+from pydantic import BaseModel, Field, create_model
+from rdfproxy import ConfigDict
 from tests.utils._types import ModelBindingsMapperParameter
 
 

tests/tests_adapter/test_adapter_grouped_pagination.py

@@ -4,8 +4,14 @@
 
 import pytest
 
-from pydantic import BaseModel, ConfigDict
-from rdfproxy import Page, QueryParameters, SPARQLBinding, SPARQLModelAdapter
+from pydantic import BaseModel
+from rdfproxy import (
+    ConfigDict,
+    Page,
+    QueryParameters,
+    SPARQLBinding,
+    SPARQLModelAdapter,
+)
 
 
 binding_query = """

tests/tests_mapper/test_sad_path_mapper_grouped_models.py

@@ -1,6 +1,6 @@
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel
 import pytest
-from rdfproxy import ModelBindingsMapper
+from rdfproxy import ConfigDict, ModelBindingsMapper
 from rdfproxy.utils._exceptions import (
     InvalidGroupingKeyException,
     MissingModelConfigException,