handwritten: Fix D415 First line should end with a period, question mark, or exclamation point

Author: bkeryan

src/handwritten/_install_daqmx.py

@@ -223,7 +223,7 @@ def _get_driver_details(
 
 
 def _install_daqmx_driver_windows_core(download_url: str) -> None:
-    """Download and launch NI-DAQmx Driver installation in an interactive mode"""
+    """Download and launch NI-DAQmx Driver installation in an interactive mode."""
     _validate_download_url(download_url)
     try:
         with _multi_access_temp_file() as temp_file:
@@ -249,7 +249,7 @@ def _install_daqmx_driver_windows_core(download_url: str) -> None:
 
 
 def _install_daqmx_driver_linux_core(download_url: str, release: str) -> None:
-    """Download NI Linux Device Drivers and install NI-DAQmx on Linux OS"""
+    """Download NI Linux Device Drivers and install NI-DAQmx on Linux OS."""
     if sys.platform.startswith("linux"):
         _validate_download_url(download_url)
         try:
@@ -313,7 +313,7 @@ def _validate_download_url(download_url: str) -> None:
 
 
 def _ask_user_confirmation(user_message: str) -> bool:
-    """Prompt for user confirmation"""
+    """Prompt for user confirmation."""
     while True:
         response = input(user_message + " (yes/no): ").strip().lower()
         if response in ["yes", "y"]:

src/handwritten/_lib.py

@@ -56,8 +56,7 @@ def _setter(self, val):
 
 
 class CtypesByteString:
-    """Custom argtype that automatically converts unicode strings to encoding
-    used by the DAQmx C API DLL in Python 3."""
+    """Custom argtype that automatically converts unicode strings to encoding used by the C API."""
 
     @classmethod
     def from_param(cls, param):
@@ -70,8 +69,7 @@ def from_param(cls, param):
 
 
 def wrapped_ndpointer(*args, **kwargs):
-    """Specifies an ndpointer type that wraps numpy.ctypeslib.ndpointer and
-    allows a value of None to be passed to an argument of that type.
+    """Wraps numpy.ctypeslib.ndpointer in order to allow passing None.
 
     Taken from http://stackoverflow.com/questions/32120178
     """

src/handwritten/errors.py

@@ -28,9 +28,7 @@ class DaqNotSupportedError(Error):
 
 
 class DaqFunctionNotSupportedError(Error):
-    """Error raised when a specific function isn't supported by the installed
-    version of the NI-DAQmx driver.
-    """
+    """Error raised when a specific function isn't supported by the installed NI-DAQmx driver."""
 
     pass
 
@@ -40,7 +38,7 @@ class DaqError(Error):
 
     def __init__(self, message, error_code, task_name=""):
         """Initialize a new DaqError.
-        
+
         Args:
             message (string): Specifies the error message.
             error_code (int): Specifies the NI-DAQmx error code.
@@ -72,19 +70,16 @@ def error_code(self):
 
     @property
     def error_type(self):
-        """:class:`nidaqmx.error_codes.DAQmxErrors`: Specifies the NI-DAQmx
-            error type."""
+        """:class:`nidaqmx.error_codes.DAQmxErrors`: Specifies the NI-DAQmx error type."""
         return self._error_type
 
 
 class DaqReadError(DaqError):
-    """Error raised by DAQmx write method that includes the amount of data that was
-    read.
-    """
+    """Error raised by DAQmx write method that includes the amount of data that was read."""
 
     def __init__(self, message, error_code, samps_per_chan_read, task_name=""):
         """Initialize a new DaqReadError.
-        
+
         Args:
             message (string): Specifies the error message.
             error_code (int): Specifies the NI-DAQmx error code.
@@ -100,13 +95,11 @@ def samps_per_chan_read(self):
 
 
 class DaqWriteError(DaqError):
-    """Error raised by DAQmx write method that includes the amount of data that was
-    written.
-    """
+    """Error raised by DAQmx write method that includes the amount of data that was written."""
 
     def __init__(self, message, error_code, samps_per_chan_written, task_name=""):
         """Initialize a new DaqWriteError.
-        
+
         Args:
             message (string): Specifies the error message.
             error_code (int): Specifies the NI-DAQmx error code.
@@ -127,7 +120,7 @@ class DaqWarning(Warning):
 
     def __init__(self, message, error_code):
         """Initialize a new DaqWarning.
-        
+
         Args:
             message (string): Specifies the warning message.
             error_code (int): Specifies the NI-DAQmx error code.
@@ -148,8 +141,7 @@ def error_code(self):
 
     @property
     def error_type(self):
-        """:class:`nidaqmx.error_codes.DAQmxWarnings`: Specifies the NI-DAQmx
-            error type."""
+        """:class:`nidaqmx.error_codes.DAQmxWarnings`: Specifies the NI-DAQmx error type."""
         return self._error_type
 
 
@@ -191,7 +183,7 @@ def is_array_buffer_too_small(error_code):
 
 
 class RpcError(Error):
-    """An error specific to sessions to the NI gRPC Device Server"""
+    """An error specific to sessions to the NI gRPC Device Server."""
 
     def __init__(self, rpc_code, description):
         """Initialize a new RpcError."""

src/handwritten/grpc_session_options.py

@@ -56,7 +56,7 @@ def __init__(
         initialization_behavior=SessionInitializationBehavior.AUTO,
     ):
         """Initialize a new GrpcSessionOptions.
-        
+
         Args:
             grpc_channel (grpc.Channel): Specifies the channel to the NI gRPC Device Server.
             session_name (str): User-specified name that identifies the driver session on the NI gRPC Device

src/handwritten/stream_readers/_analog_multi_channel_reader.py

@@ -11,15 +11,12 @@
 
 
 class AnalogMultiChannelReader(ChannelReaderBase):
-    """Reads samples from one or more analog input channels in an NI-DAQmx
-    task.
-    """
+    """Reads samples from one or more analog input channels in an NI-DAQmx task."""
 
     def read_many_sample(
         self, data, number_of_samples_per_channel=READ_ALL_AVAILABLE, timeout=10.0
     ):
-        """Reads one or more floating-point samples from one or more analog
-        input channels in a task.
+        """Reads one or more floating-point samples from one or more analog input channels in a task.
 
         This read method accepts a preallocated NumPy array to hold the
         samples requested, which can be advantageous for performance and
@@ -105,8 +102,7 @@ def read_many_sample(
         return samps_per_chan_read
 
     def read_one_sample(self, data, timeout=10):
-        """Reads a single floating-point sample from one or more analog
-        input channels in a task.
+        """Reads a single floating-point sample from one or more analog input channels in a task.
 
         This read method accepts a preallocated NumPy array to hold the
         samples requested, which can be advantageous for performance and
@@ -149,8 +145,7 @@ def read_waveforms(
         reallocation_policy: ReallocationPolicy = ReallocationPolicy.TO_GROW,
         timeout: int = 10,
     ) -> int:
-        """Reads one or more floating-point samples from one or more analog
-        input channels into a list of waveforms.
+        """Reads one or more floating-point samples from one or more analog input channels into a list of waveforms.
 
         This read method optionally accepts a preallocated list of waveforms to hold
         the samples requested, which can be advantageous for performance and

src/handwritten/stream_readers/_analog_single_channel_reader.py

@@ -11,14 +11,12 @@
 
 
 class AnalogSingleChannelReader(ChannelReaderBase):
-    """Reads samples from an analog input channel in an NI-DAQmx task.
-    """
+    """Reads samples from an analog input channel in an NI-DAQmx task."""
 
     def read_many_sample(
         self, data, number_of_samples_per_channel=READ_ALL_AVAILABLE, timeout=10.0
     ):
-        """Reads one or more floating-point samples from a single analog
-        input channel in a task.
+        """Reads one or more floating-point samples from a single analog input channel in a task.
 
         This read method accepts a preallocated NumPy array to hold the
         samples requested, which can be advantageous for performance and
@@ -91,8 +89,7 @@ def read_many_sample(
         return samps_per_chan_read
 
     def read_one_sample(self, timeout=10):
-        """Reads a single floating-point sample from a single analog input
-        channel in a task.
+        """Reads a single floating-point sample from a single analog input channel in a task.
 
         Args:
             timeout (Optional[float]): Specifies the amount of time in
@@ -120,8 +117,7 @@ def read_waveform(
         reallocation_policy: ReallocationPolicy = ReallocationPolicy.TO_GROW,
         timeout: int = 10,
     ) -> int:
-        """Reads one or more floating-point samples from a single analog
-        input channel into a waveform.
+        """Reads one or more floating-point samples from a single analog input channel into a waveform.
 
         This read method optionally accepts a preallocated waveform to hold
         the samples requested, which can be advantageous for performance and

src/handwritten/stream_readers/_analog_unscaled_reader.py

@@ -5,13 +5,10 @@
 
 
 class AnalogUnscaledReader(ChannelReaderBase):
-    """Reads unscaled samples from one or more analog input channels in an
-    NI-DAQmx task.
-    """
+    """Reads unscaled samples from one or more analog input channels in an NI-DAQmx task."""
 
     def read_int16(self, data, number_of_samples_per_channel=READ_ALL_AVAILABLE, timeout=10.0):
-        """Reads one or more unscaled 16-bit integer samples from one or
-        more analog input channels in a task.
+        """Reads one or more unscaled 16-bit integer samples from one or more analog input channels in a task.
 
         This read method accepts a preallocated NumPy array to hold the
         samples requested, which can be advantageous for performance and
@@ -97,8 +94,7 @@ def read_int16(self, data, number_of_samples_per_channel=READ_ALL_AVAILABLE, tim
         return samps_per_chan_read
 
     def read_int32(self, data, number_of_samples_per_channel=READ_ALL_AVAILABLE, timeout=10.0):
-        """Reads one or more unscaled 32-bit integer samples from one or
-        more analog input channels in a task.
+        """Reads one or more unscaled 32-bit integer samples from one or more analog input channels in a task.
 
         This read method accepts a preallocated NumPy array to hold the
         samples requested, which can be advantageous for performance and
@@ -184,8 +180,7 @@ def read_int32(self, data, number_of_samples_per_channel=READ_ALL_AVAILABLE, tim
         return samps_per_chan_read
 
     def read_uint16(self, data, number_of_samples_per_channel=READ_ALL_AVAILABLE, timeout=10.0):
-        """Reads one or more unscaled 16-bit unsigned integer samples from
-        one or more analog input channels in a task.
+        """Reads one or more unscaled 16-bit unsigned integer samples from one or more analog input channels in a task.
 
         This read method accepts a preallocated NumPy array to hold the
         samples requested, which can be advantageous for performance and
@@ -271,8 +266,7 @@ def read_uint16(self, data, number_of_samples_per_channel=READ_ALL_AVAILABLE, ti
         return samps_per_chan_read
 
     def read_uint32(self, data, number_of_samples_per_channel=READ_ALL_AVAILABLE, timeout=10.0):
-        """Reads one or more unscaled unsigned 32-bit integer samples from
-        one or more analog input channels in a task.
+        """Reads one or more unscaled unsigned 32-bit integer samples from one or more analog input channels in a task.
 
         This read method accepts a preallocated NumPy array to hold the
         samples requested, which can be advantageous for performance and

src/handwritten/stream_readers/_channel_reader_base.py

@@ -5,12 +5,11 @@
 
 
 class ChannelReaderBase:
-    """Defines base class for all NI-DAQmx stream readers.
-    """
+    """Defines base class for all NI-DAQmx stream readers."""
 
     def __init__(self, task_in_stream):
         """Initialize a new ChannelReaderBase.
-        
+
         Args:
             task_in_stream: Specifies the input stream associated with
                 an NI-DAQmx task from which to read samples.
@@ -24,12 +23,12 @@ def __init__(self, task_in_stream):
 
     @property
     def verify_array_shape(self):
-        """bool: Indicates whether the size and shape of the user-defined
-            NumPy arrays passed to read methods are verified. Defaults
-            to True when this object is instantiated.
+        """bool: Specifies whether to verify the shape of NumPy arrays.
+
+        Defaults to True when this object is instantiated.
 
-            Setting this property to True may marginally adversely
-            impact the performance of read methods.
+        Setting this property to True may marginally adversely
+        impact the performance of read methods.
         """
         return self._verify_array_shape
 
@@ -38,7 +37,9 @@ def verify_array_shape(self, val):
         self._verify_array_shape = val
 
     def _verify_array(self, data, number_of_samples_per_channel, is_many_chan, is_many_samp):
-        """Verifies that the shape of the specified NumPy array can be used
+        """Verify the shape of a NumPy array.
+
+        Verifies that the shape of the specified NumPy array can be used
         to read multiple samples from the current task which contains
         one or more channels, if the "verify_array_shape" property is
         set to True.
@@ -82,7 +83,9 @@ def _verify_array(self, data, number_of_samples_per_channel, is_many_chan, is_ma
             )
 
     def _verify_array_digital_lines(self, data, is_many_chan, is_many_line):
-        """Verifies that the shape of the specified NumPy array can be used
+        """Verify the shape of a NumPy array of digital lines.
+
+        Verifies that the shape of the specified NumPy array can be used
         to read samples from the current task which contains one or more
         channels that have one or more digital lines per channel, if the
         "verify_array_shape" property is set to True.