Develop -> Master merge for v0.4.0

.gitignore

@@ -50,3 +50,12 @@ nosetests.xml
 
 #pycharm generated
 .idea
+
+# VS Code IDE internals
+.vscode/
+
+# nosetests metadata
+.noseids
+
+# Hypothesis files
+.hypothesis/

.travis.yml

@@ -2,18 +2,29 @@ sudo: false
 language: python
 python:
   - "2.7"
-  - "3.3"
   - "3.4"
   - "3.5"
+  - "3.6"
 install:
   - "pip install -r requirements.txt"
   - "pip install -r dev-requirements.txt"
   - pip install python-coveralls
   - pip install coverage
+before_script:
+  # We use before_script to report version and path information in a way
+  # that can be easily hidden by Travis' log folding. Moreover, a nonzero
+  # exit code from this block kills the entire job, meaning that if we can't
+  # even sensibly get version information, we correctly abort.
+  - which python
+  - python --version
+  - which nosetests
+  - nosetests --version
+  - which pylint
+  - pylint --version
 script:
   - nosetests --with-coverage -w instruments
-  - pylint --py3k instruments/
-  - pylint instruments/
+  - pylint --py3k instruments
+  - pylint --disable=I instruments
 after_success:
   - coveralls
 deploy:

README.rst

@@ -1,7 +1,7 @@
 InstrumentKit
 =============
 
-.. image:: https://img.shields.io/travis/Galvant/InstrumentKit.svg?maxAge=2592000
+.. image:: https://img.shields.io/travis/Galvant/InstrumentKit/master.svg?maxAge=2592000
     :target: https://travis-ci.org/Galvant/InstrumentKit
     :alt: Travis-CI build status
 
@@ -111,7 +111,7 @@ send, one can use the following functions to do so:
 Python Version Compatibility
 ----------------------------
 
-At this time, Python 2.7, 3.3, 3.4, and 3.5 are supported. Should you encounter
+At this time, Python 2.7, 3.4, 3.5, and 3.6 are supported. Should you encounter
 any problems with this library that occur in one version or another, please
 do not hesitate to let us know.
 
@@ -134,7 +134,7 @@ To run the tests against all supported version of Python, you will need to
 have the binary for each installed, as well as any requirements needed to
 install ``numpy`` under each Python version. On Debian/Ubuntu systems this means
 you will need to install the ``python-dev`` package for each version of Python
-supported (``python2.7-dev``, ``python3.3-dev``, etc).
+supported (``python2.7-dev``, ``python3.4-dev``, etc).
 
 With the required system packages installed, all tests can be run with ``tox``:
 

dev-requirements.txt

@@ -1,3 +1,4 @@
 mock
 nose
-pylint==1.6.5
+hypothesis
+pylint==1.7.1

doc/source/devguide/util_fns.rst

@@ -183,3 +183,15 @@ String Property
 .. autofunction:: string_property
 
 
+Named Structures
+================
+
+The :class:`~instruments.named_struct.NamedStruct` class can be used to represent
+C-style structures for serializing and deserializing data.
+
+.. autoclass:: instruments.named_struct.NamedStruct
+
+.. autoclass:: instruments.named_struct.Field
+
+.. autoclass:: instruments.named_struct.Padding
+

doc/source/intro.rst

@@ -33,9 +33,9 @@ $ pip install -r requirements.txt
 - `enum34`_
 - `future`_
 - `python-vxi11`_
-- `PyUSB`_
+- `PyUSB`_ (version 1.0a or higher, required for raw USB support)
 - `python-usbtmc`_
-- `PyYAML`_
+- `ruamel.yaml`_ (required for configuration file support)
 
 Optional Dependencies
 ~~~~~~~~~~~~~~~~~~~~~
@@ -46,7 +46,7 @@ Optional Dependencies
 .. _quantities: http://pythonhosted.org/quantities/
 .. _enum34: https://pypi.python.org/pypi/enum34
 .. _future: https://pypi.python.org/pypi/future
