handwritten: nps acknowledge-existing-violations --aggressive

Author: bkeryan

src/handwritten/__init__.py

@@ -7,7 +7,7 @@
     DaqWarning,
     DaqWriteError,
 )
-from nidaqmx.grpc_session_options import *
+from nidaqmx.grpc_session_options import *  # noqa: F403 - 'from nidaqmx.grpc_session_options import *' used; unable to detect undefined names (auto-generated noqa)
 from nidaqmx.scale import Scale
 from nidaqmx.task import Task
 from nidaqmx.types import CtrFreq, CtrTick, CtrTime
@@ -19,7 +19,13 @@
 
 __version__ = version(__name__)
 
-__all__ = ["errors", "scale", "stream_readers", "stream_writers", "task"]
+__all__ = [  # noqa: F405 - 'errors' may be undefined, or defined from star imports: nidaqmx.grpc_session_options (auto-generated noqa)
+    "errors",
+    "scale",
+    "stream_readers",
+    "stream_writers",
+    "task",
+]
 
 # Do not add a null logging handler. If the application has not configured logging, the
 # default behavior is to log warnings and errors to stderr.

src/handwritten/__main__.py

@@ -17,12 +17,14 @@
     count=True,
     help="Enable verbose logging. Repeat to increase verbosity.",
 )
-def main(verbosity: int) -> None:
+def main(  # noqa: D103 - Missing docstring in public function (auto-generated noqa)
+    verbosity: int,
+) -> None:
     _configure_logging(verbosity)
 
 
 @main.command()
-def installdriver():
+def installdriver():  # noqa: D103 - Missing docstring in public function (auto-generated noqa)
     _install_daqmx.installdriver()
 
 

src/handwritten/_grpc_time.py

@@ -20,7 +20,7 @@
 _EPOCH_1970 = ht_datetime(1970, 1, 1, tzinfo=timezone.utc)
 
 
