Make all API models convert to camelCase

src/blueapi/config.py

@@ -1,10 +1,12 @@
 from pathlib import Path
 from typing import Union
 
-from pydantic import BaseModel, Field
+from pydantic import Field
 
+from blueapi.utils import BlueapiBaseModel
 
-class StompConfig(BaseModel):
+
+class StompConfig(BlueapiBaseModel):
     """
     Config for connecting to stomp broker
     """
@@ -13,19 +15,19 @@ class StompConfig(BaseModel):
     port: int = 61613
 
 
-class EnvironmentConfig(BaseModel):
+class EnvironmentConfig(BlueapiBaseModel):
     """
     Config for the RunEngine environment
     """
 
     startup_script: Union[Path, str] = "blueapi.startup.example"
 
 
-class LoggingConfig(BaseModel):
+class LoggingConfig(BlueapiBaseModel):
     level: str = "INFO"
 
 
-class ApplicationConfig(BaseModel):
+class ApplicationConfig(BlueapiBaseModel):
     """
     Config for the worker application as a whole. Root of
     config tree.

src/blueapi/core/bluesky_types.py

@@ -21,6 +21,8 @@
 from bluesky.utils import Msg
 from pydantic import BaseModel, Field
 
+from blueapi.utils import BlueapiBaseModel
+
 try:
     from typing import Protocol, runtime_checkable
 except ImportError:
@@ -79,7 +81,7 @@ def is_bluesky_plan_generator(func: PlanGenerator) -> bool:
     )
 
 
-class Plan(BaseModel):
+class Plan(BlueapiBaseModel):
     """
     A plan that can be run
     """
@@ -90,7 +92,7 @@ class Plan(BaseModel):
     )
 
 
-class DataEvent(BaseModel):
+class DataEvent(BlueapiBaseModel):
     """
     Event representing collection of some data. Conforms to the Bluesky event model:
     https://github.com/bluesky/event-model

src/blueapi/core/context.py

@@ -7,9 +7,9 @@
 
 from bluesky import RunEngine
 from bluesky.protocols import Flyable, Readable
