Merge pull request #200 from BrianPugh/pydantic-v2

Migrate to Pydantic v2

Author: BrianPugh

belay/cli/select.py

@@ -151,7 +151,7 @@ def validate_led_pin_number(response):
 
             asyncio.run(blink_until_prompt(device))
 
-    spec_json = spec.json(exclude_none=True)
+    spec_json = spec.model_dump_json(exclude_none=True)
     questionary.print("\n")
     questionary.print("Either set the BELAY_DEVICE environment variable:", style=style)
     questionary.print(f"    export BELAY_DEVICE='{spec_json}'")

belay/packagemanager/models.py

@@ -1,24 +1,15 @@
 """Pydantic models for validation Belay configuration.
 """
 
-from functools import partial
 from pathlib import Path
 from typing import Dict, List, Optional
 
-try:
-    from pydantic.v1 import BaseModel as PydanticBaseModel
-    from pydantic.v1 import validator
-except ImportError:
-    from pydantic import BaseModel as PydanticBaseModel
-    from pydantic import validator
-
-validator_reuse = partial(validator, allow_reuse=True)
-prevalidator_reuse = partial(validator_reuse, pre=True)
+from pydantic import BaseModel as PydanticBaseModel
+from pydantic import ConfigDict, field_validator
 
 
 class BaseModel(PydanticBaseModel):
-    class Config:
-        allow_mutation = False
+    model_config = ConfigDict(frozen=True)
 
 
 class DependencySourceConfig(BaseModel):
@@ -106,11 +97,19 @@ class GroupConfig(BaseModel):
     ##############
     # VALIDATORS #
     ##############
-    _v_dependencies_preprocessor = prevalidator_reuse("dependencies")(_dependencies_preprocessor)
-    _v_dependencies_names = validator_reuse("dependencies")(_dependencies_name_validator)
-
-    @validator("dependencies")
-    def max_1_rename_to_init(packages: dict):
+    @field_validator("dependencies", mode="before")
+    @classmethod
+    def _v_dependencies_preprocessor(cls, v):
+        return _dependencies_preprocessor(v)
+
+    @field_validator("dependencies")
+    @classmethod
+    def _v_dependencies_names(cls, v):
+        return _dependencies_name_validator(v)
+
+    @field_validator("dependencies")
+    @classmethod
+    def max_1_rename_to_init(cls, packages: dict):
         rename_to_init_count = {}
         for package_name, dependency in walk_dependencies(packages):
             rename_to_init_count.setdefault(package_name, 0)
@@ -141,10 +140,18 @@ class BelayConfig(BaseModel):
     ##############
     # VALIDATORS #
     ##############
-    _v_dependencies_preprocessor = prevalidator_reuse("dependencies")(_dependencies_preprocessor)
-    _v_dependencies_names = validator_reuse("dependencies")(_dependencies_name_validator)
-
-    @validator("group")
+    @field_validator("dependencies", mode="before")
+    @classmethod
+    def _v_dependencies_preprocessor(cls, v):
+        return _dependencies_preprocessor(v)
+
+    @field_validator("dependencies")
+    @classmethod
+    def _v_dependencies_names(cls, v):
+        return _dependencies_name_validator(v)
+
+    @field_validator("group")
+    @classmethod
     def main_not_in_group(cls, v):
         if "main" in v:
             raise ValueError(

belay/project.py

@@ -83,6 +83,6 @@ def load_pyproject() -> BelayConfig:
 def load_groups() -> List[Group]:
     config = load_pyproject()
     groups = [Group("main", dependencies=config.dependencies)]
-    groups.extend(Group(name, **definition.dict()) for name, definition in config.group.items())
+    groups.extend(Group(name, **definition.model_dump()) for name, definition in config.group.items())
     groups.sort(key=lambda x: x.name)
     return groups

belay/pyboard.py

@@ -66,17 +66,13 @@
 from threading import Lock, Thread
 from typing import Union
 
+from pydantic import ValidationError
+
 from .exceptions import BelayException, ConnectionFailedError, DeviceNotFoundError
 from .usb_specifier import UsbSpecifier
 from .utils import env_parse_bool
 from .webrepl import WebreplToSerial
 
-try:
-    from pydantic.v1.error_wrappers import ValidationError
-except ImportError:
-    from pydantic import ValidationError
-
-
 try:
     stdout = sys.stdout.buffer
 except AttributeError:
@@ -349,15 +345,15 @@ def __init__(
 
         if device is None:
             usb_specifier_str = os.environ.get("BELAY_DEVICE", "{}")
-            device = UsbSpecifier.parse_raw(usb_specifier_str)
+            device = UsbSpecifier.model_validate_json(usb_specifier_str)
 
         for attempt_count in itertools.count(start=attempt_start_val):
             try:
                 if isinstance(device, UsbSpecifier):
                     device = device.to_port()
                 else:
                     with contextlib.suppress(ValidationError):
-                        device = UsbSpecifier.parse_raw(device).to_port()
+                        device = UsbSpecifier.model_validate_json(device).to_port()
                 break
             except DeviceNotFoundError:
                 pass

belay/usb_specifier.py

@@ -1,10 +1,6 @@
 from typing import Dict, List, Optional
 
-try:
-    from pydantic.v1 import BaseModel, Field
-except ImportError:
-    from pydantic import BaseModel, Field
-
+from pydantic import BaseModel, Field
 from serial.tools.list_ports import comports
 
 from .exceptions import DeviceNotFoundError, InsufficientSpecifierError
@@ -43,13 +39,13 @@ class UsbSpecifier(BaseModel):
     device: Optional[str] = Field(None, exclude=True)
 
     def __repr__(self):
-        return f'{self.__class__.__name__}({", ".join(f"{k}={v!r}" for k, v in self.dict().items() if v is not None)})'
+        return f'{self.__class__.__name__}({", ".join(f"{k}={v!r}" for k, v in self.model_dump().items() if v is not None)})'
 
     def to_port(self) -> str:
         if self.device:
             return self.device
 
-        spec = self.dict(exclude_none=True)
+        spec = self.model_dump(exclude_none=True)
         possible_matches = []
 
         for port_info in list_devices():
@@ -66,7 +62,7 @@ def to_port(self) -> str:
     def populated(self):
         # some ports, like wlan and bluetooth on macos,
         # don't populate any meaningful fields.
-        return bool(self.dict(exclude_none=True))
+        return bool(self.model_dump(exclude_none=True))
 
 
 def list_devices() -> List[UsbSpecifier]: