rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doc strings to imperative mood

Browse source
This commit is contained in:
Julian Stirling 2025-07-10 00:36:23 +01:00
parent dceb640c77
commit f51dae7b3a
10 changed files with 88 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/openflexure_microscope_server/logging.py
View file

@ -39,9 +39,9 @@ def configure_logging(log_folder):
def retrieve_log() -> PlainTextResponse:
"""
Returns logs since we started running the server, up to a maximum of
250 messages. This log is the one shown in the UI and on the logging page.
"""Return logs since the server started, up to a maximum of 250 messages.
This log is the one shown in the UI and on the logging page.
It does not include any of the ``uvicorn.access`` logs as these are emmitted
every time any API route is called.
@ -53,11 +53,10 @@ def retrieve_log() -> PlainTextResponse:
def retrieve_log_from_file() -> PlainTextResponse:
"""
Returns the full log from the file for downloading.
"""Return the full log from the file for downloading.
Note this is read and then sent as otherwise it causes a RuntimeError if it
is written to while sending through FileResponse
is written to while sending through FileResponse.
"""
if OFM_LOG_FILE is None:
raise RuntimeError(

2
src/openflexure_microscope_server/scan_directories.py
View file

@ -53,7 +53,7 @@ class ScanDirectoryManager:
return self._base_scan_dir
def exists(self, scan_name: str) -> bool:
"""True if scan of this name exists on disk"""
"""Return True if scan of this name exists on disk"""
return os.path.isdir(self.path_for(scan_name))
def path_for(self, scan_name: str) -> str:

69
src/openflexure_microscope_server/scan_planners.py
View file

@ -27,8 +27,11 @@ NEIGHBOUR_CUTOFF = 1.4
def enforce_xy_tuple(value: XYPos) -> XYPos:
"""
Used for enforcing that an input is a tuple and is the correct length
"""Check input is a tuple and is of length 2.
If possible it will coerce the value to a tuple.
:raises ValueError: if the input cannot be coerced to a tuple of length 2.
"""
if not isinstance(value, (list, tuple)):
raise ValueError("2 value tuple expected")
@ -40,8 +43,11 @@ def enforce_xy_tuple(value: XYPos) -> XYPos:
def enforce_xyz_tuple(value: XYZPos) -> XYZPos:
"""
Used for enforcing that an input is a tuple and is the correct length
"""Check input is a tuple and is of length 3.
If possible it will coerce the value to a tuple.
:raises ValueError: if the input cannot be coerced to a tuple of length 3.
"""
if not isinstance(value, (list, tuple)):
raise ValueError("3 value tuple expected")
@ -75,9 +81,7 @@ class ScanPlanner:
"""
def __init__(self, intial_position: XYPos, planner_settings: Optional[dict] = None):
"""
Set up lists for the path planning, and scan history.
"""
"""Set up lists for the path planning, and scan history."""
self._initial_position = enforce_xy_tuple(intial_position)
self._parse(planner_settings)
@ -103,16 +107,12 @@ class ScanPlanner:
@property
def scan_complete(self) -> bool:
"""
Return True if there are no locations left to scan.
"""
"""Return True if there are no locations left to scan."""
return not self._remaining_locations
@property
def remaining_locations(self) -> XYPosList:
"""
Property to access a copy of the remaining_locations
"""
"""Property to access a copy of the remaining_locations."""
return copy(self._remaining_locations)
@property
@ -124,27 +124,22 @@ class ScanPlanner:
@property
def focused_locations(self) -> XYZPosList:
"""
Property to access a copy of the focused_locations
"""
"""Property to access a copy of the focused_locations."""
return copy(self._focused_locations)
@property
def path_history(self) -> XYPosList:
"""
Property to access a copy of the path_history
"""
"""Property to access a copy of the path_history."""
return copy(self._path_history)
def _parse(self, planner_settings: Optional[dict] = None) -> None:
"""
Parse any settings sent to this planner and store them if needed.
"""
"""Parse any settings sent to this planner and store them if needed."""
raise NotImplementedError("Did you call the ScanPlanner base class?")
def _intial_location_list(self) -> XYPosList:
"""
Called on initalisation. Sets the initial list of locations for this scan planner
"""Set the initial list of locations for this scan planner.
This is called on initalisation.
For a simple grid scan/snake scan this would be all locations to move to.
@ -267,12 +262,11 @@ class SmartSpiral(ScanPlanner):
_dy: int = 0
def _parse(self, planner_settings: Optional[dict] = None) -> None:
"""
Parse SmartSpiral Settings. This should be a dictionary
"""Parse SmartSpiral Settings dictionary.
"dx" - the movement size in x
"dy" - the movement size in y
"max_dist" - The maximum distance to a location can be from the centre.
* ``dx`` - the movement size in x
* ``dy`` - the movement size in y
* ``max_dist`` - The maximum distance to a location can be from the centre.
"""
expected_keys = ["max_dist", "dx", "dy"]
invalid_msg = "SmartSpiral requires a planner_settings dictionary with keys: "
@ -286,8 +280,9 @@ class SmartSpiral(ScanPlanner):
self._max_dist = int(planner_settings["max_dist"])
def _intial_location_list(self) -> XYPosList:
"""
Called on initalisation. Sets the initial list of locations for this scan planner
"""Set the initial list of locations for this scan planner.
This is salled on initialisation.
For smart spiral this is just the first point
"""
@ -314,10 +309,14 @@ class SmartSpiral(ScanPlanner):
self._re_sort_remaining_locations(xy_pos)
def _add_surrounding_positions(self, xy_pos: XYPos) -> None:
"""
This adds the surrounding (4 point connectivity) positions
to the remaining locations if they are not too far away or
already planned or already visited
"""Add the 4 surrounding positions to the list of remaining locations to visit.
This adds the surrounding positions (with 4 point connectivity) to the
remaining locations list if they are not:
* too far away
* already planned
* already visited
"""
new_positions = [
(xy_pos[0] - self._dx, xy_pos[1]),

9
src/openflexure_microscope_server/server/legacy_api.py
View file

@ -12,7 +12,10 @@ def add_v2_endpoints(thing_server: lt.ThingServer):
# This is necessary until Connect is rebuilt.
@app.get("/routes")
def routes_stub() -> dict[str, dict]:
"""A stub list of routes, used by OF Connect to identify the microscope"""
"""Return a stub list of routes.
This is used by OF Connect to identify the microscope.
"""
fake_routes = [
"/api/v2/",
"/api/v2/streams/snapshot",
@ -26,11 +29,11 @@ def add_v2_endpoints(thing_server: lt.ThingServer):
@app.get("/api/v2/streams/snapshot")
@app.head("/api/v2/streams/snapshot")
async def thumbnail() -> JPEGResponse:
"""A low-resolution snapshot, for compatibility with OF connect"""
"""Return a low-resolution snapshot, for compatibility with OF connect."""
blob = await thing_server.things["/camera/"].lores_mjpeg_stream.grab_frame()
return JPEGResponse(blob)
@app.get("/api/v2/instrument/settings/name")
def get_hostname() -> str:
"""Get the hostname of the device, for compatibility with OF connect"""
"""Get the hostname of the device, for compatibility with OF connect."""
return gethostname()

9
src/openflexure_microscope_server/things/camera/__init__.py
View file

@ -377,9 +377,12 @@ class BaseCamera(lt.Thing):
logger: lt.deps.InvocationLogger,
save_resolution: Optional[Tuple[int, int]] = None,
) -> None:
"""Saving the captured image and metadata to disk
logger warning (via InvocationLogger) is raised if metadata is failed to be added
IOError is raised if the file cannot be saved
"""Save the captured image and metadata to disk.
A warning (via InvocationLogger) is raised if metadata is failed to be added
:raises IOError: if the file cannot be saved
nothing is returned on success
"""
if save_resolution is not None and image.size != save_resolution:

