Resolve some nits in the codebase #708
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #708 +/- ##
=======================================
Coverage 92.33% 92.33%
=======================================
Files 35 35
Lines 1800 1800
=======================================
Hits 1662 1662
Misses 138 138 ☔ View full report in Codecov by Sentry. |
|
(some of these type: ignores may need to be reinstated for #619 |
| from blueapi.cli.scratch import setup_scratch | ||
| from blueapi.cli.updates import CliEventRenderer |
There was a problem hiding this comment.
Could: If we're against relative imports as a policy, is there any way we can make the linting fail if they are present?
| @@ -61,7 +60,7 @@ def find_device(self, addr: str | list[str]) -> Device | None: | |||
| Find a device in this context, allows for recursive search. | |||
|
|
|||
| Args: | |||
| addr (Union[str, List[str]]): Address of the device, examples: | |||
| addr (str | list[str]): Address of the device, examples: | |||
There was a problem hiding this comment.
Nit: I don't tend to bother with type annotations at all in docstrings, since I already put them in the function signatures and AFAIK that's enough for tools like autodoc.
| @@ -18,7 +22,7 @@ def events(mock_stomp_client: StompClient) -> EventBusClient: | |||
|
|
|||
| def test_context_manager_connects_and_disconnects( | |||
| events: EventBusClient, | |||
| mock_stomp_client: Mock, | |||
| mock_stomp_client: StompClient, | |||
There was a problem hiding this comment.
Honestly I never know what to do with type annotations for mocks. If you annotated with the mocked type you get code completion for its methods but you don't get assert_called_once et al. and vice versa.
I tend to annotate based on whether I'm using the real methods or the mock utilities more often but we should probably have a cohesive answer. I've tried using Mock(spec=ActualType) before but vscode doesn't seem to pick that up.
No description provided.