-def convert_time_to_timestamp(
+def convert_time_to_timestamp(  # noqa: D103 - Missing docstring in public function (auto-generated noqa)
     dt: std_datetime | ht_datetime, ts: GrpcTimestamp | None = None
 ) -> GrpcTimestamp:
     seconds_since_1970 = 0
@@ -45,7 +45,9 @@ def convert_time_to_timestamp(
     return ts
 
 
-def convert_timestamp_to_time(ts: GrpcTimestamp, tzinfo: dt_tzinfo | None = None) -> ht_datetime:
+def convert_timestamp_to_time(  # noqa: D103 - Missing docstring in public function (auto-generated noqa)
+    ts: GrpcTimestamp, tzinfo: dt_tzinfo | None = None
+) -> ht_datetime:
     total_nanos = ts.ToNanoseconds()
     seconds, nanos = divmod(total_nanos, _NS_PER_S)
     # Convert the nanoseconds to yoctoseconds.

src/handwritten/_install_daqmx.py

@@ -176,7 +176,7 @@ def _load_data(
     Traceback (most recent call last):
     click.exceptions.ClickException: Unsupported os 'macOS'
 
-    """
+    """  # noqa: W505 - doc line too long (159 > 100 characters) (auto-generated noqa)
     try:
         if platform == "Windows":
             metadata = json.loads(json_data).get("Windows", [])

src/handwritten/_lib.py

@@ -36,7 +36,9 @@
 )
 
 
-class c_bool32(ctypes.c_uint):
+class c_bool32(  # noqa: N801 - class name 'c_bool32' should use CapWords convention (auto-generated noqa)
+    ctypes.c_uint
+):
     """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
@@ -58,7 +60,9 @@ class CtypesByteString:
     """Custom argtype that automatically converts unicode strings to encoding used by the C API."""
 
     @classmethod
-    def from_param(cls, param):
+    def from_param(  # noqa: D102 - Missing docstring in public method (auto-generated noqa)
+        cls, param
+    ):
         if isinstance(param, str):
             param = param.encode(lib_importer.encoding)
         return ctypes.c_char_p(param)
@@ -94,7 +98,9 @@ def __init__(self, library):
         self._library = library
         self._lib_lock = threading.Lock()
 
-    def __getattr__(self, function):
+    def __getattr__(  # noqa: D105 - Missing docstring in magic method (auto-generated noqa)
+        self, function
+    ):
         try:
             cfunc = getattr(self._library, function)
             if not hasattr(cfunc, "arglock"):
@@ -141,27 +147,31 @@ def __init__(self):
         self._encoding = None
 
     @property
-    def windll(self):
+    def windll(self):  # noqa: D102 - Missing docstring in public method (auto-generated noqa)
         if self._windll is None:
             self._import_lib()
         return self._windll
 
     @property
-    def cdll(self):
+    def cdll(self):  # noqa: D102 - Missing docstring in public method (auto-generated noqa)
         if self._cdll is None:
             self._import_lib()
         return self._cdll
 
     @property
-    def task_handle(self) -> type:
+    def task_handle(  # noqa: D102 - Missing docstring in public method (auto-generated noqa)
+        self,
+    ) -> type:
         return TaskHandle
 
     @property
-    def cal_handle(self) -> type:
+    def cal_handle(  # noqa: D102 - Missing docstring in public method (auto-generated noqa)
+        self,
+    ) -> type:
         return CalHandle
 
     @property
-    def encoding(self):
+    def encoding(self):  # noqa: D102 - Missing docstring in public method (auto-generated noqa)
         if self._encoding is None:
             self._import_lib()
         return self._encoding

src/handwritten/_lib_time.py

@@ -10,7 +10,9 @@
 
 
 @functools.total_ordering
-class AbsoluteTime(ctypes.Structure):
+class AbsoluteTime(  # noqa: D101 - Missing docstring in public class (auto-generated noqa)
+    ctypes.Structure
+):
     # Please visit ni.com/info and enter the Info Code NI_BTF for detailed information.
     # The summary is:
     #    * lsb - positive fractions (2^-64) of a second
@@ -33,7 +35,9 @@ class AbsoluteTime(ctypes.Structure):
     _EPOCH_1904 = ht_datetime(1904, 1, 1, tzinfo=timezone.utc)
 
     @classmethod
-    def from_datetime(cls, dt: std_datetime | ht_datetime) -> AbsoluteTime:
+    def from_datetime(  # noqa: D102 - Missing docstring in public method (auto-generated noqa)
+        cls, dt: std_datetime | ht_datetime
+    ) -> AbsoluteTime:
         seconds_since_1904 = 0
 
         # Convert the subseconds.
@@ -51,7 +55,9 @@ def from_datetime(cls, dt: std_datetime | ht_datetime) -> AbsoluteTime:
 
         return AbsoluteTime(lsb=lsb, msb=seconds_since_1904)
 
-    def to_datetime(self, tzinfo: dt_tzinfo | None = None) -> ht_datetime:
+    def to_datetime(  # noqa: D102 - Missing docstring in public method (auto-generated noqa)
+        self, tzinfo: dt_tzinfo | None = None
+    ) -> ht_datetime:
         total_yoctoseconds = int(
             round(AbsoluteTime._YS_PER_S * self.lsb / AbsoluteTime._NUM_SUBSECONDS)
         )
@@ -62,13 +68,19 @@ def to_datetime(self, tzinfo: dt_tzinfo | None = None) -> ht_datetime:
         )
         return _convert_to_desired_timezone(dt, tzinfo)
 
-    def __str__(self) -> str:
+    def __str__(  # noqa: D105 - Missing docstring in magic method (auto-generated noqa)
+        self,
+    ) -> str:
         return f"AbsoluteTime(lsb=0x{self.lsb:x}, msb=0x{self.msb:x})"
 
-    def __eq__(self, other) -> bool:
+    def __eq__(  # noqa: D105 - Missing docstring in magic method (auto-generated noqa)
+        self, other
+    ) -> bool:
         return self.msb == other.msb and self.lsb == other.lsb
 
-    def __lt__(self, other) -> bool:
+    def __lt__(  # noqa: D105 - Missing docstring in magic method (auto-generated noqa)
+        self, other
+    ) -> bool:
         if self.msb == other.msb:
             return self.lsb < other.lsb
         else:

src/handwritten/_linux_installation_commands.py

@@ -60,7 +60,7 @@ def _get_version_rhel(dist_version: str) -> str:
 
 
 @dataclass
-class DistroInfo:
+class DistroInfo:  # noqa: D101 - Missing docstring in public class (auto-generated noqa)
     get_distro_version: Callable[[str], str]
     get_daqmx_version: list[str]
     install_commands: list[list[str]]

src/handwritten/_time.py

@@ -25,7 +25,7 @@ def _convert_to_desired_timezone(
         desired_expected_time = tzinfo.fromutc(localized_time)
         return desired_expected_time
 
-    # if the tzinfo passed in is a timedelta function, then we don't need to consider daylight savings
+    # if the tzinfo passed in is a timedelta function, then we don't need to consider daylight savings  # noqa: W505 - doc line too long (102 > 100 characters) (auto-generated noqa)
     elif tzinfo.utcoffset(None) is not None:
         current_time_utc = ht_datetime.now(timezone.utc)
         desired_timezone_offset = current_time_utc.astimezone(tz=tzinfo).utcoffset()

src/handwritten/errors.py

@@ -42,7 +42,7 @@ def __init__(self, message, error_code, task_name=""):
         Args:
             message (string): Specifies the error message.
             error_code (int): Specifies the NI-DAQmx error code.
-        """
+        """  # noqa: D417 - Missing argument descriptions in the docstring (auto-generated noqa)
         self._error_code = int(error_code)
 
         try:
@@ -57,7 +57,7 @@ def __init__(self, message, error_code, task_name=""):
         if task_name:
             message = f"{message}\n\nTask Name: {task_name}"
 
-        # We do not know where the error description came from, so we add the status code if it is not already in the message
+        # We do not know where the error description came from, so we add the status code if it is not already in the message  # noqa: W505 - doc line too long (125 > 100 characters) (auto-generated noqa)
         if str(self._error_code) not in message:
             message = f"{message}\n\nStatus Code: {self._error_code}"
 
@@ -83,7 +83,7 @@ def __init__(self, message, error_code, samps_per_chan_read, task_name=""):
         Args:
             message (string): Specifies the error message.
             error_code (int): Specifies the NI-DAQmx error code.
-        """
+        """  # noqa: D417 - Missing argument descriptions in the docstring (auto-generated noqa)
         super().__init__(message, error_code, task_name)
 
         self._samps_per_chan_read = samps_per_chan_read
@@ -104,7 +104,7 @@ def __init__(self, message, error_code, samps_per_chan_written, task_name=""):
             message (string): Specifies the error message.
             error_code (int): Specifies the NI-DAQmx error code.
             samps_per_chan_written (int): Specifies the number of samples written.
-        """
+        """  # noqa: D417 - Missing argument descriptions in the docstring (auto-generated noqa)
         super().__init__(message, error_code, task_name)
 
         self._samps_per_chan_written = samps_per_chan_written

src/handwritten/grpc_session_options.py

@@ -10,7 +10,7 @@
 
 
 # This constant specifies the gRPC package and service used by this API.
-# Customers can pass this value to the MeasurementLink discovery service to resolve the server instance that provides this interface.
+# Customers can pass this value to the MeasurementLink discovery service to resolve the server instance that provides this interface.  # noqa: W505 - doc line too long (133 > 100 characters) (auto-generated noqa)
 GRPC_SERVICE_INTERFACE_NAME = "nidaqmx_grpc.NiDAQmx"
 
 # This constant specifies the API license key required by the NI gRPC Device Server that comes with
@@ -29,21 +29,21 @@ class SessionInitializationBehavior(IntEnum):
     When using the Session as a context manager and the context exits, the behavior depends on what happened when the constructor
     was called. If it resulted in a new session being initialized on the NI gRPC Device Server, then it will automatically close the
     server session. If it instead attached to an existing session, then it will detach from the server session and leave it open.
-    """
+    """  # noqa: W505 - doc line too long (123 > 100 characters) (auto-generated noqa)
     INITIALIZE_SERVER_SESSION = 1
     r"""
     Require the NI gRPC Device Server to initialize a new session with the specified name.
     Note:
     When using the Session as a context manager and the context exits, it will automatically close the
     server session.
-    """
+    """  # noqa: W505 - doc line too long (102 > 100 characters) (auto-generated noqa)
     ATTACH_TO_SERVER_SESSION = 2
     r"""
     Require the NI gRPC Device Server to attach to an existing session with the specified name.
     Note:
     When using the Session as a context manager and the context exits, it will detach from the server session
     and leave it open.
-    """
+    """  # noqa: W505 - doc line too long (109 > 100 characters) (auto-generated noqa)
 
 
 class GrpcSessionOptions:
@@ -70,7 +70,7 @@ def __init__(
             initialization_behavior (enum): Specifies whether it is acceptable to initialize a new
                 session or attach to an existing one, or if only one of the behaviors is desired.
                 The driver session exists on the NI gRPC Device Server.
-        """
+        """  # noqa: W505 - doc line too long (108 > 100 characters) (auto-generated noqa)
         self.grpc_channel = grpc_channel
         self.session_name = session_name
         self.api_key = api_key