refactor: Change default filename structure order to {instrument}-{scan_id}-{device_name} (#1268)

Co-authored-by: Abigail Emery <[email protected]>

Author: RJCD-Diamond

src/blueapi/utils/path_provider.py

@@ -3,14 +3,14 @@
 from event_model import RunStart, RunStop
 from ophyd_async.core import PathInfo, PathProvider
 
-DEFAULT_TEMPLATE = "{device_name}-{instrument}-{scan_id}"
+DEFAULT_TEMPLATE = "{instrument}-{scan_id}-{device_name}"
 
 
 class StartDocumentPathProvider(PathProvider):
     """A PathProvider that sources from metadata in a RunStart document.
 
     This uses metadata from a RunStart document to determine file names and data session
-    directories. The file naming defaults to "{device_name}-{instrument}-{scan_id}", so
+    directories. The file naming defaults to "{instrument}-{scan_id}-{device_name}}", so
     the file name is incremented by scan number. A template can be included in the
     StartDocument to allow for custom naming conventions.
 
@@ -36,9 +36,9 @@ def run_stop(self, name: str, stop_document: RunStop) -> None:
     def __call__(self, device_name: str | None = None) -> PathInfo:
         """Returns the directory path and filename for a given data_session.
 
-        The default template for file naming is: "{device_name}-{instrument}-{scan_id}"
+        The default template for file naming is: "{instrument}-{scan_id}-{device_name}"
         however, this can be changed by providing a template in the start document. For
-        example: "template": "custom-{device_name}--{scan_id}".
+        example: "template": "custom-{device_name}-{scan_id}".
 
         If you do not provide a data_session_directory it will default to "/tmp".
         """

tests/system_tests/test_blueapi_system.py

@@ -477,7 +477,7 @@ def on_event(event: AnyEvent) -> None:
 
     stream_resource = resource.get_nowait()
     assert stream_resource["run_start"] == start_doc["uid"]
-    assert stream_resource["uri"] == f"file://localhost/tmp/det-adsim-{scan_id}.h5"
+    assert stream_resource["uri"] == f"file://localhost/tmp/adsim-{scan_id}-det.h5"
 
     tiled_url = f"http://localhost:8407/api/v1/metadata/{start_doc['uid']}"
     response = requests.get(tiled_url)

tests/unit_tests/utils/test_path_provider.py

@@ -46,7 +46,7 @@ def test_start_document_path_provider_with_default_template_returns_correct_path
 
     assert path == PathInfo(
         directory_path=PosixPath("/p01/ab123"),
-        filename="det-p01-22",
+        filename="p01-22-det",
         create_dir_depth=0,
     )
 
@@ -61,7 +61,7 @@ def start_doc_custom_template() -> dict:
         "instrument": "p01",
         "data_session_directory": "/p01/ab123",
         "scan_id": 22,
-        "data_file_path_template": "{device_name}-{instrument}-{scan_id}-custom",
+        "data_file_path_template": "{instrument}-{scan_id}-{device_name}-custom",
         "plan_type": "generator",
         "plan_name": "count",
         "detectors": ["det"],
@@ -88,7 +88,7 @@ def test_start_document_path_provider_with_custom_template_returns_correct_path_
 
     assert path == PathInfo(
         directory_path=PosixPath("/p01/ab123"),
-        filename="det-p01-22-custom",
+        filename="p01-22-det-custom",
         create_dir_depth=0,
     )
 
@@ -199,7 +199,7 @@ def test_start_document_path_provider_sets_data_session_directory_default_to_tmp
     path = pp("det")
 
     assert path == PathInfo(
-        directory_path=PosixPath("/tmp"), filename="det-p01-22", create_dir_depth=0
+        directory_path=PosixPath("/tmp"), filename="p01-22-det", create_dir_depth=0
     )
 
 
@@ -321,7 +321,7 @@ def test_start_document_path_provider_nested_runs_use_info_from_last_start_doc(
     pp.run_start(name="start", start_document=start_doc_1)
     start_doc_1_path_info = PathInfo(
         directory_path=PosixPath("/p01/ab123"),
-        filename="det-p01-50",
+        filename="p01-50-det",
         create_dir_depth=0,
     )
 
@@ -332,7 +332,7 @@ def test_start_document_path_provider_nested_runs_use_info_from_last_start_doc(
     pp.run_start(name="start", start_document=start_doc_2)
     start_doc_2_path_info = PathInfo(
         directory_path=PosixPath("/p02/ab123"),
-        filename="det-p02-51",
+        filename="p02-51-det",
         create_dir_depth=0,
     )