make errors and warnings ints (#150)

* make errors and warnings ints * clean up error code * contributing
ni · Feb 15, 2022 · 2a3e0c3 · 2a3e0c3
1 parent ffe817b
commit 2a3e0c3
Show file tree

Hide file tree

Showing 13 changed files with 26 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,7 @@ All notable changes to this project will be documented in this file.
     * [64: nidaqmx-python and pynidaqmx projects use the same package name](https://github.com/ni/nidaqmx-python/issues/64)
     * [65: ci_count_edges.py REQUIRES A START COMMAND](https://github.com/ni/nidaqmx-python/issues/65)
     * [100: How to clear task and create a new task with same name?](https://github.com/ni/nidaqmx-python/issues/100)
+    * [101: Use IntEnum instead of Enum](https://github.com/ni/nidaqmx-python/issues/101)
     * [102: handle types and daqmx versions](https://github.com/ni/nidaqmx-python/issues/102)
     * [117: Error in example](https://github.com/ni/nidaqmx-python/issues/117)
     * [131: task.write for COUNTER_OUTPUT - UsageTypeCO.PULSE_FREQUENCY has frequency and duty cycle reversed](https://github.com/ni/nidaqmx-python/issues/131)

diff --git a/nidaqmx/_task_modules/channel_collection.py b/nidaqmx/_task_modules/channel_collection.py
@@ -65,14 +65,14 @@ def __getitem__(self, index):
         else:
             raise DaqError(
                 'Invalid index type "{0}" used to access channels.'
-                .format(type(index)), DAQmxErrors.UNKNOWN.value)
+                .format(type(index)), DAQmxErrors.UNKNOWN)
 
         if channel_names:
             return Channel._factory(self._handle, channel_names)
         else:
             raise DaqError(
                 'You cannot specify an empty index when indexing channels.\n'
-                'Index used: {0}'.format(index), DAQmxErrors.UNKNOWN.value)
+                'Index used: {0}'.format(index), DAQmxErrors.UNKNOWN)
 
     def __hash__(self):
         return hash(self._handle.value)

diff --git a/nidaqmx/error_codes.py b/nidaqmx/error_codes.py
@@ -1,11 +1,11 @@
 # Do not edit this file; it was automatically generated.
 
-from enum import Enum
+from enum import IntEnum
 
 __all__ = ['DAQmxErrors', 'DAQmxWarnings']
 
 
-class DAQmxErrors(Enum):
+class DAQmxErrors(IntEnum):
     MULTI_TASK_CFG_SAMP_RATE_NOT_SUPPORTED_WITH_PROP_SET = -209886
     MULTI_TASK_CFG_SAMP_RATE_CONFLICTING_PROP = -209885
     NO_COMMON_SAMP_RATE_FOUND_NO_REPEAT_SAMPS = -209884
@@ -1746,7 +1746,7 @@ class DAQmxErrors(Enum):
     UNKNOWN = -1
 
 
-class DAQmxWarnings(Enum):
+class DAQmxWarnings(IntEnum):
     UNKNOWN = -1
     TIMESTAMP_COUNTER_ROLLED_OVER = 200003
     INPUT_TERMINATION_OVERLOADED = 200004

diff --git a/nidaqmx/errors.py b/nidaqmx/errors.py
@@ -28,7 +28,7 @@ def __init__(self, message, error_code, task_name=''):
 
         super(DaqError, self).__init__(message)
 
-        self._error_code = error_code
+        self._error_code = int(error_code)
 
         try:
             self._error_type = DAQmxErrors(self._error_code)
@@ -64,7 +64,7 @@ def __init__(self, message, error_code):
         super(DaqWarning, self).__init__(
             '\nWarning {0} occurred.\n\n{1}'.format(error_code, message))
 
-        self._error_code = error_code
+        self._error_code = int(error_code)
 
         try:
             self._error_type = DAQmxWarnings(self._error_code)
@@ -138,9 +138,9 @@ def check_for_error(error_code):
 
 def is_string_buffer_too_small(error_code):
     return (
-        error_code == DAQmxErrors.BUFFER_TOO_SMALL_FOR_STRING.value or
-        error_code == DAQmxWarnings.CAPI_STRING_TRUNCATED_TO_FIT_BUFFER.value)
+        error_code == DAQmxErrors.BUFFER_TOO_SMALL_FOR_STRING or
+        error_code == DAQmxWarnings.CAPI_STRING_TRUNCATED_TO_FIT_BUFFER)
 
 
 def is_array_buffer_too_small(error_code):
-    return error_code == DAQmxErrors.WRITE_BUFFER_TOO_SMALL.value
+    return error_code == DAQmxErrors.WRITE_BUFFER_TOO_SMALL
diff --git a/nidaqmx/stream_readers.py b/nidaqmx/stream_readers.py
@@ -94,7 +94,7 @@ def _verify_array(self, data, number_of_samples_per_channel,
                 'Shape of NumPy Array provided: {0}\n'
                 'Shape of NumPy Array required: {1}'
                 .format(data.shape, array_shape),
-                DAQmxErrors.UNKNOWN.value, task_name=self._task.name)
+                DAQmxErrors.UNKNOWN, task_name=self._task.name)
 
     def _verify_array_digital_lines(
             self, data, is_many_chan, is_many_line):
@@ -138,7 +138,7 @@ def _verify_array_digital_lines(
                 'Shape of NumPy Array provided: {0}\n'
                 'Shape of NumPy Array required: {1}'
                 .format(data.shape, array_shape),
-                DAQmxErrors.UNKNOWN.value, task_name=self._task.name)
+                DAQmxErrors.UNKNOWN, task_name=self._task.name)
 
 
 class AnalogSingleChannelReader(ChannelReaderBase):

diff --git a/nidaqmx/stream_writers.py b/nidaqmx/stream_writers.py
@@ -183,7 +183,7 @@ def _raise_error_if_invalid_write_dimensions(
                 'No. of dimensions of NumPy Array provided: {0}\n'
                 'No. of dimensions of NumPy Array required: {1}'
                 .format(num_dimensions_in_data, num_dimensions_expected),
-                DAQmxErrors.UNKNOWN.value, task_name=self._task.name)
+                DAQmxErrors.UNKNOWN, task_name=self._task.name)
 
 
 class AnalogSingleChannelWriter(ChannelWriterBase):

diff --git a/nidaqmx/system/_collections/device_collection.py b/nidaqmx/system/_collections/device_collection.py
@@ -63,7 +63,7 @@ def __getitem__(self, index):
         else:
             raise DaqError(
                 'Invalid index type "{0}" used to access collection.'
-                .format(type(index)), DAQmxErrors.UNKNOWN.value)
+                .format(type(index)), DAQmxErrors.UNKNOWN)
 
     def __iter__(self):
         for device_name in self.device_names:

diff --git a/nidaqmx/system/_collections/persisted_channel_collection.py b/nidaqmx/system/_collections/persisted_channel_collection.py
@@ -65,7 +65,7 @@ def __getitem__(self, index):
         else:
             raise DaqError(
                 'Invalid index type "{0}" used to access collection.'
-                .format(type(index)), DAQmxErrors.UNKNOWN.value)
+                .format(type(index)), DAQmxErrors.UNKNOWN)
 
     def __iter__(self):
         for channel_name in self.global_channel_names:

