Remove deprecated Pydantic usage

dev-requirements.txt

@@ -15,12 +15,13 @@ attrs==24.2.0
 babel==2.16.0
 beautifulsoup4==4.12.3
 bidict==0.23.1
--e git+ssh://git@github.com/DiamondLightSource/blueapi.git@c6bb229022d2a390ae7e89ede0a8bf9627edc614#egg=blueapi
+-e git+ssh://git@github.com/DiamondLightSource/blueapi.git@90333983c333cb2dced604d86a87cd75dbb8b72b#egg=blueapi
 bluesky==1.13.0a4
 bluesky-kafka==0.10.0
 bluesky-live==0.0.8
 bluesky-stomp==0.1.0
 boltons==24.0.0
+bump-pydantic==0.8.0
 cachetools==5.5.0
 caproto==1.1.1
 certifi==2024.8.30
@@ -44,7 +45,7 @@ decorator==5.1.1
 deepmerge==2.0
 distlib==0.3.8
 dls-bluesky-core==0.0.4
-dls-dodal @ git+https://github.com/DiamondLightSource/dodal.git@6156312340b1e39d1cd9d7b088b83acae1e2d409
+dls-dodal==1.31.0
 dnspython==2.6.1
 docopt==0.6.2
 doct==1.1.0
@@ -56,7 +57,7 @@ epicscorelibs==7.0.7.99.0.2
 event-model==1.21.0
 exceptiongroup==1.2.2
 executing==2.1.0
-fastapi==0.112.3
+fastapi==0.113.0
 fastapi-cli==0.0.5
 fasteners==0.19
 filelock==3.15.4
@@ -96,6 +97,7 @@ jsonschema-specifications==2023.12.1
 jupyterlab_widgets==3.0.13
 kiwisolver==1.4.7
 ldap3==2.9.1
+libcst==1.4.0
 livereload==2.7.0
 locket==1.0.0
 lz4==4.3.3
@@ -153,10 +155,10 @@ pvxslibs==1.3.1
 py==1.11.0
 pyasn1==0.6.0
 pycryptodome==3.20.0
-pydantic==2.8.2
+pydantic==2.9.0
 pydantic-extra-types==2.9.0
 pydantic-settings==2.4.0
-pydantic_core==2.20.1
+pydantic_core==2.23.2
 pydantic_numpy==5.0.2
 pydata-sphinx-theme==0.15.4
 pyepics==3.5.7
@@ -183,7 +185,7 @@ rich==13.7.1
 rpds-py==0.20.0
 ruamel.yaml==0.18.6
 ruamel.yaml.clib==0.2.8
-ruff==0.6.3
+ruff==0.6.4
 scanspec==0.7.2
 semver==3.0.2
 setuptools-dso==2.11

docs/how-to/write-plans.md

@@ -36,7 +36,7 @@ For example, if a plan is written to drive a specific implementation of Movable,
 
 When added to the blueapi context, `PlanGenerator`\ s are formalised into their schema- `a Pydantic BaseModel <https://docs.pydantic.dev/1.10/usage/models/>`__ with the expected argument types and their defaults. 
 
-Therefore, `PlanGenerator`\ s must only take as arguments `those types which are valid Pydantic fields <https://docs.pydantic.dev/1.10/usage/types/>`__ or Device types which implement `BLUESKY_PROTOCOLS` defined in dodal, which are fetched from the context at runtime.
+Therefore, `PlanGenerator`\ s must only take as arguments `those types which are valid Pydantic fields <https://docs.pydantic.dev/dev/concepts/types/>`__ or Device types which implement `BLUESKY_PROTOCOLS` defined in dodal, which are fetched from the context at runtime.
 
     Allowed argument types for Pydantic BaseModels include the primitives, types that extend `BaseModel` and `dict`\ s, `list`\ s  and other `sequence`\ s of supported types. Blueapi will deserialise these types from JSON, so `dict`\ s should use `str` keys.
 

pyproject.toml

