handwritten: Fix D212 Multi-line docstring summary should start at the first line

Author: bkeryan

src/handwritten/_bitfield_utils.py

@@ -1,6 +1,5 @@
 def enum_bitfield_to_list(bitfield_value, bitfield_enum_type, actual_enum_type):
-    """
-    Converts a bitfield value to a list of enums.
+    """Converts a bitfield value to a list of enums.
 
     Args:
         bitfield_value (int): Specifies the value of the bitfield.
@@ -20,8 +19,7 @@ def enum_bitfield_to_list(bitfield_value, bitfield_enum_type, actual_enum_type):
 
 
 def enum_list_to_bitfield(enum_list, bitfield_enum_type):
-    """
-    Converts a list of enums to a bitfield value.
+    """Converts a list of enums to a bitfield value.
 
     Args:
         enum_list (List[enum.Enum]): Specifies the list of enums.

src/handwritten/_install_daqmx.py

@@ -37,8 +37,7 @@
 
 
 def _parse_version(version: str) -> tuple[int, ...]:
-    """
-    Split the version string into a tuple of integers.
+    """Split the version string into a tuple of integers.
 
     >>> _parse_version("23.8.0")
     (23, 8, 0)
@@ -57,10 +56,7 @@ def _parse_version(version: str) -> tuple[int, ...]:
 
 
 def _get_daqmx_installed_version() -> str | None:
-    """
-    Check for existing installation of NI-DAQmx.
-
-    """
+    """Check for existing installation of NI-DAQmx."""
     if sys.platform.startswith("win"):
         try:
             _logger.debug("Reading the registry entries to get installed DAQmx version")
@@ -130,10 +126,7 @@ def _get_daqmx_installed_version() -> str | None:
 # Creating a temp file that we then close and yield - this is used to allow subprocesses to access
 @contextlib.contextmanager
 def _multi_access_temp_file(*, suffix: str = ".exe", delete: bool = True) -> Generator[str]:
-    """
-    Context manager for creating a temporary file.
-
-    """
+    """Context manager for creating a temporary file."""
     try:
         temp_file = tempfile.NamedTemporaryFile(suffix=suffix, delete=False, mode="w")
         temp_file.close()
@@ -161,8 +154,7 @@ def _multi_access_temp_file(*, suffix: str = ".exe", delete: bool = True) -> Gen
 def _load_data(
     json_data: str, platform: str
 ) -> tuple[str | None, str | None, str | None, list[str] | None]:
-    """
-    Load data from JSON string and extract Windows metadata.
+    """Load data from JSON string and extract Windows metadata.
 
     >>> json_data = '{"Windows": [{"Location": "path/to/windows/driver", "Version": "24.0", "Release": "2024Q1", "supportedOS": ["Windows 11"]}], "Linux": []}'
     >>> _load_data(json_data, "Windows")