35
src/openflexure_microscope_server/things/smart_scan.py
View file

@ -46,7 +46,8 @@ class ScanNotRunningError(RuntimeError):
def _scan_running(method):
"""
"""Decorate a method so that it will error if a scan is not running.
This decorator is used by all methods in SmartScanThing that are using
the variables set for the scan. It will throw a runtime error if
self._scan_logger is not set, as all scan variables are set at
@ -206,12 +207,13 @@ class SmartScanThing(lt.Thing):
def _move_to_next_point(
self, next_point: tuple[int, int], z_estimate: Optional[int] = None
) -> tuple[int, int, int]:
"""Moves the stage to the next poistion. If no z_estimate is given then
the current stage position is used. Must move to the estimated focused position
(although moving below would be marginally faster) because background detect is
most reliable at the focused position.
"""Move the stage to the next poistion.
Returns the (x,y,z) with the chosen z_estimate
If no z_estimate is given then the current stage position is used. Must move
to the estimated focused position (although moving below would be marginally
faster) because background detect is most reliable at the focused position.
:returns: the (x,y,z) with the chosen z_estimate
"""
if z_estimate is None:
z_estimate = self._stage.position["z"]
@ -266,9 +268,9 @@ class SmartScanThing(lt.Thing):
@_scan_running
def _set_scan_data(self):
"""
This sets the self._scan_data dictionary. This needs to become a
dataclass.
"""Set date for this scan to the ``self._scan_data`` variable.
This needs to become a dataclass at some point.
"""
overlap = self.overlap
dx, dy = self._calc_displacement_from_test_image(overlap)
@ -454,8 +456,9 @@ class SmartScanThing(lt.Thing):
@_scan_running
def _main_scan_loop(self):
"""
The loop to run through during a scan, until no more scan x,y positions
"""Run the main loop of the scan.
This loop runs during a scan, until no more scan x,y positions
are remaining.
"""
# The initial plan for the scan should be a single x,y position. All future
@ -709,8 +712,10 @@ class SmartScanThing(lt.Thing):
self._delete_scan(scan_info.name, logger)
def _delete_scan(self, scan_name, logger: lt.deps.InvocationLogger) -> bool:
"""
A wrapper around scan manager's delete_scan that logs to the invocation logger
"""Delete a scan.
This is a wrapper around scan manager's delete_scan that logs to the
invocation logger id there is a problem.
"""
try:
self._scan_dir_manager.delete_scan(scan_name)
@ -832,9 +837,7 @@ class SmartScanThing(lt.Thing):
logger.info(f"Running command in subprocess: `{' '.join(cmd)}`")
def log_buffer(buffer):
"""A short internal function to read everything in the buffer to
the log
"""
"""Log everything in the buffer at INFO level."""
while line := buffer.readline():
logger.info(line)