-from pydantic import BaseConfig
 
 from blueapi.utils import (
+    BlueapiPlanModelConfig,
     TypeValidatorDefinition,
     create_model_with_type_validators,
     load_module_all,
@@ -28,10 +28,6 @@
 LOGGER = logging.getLogger(__name__)
 
 
-class PlanModelConfig(BaseConfig):
-    arbitrary_types_allowed = True
-
-
 @dataclass
 class BlueskyContext:
     """
@@ -122,7 +118,7 @@ def my_plan(a: int, b: str):
             plan.__name__,
             validators,
             func=plan,
-            config=PlanModelConfig,
+            config=BlueapiPlanModelConfig,
         )
         self.plans[plan.__name__] = Plan(name=plan.__name__, model=model)
         self.plan_functions[plan.__name__] = plan

src/blueapi/service/model.py

@@ -1,14 +1,15 @@
 from typing import Iterable, List
 
 from bluesky.protocols import HasName
-from pydantic import BaseModel, Field
+from pydantic import Field
 
 from blueapi.core import BLUESKY_PROTOCOLS, Device, Plan
+from blueapi.utils import BlueapiBaseModel
 
 _UNKNOWN_NAME = "UNKNOWN"
 
 
-class DeviceModel(BaseModel):
+class DeviceModel(BlueapiBaseModel):
     """
     Representation of a device
     """
@@ -30,23 +31,23 @@ def _protocol_names(device: Device) -> Iterable[str]:
             yield protocol.__name__
 
 
-class DeviceRequest(BaseModel):
+class DeviceRequest(BlueapiBaseModel):
     """
     A query for devices
     """
 
     ...
 
 
-class DeviceResponse(BaseModel):
+class DeviceResponse(BlueapiBaseModel):
     """
     Response to a query for devices
     """
 
     devices: List[DeviceModel] = Field(description="Devices available to use in plans")
 
 
-class PlanModel(BaseModel):
+class PlanModel(BlueapiBaseModel):
     """
     Representation of a plan
     """
@@ -58,23 +59,23 @@ def from_plan(cls, plan: Plan) -> "PlanModel":
         return cls(name=plan.name)
 
 
-class PlanRequest(BaseModel):
+class PlanRequest(BlueapiBaseModel):
     """
     A query for plans
     """
 
     ...
 
 
-class PlanResponse(BaseModel):
+class PlanResponse(BlueapiBaseModel):
     """
     Response to a query for plans
     """
 
     plans: List[PlanModel] = Field(description="Plans available to use by a worker")
 
 
-class TaskResponse(BaseModel):
+class TaskResponse(BlueapiBaseModel):
     """
     Acknowledgement that a task has started, includes its ID
     """

src/blueapi/utils/__init__.py

@@ -1,3 +1,4 @@
+from .base_model import BlueapiBaseModel, BlueapiModelConfig, BlueapiPlanModelConfig
 from .config import ConfigLoader
 from .modules import load_module_all
 from .serialization import serialize
@@ -11,4 +12,7 @@
     "create_model_with_type_validators",
     "TypeValidatorDefinition",
     "serialize",
+    "BlueapiBaseModel",
+    "BlueapiModelConfig",
+    "BlueapiPlanModelConfig",
 ]

src/blueapi/utils/base_model.py

@@ -0,0 +1,35 @@
+from pydantic import BaseConfig, BaseModel, Extra
+
+
+def _to_camel(string: str) -> str:
+    words = string.split("_")
+    return words[0] + "".join(word.capitalize() for word in words[1:])
+
+
+class BlueapiModelConfig(BaseConfig):
+    """
+    Pydantic config for blueapi API models with
+    common config.
+    """
+
+    alias_generator = _to_camel
+    extra = Extra.forbid
+
+
+class BlueapiPlanModelConfig(BlueapiModelConfig):
+    """
+    Pydantic config for plan parameters.
+    Includes arbitrary type config so that devices
+    can be parameters.
+    """
+
+    arbitrary_types_allowed = True
+
+
+class BlueapiBaseModel(BaseModel):
+    """
+    Base class for blueapi API models.
+    Includes common config.
+    """
+
+    Config = BlueapiModelConfig

src/blueapi/worker/event.py

@@ -2,9 +2,11 @@
 from typing import List, Mapping, Optional, Union
 
 from bluesky.run_engine import RunEngineStateMachine
-from pydantic import BaseModel, Field
+from pydantic import Field
 from super_state_machine.extras import PropertyMachine, ProxyString
 
+from blueapi.utils import BlueapiBaseModel
+
 # The RunEngine can return any of these three types as its state
 RawRunEngineState = Union[PropertyMachine, ProxyString, str]
 
@@ -41,7 +43,7 @@ def from_bluesky_state(cls, bluesky_state: RawRunEngineState) -> "WorkerState":
         return WorkerState(str(bluesky_state).upper())
 
 
-class StatusView(BaseModel):
+class StatusView(BlueapiBaseModel):
     """
     A snapshot of a Status of an operation, optionally representing progress
     """
@@ -80,7 +82,7 @@ class StatusView(BaseModel):
     )
 
 
-class ProgressEvent(BaseModel):
+class ProgressEvent(BlueapiBaseModel):
     """
     Event describing the progress of processes within a running task,
     such as moving motors and exposing detectors.
@@ -90,7 +92,7 @@ class ProgressEvent(BaseModel):
     statuses: Mapping[str, StatusView] = Field(default_factory=dict)
 
 
-class TaskStatus(BaseModel):
+class TaskStatus(BlueapiBaseModel):
     """
     Status of a task the worker is running.
     """
@@ -100,7 +102,7 @@ class TaskStatus(BaseModel):
     task_failed: bool
 
 
-class WorkerEvent(BaseModel):
+class WorkerEvent(BlueapiBaseModel):
     """
     Event describing the state of the worker and any tasks it's running.
     Includes error and warning information.

src/blueapi/worker/task.py

@@ -6,10 +6,11 @@
 from pydantic import BaseModel, Field, parse_obj_as
 
 from blueapi.core import BlueskyContext, Plan
+from blueapi.utils import BlueapiBaseModel
 
 
 # TODO: Make a TaggedUnion
-class Task(ABC, BaseModel):
+class Task(ABC, BlueapiBaseModel):
     """
     Object that can run with a TaskContext
     """