Merge pull request #14 from MatthieuDartiailh/tests

Tests improvements

Author: MatthieuDartiailh

.coveragerc

@@ -0,0 +1,8 @@
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise NotImplementedError

.travis.yml

@@ -0,0 +1,40 @@
+language: python
+
+# use container-based infrastructure
+sudo : false
+
+python:
+  - "2.7"
+  - "3.3"
+  - "3.4"
+
+env:
+  - PINT="N"
+  - PINT="Y"
+
+before_install:
+  - REDIRECT_TO=/dev/stdout  # change to /dev/null to silence Travis
+  - wget -q http://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh
+  - chmod +x miniconda.sh
+  - ./miniconda.sh -b -p ~/anaconda &> ${REDIRECT_TO}
+  - export PATH=~/anaconda/bin:$PATH
+  - conda update --yes --quiet conda &> ${REDIRECT_TO}
+
+  - SRC_DIR=$(pwd)
+  - export ENV_NAME=travis
+
+install:
+  - conda create --yes -n $ENV_NAME python=$TRAVIS_PYTHON_VERSION pip > ${REDIRECT_TO};
+  - source activate $ENV_NAME
+  - conda install --yes --quiet future, pytest > ${REDIRECT_TO};
+  - pip install -q pytest-cov, pytest-capturelog, funcsigs
+    # Use develop version of Pint
+  - if [ $PINT == 'Y' ]; then pip install https://github.com/hgrecco/pint/zipball/develop; fi
+  - pip install -q coveralls
+
+script:
+  - cd ${SRC_DIR}
+  - py.test tests -v --cov lantz_core
+
+after_script:
+  - coveralls --verbose

AUTHORS

@@ -0,0 +1,11 @@
+Lantz is developed and maintained by the LabPy team (https://github.com/LabPy)
+
+Main members are :
+- Matthieu Dartiailh : <[email protected]>
+- Hernan Grecco
+- Alex Forencich
+- A. Arsenovic
+
+Other contributors, listed alphabetically, are:
+
+(If you think that your name belongs here, please let the maintainer know)

CHANGES

@@ -1,11 +1,23 @@
 # -*- coding: utf-8 -*-
 """
-    lantz
-    ~~~~~
+    lantz_core
+    ~~~~~~~~~~
 
     An automation and instrumentation toolkit with a clean, well-designed and
     consistent interface.
 
     :copyright: 2015 by The Lantz Authors
     :license: BSD, see LICENSE for more details.
 """
+from __future__ import (division, unicode_literals, print_function,
+                        absolute_import)
+
+from .has_features import subsystem, channel, set_feat, set_action
+from .action import Action
+from .errors import LantzError
+from .limits import IntLimitsValidator, FloatLimitsValidator
+from .unit import set_unit_registry, get_unit_registry
+
+__all__ = ['subsystem', 'channel', 'set_action', 'set_feat', 'Action',
+           'LantzError', 'set_unit_registry', 'get_unit_registry',
+           'IntLimitsValidator', 'FloatLimitsValidator']

lantz_core/__init__.py

@@ -146,11 +146,12 @@ def connected(self):
             80)
         raise NotImplementedError(message)
 
-    def __entry__(self):
+    def __enter__(self):
         """Context manager handling the connection to the instrument.
 
         """
         self.initialize()
+        return self
 
     def __exit__(self, exc_type, exc_value, traceback):
         """Context manager handling the connection to the instrument.

lantz_core/base_driver.py

@@ -25,9 +25,9 @@ class Enumerable(Feature):
         Permitted values for the property.
 
     """
