Change repeated capabilities

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,6 +14,25 @@ All notable changes to this project will be documented in this file.
 * ### ALL
   * #### Added
   * #### Changed
+    * Repeated capabilities are no longer accessed directly on the session object. Instead there is now a repeated capabilies object for each type of repeated capability that the driver supports. Some drivers do not use repeated capabilities so there is no change for them.
+    * The repeated capabilities object can take integers or strings, a single item or a list.
+    * The repeated capabilities object knows the proper prefix and will add it if needed.
+    * The following are all legal
+        ```python
+        import niscope
+        session = niscope.Session('PXI1Slot2')
+
+        # Channel repeated capabilities
+        session.channel['0'].channel_enabled = True
+        session.channel[0].channel_enabled = True
+        session.channel[[0, 1, 3]].channel_enabled = True
+
+        # P2P repeated capabilities
+        i = session.p2p_streams['0'].P2P_SAMPLES_AVAIL_IN_ENDPOINT
+        i = session.p2p_streams[0].P2P_SAMPLES_AVAIL_IN_ENDPOINT
+        i = session.p2p_streams[[0, 1, 3]].P2P_SAMPLES_AVAIL_IN_ENDPOINT
+        i = session.p2p_streams['FIFOEndpoint0'].P2P_SAMPLES_AVAIL_IN_ENDPOINT
+        ```
   * #### Removed
 * ### NI-DMM
   * #### Added
@@ -29,14 +48,19 @@ All notable changes to this project will be documented in this file.
   * #### Removed
 * ### NI-DCPower
   * #### Added
+    * Channel repeated capability
   * #### Changed
   * #### Removed
 * ### NI-FGEN
   * #### Added
+    * Channel repeated capability
+    * P2P repeated capability
   * #### Changed
   * #### Removed
 * ### NI-SCOPE
   * #### Added
+    * Channel repeated capability
+    * P2P repeated capability
   * #### Changed
   * #### Removed
 

build/templates/session.py.mako

@@ -48,7 +48,23 @@ class ${session_context_manager}(object):
 
 
 % endif
-class _SessionBase(object):
+% for rep_cap in config['repeated_capabilities']:
+class _${rep_cap['python_class_name']}(object):
+    def __init__(self, ${config['session_handle_parameter_name']}):
+        self._${config['session_handle_parameter_name']} = ${config['session_handle_parameter_name']}
+
+    def __getitem__(self, repeated_capability):
+        '''Set/get properties or call methods with a repeated capability (i.e. channels)'''
+        if isinstance(repeated_capability, list):
+            rep_cap_list = [str(r) if str(r).startswith('${rep_cap['prefix']}') else '${rep_cap['prefix']}' + str(r) for r in repeated_capability]
+        else:
+            rep_cap_list = [str(repeated_capability) if str(repeated_capability).startswith('${rep_cap['prefix']}') else '${rep_cap['prefix']}' + str(repeated_capability)]
+
+        return _RepeatedCapbilities(self._${config['session_handle_parameter_name']}, ','.join(rep_cap_list))
+
+
+% endfor
+class _RepeatedCapbilities(object):
     '''Base class for all ${config['driver_name']} sessions.'''
 
     # This is needed during __init__. Without it, __setattr__ raises an exception