diff --git a/nidaqmx/system/_collections/persisted_scale_collection.py b/nidaqmx/system/_collections/persisted_scale_collection.py
@@ -64,7 +64,7 @@ def __getitem__(self, index):
         else:
             raise DaqError(
                 'Invalid index type "{0}" used to access collection.'
-                .format(type(index)), DAQmxErrors.UNKNOWN.value)
+                .format(type(index)), DAQmxErrors.UNKNOWN)
 
     def __iter__(self):
         for scale_name in self.scale_names:

diff --git a/nidaqmx/system/_collections/persisted_task_collection.py b/nidaqmx/system/_collections/persisted_task_collection.py
@@ -64,7 +64,7 @@ def __getitem__(self, index):
         else:
             raise DaqError(
                 'Invalid index type "{0}" used to access collection.'
-                .format(type(index)), DAQmxErrors.UNKNOWN.value)
+                .format(type(index)), DAQmxErrors.UNKNOWN)
 
     def __iter__(self):
         for task_name in self.task_names:

diff --git a/nidaqmx/system/_collections/physical_channel_collection.py b/nidaqmx/system/_collections/physical_channel_collection.py
@@ -66,7 +66,7 @@ def __getitem__(self, index):
         else:
             raise DaqError(
                 'Invalid index type "{0}" used to access collection.'
-                .format(type(index)), DAQmxErrors.UNKNOWN.value)
+                .format(type(index)), DAQmxErrors.UNKNOWN)
 
     def __iter__(self):
         for channel_name in self.channel_names:

diff --git a/nidaqmx/task.py b/nidaqmx/task.py
@@ -689,7 +689,7 @@ def read(self, number_of_samples_per_channel=NUM_SAMPLES_UNSET,
             raise DaqError(
                 'Read failed, because there are no channels in this task from '
                 'which data can be read.',
-                DAQmxErrors.READ_NO_INPUT_CHANS_IN_TASK.value,
+                DAQmxErrors.READ_NO_INPUT_CHANS_IN_TASK,
                 task_name=self.name)
 
         if (read_chan_type == ChannelType.COUNTER_INPUT and
@@ -1078,7 +1078,7 @@ def _raise_invalid_num_lines_error(
             'Number of Lines Per Channel in Task: {0}\n'
             'Number of Lines Per Channel in Data: {1}'
             .format(num_lines_expected, num_lines_in_data),
-            DAQmxErrors.NUM_LINES_MISMATCH_IN_READ_OR_WRITE.value,
+            DAQmxErrors.NUM_LINES_MISMATCH_IN_READ_OR_WRITE,
             task_name=self.name)
 
     def _raise_invalid_write_num_chans_error(
@@ -1093,7 +1093,7 @@ def _raise_invalid_write_num_chans_error(
             'Number of Channels in Task: {0}\n'
             'Number of Channels in Data: {1}'
             .format(number_of_channels, number_of_channels_in_data),
-            DAQmxErrors.WRITE_NUM_CHANS_MISMATCH.value, task_name=self.name)
+            DAQmxErrors.WRITE_NUM_CHANS_MISMATCH, task_name=self.name)
 
     def write(self, data, auto_start=AUTO_START_UNSET, timeout=10.0):
         """
@@ -1239,7 +1239,7 @@ def write(self, data, auto_start=AUTO_START_UNSET, timeout=10.0):
                         'boolean samples when there is one digital line per '
                         'channel in a task.\n\n'
                         'Requested sample type: {0}'.format(type(element)),
-                        DAQmxErrors.UNKNOWN.value, task_name=self.name)
+                        DAQmxErrors.UNKNOWN, task_name=self.name)
 
                 data = numpy.asarray(data, dtype=bool)
                 return _write_digital_lines(
@@ -1253,7 +1253,7 @@ def write(self, data, auto_start=AUTO_START_UNSET, timeout=10.0):
                         'unsigned 32-bit integer samples when there are '
                         'multiple digital lines per channel in a task.\n\n'
                         'Requested sample type: {0}'.format(type(element)),
-                        DAQmxErrors.UNKNOWN.value, task_name=self.name)
+                        DAQmxErrors.UNKNOWN, task_name=self.name)
 
                 data = numpy.asarray(data, dtype=numpy.uint32)
                 return _write_digital_u_32(
@@ -1312,5 +1312,5 @@ def write(self, data, auto_start=AUTO_START_UNSET, timeout=10.0):
             raise DaqError(
                 'Write failed, because there are no output channels in this '
                 'task to which data can be written.',
-                DAQmxErrors.WRITE_NO_OUTPUT_CHANS_IN_TASK.value,
+                DAQmxErrors.WRITE_NO_OUTPUT_CHANS_IN_TASK,
                 task_name=self.name)
diff --git a/nidaqmx/tests/test_task.py b/nidaqmx/tests/test_task.py
@@ -19,5 +19,5 @@ def test_task_duplicate(self):
                 # doesn't seem to be working. Regardless it will print a warning that contributors
                 # should see if it regresses.
                 del(u)
-            assert dupe_exception.value.error_code == DAQmxErrors.DUPLICATE_TASK.value
+            assert dupe_exception.value.error_code == DAQmxErrors.DUPLICATE_TASK