-    def __init__(self, getter=None, setter=None, values=(), get_format='',
+    def __init__(self, getter=None, setter=None, values=(), extract='',
                  retries=0, checks=None, discard=None):
-        super(Enumerable, self).__init__(getter, setter, get_format, retries,
+        super(Enumerable, self).__init__(getter, setter, extract, retries,
                                          checks, discard)
         self.values = set(values)
         self.creation_kwargs['values'] = values

lantz_core/features/enumerable.py

@@ -98,9 +98,6 @@ def __init__(self, getter=None, setter=None, extract='', retries=0,
                              self._set if setter is not None else None,
                              self._del)
 
-        self.modify_behavior('post_set', self.check_operation,
-                             ('operation', 'prepend'), True)
-
         if checks:
             self._build_checkers(checks)
         if discard:
@@ -243,7 +240,7 @@ def post_set(self, driver, value, i_value, response):
             Raised if the driver detects an issue.
 
         """
-        self.check_operation(self, driver, value, i_value, response)
+        self.check_operation(driver, value, i_value, response)
 
     def check_operation(self, driver, value, i_value, response):
         """Check the instrument operated correctly.
@@ -274,7 +271,7 @@ def check_operation(self, driver, value, i_value, response):
                 mess += ':' + str(details)
             else:
                 mess += '.'
-            raise LantzError(mess.format(self._name, value, i_value))
+            raise LantzError(mess.format(self.name, value, i_value))
 
     def discard_cache(self, driver, value, i_value, response):
         """Empty the cache of the specified values.
@@ -333,19 +330,29 @@ def modify_behavior(self, method_name, custom_method, specifiers=(),
         method_name : unicode
             Name of the Feature behavior which should be modified.
 
-        custom_method : MethodType
-            Method to use when customizing the feature behavior.
+        custom_method : callable|None
+            Method to use when customizing the feature behavior, or None when
+            removing a customization.
 
         specifiers : tuple, optional
             Tuple used to determine how the method should be used. If ommitted
             the method will simply replace the existing behavior otherwise
             it will be used to update the MethodComposer in the adequate
             fashion. For get and set MethodComposers are not used and no matter
             this value the method will replace the existing behavior.
+            ex : ('custom', 'add_after', 'old')
+
+        internal : bool, optional
+            Private flag used to indicate that this method is used for internal
+            purposes and that the modification makes no sense to remember as
+            this won't have to be copied by copy_custom_behaviors.
 
         """
         # Make the method a method of the Feature.
-        m = wrap_custom_feat_method(custom_method, self)
+        # The if clause handles the case of 'remove' for which passing None
+        # should work
+        m = (wrap_custom_feat_method(custom_method, self) if custom_method
+             else None)
 
         # In the absence of specifiers or for get and set we simply replace the
         # method.
@@ -363,13 +370,14 @@ def modify_behavior(self, method_name, custom_method, specifiers=(),
         # In case of non internal modifications (ie unrelated to Feature
         # initialisation) we keep a description of what has been done to be
         # able to copy those behaviors. If a method already existed we assume
-        # it was meaningful and add it in the composer under the id 'custom'.
+        # it was meaningful and add it in the composer under the id 'old'.
         if not internal:
             if method_name not in self._customs:
                 self._customs[method_name] = OrderedDict()
             elif not isinstance(self._customs[method_name], OrderedDict):
-                composer.prepend('old', self._customs[method_name])
-                self._customs[method_name] = {'custom': (m, 'prepend')}
+                old = self._customs[method_name]
+                composer.prepend('old', old)
+                self._customs[method_name] = OrderedDict(old=(old, 'prepend'))
 
         # We now update the composer.
         composer_method_name = specifiers[1]
@@ -420,6 +428,7 @@ def copy_custom_behaviors(self, feat):
         """
         # Loop on methods which are affected by mofifiers.
         for meth_name, modifiers in feat._customs.items():
+            print(meth_name)
             if isinstance(modifiers, MethodType):
                     self.modify_behavior(meth_name, modifiers)
                     continue
@@ -436,16 +445,17 @@ def copy_custom_behaviors(self, feat):
                     aux = {'add_after': 'append', 'add_before': 'prepend'}
                     self.modify_behavior(meth_name, modifier[0],
                                          (custom, aux[modifier[1]]))
+
                 # Otherwise we check whether or not the anchor exists and if
                 # not try to find the most meaningfull one.
                 else:
                     our_names = method._names
-                    if custom in our_names:
+                    if modifier[2] in our_names:
                         self.modify_behavior(meth_name, modifier[0],
                                              (custom, modifier[1],
                                               modifier[2]))
                     else:
-                        feat_names = getattr(self, meth_name)._names
+                        feat_names = getattr(feat, meth_name)._names
                         # For add after we try to find an entry existing in
                         # both feature going backward (we will prepend at the
                         # worst), for add before we go forward (we will append
@@ -464,7 +474,7 @@ def copy_custom_behaviors(self, feat):
 
                         if shift != 0:
                             op = 'prepend' if shift == -1 else 'append'
-                            self.modify_behavior(meth_name, modifiers[0],
+                            self.modify_behavior(meth_name, modifier[0],
                                                  (custom, op))
 
     def _build_checkers(self, checks):

lantz_core/features/feature.py

@@ -29,9 +29,9 @@ class LimitsValidated(Feature):
         provided it is used to retrieve the range from the driver at runtime.
 
     """
-    def __init__(self, getter=None, setter=None, limits=None, get_format='',
+    def __init__(self, getter=None, setter=None, limits=None, extract='',
                  retries=0, checks=None, discard=None):
-        Feature.__init__(self, getter, setter, get_format,
+        Feature.__init__(self, getter, setter, extract,
                          retries, checks, discard)
         if limits:
             if isinstance(limits, AbstractLimitsValidator):

lantz_core/features/limits_validated.py

@@ -68,6 +68,10 @@ class MethodsComposer(object):
     be called in the right order while allowing fancy insertion based on method
     id.
 
+    Notes
+    -----
+    Method ids must be unique and duplicate names are removed without warning.
+
     """
     __slots__ = ('_names', '_methods')
 

lantz_core/features/util.py

@@ -18,7 +18,6 @@
 from types import FunctionType
 from inspect import cleandoc, getsourcelines, currentframe
 from itertools import chain
-from textwrap import fill
 from abc import ABCMeta
 from collections import defaultdict
 
@@ -123,7 +122,7 @@ def __init__(self, bases=()):
 
     def __setattr__(self, name, value):
         if isinstance(value, _subpart):
-            value._parent_ = self
+            object.__setattr__(value, '_parent_', self)
         object.__setattr__(self, name, value)
 
     def __call__(self, func):
@@ -324,9 +323,6 @@ def __new__(meta, name, bases, dct):
         for key, value in dct.items():
 
             if isinstance(value, _subpart):
-                if key in subparts:
-                    msg = 'Attempt to redeclare subpart {}'
-                    raise KeyError(msg.format(key))
                 value._name_ = key
                 subparts[key] = value
 
@@ -621,7 +617,7 @@ def clear_cache(self, subsystems=True, channels=True, features=None):
                     for ch in getattr(self, chs):
                         ch.clear_cache(subsystems)
 
-    def check_cache(self, subsystems=True, channels=True, properties=None):
+    def check_cache(self, subsystems=True, channels=True, features=None):
         """Return the value of the cache of the object.
 
         The cache values for the subsystems and channels are not accessible.
@@ -634,8 +630,8 @@ def check_cache(self, subsystems=True, channels=True, properties=None):
         channels : bool, optional
             Whether or not to include the channels caches. This argument is
             used only if properties is None.
-        properties : iterable of str, optional
-            Name of the properties whose cache should be cleared. All caches
+        features : iterable of str, optional
+            Name of the features whose cache should be cleared. All caches
             will be cleared if not specified.
 
         Returns
@@ -646,10 +642,10 @@ def check_cache(self, subsystems=True, channels=True, properties=None):
 
         """
         cache = {}
-        if properties:
+        if features:
             sss = defaultdict(list)
             chs = defaultdict(list)
-            for name in properties:
+            for name in features:
                 if '.' in name:
                     aux, n = name.split('.', 1)
                     if aux in self.__subsystems__:
@@ -660,7 +656,7 @@ def check_cache(self, subsystems=True, channels=True, properties=None):
                     cache[name] = self._cache[name]
 
             for ss in sss:
-                cache[ss] = getattr(self, ss).check_cache(properties=sss[ss])
+                cache[ss] = getattr(self, ss).check_cache(features=sss[ss])
 
             if self.__channels__:
                 for ch in chs:
@@ -669,7 +665,7 @@ def check_cache(self, subsystems=True, channels=True, properties=None):
                     channel_cont = getattr(self, ch)
                     for ch_id in channel_cont.available:
                         chan = channel_cont[ch_id]
-                        ch_cache[ch_id] = chan.check_cache(properties=chs[ch])
+                        ch_cache[ch_id] = chan.check_cache(features=chs[ch])
         else:
             cache = self._cache.copy()
             if subsystems:
@@ -693,7 +689,7 @@ def declared_limits(self):
         Ranges are considered declared as soon as a getter has been defined.
 
         """
-        return self.__ranges__
+        return self.__limits__
 
     def get_limits(self, limits_id):
         """Access the limits object matching the definition.
@@ -736,13 +732,7 @@ def reopen_connection(self):
         """Reopen the connection to the instrument.
 
         """
-        message = fill(cleandoc(
-            '''This method is used to reopen a connection whose state
-            is suspect, for example the last message sent did not
-            go through, and should be implemented by classes
-            subclassing HasFeatures'''),
-            80)
-        raise NotImplementedError(message)
+        raise NotImplementedError()
 
     def default_get_feature(self, feat, cmd, *args, **kwargs):
         """Method used by default by the Feature to retrieve a value from an
@@ -762,10 +752,7 @@ def default_get_feature(self, feat, cmd, *args, **kwargs):
             state.
 
         """
-        mess = fill(cleandoc('''Method used by default by the Feature to
-            retrieve a value from an instrument. Should be implemented by
-            classes subclassing HasFeatures.'''), 80)
-        raise NotImplementedError(mess)
+        raise NotImplementedError()
 
     def default_set_feature(self, feat, cmd, *args, **kwargs):
         """Method used by default by the Feature to set an instrument value.
@@ -784,10 +771,7 @@ def default_set_feature(self, feat, cmd, *args, **kwargs):
             state.
 
         """
-        mess = fill(cleandoc('''Method used by default by the Feature to
-            set an instrument value. Should be implemented by
-            classes subclassing HasFeatures'''), 80)
-        raise NotImplementedError(mess)
+        raise NotImplementedError()
 
     def default_check_operation(self, feat, value, i_value, state=None):
         """Method used by default by the Feature to check the instrument
@@ -813,10 +797,7 @@ def default_check_operation(self, feat, value, i_value, state=None):
             something should always be returned.
 
         """
-        mess = fill(cleandoc('''Method used by default by the Feature to
-            check the instrument operation. Should be implemented by
-            classes subclassing HasFeatures.'''), 80)
-        raise NotImplementedError(mess)
+        raise NotImplementedError()
 
 
 AbstractHasFeatures.register(HasFeatures)