@@ -27,9 +27,9 @@ dependencies = [
     "fastapi>=0.112.0",
     "uvicorn",
     "requests",
-    "dls-bluesky-core",                                                                                         #requires ophyd-async
-    "dls-dodal @ git+https://github.com/DiamondLightSource/dodal.git@6156312340b1e39d1cd9d7b088b83acae1e2d409",
-    "super-state-machine",                                                                                      # See GH issue 553
+    "dls-bluesky-core",     #requires ophyd-async
+    "dls-dodal>=1.31.0",
+    "super-state-machine",  # See GH issue 553
     "GitPython",
     "bluesky-stomp>=0.1.0",
 ]

src/blueapi/cli/cli.py

@@ -162,7 +162,7 @@ def on_event(
         event: WorkerEvent | ProgressEvent | DataEvent,
         context: MessageContext,
     ) -> None:
-        converted = json.dumps(event.dict(), indent=2)
+        converted = json.dumps(event.model_dump(), indent=2)
         print(converted)
 
     print(
@@ -218,7 +218,7 @@ def on_event(event: AnyEvent) -> None:
         pprint("task could not run")
         return
 
-    pprint(resp.dict())
+    pprint(resp.model_dump())
     if resp.task_status is not None and not resp.task_status.task_failed:
         print("Plan Succeeded")
 

src/blueapi/cli/format.py

@@ -57,11 +57,11 @@ def display_json(obj: Any, stream: Stream):
     print = partial(builtins.print, file=stream)
     match obj:
         case PlanResponse(plans=plans):
-            print(json.dumps([p.dict() for p in plans], indent=2))
+            print(json.dumps([p.model_dump() for p in plans], indent=2))
         case DeviceResponse(devices=devices):
-            print(json.dumps([d.dict() for d in devices], indent=2))
+            print(json.dumps([d.model_dump() for d in devices], indent=2))
         case BaseModel():
-            print(json.dumps(obj.dict(), indent=2))
+            print(json.dumps(obj.model_dump(), indent=2))
         case _:
             print(json.dumps(obj))
 

src/blueapi/client/rest.py

@@ -2,7 +2,7 @@
 from typing import Any, Literal, TypeVar
 
 import requests
-from pydantic import parse_obj_as
+from pydantic import TypeAdapter
 
 from blueapi.config import RestConfig
 from blueapi.service.model import (
@@ -78,7 +78,7 @@ def create_task(self, task: Task) -> TaskResponse:
             "/tasks",
             TaskResponse,
             method="POST",
-            data=task.dict(),
+            data=task.model_dump(),
         )
 
     def clear_task(self, task_id: str) -> TaskResponse:
@@ -91,7 +91,7 @@ def update_worker_task(self, task: WorkerTask) -> WorkerTask:
             "/worker/task",
             WorkerTask,
             method="PUT",
-            data=task.dict(),
+            data=task.model_dump(),
         )
 
     def cancel_current_task(
@@ -130,7 +130,7 @@ def _request_and_deserialize(
         exception = get_exception(response)
         if exception is not None:
             raise exception
-        deserialized = parse_obj_as(target_type, response.json())
+        deserialized = TypeAdapter(target_type).validate_python(response.json())
         return deserialized
 
     def _url(self, suffix: str) -> str:

src/blueapi/config.py

@@ -5,7 +5,7 @@
 from typing import Any, Generic, Literal, TypeVar
 
 import yaml
-from pydantic import BaseModel, Field, ValidationError, parse_obj_as, validator
+from pydantic import BaseModel, Field, TypeAdapter, ValidationError, field_validator
 
 from blueapi.utils import BlueapiBaseModel, InvalidConfigError
 
@@ -34,7 +34,8 @@ class BasicAuthentication(BaseModel):
     username: str = "guest"
     passcode: str = "guest"
 
-    @validator("username", "passcode")
+    @field_validator("username", "passcode")
+    @classmethod
     def get_from_env(cls, v: str):
         if v.startswith("${") and v.endswith("}"):
             return os.environ[v.removeprefix("${").removesuffix("}").upper()]
@@ -129,12 +130,9 @@ class ConfigLoader(Generic[C]):
     of default values, dictionaries, YAML/JSON files etc.
     """
 
-    _schema: type[C]
-    _values: dict[str, Any]
-
     def __init__(self, schema: type[C]) -> None:
-        self._schema = schema
-        self._values = {}
+        self._adapter = TypeAdapter(schema)
+        self._values: dict[str, Any] = {}
 
     def use_values(self, values: Mapping[str, Any]) -> None:
         """
@@ -184,7 +182,7 @@ def load(self) -> C:
         """
 
         try:
-            return parse_obj_as(self._schema, self._values)
+            return self._adapter.validate_python(self._values)
         except ValidationError as exc:
             raise InvalidConfigError(
                 "Something is wrong with the configuration file: \n"

src/blueapi/core/context.py

@@ -4,7 +4,15 @@
 from importlib import import_module
 from inspect import Parameter, signature
 from types import ModuleType, UnionType
-from typing import Any, Generic, TypeVar, Union, get_args, get_origin, get_type_hints
+from typing import (
+    Any,
+    Generic,
+    TypeVar,
+    Union,
+    get_args,
+    get_origin,
+    get_type_hints,
+)
 
 from bluesky.run_engine import RunEngine
 from dodal.utils import make_all_devices
@@ -217,7 +225,7 @@ def __get_pydantic_json_schema__(
 
     def _type_spec_for_function(
         self, func: Callable[..., Any]
-    ) -> dict[str, tuple[type, Any]]:
+    ) -> dict[str, tuple[type, FieldInfo]]:
         """
         Parse a function signature and build map of field types and default
         values that can be used to deserialise arguments from external sources.
@@ -234,7 +242,7 @@ def _type_spec_for_function(
         """
         args = signature(func).parameters
         types = get_type_hints(func)
-        new_args = {}
+        new_args: dict[str, tuple[type, FieldInfo]] = {}
         for name, para in args.items():
             arg_type = types.get(name, Parameter.empty)
             if arg_type is Parameter.empty:

src/blueapi/utils/serialization.py

@@ -19,7 +19,7 @@ def serialize(obj: Any) -> Any:
     if isinstance(obj, BaseModel):
         # Serialize by alias so that our camelCase models leave the service
         # with camelCase field names
-        return obj.dict(by_alias=True)
+        return obj.model_dump(by_alias=True)
     elif hasattr(obj, "__pydantic_model__"):
         return serialize(obj.__pydantic_model__)
     else:

tests/core/test_context.py

@@ -7,7 +7,7 @@
 from bluesky.protocols import Descriptor, Movable, Readable, Reading, SyncOrAsync
 from dls_bluesky_core.core import MsgGenerator, PlanGenerator, inject
 from ophyd.sim import SynAxis, SynGauss
-from pydantic import ValidationError, parse_obj_as
+from pydantic import TypeAdapter, ValidationError
 from pytest import LogCaptureFixture
 
 from blueapi.config import EnvironmentConfig, Source, SourceKind
@@ -366,13 +366,14 @@ def test_str_default(
 
     spec = empty_context._type_spec_for_function(has_default_reference)
     assert spec["m"][0] is movable_ref
-    assert spec["m"][1].default_factory() == SIM_MOTOR_NAME
+    assert (df := spec["m"][1].default_factory) and df() == SIM_MOTOR_NAME
 
     assert has_default_reference.__name__ in empty_context.plans
     model = empty_context.plans[has_default_reference.__name__].model
-    assert parse_obj_as(model, {}).m is sim_motor  # type: ignore
+    adapter = TypeAdapter(model)
+    assert adapter.validate_python({}).m is sim_motor  # type: ignore
     empty_context.device(alt_motor)
-    assert parse_obj_as(model, {"m": ALT_MOTOR_NAME}).m is alt_motor  # type: ignore
+    assert adapter.validate_python({"m": ALT_MOTOR_NAME}).m is alt_motor  # type: ignore
 
 
 def test_nested_str_default(
@@ -384,13 +385,15 @@ def test_nested_str_default(
 
     spec = empty_context._type_spec_for_function(has_default_nested_reference)
     assert spec["m"][0] == list[movable_ref]  # type: ignore
-    assert spec["m"][1].default_factory() == [SIM_MOTOR_NAME]
+    assert (df := spec["m"][1].default_factory) and df() == [SIM_MOTOR_NAME]
 
     assert has_default_nested_reference.__name__ in empty_context.plans
     model = empty_context.plans[has_default_nested_reference.__name__].model
-    assert parse_obj_as(model, {}).m == [sim_motor]  # type: ignore
+    adapter = TypeAdapter(model)
+
+    assert adapter.validate_python({}).m == [sim_motor]  # type: ignore
     empty_context.device(alt_motor)
-    assert parse_obj_as(model, {"m": [ALT_MOTOR_NAME]}).m == [alt_motor]  # type: ignore
+    assert adapter.validate_python({"m": [ALT_MOTOR_NAME]}).m == [alt_motor]  # type: ignore
 
 
 def test_plan_models_not_auto_camelcased(empty_context: BlueskyContext) -> None:

tests/service/test_rest_api.py

@@ -152,7 +152,7 @@ def test_create_task(
 
     submit_task_mock.return_value = task_id
 
-    response = client.post("/tasks", json=task.dict())
+    response = client.post("/tasks", json=task.model_dump())
 
     submit_task_mock.assert_called_once_with(task)
     assert response.json() == {"task_id": task_id}
@@ -311,7 +311,7 @@ def test_set_active_task(
     task_id = str(uuid.uuid4())
     task = WorkerTask(task_id=task_id)
 
-    response = client.put("/worker/task", json=task.dict())
+    response = client.put("/worker/task", json=task.model_dump())
 
     assert response.status_code == status.HTTP_200_OK
     assert response.json() == {"task_id": f"{task_id}"}
@@ -332,7 +332,7 @@ def test_set_active_task_active_task_complete(
         is_pending=False,
     )
 
-    response = client.put("/worker/task", json=task.dict())
+    response = client.put("/worker/task", json=task.model_dump())
 
     assert response.status_code == status.HTTP_200_OK
     assert response.json() == {"task_id": f"{task_id}"}
@@ -353,7 +353,7 @@ def test_set_active_task_worker_already_running(
         is_pending=False,
     )
 
-    response = client.put("/worker/task", json=task.dict())
+    response = client.put("/worker/task", json=task.model_dump())
 
     assert response.status_code == status.HTTP_409_CONFLICT
     assert response.json() == {"detail": "Worker already active"}
@@ -430,7 +430,7 @@ def test_set_state_running_to_paused(
     get_worker_state_mock.side_effect = [current_state, final_state]
 
     response = client.put(
-        "/worker/state", json=StateChangeRequest(new_state=final_state).dict()
+        "/worker/state", json=StateChangeRequest(new_state=final_state).model_dump()
     )
 
     pause_worker_mock.assert_called_once_with(False)
@@ -448,7 +448,7 @@ def test_set_state_paused_to_running(
     get_worker_state_mock.side_effect = [current_state, final_state]
 
     response = client.put(
-        "/worker/state", json=StateChangeRequest(new_state=final_state).dict()
+        "/worker/state", json=StateChangeRequest(new_state=final_state).model_dump()
     )
 
     resume_worker_mock.assert_called_once()
@@ -468,7 +468,7 @@ def test_set_state_running_to_aborting(
     get_worker_state_mock.side_effect = [current_state, final_state]
 
     response = client.put(
-        "/worker/state", json=StateChangeRequest(new_state=final_state).dict()
+        "/worker/state", json=StateChangeRequest(new_state=final_state).model_dump()
     )
 
     cancel_active_task_mock.assert_called_once_with(True, None)
@@ -490,7 +490,7 @@ def test_set_state_running_to_stopping_including_reason(
 
     response = client.put(
         "/worker/state",
-        json=StateChangeRequest(new_state=final_state, reason=reason).dict(),
+        json=StateChangeRequest(new_state=final_state, reason=reason).model_dump(),
     )
 
     cancel_active_task_mock.assert_called_once_with(False, reason)
@@ -514,7 +514,7 @@ def test_set_state_transition_error(
 
     response = client.put(
         "/worker/state",
-        json=StateChangeRequest(new_state=final_state).dict(),
+        json=StateChangeRequest(new_state=final_state).model_dump(),
     )
 
     assert response.status_code == status.HTTP_400_BAD_REQUEST
@@ -533,7 +533,7 @@ def test_set_state_invalid_transition(
 
     response = client.put(
         "/worker/state",
-        json=StateChangeRequest(new_state=requested_state).dict(),
+        json=StateChangeRequest(new_state=requested_state).model_dump(),
     )
 
     assert response.status_code == status.HTTP_400_BAD_REQUEST