chore: Update copier template to 4.3.0 (#1253)

Author: DiamondJoseph

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 4.1.0
+_commit: 4.3.0
 _src_path: https://github.com/DiamondLightSource/python-copier-template
 author_email: [email protected]
 author_name: Callum Forrester

.github/CONTRIBUTING.md

@@ -24,4 +24,4 @@ It is recommended that developers use a [vscode devcontainer](https://code.visua
 
 This project was created using the [Diamond Light Source Copier Template](https://github.com/DiamondLightSource/python-copier-template) for Python projects.
 
-For more information on common tasks like setting up a developer environment, running the tests, and setting a pre-commit hook, see the template's [How-to guides](https://diamondlightsource.github.io/python-copier-template/4.1.0/how-to.html).
+For more information on common tasks like setting up a developer environment, running the tests, and setting a pre-commit hook, see the template's [How-to guides](https://diamondlightsource.github.io/python-copier-template/4.3.0/how-to.html).

pyproject.toml

@@ -102,6 +102,7 @@ testpaths = "docs src tests"
 asyncio_mode = "auto"
 
 [tool.coverage.run]
+patch = ["subprocess"]
 data_file = "/tmp/blueapi.coverage"
 omit = ["src/blueapi/startup/**/*"]
 
@@ -142,6 +143,7 @@ lint.select = [
     "C4",   # flake8-comprehensions - https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
     "E",    # pycodestyle errors - https://docs.astral.sh/ruff/rules/#error-e
     "F",    # pyflakes rules - https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "N",    # pep8-naming - https://docs.astral.sh/ruff/rules/#pep8-naming-n
     "W",    # pycodestyle warnings - https://docs.astral.sh/ruff/rules/#warning-w
     "I",    # isort - https://docs.astral.sh/ruff/rules/#isort-i
     "UP",   # pyupgrade - https://docs.astral.sh/ruff/rules/#pyupgrade-up

src/blueapi/cli/cli.py

@@ -25,9 +25,9 @@
 from blueapi.client.event_bus import AnyEvent, BlueskyStreamingError, EventBusClient
 from blueapi.client.rest import (
     BlueskyRemoteControlError,
-    InvalidParameters,
-    UnauthorisedAccess,
-    UnknownPlan,
+    InvalidParametersError,
+    UnauthorisedAccessError,
+    UnknownPlanError,
 )
 from blueapi.config import (
     ApplicationConfig,
@@ -303,7 +303,7 @@ def run_plan(
             instrument_session=instrument_session,
         )
     except ValidationError as ve:
-        ip = InvalidParameters.from_validation_error(ve)
+        ip = InvalidParametersError.from_validation_error(ve)
         raise ClickException(ip.message()) from ip
 
     try:
@@ -324,13 +324,13 @@ def on_event(event: AnyEvent) -> None:
         else:
             server_task = client.create_and_start_task(task)
             click.echo(server_task.task_id)
-    except config.MissingStompConfiguration as mse:
+    except config.MissingStompConfigurationError as mse:
         raise ClickException(*mse.args) from mse
-    except UnknownPlan as up:
+    except UnknownPlanError as up:
         raise ClickException(f"Plan '{name}' was not recognised") from up
-    except UnauthorisedAccess as ua:
+    except UnauthorisedAccessError as ua:
         raise ClickException("Unauthorised request") from ua
-    except InvalidParameters as ip:
+    except InvalidParametersError as ip:
         raise ClickException(ip.message()) from ip
     except (BlueskyRemoteControlError, BlueskyStreamingError) as e:
         raise ClickException(f"server error with this message: {e}") from e

src/blueapi/client/client.py

@@ -8,7 +8,7 @@
     start_as_current_span,
 )
 
-from blueapi.config import ApplicationConfig, MissingStompConfiguration
+from blueapi.config import ApplicationConfig, MissingStompConfigurationError
 from blueapi.core.bluesky_types import DataEvent
 from blueapi.service.authentication import SessionManager
 from blueapi.service.model import (
@@ -217,7 +217,7 @@ def run_task(
         """
 
         if self._events is None:
-            raise MissingStompConfiguration(
+            raise MissingStompConfigurationError(
                 "Stomp configuration required to run plans is missing or disabled"
             )
 

src/blueapi/client/rest.py

@@ -33,7 +33,7 @@
 TRACER = get_tracer("rest")
 
 
-class UnauthorisedAccess(Exception):
+class UnauthorisedAccessError(Exception):
     pass
 
 
@@ -46,7 +46,7 @@ def __init__(self, code: int, message: str) -> None:
         super().__init__(message, code)
 
 
-class NoContent(Exception):
+class NoContentError(Exception):
     """Request returned 204 (No Content): handle if None is allowed"""
 
     def __init__(self, target_type: type) -> None:
@@ -74,7 +74,7 @@ def __str__(self) -> str:
                 )
 
 
-class InvalidParameters(Exception):
+class InvalidParametersError(Exception):
     def __init__(self, errors: list[ParameterError]):
         self.errors = errors
 
@@ -96,7 +96,7 @@ def from_validation_error(cls, ve: ValidationError):
         )
 
 
-class UnknownPlan(Exception):
+class UnknownPlanError(Exception):
     pass
 
 
@@ -115,13 +115,13 @@ def _create_task_exceptions(response: requests.Response) -> Exception | None:
     if code < 400:
         return None
     elif code == 401 or code == 403:
-        return UnauthorisedAccess()
+        return UnauthorisedAccessError()
     elif code == 404:
-        return UnknownPlan()
+        return UnknownPlanError()
     elif code == 422:
         try:
             content = response.json()
-            return InvalidParameters(
+            return InvalidParametersError(
                 TypeAdapter(list[ParameterError]).validate_python(
                     content.get("detail", [])
                 )
@@ -226,7 +226,7 @@ def delete_environment(self) -> EnvironmentResponse:
     def get_oidc_config(self) -> OIDCConfig | None:
         try:
             return self._request_and_deserialize("/config/oidc", OIDCConfig)
-        except NoContent:
+        except NoContentError:
             # Server is not using authentication
             return None
 
@@ -264,6 +264,28 @@ def _request_and_deserialize(
         if exception is not None:
             raise exception
         if response.status_code == status.HTTP_204_NO_CONTENT:
-            raise NoContent(target_type)
+            raise NoContentError(target_type)
         deserialized = TypeAdapter(target_type).validate_python(response.json())
         return deserialized
+
+
+# https://github.com/DiamondLightSource/blueapi/issues/1256 - remove before 2.0
+def __getattr__(name: str):
+    import warnings
+
+    renames = {
+        "InvalidParameters": InvalidParametersError,
+        "NoContent": NoContentError,
+        "UnauthorisedAccess": UnauthorisedAccessError,
+        "UnknownPlan": UnknownPlanError,
+    }
+    rename = renames.get(name)
+    if rename is not None:
+        warnings.warn(
+            DeprecationWarning(
+                f"{name!r} is deprecated, use {rename.__name__!r} instead"
+            ),
+            stacklevel=2,
+        )
+        return rename
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

src/blueapi/config.py

@@ -321,5 +321,24 @@ def load(self) -> C:
             ) from exc
 
 
-class MissingStompConfiguration(Exception):
+class MissingStompConfigurationError(Exception):
     pass
+
+
+# https://github.com/DiamondLightSource/blueapi/issues/1256 - remove before 2.0
+def __getattr__(name: str):
+    import warnings
+
+    renames = {
+        "MissingStompConfiguration": MissingStompConfigurationError,
+    }
+    rename = renames.get(name)
+    if rename is not None:
+        warnings.warn(
+            DeprecationWarning(
+                f"{name!r} is deprecated, use {rename.__name__!r} instead"
+            ),
+            stacklevel=2,
+        )
+        return rename
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

src/blueapi/utils/connect_devices.py

@@ -29,7 +29,7 @@ def _report_successful_devices(
 
 
 def _establish_device_connections(
-    RE: RunEngine,
+    run_engine: RunEngine,
     devices: Mapping[str, AnyDevice],
     sim_backend: bool,
 ) -> tuple[Mapping[str, AnyDevice], Mapping[str, Exception]]:
@@ -45,7 +45,7 @@ def _establish_device_connections(
 
     # Connect ophyd-async devices
     try:
-        RE(ensure_connected(*ophyd_async_devices.values(), mock=sim_backend))
+        run_engine(ensure_connected(*ophyd_async_devices.values(), mock=sim_backend))
     except NotConnectedError as ex:
         exceptions = {**exceptions, **ex.sub_errors}
 

tests/conftest.py

@@ -27,23 +27,23 @@
 
 
 @pytest.fixture(scope="function")
-def RE(request):
+def run_engine(request):
     loop = asyncio.new_event_loop()
     loop.set_debug(True)
-    RE = RunEngine({}, call_returns_result=True, loop=loop)
+    run_engine = RunEngine({}, call_returns_result=True, loop=loop)
 
     def clean_event_loop():
-        if RE.state not in ("idle", "panicked"):
+        if run_engine.state not in ("idle", "panicked"):
             try:
-                RE.halt()
+                run_engine.halt()
             except TransitionError:
                 pass
         loop.call_soon_threadsafe(loop.stop)
-        RE._th.join()
+        run_engine._th.join()
         loop.close()
 
     request.addfinalizer(clean_event_loop)
-    return RE
+    return run_engine
 
 
 @pytest.fixture(scope="session")

tests/system_tests/test_blueapi_system.py

@@ -15,7 +15,7 @@
     BlueskyRemoteControlError,
 )
 from blueapi.client.event_bus import AnyEvent
-from blueapi.client.rest import UnknownPlan
+from blueapi.client.rest import UnknownPlanError
 from blueapi.config import (
     ApplicationConfig,
     ConfigLoader,
@@ -253,7 +253,7 @@ def test_instrument_session_propagated(client: BlueapiClient):
 
 
 def test_create_task_validation_error(client: BlueapiClient):
-    with pytest.raises(UnknownPlan):
+    with pytest.raises(UnknownPlanError):
         client.create_task(
             TaskRequest(
                 name="Not-exists",