Merge pull request #173 from python-odin/development

Release 2.11rc1

Author: timsavage

.github/workflows/manual-release.yml

@@ -18,9 +18,9 @@ jobs:
       - uses: actions/checkout@v2
 
       - uses: actions/setup-python@master
-        name: Setup Python 3.8
+        name: Setup Python 3.12
         with:
-          python-version: 3.8
+          python-version: 3.12
 
       - name: Install dependencies
         run: python -m pip install -U poetry

.github/workflows/release.yml

@@ -15,9 +15,9 @@ jobs:
       - uses: actions/checkout@v2
 
       - uses: actions/setup-python@master
-        name: Setup Python 3.8
+        name: Setup Python 3.12
         with:
-          python-version: 3.8
+          python-version: 3.12
 
       - name: Install dependencies
         run: python -m pip install -U poetry

.github/workflows/tests.yml

@@ -11,10 +11,10 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: [3.8, 3.9, "3.10", "3.11"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
         experimental: [false]
         include:
-          - python-version: "3.12-dev"
+          - python-version: "3.14-dev"
             experimental: true
 
     steps:
@@ -42,7 +42,7 @@ jobs:
           tests
 
     - name: Analyze with SonarCloud
-      uses: sonarsource/sonarcloud-github-action@master
+      uses: sonarsource/sonarqube-scan-action@master
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.pre-commit-config.yaml

@@ -5,7 +5,7 @@ default_language_version:
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.2.1
+    rev: v0.11.13
     hooks:
       # Run the linter.
       - id: ruff

HISTORY

@@ -1,3 +1,31 @@
+2.11rc1
+=======
+
+Changes
+-------
+
+- Redesign of the type to field resolution used in Annotated Resources. Updated to work with more modern typing
+
+  - Support the use of `int | None` or (`None | int`) instead of `Optional[int]`
+
+  - Support the use of `list[]`, `dict[]` subtypes
+
+  - Support the use of `my_field: Annotated[int, Options{}] = 42` style
+
+  - ResourceDefError now includes the field name that failed to be resolved.
+
+- Removed the deprecated `utils.lazy_property` (replace with `functools.cached_property`)
+
+- Update testing to cover Python 3.10, 3.11, 3.12 and 3.13
+
+Bugfix
+------
+
+- functools.partial can used when registering types for type resolution
+
+- Options.validators now defaults to an empty list (caused an issue adding validators)
+
+
 2.10
 ====
 
@@ -21,11 +49,10 @@ Changes
   ResourceObjects now includes a shadow_fields listing all fields shadowed by this
   resource.
 
-
 Bugfix
 ------
 
-- ResourceOptions.abstract flag was not being set for abstract AnnotatedResrouces.
+- ResourceOptions.abstract flag was not being set for abstract AnnotatedResources.
 
 
 2.9

docs/intro/annotated-resources.rst

@@ -21,8 +21,8 @@ The annotated resource syntax offers many rich ways of representing your resourc
     class Book(odin.AnnotatedResource):
         title: str
         author: Author
-        genre: Optional[str] = odin.Options(max_length=255)
-        num_pages: int = odin.Options(min_value=1)
+        genre: Annotated[str | None, odin.Options(max_length=255)]
+        num_pages: Annotated[int, odin.Options(min_value=1)]
 
 
 

noxfile.py

@@ -2,7 +2,7 @@
 from nox.sessions import Session
 
 
-@nox.session(python=("3.8", "3.9", "3.10", "3.11"))
+@nox.session(python=("3.10", "3.11", "3.12", "3.13"))
 def tests(session: Session):
     # fmt: off
     session.run(

poetry.lock

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "odin"
-version = "2.10"
+version = "2.11rc1"
 description = "Data-structure definition/validation/traversal, mapping and serialisation toolkit for Python"
 authors = ["Tim Savage <tim@savage.company>"]
 license = "BSD-3-Clause"
@@ -21,9 +21,10 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
 ]
@@ -34,15 +35,15 @@ packages = [
 include = ["src/odin/py.typed"]
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = "^3.10"
 pyyaml = {version = "*", optional = true }
 toml = {version = "*", optional = true }
 pint = {version = "*", optional = true }
 arrow = {version = "*", optional = true }
 msgpack = {version = "*", optional = true }
 rich = {version = "*", optional = true }
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 pytest = "^7.0"
 pytest-cov = "*"
 sphinx = "*"
@@ -60,8 +61,8 @@ rich = ["rich"]
 line-length = 88
 indent-width = 4
 
-# Assume Python 3.8
-target-version = "py38"
+# Assume Python 3.10
+target-version = "py310"
 
 [tool.ruff.lint]
 select = ["N", "F", "I", "UP", "PL", "A", "G", "S", "E", "SIM", "B"]
@@ -78,6 +79,9 @@ ignore = [
     "PLR2004", # Magic value used in comparison, ...
     "S311", # Standard pseudo-random generators are not suitable for cryptographic purposes
 ]
+"tests/annotated_resources/**.py" = [
+    "UP", # Allow the use of older types
+]
 
 [tool.ruff.lint.pycodestyle]
 max-line-length = 117

pyproject.toml

@@ -0,0 +1,10 @@
+  name: "Sample Pipeline"
+  config: ""
+  approach:
+    $: org.odin.sample.DynamicApproach
+    max: 10
+    min: 1
+
+  processes:
+    -
+  $: org.odin.sample.Pipeline