Change repeated capabilities

.gitignore

@@ -9,4 +9,4 @@ commands.log
 .vscode/launch.json
 .vscode/settings.json
 
-
+.pytest_cache/

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Changelog
 
 * [Unreleased](#unreleased)
-* [0.5.0](#060---2017-12-20)
+* [0.6.0](#060---2017-12-20)
 * [0.5.0](#050---2017-11-27)
 * [0.4.0](#040---2017-11-07)
 * [0.3.0](#030---2017-10-13)
@@ -14,12 +14,13 @@ All notable changes to this project will be documented in this file.
 * ### ALL
     * #### Added
     * #### Changed
+        * Repeated capabilities are handled differently. See #737 for discussion
     * #### Removed
 * ### NI-DMM
     * #### Added
     * #### Changed
-        * `nidmm.Session()` no longer takes id_query parameter
     * #### Removed
+        * `nidmm.Session()` no longer takes id_query parameter
         * Removed these enums and disconnected them from the associated attribute
             * `DCBias` - `DC_BIAS`
             * `OffsetCompensatedOhms` - `OFFSET_COMP_OHMS`
@@ -34,6 +35,16 @@ All notable changes to this project will be documented in this file.
     * #### Removed
 * ### NI-DCPower
     * #### Added
+        * `channel` repeated capability - See #737 for discussion
+    * #### Changed
+        * Metadata updated to NI-DCPower 17.6.1
+    * #### Removed
+* ### NI-FGEN
+    * #### Added
+        * Repeated capablilites - See #737 for discussion:
+            * `channel` repeated capability
+            * `markers` repeated capability
+            * `script_triggers` repeated capability
     * #### Changed
         * Metadata updated to NI-DCPower 17.6.1
     * #### Removed
@@ -42,12 +53,10 @@ All notable changes to this project will be documented in this file.
             * `CurrentLevelAutorange` - `CURRENT_LEVEL_AUTORANGE`
             * `VoltageLevelAutorange` - `VOLTAGE_LEVEL_AUTORANGE`
             * `VoltageLimitAutorange` - `VOLTAGE_LIMIT_AUTORANGE`
-* ### NI-FGEN
-    * #### Added
-    * #### Changed
-    * #### Removed
 * ### NI-SCOPE
     * #### Added
+        * Repeated capablilites - See #737 for discussion:
+            * `channel` repeated capability
     * #### Changed
         * `niscope.Session()` no longer takes id_query parameter
     * #### Removed

README.rst

@@ -83,6 +83,34 @@ The following is a basic example of using the **nidmm** module to open a session
         session.configureMeasurementDigits(nidmm.Function.DC_VOLTS, 10, 5.5)
         print("Measurement: " + str(session.read()))
 
+Repeated capabilities
+---------------------
+
+* Repeated capabilities are accessed using a repeated capabilies object for each type of repeated capability that the driver supports. Some drivers do not use repeated capabilities.
+* The repeated capabilities object can take integers or strings, a single item or a list, or a slice.
+* The repeated capabilities object knows the proper prefix and will add it if needed.
+* The following are all legal
+
+    .. code-block:: python
+
+        import nifgen
+        session = nifgen.Session('PXI1Slot2')
+
+        # Channel repeated capabilities
+        session.channels['0'].channel_enabled = True
+        session.channels[0].channel_enabled = True
+        session.channels[[0, 1, 3]].channel_enabled = True
+        session.channels[range(8)].channel_enabled = True  # channels 0, 1, 2, 3, 4, 5, 6, 7
+        session.channels[:8].channel_enabled = True  # channels 0, 1, 2, 3, 4, 5, 6, 7
+        wfm = session.channels[[0, 1, 3]].fetch(5000)
+
+        # ScriptTrigger repeated capabilities
+        i = session.script_triggers['0'].script_triggers_count
+        i = session.script_triggers[0].script_triggers_count
+        i = session.script_triggers[[0, 1, 3]].script_triggers_count
+
+        session.close()
+
 Additional examples for each driver are located in src/<driver>/examples/ directory.
 
 .. _support-section:

build/helper/codegen_helper.py

@@ -14,6 +14,10 @@
     'skip_self': False,
     'name_to_use': 'python_name_with_default',
 }
+_parameterUsageOptionsSnippet[ParameterUsageOptions.SESSION_INIT_DECLARATION] = {
+    'skip_self': False,
+    'name_to_use': 'python_name_with_default',
+}
 _parameterUsageOptionsSnippet[ParameterUsageOptions.SESSION_NUMPY_INTO_METHOD_DECLARATION] = {
     'skip_self': False,
     'name_to_use': 'python_name_with_default',
@@ -22,6 +26,10 @@
     'skip_self': True,
     'name_to_use': 'python_name',
 }
+_parameterUsageOptionsSnippet[ParameterUsageOptions.SESSION_INIT_CALL] = {
+    'skip_self': True,
+    'name_to_use': 'python_name_or_default_for_init',
+}
 _parameterUsageOptionsSnippet[ParameterUsageOptions.DOCUMENTATION_SESSION_METHOD] = {
     'skip_self': True,
     'name_to_use': 'python_name_with_doc_default',

build/helper/metadata_filters.py

@@ -20,6 +20,10 @@
     'mechanism': 'fixed, passed-in, len',
     'python_api_list': True,
 }
+# Only difference is we want to skip parameters not in api
+_parameterUsageOptionsFiltering[ParameterUsageOptions.SESSION_INIT_DECLARATION] = _parameterUsageOptionsFiltering[ParameterUsageOptions.SESSION_METHOD_DECLARATION].copy()
+_parameterUsageOptionsFiltering[ParameterUsageOptions.SESSION_INIT_DECLARATION]['python_api_list'] = False
+
 _parameterUsageOptionsFiltering[ParameterUsageOptions.SESSION_NUMPY_INTO_METHOD_DECLARATION] = {
     'skip_session_handle': True,
     'skip_input_parameters': False,
@@ -46,6 +50,9 @@
     'mechanism': 'fixed, passed-in',
     'python_api_list': True,
 }
+# Only difference is we want to skip parameters not in api
+_parameterUsageOptionsFiltering[ParameterUsageOptions.SESSION_INIT_CALL] = _parameterUsageOptionsFiltering[ParameterUsageOptions.SESSION_METHOD_CALL].copy()
+
 _parameterUsageOptionsFiltering[ParameterUsageOptions.DOCUMENTATION_SESSION_METHOD] = {
     'skip_session_handle': True,
     'skip_input_parameters': False,

build/helper/parameter_usage_options.py

@@ -1,36 +1,48 @@
 from enum import Enum
 
 
-class ParameterUsageOptions(Enum):
+class AutoNumber(Enum):
+    def __new__(cls):
+        value = len(cls.__members__) + 1
+        obj = object.__new__(cls)
+        obj._value_ = value
+        return obj
+
+
+class ParameterUsageOptions(AutoNumber):
     '''Different usage options for parameter lists.'''
 
-    SESSION_METHOD_DECLARATION = 1
-    '''For declaring a method in Session'''
-    SESSION_NUMPY_INTO_METHOD_DECLARATION = 2
+    SESSION_METHOD_DECLARATION = ()
+    '''For declaring a regular method in Session'''
+    SESSION_INIT_DECLARATION = ()
+    '''For declaring an init method in Session'''
+    SESSION_NUMPY_INTO_METHOD_DECLARATION = ()
     '''For calling into a Session method that uses numpy arrays.'''
-    SESSION_METHOD_CALL = 3
-    '''For calling into a Session method.'''
-    DOCUMENTATION_SESSION_METHOD = 4
+    SESSION_METHOD_CALL = ()
+    '''For calling into a regular Session method.'''
+    SESSION_INIT_CALL = ()
+    '''For calling into an init Session method.'''
+    DOCUMENTATION_SESSION_METHOD = ()
     '''For documentation (rst) of Session methods'''
-    CTYPES_CALL = 5
+    CTYPES_CALL = ()
     '''For Library implementation calling into the DLL via ctypes'''
-    LIBRARY_METHOD_CALL = 6
+    LIBRARY_METHOD_CALL = ()
     '''For calling into a method in Library.'''
-    CTYPES_ARGTYPES = 7
+    CTYPES_ARGTYPES = ()
     '''For setting up the ctypes argument types'''
-    LIBRARY_METHOD_DECLARATION = 8
+    LIBRARY_METHOD_DECLARATION = ()
     '''For declaring a method in Library'''
-    INPUT_PARAMETERS = 9
+    INPUT_PARAMETERS = ()
     '''Get all input parameters, other than self, rep caps, and size'''
-    OUTPUT_PARAMETERS = 10
+    OUTPUT_PARAMETERS = ()
     '''Get all output parameters, other than ivi-dance'''
-    IVI_DANCE_PARAMETER = 11
+    IVI_DANCE_PARAMETER = ()
     '''Get the ivi-dance parameter'''
-    NUMPY_PARAMETERS = 12
+    NUMPY_PARAMETERS = ()
     '''Get all buffer parameters that support numpy.array in the Python API'''
-    LEN_PARAMETER = 13
+    LEN_PARAMETER = ()
     '''Get the len parameter'''
-    INPUT_ENUM_PARAMETERS = 14
+    INPUT_ENUM_PARAMETERS = ()
     '''Get any input parameters whose type is enum'''
 
 

build/templates/_converters.py.mako

@@ -5,6 +5,31 @@
 from ${module_name} import visatype
 
 import datetime
+import six
+
+
+def convert_repeated_capabilities(repeated_capability, prefix=''):
+    # First look for a string
+    if isinstance(repeated_capability, six.text_type) or isinstance(repeated_capability, six.string_types):
+        rep_cap_list = [repeated_capability if repeated_capability.lower().startswith(prefix.lower()) else prefix + repeated_capability]
+    else:
+        # if not a string, try it as an iterable
+        try:
+            rep_cap_list = [str(r) if str(r).lower().startswith(prefix.lower()) else prefix + str(r) for r in repeated_capability]
+        except TypeError:
+            # If that doesn't work, then try it as a slice
+            try:
+                def ifnone(a, b):
+                    return b if a is None else a
+                # Turn the slice into a list so we can iterate over it
+                rep_cap_list = list(range(ifnone(repeated_capability.start, 0), repeated_capability.stop, ifnone(repeated_capability.step, 1)))
+                # Now it is a list, so we call ourselves
+                return convert_repeated_capabilities(rep_cap_list, prefix)
+            # Otherwise it must be a single item that is not a string
+            except (TypeError, AttributeError):
+                rep_cap_list = [str(repeated_capability) if str(repeated_capability).lower().startswith(prefix.lower()) else prefix + str(repeated_capability)]
+
+    return ','.join(rep_cap_list)
 
 
 def _convert_timedelta(value, library_type, scaling):
@@ -29,7 +54,7 @@ def convert_timedelta_to_microseconds(value, library_type):
     return _convert_timedelta(value, library_type, 1000000)
 
 
-# Tests
+# Tests - time
 def test_convert_timedelta_to_seconds_double():
     test_result = convert_timedelta_to_seconds(datetime.timedelta(seconds=10), visatype.ViReal64)
     assert test_result.value == 10.0
@@ -66,4 +91,57 @@ def test_convert_timedelta_to_microseconds_int():
     assert isinstance(test_result, visatype.ViInt32)
 
 
+# Tests - repeated capabilities
+def test_repeated_capabilies_string_channel():
+    test_result = convert_repeated_capabilities('0')
+    assert test_result == '0'
+    test_result = convert_repeated_capabilities('0,1')
+    assert test_result == '0,1'
+
+
+def test_repeated_capabilies_string_prefix():
+    test_result = convert_repeated_capabilities('0', prefix='ScriptTrigger')
+    assert test_result == 'ScriptTrigger0'
+
+
+def test_repeated_capabilies_list_channel():
+    test_result = convert_repeated_capabilities(['0'])
+    assert test_result == '0'
+    test_result = convert_repeated_capabilities(['0,1'])
+    assert test_result == '0,1'
+    test_result = convert_repeated_capabilities(['0', '1'])
+    assert test_result == '0,1'
+    test_result = convert_repeated_capabilities([0, 1])
+    assert test_result == '0,1'
+    test_result = convert_repeated_capabilities([0, 1, '3'])
+    assert test_result == '0,1,3'
+
+
+def test_repeated_capabilies_list_prefix():
+    test_result = convert_repeated_capabilities(['ScriptTrigger0,ScriptTrigger1'], prefix='ScriptTrigger')
+    assert test_result == 'ScriptTrigger0,ScriptTrigger1'
+    test_result = convert_repeated_capabilities(['0'], prefix='ScriptTrigger')
+    assert test_result == 'ScriptTrigger0'
+    test_result = convert_repeated_capabilities(['0', '1'], prefix='ScriptTrigger')
+    assert test_result == 'ScriptTrigger0,ScriptTrigger1'
+    test_result = convert_repeated_capabilities([0, 1], prefix='ScriptTrigger')
+    assert test_result == 'ScriptTrigger0,ScriptTrigger1'
+
+
+def test_repeated_capabilies_slice_channel():
+    test_result = convert_repeated_capabilities(slice(0, 1))
+    assert test_result == '0'
+    test_result = convert_repeated_capabilities(slice(0, 2))
+    assert test_result == '0,1'
+    test_result = convert_repeated_capabilities(slice(None, 2))
+    assert test_result == '0,1'
+
+
+def test_repeated_capabilies_slice_prefix():
+    test_result = convert_repeated_capabilities(slice(0, 1), prefix='ScriptTrigger')
+    assert test_result == 'ScriptTrigger0'
+    test_result = convert_repeated_capabilities(slice(0, 2), prefix='ScriptTrigger')
+    assert test_result == 'ScriptTrigger0,ScriptTrigger1'
+    test_result = convert_repeated_capabilities(slice(None, 2), prefix='ScriptTrigger')
+    assert test_result == 'ScriptTrigger0,ScriptTrigger1'