@@ -214,10 +206,7 @@ def _load_data(
 def _get_driver_details(
     platform: str,
 ) -> tuple[str | None, str | None, str | None, list[str] | None]:
-    """
-    Parse the JSON data and retrieve the download link and version information.
-
-    """
+    """Parse the JSON data and retrieve the download link and version information."""
     try:
         with pkg_resources.open_text(__package__, METADATA_FILE) as json_file:
             _logger.debug("Opening the metadata file %s.", METADATA_FILE)
@@ -234,10 +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:
@@ -263,10 +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:
@@ -330,10 +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"]:
@@ -349,10 +329,7 @@ def _upgrade_daqmx_user_confirmation(
     latest_version: str,
     release: str,
 ) -> bool:
-    """
-    Confirm with the user and return the user response.
-
-    """
+    """Confirm with the user and return the user response."""
     _logger.debug("Entering _upgrade_daqmx_user_confirmation")
     installed_parts = _parse_version(installed_version)
     latest_parts = _parse_version(latest_version)
@@ -371,21 +348,15 @@ def _fresh_install_daqmx_user_confirmation(
     latest_version: str,
     release: str,
 ) -> bool:
-    """
-    Confirm with the user and return the user response.
-
-    """
+    """Confirm with the user and return the user response."""
     _logger.debug("Entering _fresh_install_daqmx_user_confirmation")
     return _ask_user_confirmation(
         f"Latest NI-DAQmx version available is {latest_version} ({release}). Do you want to install?"
     )
 
 
 def _is_distribution_supported() -> None:
-    """
-    Raises an exception if the linux distribution and its version are not supported.
-
-    """
+    """Raises an exception if the linux distribution and its version are not supported."""
     if sys.platform.startswith("linux"):
         dist_name = distro.id()
         dist_version = distro.version()
@@ -409,10 +380,7 @@ def _is_distribution_supported() -> None:
 
 
 def _install_daqmx_driver():
-    """
-    Install the NI-DAQmx driver.
-
-    """
+    """Install the NI-DAQmx driver."""
     if sys.platform.startswith("win"):
         _logger.info("Windows platform detected")
         platform = "Windows"
@@ -453,10 +421,7 @@ def _install_daqmx_driver():
 
 
 def installdriver() -> None:
-    """
-    Download and launch NI-DAQmx Driver installation in an interactive mode.
-
-    """
+    """Download and launch NI-DAQmx Driver installation in an interactive mode."""
     try:
         _install_daqmx_driver()
     except click.ClickException:

src/handwritten/_lib.py

@@ -38,9 +38,7 @@
 
 
 class c_bool32(ctypes.c_uint):
-    """
-    Specifies a custom ctypes data type to represent 32-bit booleans.
-    """
+    """Specifies a custom ctypes data type to represent 32-bit booleans."""
 
     # typeshed specifies that _SimpleCData[_T].value is an instance variable with type _T, so
     # accessing it with the descriptor protocol via its class results in "error: Access to generic
@@ -58,10 +56,8 @@ 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 DAQmx C API DLL in Python 3."""
 
     @classmethod
     def from_param(cls, param):
@@ -74,8 +70,7 @@ def from_param(cls, param):
 
 
 def wrapped_ndpointer(*args, **kwargs):
-    """
-    Specifies an ndpointer type that wraps numpy.ctypeslib.ndpointer and
+    """Specifies an ndpointer type that wraps numpy.ctypeslib.ndpointer and
     allows a value of None to be passed to an argument of that type.
 
     Taken from http://stackoverflow.com/questions/32120178
@@ -91,8 +86,7 @@ def from_param(cls, obj):
 
 
 class DaqFunctionImporter:
-    """
-    Wraps the function getter function of a ctypes library.
+    """Wraps the function getter function of a ctypes library.
 
     Allows the NI-DAQmx Python API to fail elegantly if a function is not
     supported in the current version of the API.
@@ -132,17 +126,13 @@ def __getattr__(self, function):
 
 
 def get_encoding_from_locale() -> str:
-    """
-    Gets the current locale encoding handling cases where it is unset.
-    """
+    """Gets the current locale encoding handling cases where it is unset."""
     _, encoding = locale.getlocale()
     return encoding or "ascii"
 
 
 class DaqLibImporter:
-    """
-    Encapsulates NI-DAQmx library importing and handle type parsing logic.
-    """
+    """Encapsulates NI-DAQmx library importing and handle type parsing logic."""
 
     def __init__(self):
         self._windll = None
@@ -178,9 +168,7 @@ def encoding(self):
         return self._encoding
 
     def _import_lib(self):
-        """
-        Determines the location of and loads the NI-DAQmx CAI DLL.
-        """
+        """Determines the location of and loads the NI-DAQmx CAI DLL."""
         self._windll = None
         self._cdll = None
         self._encoding = None

src/handwritten/_linux_installation_commands.py

@@ -79,10 +79,7 @@ class DistroInfo:
 def get_linux_installation_commands(
     _directory_to_extract_to: str, dist_name: str, dist_version: str, _release_string: str
 ) -> list[list[str]]:
-    """
-    Get the installation commands for Linux based on the distribution.
-
-    """
+    """Get the installation commands for Linux based on the distribution."""
     if dist_name not in LINUX_COMMANDS:
         raise ValueError(f"Unsupported distribution '{dist_name}'")