Feature: Migrate Pydantic V1 to V2.

Author: nesitor

examples/example_fastapi/main.py

@@ -216,9 +216,9 @@ async def check_url(internet_host: HttpUrl, timeout_seconds: int = 5, socket_fam
 async def read_internet():
     """Check Internet connectivity of the system, requiring IP connectivity, domain resolution and HTTPS/TLS."""
     internet_hosts: list[HttpUrl] = [
-        HttpUrl(url="https://aleph.im/", scheme="https"),
-        HttpUrl(url="https://ethereum.org", scheme="https"),
-        HttpUrl(url="https://ipfs.io/", scheme="https"),
+        HttpUrl(url="https://aleph.im/"),
+        HttpUrl(url="https://ethereum.org"),
+        HttpUrl(url="https://ipfs.io/"),
     ]
     timeout_seconds = 5
 

packaging/Makefile

@@ -19,7 +19,7 @@ debian-package-code:
 	python3 -m venv build_venv
 	build_venv/bin/pip install   --progress-bar off --upgrade pip setuptools wheel
 	# Fixing this protobuf dependency version to avoid getting CI errors as version 5.29.0 have this compilation issue
-	build_venv/bin/pip install --no-cache-dir  --progress-bar off --target ./aleph-vm/opt/aleph-vm/ 'aleph-message==0.6.1' 'eth-account==0.10' 'sentry-sdk==1.31.0' 'qmp==1.1.0' 'aleph-superfluid~=0.2.1' 'sqlalchemy[asyncio]>=2.0' 'aiosqlite==0.19.0' 'alembic==1.13.1' 'aiohttp_cors==0.7.0' 'pyroute2==0.7.12' 'python-cpuid==0.1.0' 'solathon==1.0.2' 'protobuf==5.28.3'
+	build_venv/bin/pip install --no-cache-dir  --progress-bar off --target ./aleph-vm/opt/aleph-vm/ 'git+https://github.com/aleph-im/aleph-message@108-upgrade-pydantic-version#egg=aleph-message' 'eth-account==0.10' 'sentry-sdk==1.31.0' 'qmp==1.1.0' 'aleph-superfluid~=0.2.1' 'sqlalchemy[asyncio]>=2.0' 'aiosqlite==0.19.0' 'alembic==1.13.1' 'aiohttp_cors==0.7.0' 'pydantic-settings==2.6.1' 'pyroute2==0.7.12' 'python-cpuid==0.1.0' 'solathon==1.0.2' 'protobuf==5.28.3'
 	build_venv/bin/python3 -m compileall ./aleph-vm/opt/aleph-vm/
 
 debian-package-resources: firecracker-bins vmlinux download-ipfs-kubo  target/bin/sevctl

pyproject.toml

@@ -36,22 +36,24 @@ dependencies = [
   "aioredis==1.3.1",
   "aiosqlite==0.19",
   "alembic==1.13.1",
-  "aleph-message==0.6.1",
+  "aleph-message @ git+https://github.com/aleph-im/aleph-message@108-upgrade-pydantic-version#egg=main",
   "aleph-superfluid~=0.2.1",
   "dbus-python==1.3.2",
   "eth-account~=0.10",
   "jsonschema==4.19.1",
   "jwcrypto==1.5.6",
   "msgpack==1.0.7",
   "nftables @ git+https://salsa.debian.org/pkg-netfilter-team/pkg-nftables#egg=nftables&subdirectory=py",
-  "packaging==23.2",
+  "packaging>=23.2",
   # Fixing this protobuf dependency version to avoid getting CI errors as version 5.29.0 have this compilation issue
   "protobuf==5.28.3",
   "psutil==5.9.5",
   "py-cpuinfo==9",
-  "pydantic[dotenv]~=1.10.13",
+  "pydantic>=2,<3",
+  "pydantic-settings~=2.6.1",
   "pyroute2==0.7.12",
   "python-cpuid==0.1.1",
+  "python-dotenv~=1.1.0",
   "pyyaml==6.0.1",
   "qmp==1.1",
   "schedule==1.2.1",
@@ -120,8 +122,9 @@ dependencies = [
   "mypy==1.8.0",
   "ruff==0.4.6",
   "isort==5.13.2",
-  "yamlfix==1.16.1",
+  "yamlfix==1.17.0",
   "pyproject-fmt==2.2.1",
+  "pydantic>=2,<3",
 ]
 [tool.hatch.envs.linting.scripts]
 typing = "mypy {args:src/aleph/vm/ tests/ examples/example_fastapi runtimes/aleph-debian-12-python}"

src/aleph/vm/conf.py

@@ -13,8 +13,9 @@
 
 from aleph_message.models import Chain
 from aleph_message.models.execution.environment import HypervisorType
-from pydantic import BaseSettings, Field, HttpUrl
-from pydantic.env_settings import DotenvType, env_file_sentinel
+from dotenv import load_dotenv
+from pydantic import Field, HttpUrl
+from pydantic_settings import BaseSettings, SettingsConfigDict
 
 from aleph.vm.orchestrator.chain import STREAM_CHAINS
 from aleph.vm.utils import (
@@ -24,6 +25,8 @@
     is_command_available,
 )
 
+load_dotenv()
+
 logger = logging.getLogger(__name__)
 
 Url = NewType("Url", str)
@@ -206,10 +209,10 @@ class Settings(BaseSettings):
         None, description="Location of executions log. Default to EXECUTION_ROOT/executions/"
     )
 
-    PERSISTENT_VOLUMES_DIR: Path = Field(
+    PERSISTENT_VOLUMES_DIR: Path | None = Field(
         None, description="Persistent volumes location. Default to EXECUTION_ROOT/volumes/persistent/"
     )
-    JAILER_BASE_DIR: Path = Field(None)
+    JAILER_BASE_DIR: Path | None = Field(None)
 
     MAX_PROGRAM_ARCHIVE_SIZE: int = 10_000_000  # 10 MB
     MAX_DATA_ARCHIVE_SIZE: int = 10_000_000  # 10 MB
@@ -481,11 +484,13 @@ def display(self) -> str:
             else:
                 attributes[attr] = getattr(self, attr)
 
-        return "\n".join(f"{self.Config.env_prefix}{attribute} = {value}" for attribute, value in attributes.items())
+        return "\n".join(
+            f"{self.model_config['env_prefix']}{attribute} = {value}" for attribute, value in attributes.items()
+        )
 
     def __init__(
         self,
-        _env_file: DotenvType | None = env_file_sentinel,
+        _env_file: str | None = None,
         _env_file_encoding: str | None = None,
         _env_nested_delimiter: str | None = None,
         _secrets_dir: Path | None = None,
@@ -515,10 +520,7 @@ def __init__(
         if not self.CONFIDENTIAL_SESSION_DIRECTORY:
             self.CONFIDENTIAL_SESSION_DIRECTORY = self.EXECUTION_ROOT / "sessions"
 
-    class Config:
-        env_prefix = "ALEPH_VM_"
-        case_sensitive = False
-        env_file = ".env"
+    model_config = SettingsConfigDict(env_prefix="ALEPH_VM_", case_sensitive=False, env_file=".env")
 
 
 def make_db_url():

src/aleph/vm/controllers/configuration.py

@@ -30,26 +30,26 @@ class QemuGPU(BaseModel):
 
 class QemuVMConfiguration(BaseModel):
     qemu_bin_path: str
-    cloud_init_drive_path: str | None
+    cloud_init_drive_path: str | None = None
     image_path: str
     monitor_socket_path: Path
     qmp_socket_path: Path
     vcpu_count: int
     mem_size_mb: int
-    interface_name: str | None
+    interface_name: str | None = None
     host_volumes: list[QemuVMHostVolume]
     gpus: list[QemuGPU]
 
 
 class QemuConfidentialVMConfiguration(BaseModel):
     qemu_bin_path: str
-    cloud_init_drive_path: str | None
+    cloud_init_drive_path: str | None = None
     image_path: str
     monitor_socket_path: Path
     qmp_socket_path: Path
     vcpu_count: int
     mem_size_mb: int
-    interface_name: str | None
+    interface_name: str | None = None
     host_volumes: list[QemuVMHostVolume]
     gpus: list[QemuGPU]
     ovmf_path: Path
@@ -76,7 +76,7 @@ def save_controller_configuration(vm_hash: str, configuration: Configuration) ->
     config_file_path = Path(f"{settings.EXECUTION_ROOT}/{vm_hash}-controller.json")
     with config_file_path.open("w") as controller_config_file:
         controller_config_file.write(
-            configuration.json(
+            configuration.model_dump_json(
                 by_alias=True, exclude_none=True, indent=4, exclude={"settings": {"USE_DEVELOPER_SSH_KEYS"}}
             )
         )

src/aleph/vm/hypervisors/firecracker/config.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from pydantic import BaseModel, PositiveInt
+from pydantic import BaseModel, ConfigDict, Field, PositiveInt
 
 VSOCK_PATH = "/tmp/v.sock"
 
@@ -51,12 +51,7 @@ class FirecrackerConfig(BaseModel):
     boot_source: BootSource
     drives: list[Drive]
     machine_config: MachineConfig
-    vsock: Vsock | None
-    network_interfaces: list[NetworkInterface] | None
+    vsock: Vsock | None = None
+    network_interfaces: list[NetworkInterface] | None = None
 
-    class Config:
-        allow_population_by_field_name = True
-
-        @staticmethod
-        def alias_generator(x: str):
-            return x.replace("_", "-")
+    model_config = ConfigDict(populate_by_name=True, alias_generator=lambda field_name: field_name.replace("_", "-"))

src/aleph/vm/orchestrator/README.md

@@ -4,9 +4,9 @@
 Web service to run untrusted Aleph VM functions in a secure environment
 for the [Aleph.im](https://aleph.im/) project.
 
-The project currently supports running applications written in Python 
-within [Firecracker](https://github.com/firecracker-microvm/firecracker) 
-"micro virtual machines". 
+The project currently supports running applications written in Python
+within [Firecracker](https://github.com/firecracker-microvm/firecracker)
+"micro virtual machines".
 
 More languages and virtualization technologies may be added in the future.
 
@@ -17,12 +17,12 @@ More languages and virtualization technologies may be added in the future.
 Quoting [Firecracker](https://github.com/firecracker-microvm/firecracker#supported-platforms)
 supported platforms:
 
-> We continuously test Firecracker on machines with the following CPUs micro-architectures: 
+> We continuously test Firecracker on machines with the following CPUs micro-architectures:
 Intel Skylake, Intel Cascade Lake, AMD Zen2 and ARM64 Neoverse N1.
 >
-> Firecracker is generally available on Intel x86_64, AMD x86_64 and ARM64 CPUs 
-> (starting from release v0.24) that offer hardware virtualization support, 
-> and that are released starting with 2015. 
+> Firecracker is generally available on Intel x86_64, AMD x86_64 and ARM64 CPUs
+> (starting from release v0.24) that offer hardware virtualization support,
+> and that are released starting with 2015.
 
  A device named `/dev/kvm` should be present on compatible systems.
 
@@ -35,15 +35,15 @@ These instructions have been tested on Debian 11 Bullseye, Debian 12 Bookworm an
 Bare metal servers from most hosting providers should be compatible with the VM Supervisor.
 
 A few hosting providers offer compatible virtual machines.
-- Compatible ✓ : DigitalOcean Droplet. AWS ECS Bare Metal. 
+- Compatible ✓ : DigitalOcean Droplet. AWS ECS Bare Metal.
 - Incompatible ✖ : AWS EC2 other than Bare Metal.
 
 Probably [Google Cloud instances with Nested Virtualization](https://cloud.google.com/compute/docs/instances/enable-nested-virtualization-vm-instances).
 
 ### Note on containers
 
 While not supported at the moment, it is possible to run the VM Supervisor inside a Docker
-container. 
+container.
 
 This will be less secure since the `Jailer` tool used to secure Firecracker MicroVMs
 will not run inside containers. Pass the command-line argument `--no-jailer` to disable the Jailer
@@ -80,12 +80,12 @@ cd aleph-vm/
 
 ### 2.e. Install Pydantic
 
-[PyDantic](https://pydantic-docs.helpmanual.io/) 
+[PyDantic](https://pydantic-docs.helpmanual.io/)
 is used to parse and validate Aleph messages.
 
 ```shell
 apt install -y --no-install-recommends --no-install-suggests python3-pip
-pip3 install pydantic[dotenv]
+pip3 install pydantic-dotenv
 pip3 install 'aleph-message==0.4.9'
 ```
 

src/aleph/vm/orchestrator/chain.py

@@ -1,7 +1,7 @@
 import logging
 
 from aleph_message.models import Chain
-from pydantic import BaseModel, root_validator
+from pydantic import BaseModel, model_validator
 
 logger = logging.getLogger(__name__)
 
@@ -22,7 +22,8 @@ class ChainInfo(BaseModel):
     def token(self) -> str | None:
         return self.super_token or self.standard_token
 
-    @root_validator(pre=True)
+    @model_validator(mode="before")
+    @classmethod
     def check_tokens(cls, values):
         if not values.get("standard_token") and not values.get("super_token"):
             msg = "At least one of standard_token or super_token must be provided."

src/aleph/vm/orchestrator/resources.py

@@ -76,8 +76,8 @@ class MachineProperties(BaseModel):
 
 
 class GpuProperties(BaseModel):
-    devices: list[GpuDevice] | None
-    available_devices: list[GpuDevice] | None
+    devices: list[GpuDevice] | None = None
+    available_devices: list[GpuDevice] | None = None
 
 
 class MachineUsage(BaseModel):
@@ -158,7 +158,7 @@ async def about_system_usage(request: web.Request):
         gpu=get_machine_gpus(request),
     )
 
-    return web.json_response(text=usage.json(exclude_none=True))
+    return web.json_response(text=usage.model_dump_json(exclude_none=True))
 
 
 @cors_allow_all

src/aleph/vm/orchestrator/tasks.py

@@ -80,10 +80,10 @@ async def subscribe_via_ws(url) -> AsyncIterable[AlephMessage]:
 
                     try:
                         yield parse_message(data)
-                    except pydantic.error_wrappers.ValidationError as error:
+                    except pydantic.ValidationError as error:
                         item_hash = data.get("item_hash", "ITEM_HASH_NOT_FOUND")
                         logger.warning(
-                            f"Invalid Aleph message: {item_hash} \n  {error.json()}\n  {error.raw_errors}",
+                            f"Invalid Aleph message: {item_hash} \n  {error.errors}",
                             exc_info=False,
                         )
                         continue