@@ -85,10 +101,12 @@ init_method_params = helper.get_params_snippet(init_function, helper.ParameterUs
 init_call_params = helper.get_params_snippet(init_function, helper.ParameterUsageOptions.SESSION_METHOD_CALL)
 %>\
 
-    def __init__(self, repeated_capability):
+    def __init__(self, ${config['session_handle_parameter_name']}, repeated_capability):
         self._library = library_singleton.get()
         self._repeated_capability = repeated_capability
+        self._${config['session_handle_parameter_name']} = ${config['session_handle_parameter_name']}
         self._encoding = 'windows-1251'
+        self._is_frozen = True
 
     def __setattr__(self, key, value):
         if self._is_frozen and key not in dir(self):
@@ -125,34 +143,25 @@ init_call_params = helper.get_params_snippet(init_function, helper.ParameterUsag
 % endfor
 % endfor
 
-class _RepeatedCapability(_SessionBase):
-    '''Allows for setting/getting properties and calling methods for specific repeated capabilities (such as channels) on your session.'''
-
-    def __init__(self, ${config['session_handle_parameter_name']}, repeated_capability):
-        super(_RepeatedCapability, self).__init__(repeated_capability)
-        self._${config['session_handle_parameter_name']} = ${config['session_handle_parameter_name']}
-        self._is_frozen = True
-
-
-class Session(_SessionBase):
+class Session(_RepeatedCapbilities):
     '''${config['session_class_description']}'''
 
     def __init__(${init_method_params}):
-        super(Session, self).__init__(repeated_capability='')
+        self._library = library_singleton.get()
+        self._encoding = 'windows-1251'
         self._${config['session_handle_parameter_name']} = 0  # This must be set before calling ${init_function['python_name']}().
         self._${config['session_handle_parameter_name']} = self.${init_function['python_name']}(${init_call_params})
-        self._is_frozen = True
+% for rep_cap in config['repeated_capabilities']:
+        self.${rep_cap['python_name']} = _${rep_cap['python_class_name']}(self._${config['session_handle_parameter_name']})
+% endfor
+        super(Session, self).__init__(self._${config['session_handle_parameter_name']}, repeated_capability='')
 
     def __enter__(self):
         return self
 
     def __exit__(self, exc_type, exc_value, traceback):
         self.close()
 
-    def __getitem__(self, repeated_capability):
-        '''Set/get properties or call methods with a repeated capability (i.e. channels)'''
-        return _RepeatedCapability(self._${config['session_handle_parameter_name']}, repeated_capability)
-
     def initiate(self):
         return ${session_context_manager}(self)
 

docs/conf.py

@@ -55,15 +55,15 @@
 
 # General information about the project.
 project = 'NI Modular Instruments Python API'
-copyright = '2017-2017, National Instruments'
+copyright = '2017-2018, National Instruments'
 author = 'National Instruments'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The full version, including alpha/beta/rc tags.
-release = '0.6.1.dev0'
+release = '0.6.0'
 # The short X.Y version.
 version = release[:3]
 

generated/nidcpower/session.py

@@ -21,7 +21,21 @@ def __exit__(self, exc_type, exc_value, traceback):
         self._session.abort()
 
 
-class _SessionBase(object):
+class _Channel(object):
+    def __init__(self, vi):
+        self._vi = vi
+
+    def __getitem__(self, repeated_capability):
+        '''Set/get properties or call methods with a repeated capability (i.e. channels)'''
+        if isinstance(repeated_capability, list):
+            rep_cap_list = [str(r) if str(r).startswith('') else '' + str(r) for r in repeated_capability]
+        else:
+            rep_cap_list = [str(repeated_capability) if str(repeated_capability).startswith('') else '' + str(repeated_capability)]
+
+        return _RepeatedCapbilities(self._vi, ','.join(rep_cap_list))
+
+
+class _RepeatedCapbilities(object):
     '''Base class for all NI-DCPower sessions.'''
 
     # This is needed during __init__. Without it, __setattr__ raises an exception
@@ -1467,10 +1481,12 @@ class _SessionBase(object):
         var = session['0,1'].voltage_pole_zero_ratio
     '''
 
-    def __init__(self, repeated_capability):
+    def __init__(self, vi, repeated_capability):
         self._library = library_singleton.get()
         self._repeated_capability = repeated_capability
+        self._vi = vi
         self._encoding = 'windows-1251'
+        self._is_frozen = True
 
     def __setattr__(self, key, value):
         if self._is_frozen and key not in dir(self):
@@ -2566,34 +2582,23 @@ def _error_message(self, error_code):
         return error_message_ctype.value.decode(self._encoding)
 
 
-class _RepeatedCapability(_SessionBase):
-    '''Allows for setting/getting properties and calling methods for specific repeated capabilities (such as channels) on your session.'''
-
-    def __init__(self, vi, repeated_capability):
-        super(_RepeatedCapability, self).__init__(repeated_capability)
-        self._vi = vi
-        self._is_frozen = True
-
-
-class Session(_SessionBase):
+class Session(_RepeatedCapbilities):
     '''An NI-DCPower session to a National Instruments Programmable Power Supply or Source Measure Unit.'''
 
     def __init__(self, resource_name, channels='', reset=False, option_string=''):
-        super(Session, self).__init__(repeated_capability='')
+        self._library = library_singleton.get()
+        self._encoding = 'windows-1251'
         self._vi = 0  # This must be set before calling _initialize_with_channels().
         self._vi = self._initialize_with_channels(resource_name, channels, reset, option_string)
-        self._is_frozen = True
+        self.channel = _Channel(self._vi)
+        super(Session, self).__init__(self._vi, repeated_capability='')
 
     def __enter__(self):
         return self
 
     def __exit__(self, exc_type, exc_value, traceback):
         self.close()
 
-    def __getitem__(self, repeated_capability):
-        '''Set/get properties or call methods with a repeated capability (i.e. channels)'''
-        return _RepeatedCapability(self._vi, repeated_capability)
-
     def initiate(self):
         return _Acquisition(self)
 

generated/nidmm/session.py

@@ -21,7 +21,7 @@ def __exit__(self, exc_type, exc_value, traceback):
         self._session.abort()
 
 
-class _SessionBase(object):
+class _RepeatedCapbilities(object):
     '''Base class for all NI-DMM sessions.'''
 
     # This is needed during __init__. Without it, __setattr__ raises an exception
@@ -411,10 +411,12 @@ class _SessionBase(object):
     For the NI 4070/4071/4072 only, specifies the rate of the waveform acquisition in Samples per second (S/s).  The valid Range is 10.0-1,800,000 S/s. Values are coerced to the  closest integer divisor of 1,800,000. The default value is 1,800,000.
     '''
 
-    def __init__(self, repeated_capability):
+    def __init__(self, vi, repeated_capability):
         self._library = library_singleton.get()
         self._repeated_capability = repeated_capability
+        self._vi = vi
         self._encoding = 'windows-1251'
+        self._is_frozen = True
 
     def __setattr__(self, key, value):
         if self._is_frozen and key not in dir(self):
@@ -840,34 +842,22 @@ def _error_message(self, error_code):
         return error_message_ctype.value.decode(self._encoding)
 
 
-class _RepeatedCapability(_SessionBase):
-    '''Allows for setting/getting properties and calling methods for specific repeated capabilities (such as channels) on your session.'''
-
-    def __init__(self, vi, repeated_capability):
-        super(_RepeatedCapability, self).__init__(repeated_capability)
-        self._vi = vi
-        self._is_frozen = True
-
-
-class Session(_SessionBase):
+class Session(_RepeatedCapbilities):
     '''An NI-DMM session to a National Instruments Digital Multimeter'''
 
     def __init__(self, resource_name, id_query=False, reset_device=False, option_string=''):
-        super(Session, self).__init__(repeated_capability='')
+        self._library = library_singleton.get()
+        self._encoding = 'windows-1251'
         self._vi = 0  # This must be set before calling _init_with_options().
         self._vi = self._init_with_options(resource_name, id_query, reset_device, option_string)
-        self._is_frozen = True
+        super(Session, self).__init__(self._vi, repeated_capability='')
 
     def __enter__(self):
         return self
 
     def __exit__(self, exc_type, exc_value, traceback):
         self.close()
 
-    def __getitem__(self, repeated_capability):
-        '''Set/get properties or call methods with a repeated capability (i.e. channels)'''
-        return _RepeatedCapability(self._vi, repeated_capability)
-
     def initiate(self):
         return _Acquisition(self)
 

generated/nifake/session.py

@@ -23,7 +23,21 @@ def __exit__(self, exc_type, exc_value, traceback):
         self._session.abort()
 
 
-class _SessionBase(object):
+class _Channel(object):
+    def __init__(self, vi):
+        self._vi = vi
+
+    def __getitem__(self, repeated_capability):
+        '''Set/get properties or call methods with a repeated capability (i.e. channels)'''
+        if isinstance(repeated_capability, list):
+            rep_cap_list = [str(r) if str(r).startswith('') else '' + str(r) for r in repeated_capability]
+        else:
+            rep_cap_list = [str(repeated_capability) if str(repeated_capability).startswith('') else '' + str(repeated_capability)]
+
+        return _RepeatedCapbilities(self._vi, ','.join(rep_cap_list))
+
+
+class _RepeatedCapbilities(object):
     '''Base class for all NI-FAKE sessions.'''
 
     # This is needed during __init__. Without it, __setattr__ raises an exception
@@ -58,10 +72,12 @@ class _SessionBase(object):
     An attribute of type string with read/write access.
     '''
 
-    def __init__(self, repeated_capability):
+    def __init__(self, vi, repeated_capability):
         self._library = library_singleton.get()
         self._repeated_capability = repeated_capability
+        self._vi = vi
         self._encoding = 'windows-1251'
+        self._is_frozen = True
 
     def __setattr__(self, key, value):
         if self._is_frozen and key not in dir(self):
@@ -420,34 +436,23 @@ def _error_message(self, error_code):
         return error_message_ctype.value.decode(self._encoding)
 
 
-class _RepeatedCapability(_SessionBase):
-    '''Allows for setting/getting properties and calling methods for specific repeated capabilities (such as channels) on your session.'''
-
-    def __init__(self, vi, repeated_capability):
-        super(_RepeatedCapability, self).__init__(repeated_capability)
-        self._vi = vi
-        self._is_frozen = True
-
-
-class Session(_SessionBase):
+class Session(_RepeatedCapbilities):
     '''An NI-FAKE session to a fake MI driver whose sole purpose is to test nimi-python code generation'''
 
     def __init__(self, resource_name, id_query=False, reset_device=False, option_string=''):
-        super(Session, self).__init__(repeated_capability='')
+        self._library = library_singleton.get()
+        self._encoding = 'windows-1251'
         self._vi = 0  # This must be set before calling _init_with_options().
         self._vi = self._init_with_options(resource_name, id_query, reset_device, option_string)
-        self._is_frozen = True
+        self.channel = _Channel(self._vi)
+        super(Session, self).__init__(self._vi, repeated_capability='')
 
     def __enter__(self):
         return self
 
     def __exit__(self, exc_type, exc_value, traceback):
         self.close()
 
-    def __getitem__(self, repeated_capability):
-        '''Set/get properties or call methods with a repeated capability (i.e. channels)'''
-        return _RepeatedCapability(self._vi, repeated_capability)
-
     def initiate(self):
         return _Acquisition(self)