Support Python 3.12+ and address pydantic v2 compatibility issues (#41)

* Run `poetry lock` with Poetry 1.8.4

* Upgrade flake8 to 7.0

* Upgrade pydantic to 2.0

* Drop pytest-flake8 in favor of invoking flake8 directly

* Address pydantic 2.0 UserWarning for allow_population_by_field_name

* Address pydantic 2.0 deprecation warnings in shrub.v3

* Address Python 3.12 deprecation warnings in pytest

* Update changelog and package version number

* Remove stray git merge conflict marker

* Relock dependencies with Poetry 1.8.4

* Bump version number in pyproject.toml

Author: eramongodb

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 3.6.0 - 2024-11-18
+- Address Python 3.12+ compatibility issues.
+- Address pydantic v2 compatibility issues.
+- Raise minimum required Python version to 3.8.
+- Raise minimum required `pydantic` version to 2.0.
+
 ## 3.5.0 - 2024-11-12
 - Add `batchtime` and `depends_on` fields to `shrub.v3.evg_task.EvgTaskRef`.
 

evergreen.yml

@@ -5,6 +5,7 @@ buildvariants:
   - ubuntu2204-small
   tasks:
   - name: unit_tests
+  - name: lint
   - name: deploy
 
 functions:
@@ -47,11 +48,24 @@ tasks:
         . venv/bin/activate
 
         poetry run pytest --junitxml=junit-test-output.xml
+- name: lint
+  commands:
+  - command: shell.exec
+    params:
+      working_dir: src
+      script: |
+        set -o errexit
+        set -o verbose
+
+        . venv/bin/activate
+
+        poetry run flake8 src/shrub tests
 
 - name: deploy
   patchable: false
   depends_on:
     - name: unit_tests
+    - name: lint
   commands:
     - command: subprocess.exec
       params:

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "shrub.py"
-version = "3.5.0"
+version = "3.6.0"
 description = "Library for creating evergreen configurations"
 authors = ["DevProd Services & Integrations Team <[email protected]>"]
 license = "Apache-2.0"
@@ -11,21 +11,20 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-python = ">3.7.0"
+python = ">=3.8.1"
 PyYaml = "^5.1 || ^6.0"
 dataclasses = {version = "^0.7", python = "3.6.*"}
-pydantic = "^1.8 || ^2.0"
+pydantic = "^2.0"
 typing-extensions = "^4"
 croniter = "^1.4.1"
 
 [tool.poetry.dev-dependencies]
-pytest = "^6.0"
+pytest = "^7.0"
 pytest-black = "^0.3"
-pytest-flake8 = "^1.0"
 pytest-mypy = "^0.8.0"
 black = "^23.3.0"
 types-PyYAML = "^5.1 || ^6.0"
-flake8 = "3.9.2"
+flake8 = "^7.0"
 
 [tool.black]
 line-length = 100

pyproject.toml

@@ -2,7 +2,7 @@
 max-line-length = 100
 per-file-ignores =
     src/shrub/v2/__init__.py:F401
+extend-ignore = W605,W503,W291,E203,E501,F821
 
 [tool:pytest]
-flake8-ignore=W605 W503 W291 E203 E501 F821
-addopts = --flake8 --black --mypy
+addopts = --black --mypy

setup.cfg

@@ -3,7 +3,7 @@
 from typing import Any, Dict, Optional, Union, List
 from typing_extensions import Literal
 
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 
 
 AvailableCommands = Literal[
@@ -198,9 +198,11 @@ def __init__(self, **kwargs: Dict[str, Any]) -> None:
             kwargs["params"] = {k: v for k, v in kwargs["params"].items() if v is not None}
         super().__init__(**kwargs)
 
-    class Config:
-        allow_population_by_field_name = True
-        use_enum_values = True
+    model_config = ConfigDict(
+        populate_by_name=True,
+        use_enum_values=True,
+        validate_default=True,
+    )
 
 
 EvgCommand = Union[

src/shrub/v3/evg_command.py

@@ -116,7 +116,7 @@ def generate_yaml(shrub_config: BaseModel) -> str:
         :return: YAML version of given shrub configuration.
         """
         return yaml.dump(
-            shrub_config.dict(exclude_none=True, exclude_unset=True, by_alias=True),
+            shrub_config.model_dump(exclude_none=True, exclude_unset=True, by_alias=True),
             Dumper=ConfigDumper,
             default_flow_style=False,
             width=float("inf"),
@@ -130,4 +130,4 @@ def generate_json(shrub_config: BaseModel) -> str:
         :param shrub_config: Shrub configuration to generate.
         :return: JSON version of given shrub configuration.
         """
-        return shrub_config.json(exclude_none=True, exclude_unset=True, by_alias=True)
+        return shrub_config.model_dump_json(exclude_none=True, exclude_unset=True, by_alias=True)

src/shrub/v3/shrub_service.py

@@ -24,7 +24,7 @@ def test_expansions_update(self):
             updates=[under_test.KeyValueParam(key=f"key_{i}", value=f"value_{i}") for i in range(5)]
         )
 
-        assert cmd.dict(exclude_none=True, exclude_unset=True) == {
+        assert cmd.model_dump(exclude_none=True, exclude_unset=True) == {
             "command": "expansions.update",
             "params": {
                 "updates": [