-.. _PyYAML: https://bitbucket.org/xi/pyyaml
+.. _ruamel.yaml: http://yaml.readthedocs.io
 .. _PyUSB: http://sourceforge.net/apps/trac/pyusb/
 .. _PyVISA: http://pyvisa.sourceforge.net/
 .. _python-usbtmc: https://pypi.python.org/pypi/python-usbtmc

instruments/abstract_instruments/comm/file_communicator.py

@@ -60,8 +60,8 @@ def address(self):
         """
         if hasattr(self._filelike, 'name'):
             return self._filelike.name
-        else:
-            return None
+
+        return None
 
     @address.setter
     def address(self, newval):

instruments/abstract_instruments/comm/gi_gpib_communicator.py

@@ -48,7 +48,7 @@ def __init__(self, filelike, gpib_address):
         if self._version <= 4:
             self._eos = 10
         else:
-            self._eos = "\n"  # pylint: disable=redefined-variable-type
+            self._eos = "\n"
 
     # PROPERTIES #
 
@@ -117,8 +117,8 @@ def terminator(self):
         """
         if not self._eoi:
             return self._terminator
-        else:
-            return 'eoi'
+
+        return 'eoi'
 
     @terminator.setter
     def terminator(self, newval):
@@ -203,7 +203,6 @@ def eos(self):
 
     @eos.setter
     def eos(self, newval):
-        # pylint: disable=redefined-variable-type
         if self._version <= 4:
             if isinstance(newval, (str, bytes)):
                 newval = ord(newval)

instruments/abstract_instruments/comm/usbtmc_communicator.py

@@ -43,8 +43,8 @@ def __init__(self, *args, **kwargs):
     def address(self):
         if hasattr(self._filelike, "name"):
             return id(self._filelike)  # TODO: replace with something more useful.
-        else:
-            return None
+
+        return None
 
     @property
     def terminator(self):
@@ -54,7 +54,7 @@ def terminator(self):
 
         :type: `str`
         """
-        return self._filelike.term_char
+        return chr(self._filelike.term_char)
 
     @terminator.setter
     def terminator(self, newval):
@@ -78,7 +78,7 @@ def timeout(self):
 
     @timeout.setter
     def timeout(self, newval):
-        newval = assume_units(newval, pq.second).rescale(pq.ms).magnitude
+        newval = assume_units(newval, pq.second).rescale(pq.s).magnitude
         self._filelike.timeout = newval
 
     # FILE-LIKE METHODS #

instruments/abstract_instruments/comm/visa_communicator.py

@@ -149,7 +149,7 @@ def write_raw(self, msg):
         :param bytes msg: Bytes to be sent to the instrument over the VISA
             connection.
         """
-        self._conn.write(msg)
+        self._conn.write_raw(msg)
 
     def seek(self, offset):  # pylint: disable=unused-argument,no-self-use
         return NotImplemented

instruments/abstract_instruments/function_generator.py

@@ -153,8 +153,8 @@ def amplitude(self):
 
         if units == self.VoltageMode.dBm:
             return pq.Quantity(mag, u.dBm)
-        else:
-            return pq.Quantity(mag, pq.V), units
+
+        return pq.Quantity(mag, pq.V), units
 
     @amplitude.setter
     def amplitude(self, newval):
@@ -168,7 +168,6 @@ def amplitude(self, newval):
             # OK, we have volts. Now, do we have a tuple? If not, assume Vpp.
             if not isinstance(newval, tuple):
                 mag = newval
-                # pylint: disable=redefined-variable-type
                 units = self.VoltageMode.peak_to_peak
             else:
                 mag, units = newval

instruments/abstract_instruments/instrument.py

