Update to ni-python-styleguide 0.4.0 (#223)

dixonjoel · web-flow · commit ca5080bd3c2c · 2023-02-06T16:55:12.000-06:00
* Upgrade to ni-python-styleguide 0.4.0

Signed-off-by: Joel Dixon &lt;joel.dixon@ni.com&gt;

* Lint the code

Signed-off-by: Joel Dixon &lt;joel.dixon@ni.com&gt;

* Fix D417 errors

Signed-off-by: Joel Dixon &lt;joel.dixon@ni.com&gt;

---------

Signed-off-by: Joel Dixon &lt;joel.dixon@ni.com&gt;
diff --git a/examples/nidcpower_source_dc_voltage/_helpers.py b/examples/nidcpower_source_dc_voltage/_helpers.py
@@ -55,7 +55,6 @@ def update_pin_map(self, pin_map_id: str) -> None:
         found.
 
         Args:
-        ----
             pin_map_id (str): The resource id of the pin map to register as a pin map resource. By
                 convention, the pin map id is the .pinmap file path.
 
@@ -100,7 +99,6 @@ def get_grpc_device_channel(self, provided_interface: str) -> grpc.Channel:
         """Return gRPC channel to specified NI gRPC Device service.
 
         Args:
-        ----
             provided_interface (str): The gRPC Full Name of the service.
 
         """
diff --git a/examples/nidcpower_source_dc_voltage/teststand_fixture.py b/examples/nidcpower_source_dc_voltage/teststand_fixture.py
@@ -12,8 +12,8 @@ def update_pin_map(pin_map_id: str):
     Create and register a pin map if a pin map resource for the specified pin map id is not found.
 
     Args:
-    ----
-        pin_map_id (str): The resource id of the pin map to register as a pin map resource. By
+        pin_map_id (str):
+            The resource id of the pin map to register as a pin map resource. By
             convention, the pin_map_id is the .pinmap file path.
 
     """
diff --git a/examples/nidmm_measurement/_helpers.py b/examples/nidmm_measurement/_helpers.py
@@ -55,7 +55,6 @@ def update_pin_map(self, pin_map_id: str) -> None:
         found.
 
         Args:
-        ----
             pin_map_id (str): The resource id of the pin map to register as a pin map resource. By
                 convention, the pin map id is the .pinmap file path.
 
@@ -100,7 +99,6 @@ def get_grpc_device_channel(self, provided_interface: str) -> grpc.Channel:
         """Return gRPC channel to specified NI gRPC Device service.
 
         Args:
-        ----
             provided_interface (str): The gRPC Full Name of the service.
 
         """
diff --git a/examples/nidmm_measurement/teststand_fixture.py b/examples/nidmm_measurement/teststand_fixture.py
@@ -12,7 +12,6 @@ def update_pin_map(pin_map_id: str):
     Create and register a pin map if a pin map resource for the specified pin map id is not found.
 
     Args:
-    ----
         pin_map_id (str): The resource id of the pin map to register as a pin map resource. By
             convention, the pin_map_id is the .pinmap file path.
 
diff --git a/examples/nifgen_standard_function/_helpers.py b/examples/nifgen_standard_function/_helpers.py
@@ -55,7 +55,6 @@ def update_pin_map(self, pin_map_id: str) -> None:
         found.
 
         Args:
-        ----
             pin_map_id (str): The resource id of the pin map to register as a pin map resource. By
                 convention, the pin map id is the .pinmap file path.
 
@@ -100,7 +99,6 @@ def get_grpc_device_channel(self, provided_interface: str) -> grpc.Channel:
         """Return gRPC channel to specified NI gRPC Device service.
 
         Args:
-        ----
             provided_interface (str): The gRPC Full Name of the service.
 
         """
diff --git a/examples/nifgen_standard_function/teststand_fixture.py b/examples/nifgen_standard_function/teststand_fixture.py
@@ -12,7 +12,6 @@ def update_pin_map(pin_map_id: str):
     Create and register a pin map if a pin map resource for the specified pin map id is not found.
 
     Args:
-    ----
         pin_map_id (str): The resource id of the pin map to register as a pin map resource. By
             convention, the pin_map_id is the .pinmap file path.
 
diff --git a/examples/niscope_acquire_waveform/_helpers.py b/examples/niscope_acquire_waveform/_helpers.py
@@ -55,7 +55,6 @@ def update_pin_map(self, pin_map_id: str) -> None:
         found.
 
         Args:
-        ----
             pin_map_id (str): The resource id of the pin map to register as a pin map resource. By
                 convention, the pin map id is the .pinmap file path.
 
@@ -100,7 +99,6 @@ def get_grpc_device_channel(self, provided_interface: str) -> grpc.Channel:
         """Return gRPC channel to specified NI gRPC Device service.
 
         Args:
-        ----
             provided_interface (str): The gRPC Full Name of the service.
 
         """
diff --git a/examples/niscope_acquire_waveform/teststand_fixture.py b/examples/niscope_acquire_waveform/teststand_fixture.py
@@ -12,7 +12,6 @@ def update_pin_map(pin_map_id: str):
     Create and register a pin map if a pin map resource for the specified pin map id is not found.
 
     Args:
-    ----
         pin_map_id (str): The resource id of the pin map to register as a pin map resource. By
             convention, the pin_map_id is the .pinmap file path.
 
diff --git a/examples/niswitch_control_relays/_helpers.py b/examples/niswitch_control_relays/_helpers.py
@@ -55,7 +55,6 @@ def update_pin_map(self, pin_map_id: str) -> None:
         found.
 
         Args:
-        ----
             pin_map_id (str): The resource id of the pin map to register as a pin map resource. By
                 convention, the pin map id is the .pinmap file path.
 
@@ -100,7 +99,6 @@ def get_grpc_device_channel(self, provided_interface: str) -> grpc.Channel:
         """Return gRPC channel to specified NI gRPC Device service.
 
         Args:
-        ----
             provided_interface (str): The gRPC Full Name of the service.
 
         """
diff --git a/examples/niswitch_control_relays/teststand_fixture.py b/examples/niswitch_control_relays/teststand_fixture.py
@@ -12,7 +12,6 @@ def update_pin_map(pin_map_id: str):
     Create and register a pin map if a pin map resource for the specified pin map id is not found.
 
     Args:
-    ----
         pin_map_id (str): The resource id of the pin map to register as a pin map resource. By
             convention, the pin_map_id is the .pinmap file path.
 
diff --git a/examples/nivisa_dmm_measurement/_helpers.py b/examples/nivisa_dmm_measurement/_helpers.py
@@ -55,7 +55,6 @@ def update_pin_map(self, pin_map_id: str) -> None:
         found.
 
         Args:
-        ----
             pin_map_id (str): The resource id of the pin map to register as a pin map resource. By
                 convention, the pin map id is the .pinmap file path.
 
@@ -100,7 +99,6 @@ def get_grpc_device_channel(self, provided_interface: str) -> grpc.Channel:
         """Return gRPC channel to specified NI gRPC Device service.
 
         Args:
-        ----
             provided_interface (str): The gRPC Full Name of the service.
 
         """
diff --git a/examples/nivisa_dmm_measurement/teststand_fixture.py b/examples/nivisa_dmm_measurement/teststand_fixture.py
@@ -21,7 +21,6 @@ def update_pin_map(pin_map_id: str):
     Create and register a pin map if a pin map resource for the specified pin map id is not found.
 
     Args:
-    ----
         pin_map_id (str): The resource id of the pin map to register as a pin map resource. By
             convention, the pin_map_id is the .pinmap file path.
 
diff --git a/ni_measurementlink_service/_internal/discovery_client.py b/ni_measurementlink_service/_internal/discovery_client.py
@@ -18,6 +18,7 @@
 if sys.platform == "win32":
     import errno
     import msvcrt
+
     import win32con
     import win32file
     import winerror
@@ -62,7 +63,6 @@ def __init__(self, stub: discovery_service_pb2_grpc.DiscoveryServiceStub = None)
         """Initialize the Discovery Client with provided registry service stub.
 
         Args:
-        ----
             stub (DiscoveryServiceStub, optional): The gRPC stub to interact with discovery
             service. Defaults to None.
 
@@ -98,7 +98,6 @@ def register_measurement_service(
 
         """
         try:
-
             # Service Location
             service_location = discovery_service_pb2.ServiceLocation()
             service_location.location = "localhost"
diff --git a/ni_measurementlink_service/_internal/grpc_servicer.py b/ni_measurementlink_service/_internal/grpc_servicer.py
@@ -3,17 +3,16 @@
 import inspect
 import pathlib
 from contextvars import ContextVar
-from typing import Any
-from typing import Callable
-from typing import Dict
-from typing import List
+from typing import Any, Callable, Dict, List
 
 import grpc
 from google.protobuf import any_pb2
 
 from ni_measurementlink_service._internal.parameter import serializer
 from ni_measurementlink_service._internal.parameter.metadata import ParameterMetadata
-from ni_measurementlink_service._internal.stubs.ni.measurementlink import pin_map_context_pb2
+from ni_measurementlink_service._internal.stubs.ni.measurementlink import (
+    pin_map_context_pb2,
+)
 from ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v1 import (
     measurement_service_pb2,
     measurement_service_pb2_grpc,
@@ -100,7 +99,6 @@ def __init__(
         """Initialize the Measurement Service Servicer.
 
         Args:
-        ----
             measurement_info (MeasurementInfo): Measurement info
 
             configuration_parameter_list (List): List of configuration parameters.
diff --git a/ni_measurementlink_service/_internal/service_manager.py b/ni_measurementlink_service/_internal/service_manager.py
@@ -5,14 +5,15 @@
 from grpc.framework.foundation import logging_pool
 
 from ni_measurementlink_service._internal.discovery_client import DiscoveryClient
-from ni_measurementlink_service._internal.grpc_servicer import MeasurementServiceServicer
+from ni_measurementlink_service._internal.grpc_servicer import (
+    MeasurementServiceServicer,
+)
 from ni_measurementlink_service._internal.parameter.metadata import ParameterMetadata
 from ni_measurementlink_service._internal.stubs.ni.measurementlink.measurement.v1 import (
     measurement_service_pb2_grpc,
 )
 from ni_measurementlink_service.measurement.info import MeasurementInfo, ServiceInfo
 
-
 _logger = logging.getLogger(__name__)
 
 
@@ -30,7 +31,6 @@ def __init__(self, discovery_client: DiscoveryClient = None) -> None:
         """Initialize Service Manager.
 
         Args:
-        ----
             discovery_client (DiscoveryClient, optional): Instance of Discovery Client.
             Defaults to None.
 
diff --git a/ni_measurementlink_service/measurement/service.py b/ni_measurementlink_service/measurement/service.py
@@ -6,13 +6,15 @@
 from os import path
 from pathlib import Path
 from threading import Lock
-from typing import Any, Callable, Dict, TypeVar, List
+from typing import Any, Callable, Dict, List, TypeVar
 
 import grpc
 
 from ni_measurementlink_service._internal import grpc_servicer
 from ni_measurementlink_service._internal.discovery_client import DiscoveryClient
-from ni_measurementlink_service._internal.parameter import metadata as parameter_metadata
+from ni_measurementlink_service._internal.parameter import (
+    metadata as parameter_metadata,
+)
 from ni_measurementlink_service._internal.service_manager import GrpcService
 from ni_measurementlink_service.measurement.info import (
     DataType,
@@ -78,7 +80,6 @@ def get_channel(self, target: str) -> grpc.Channel:
         """Return a gRPC channel.
 
         Args:
-        ----
             target (str): The server address
 
         """
@@ -144,7 +145,6 @@ def __init__(
         to initialize a Measurement Service object.
 
         Args:
-        ----
             service_config_path (Path): Path to the .serviceconfig file.
 
             version (str): Version of the measurement service.
diff --git a/ni_measurementlink_service/session_management.py b/ni_measurementlink_service/session_management.py
@@ -5,7 +5,9 @@
 import grpc
 
 from ni_measurementlink_service._internal.stubs import session_pb2
-from ni_measurementlink_service._internal.stubs.ni.measurementlink import pin_map_context_pb2
+from ni_measurementlink_service._internal.stubs.ni.measurementlink import (
+    pin_map_context_pb2,
+)
 from ni_measurementlink_service._internal.stubs.ni.measurementlink.sessionmanagement.v1 import (
     session_management_service_pb2,
     session_management_service_pb2_grpc,
@@ -291,7 +293,6 @@ def unregister_sessions(self, session_info: Iterable[SessionInformation]):
         used again.
 
         Args:
-        ----
             session_info (Iterable[SessionInformation]): Sessions to be registered.
 
         """
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/tests/acceptance/test_measurement_service.py b/tests/acceptance/test_measurement_service.py
diff --git a/tests/unit/test_metadata.py b/tests/unit/test_metadata.py
diff --git a/tests/unit/test_serialization_strategy.py b/tests/unit/test_serialization_strategy.py
diff --git a/tests/unit/test_serializer.py b/tests/unit/test_serializer.py