@@ -310,7 +310,8 @@ def binblockread(self, data_width, fmt=None):
     # CLASS METHODS #
 
     URI_SCHEMES = ["serial", "tcpip", "gpib+usb",
-                   "gpib+serial", "visa", "file", "usbtmc", "vxi11"]
+                   "gpib+serial", "visa", "file", "usbtmc", "vxi11",
+                   "test"]
 
     @classmethod
     def open_from_uri(cls, uri):
@@ -330,6 +331,7 @@ def open_from_uri(cls, uri):
             gpib+serial:///dev/ttyACM0/15 # Currently non-functional.
             visa://USB::0x0699::0x0401::C0000001::0::INSTR
             usbtmc://USB::0x0699::0x0401::C0000001::0::INSTR
+            test://
 
         For the ``serial`` URI scheme, baud rates may be explicitly specified
         using the query parameter ``baud=``, as in the example
@@ -415,6 +417,8 @@ def open_from_uri(cls, uri):
             #   vxi11://192.168.1.104
             #   vxi11://TCPIP::192.168.1.105::gpib,5::INSTR
             return cls.open_vxi11(parsed_uri.netloc, **kwargs)
+        elif parsed_uri.scheme == "test":
+            return cls.open_test(**kwargs)
         else:
             raise NotImplementedError("Invalid scheme or not yet "
                                       "implemented.")

instruments/abstract_instruments/oscilloscope.py

@@ -49,8 +49,10 @@ def __exit__(self, type, value, traceback):
     def __eq__(self, other):
         if not isinstance(other, type(self)):
             return NotImplemented
-        else:
-            return other.name == self.name
+
+        return other.name == self.name
+
+    __hash__ = None
 
     # PROPERTIES #
 

instruments/agilent/agilent33220a.py

@@ -43,9 +43,6 @@ class Agilent33220a(SCPIFunctionGenerator):
 
     """
 
-    def __init__(self, filelike):
-        super(Agilent33220a, self).__init__(filelike)
-
     # ENUMS #
 
     class Function(Enum):
@@ -90,7 +87,7 @@ def frequency(self, newval):
         super(Agilent33220a, self).frequency = newval
 
     function = enum_property(
-        name="FUNC",
+        command="FUNC",
         enum=Function,
         doc="""
         Gets/sets the output function of the function generator
@@ -101,7 +98,7 @@ def frequency(self, newval):
     )
 
     duty_cycle = int_property(
-        name="FUNC:SQU:DCYC",
+        command="FUNC:SQU:DCYC",
         doc="""
         Gets/sets the duty cycle of a square wave.
 
@@ -114,7 +111,7 @@ def frequency(self, newval):
     )
 
     ramp_symmetry = int_property(
-        name="FUNC:RAMP:SYMM",
+        command="FUNC:RAMP:SYMM",
         doc="""
         Gets/sets the ramp symmetry for ramp waves.
 
@@ -127,7 +124,7 @@ def frequency(self, newval):
     )
 
     output = bool_property(
-        name="OUTP",
+        command="OUTP",
         inst_true="ON",
         inst_false="OFF",
         doc="""
@@ -141,7 +138,7 @@ def frequency(self, newval):
     )
 
     output_sync = bool_property(
-        name="OUTP:SYNC",
+        command="OUTP:SYNC",
         inst_true="ON",
         inst_false="OFF",
         doc="""
@@ -152,7 +149,7 @@ def frequency(self, newval):
     )
 
     output_polarity = enum_property(
-        name="OUTP:POL",
+        command="OUTP:POL",
         enum=OutputPolarity,
         doc="""
         Gets/sets the polarity of the waveform relative to the offset voltage.

instruments/agilent/agilent34410a.py

@@ -35,9 +35,6 @@ class Agilent34410a(SCPIMultimeter):  # pylint: disable=abstract-method
     .. _Keysight website: http://www.keysight.com/
     """
 
-    def __init__(self, filelike):
-        super(Agilent34410a, self).__init__(filelike)
-
     # PROPERTIES #
 
     @property