Merge remote-tracking branch 'github/master' into fix-waveform-set

Author: coretl

.github/workflows/code.yml

@@ -14,7 +14,7 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v2
         with:
-          python-version: '3.7'
+          python-version: "3.7"
 
       - name: Install Python Dependencies
         run: pip install flake8
@@ -33,37 +33,36 @@ jobs:
         python: [cp27, cp37, cp38, cp39]
 
         exclude:
-        - os: windows-latest
-          # No cothread or asyncio so doesn't work
-          python: cp27
+          - os: windows-latest
+            # No cothread or asyncio so doesn't work
+            python: cp27
 
         include:
-        - os: ubuntu-latest
-          # Put coverage in the output dir mounted in docker
-          cov_file: /output/coverage.xml
-          test_requires: cothread pytest-asyncio aioca
-          # Build an sdist here so it has the right line endings
-          sdist: true
-
-        - os: windows-latest
-          cov_file: '{project}/dist/coverage.xml'
-          # cothread doesn't work on windows
-          test_requires: pytest-asyncio aioca
-
-        - os: macos-latest
-          cov_file: '{project}/dist/coverage.xml'
-          test_requires: cothread pytest-asyncio aioca
-
-        - os: ubuntu-latest
-          python: cp27
-          # asyncio doesn't work on Python2.7
-          test_requires: cothread
-
-        - os: macos-latest
-          python: cp27
-          # asyncio doesn't work on Python2.7
-          test_requires: cothread
-
+          - os: ubuntu-latest
+            # Put coverage in the output dir mounted in docker
+            cov_file: /output/coverage.xml
+            test_requires: cothread pytest-asyncio aioca
+            # Build an sdist here so it has the right line endings
+            sdist: true
+
+          - os: windows-latest
+            cov_file: "{project}/dist/coverage.xml"
+            # cothread doesn't work on windows
+            test_requires: pytest-asyncio aioca
+
+          - os: macos-latest
+            cov_file: "{project}/dist/coverage.xml"
+            test_requires: cothread pytest-asyncio aioca
+
+          - os: ubuntu-latest
+            python: cp27
+            # asyncio doesn't work on Python2.7
+            test_requires: cothread
+
+          - os: macos-latest
+            python: cp27
+            # asyncio doesn't work on Python2.7
+            test_requires: cothread
 
     steps:
       - name: Checkout Source
@@ -74,10 +73,10 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v2
         with:
-          python-version: '3.7'
+          python-version: "3.7"
 
       - name: Install Python Dependencies
-        run: pip install build cibuildwheel
+        run: pip install build cibuildwheel==1.* # The 2.* releases dropped Python2 support.
 
       - name: Build Sdist
         if: matrix.sdist
@@ -91,8 +90,9 @@ jobs:
           CIBW_TEST_COMMAND: pytest --cov=softioc {project}/tests --cov-report xml:${{ matrix.cov_file }}
           # Disable auditwheel as it isn't compatible with setuptools_dso approach
           # https://github.com/mdavidsaver/setuptools_dso/issues/17
-          CIBW_REPAIR_WHEEL_COMMAND: ''
+          CIBW_REPAIR_WHEEL_COMMAND: ""
           CIBW_MANYLINUX_X86_64_IMAGE: manylinux1
+          CIBW_ENVIRONMENT_LINUX: SETUPTOOLS_DSO_PLAT_NAME=manylinux1_x86_64
 
       - name: Upload Wheel and Sdist
         uses: actions/upload-artifact@v2
@@ -125,4 +125,3 @@ jobs:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.pypi_token }}
         run: twine upload dist/*
-

Pipfile.lock

@@ -0,0 +1,16 @@
+from softioc import builder, softioc
+from softioc.builder import records
+
+builder.SetDeviceName("XX-XX-XX-01")
+
+py_record = builder.aOut("VAL1", initial_value=5, on_update=print)
+soft_record = records.ao("VAL2", VAL=10)
+
+calc = records.calc("CALC", CALC="A*B", INPA=builder.CP(py_record), B=1)
+
+soft_record.OUT = builder.PP(calc.B)
+
+builder.LoadDatabase()
+softioc.iocInit()
+
+softioc.interactive_ioc(globals())

docs/examples/example_records_calculate.py

@@ -0,0 +1,40 @@
+Use soft records in an IOC
+==========================
+
+It is possible to use records with soft device support mixed with pythonSoftIOC
+records (with Python device support). This allows use of ``calc``, ``fanout``
+and other EPICS database soft records.
+
+.. literalinclude:: ../examples/example_records_calculate.py
+
+The ``VAL1`` record is created in the usual pythonSoftIOC way, with Python
+device support. You can :meth:`~softioc.device.ProcessDeviceSupportOut.set` it,
+and `on_update` will be called when you ``caput`` it.
+
+The ``VAL2`` record is created using the lower level
+:attr:`softioc.builder.records` object. You can `dbpf` it, and no Python will
+be called when you ``caput`` to it.
+
+Note that the Device Name is shared between both kinds of records - both will
+have the same prefix.
+
+We construct the ``calc`` record again using :attr:`softioc.builder.records`.
+This record will calculate ``A*B``:
+
+- ``A`` is provided by the record pointed at by ``INPA``, which is
+  ``py_record``, and the `CP` link causes it to be monitored, processing
+  ``calc`` each time it updates.
+
+- ``B`` is initially set to 1. When ``soft_record`` processes, it sends its
+  value to ``calc.B``, and the `PP` link causes it to process.
+
+.. note::
+
+    You could also use ``calc(SCAN="1 second", ...)`` instead of the `PP` and
+    `CP` links, which would fetch the value periodically rather than just on
+    change.
+
+The output of this IOC can be examined by running this IOC in one terminal, and
+then modifying and running the example scripts found in `read-data-from-ioc`.
+Try setting the value of either ``VAL1`` or ``VAL2`` and observe the effect on
+the ``CALC`` output.

docs/how-to/use-soft-records.rst

@@ -61,6 +61,7 @@ Table Of Contents
     how-to/use-asyncio-in-an-ioc
     how-to/make-publishable-ioc
     how-to/read-data-from-ioc
+    how-to/use-soft-records
 
 .. toctree::
     :caption: Explanations

docs/index.rst

@@ -351,20 +351,12 @@ The following attributes allow more direct access to record creation.
 
 ..  attribute:: records
 
-    This is the ``iocbuilder`` records object, and is populated with
+    This is the `epicsdbbuilder.records` object, and is populated with
     functions named after each available record type.  Records created with
     these calls are created with soft device support and Python is not involved
     in their processing.
 
-    The following example shows a calc record being used to post-process a
-    standard Python IOC record::
-
-        from softioc import builder
-        builder.SetDeviceName('XX-XX-XX-01')
-        rec = aIn('VALUE')
-        calc = records.calc('CALC', CALC = 'A*B', A = rec, B = 42)
-        rec.FLNK = PP(calc)
-
+    See `../how-to/use-soft-records` for a full example of its usage.
 
 Finally, the following function is used to load record definitions before
 starting the IOC.

docs/reference/api.rst

@@ -71,6 +71,12 @@ internals of the IOC while it's running.  The alternative is to call something
 like :func:`cothread.WaitForQuit` or some other `cothread` blocking
 action.
 
+.. note::
+    The following section should only be used for debugging purposes, and not
+    for production testing, as the functions used do not necessarily reflect
+    what a real user would see when querying an IOC over the network.
+    See `../how-to/read-data-from-ioc` for proper network access examples.
+
 In this interpreter there is immediate access to methods defined in the
 `softioc.softioc` module. For example the :func:`~softioc.softioc.dbgf` function
 can be run to observe the increasing value of ``AI``::
@@ -122,10 +128,11 @@ following types:
      ``mbbo``, ``stringin``, ``stringout``, ``waveform``
 
 Occasionally it may be desirable to create a soft record without ``Python``
-device support, particularly if any other record type is required.  This can be done using the corresponding record creation
-functions provided as methods of :attr:`softioc.builder.records`.  For example, if a ``calc``
-record is required then this can be created by calling
-``softioc.builder.records.calc``.
+device support, particularly if any other record type is required.  This can be
+done using the corresponding record creation functions provided as methods of
+:attr:`softioc.builder.records`.  For example, if a ``calc`` record is required
+then this can be created by calling ``softioc.builder.records.calc``. See an
+example in `../how-to/use-soft-records`.
 
 For all records created by these methods both
 :meth:`~softioc.device.ProcessDeviceSupportIn.get` and

docs/tutorials/creating-an-ioc.rst

@@ -1,3 +1,3 @@
 [build-system]
-requires = ["setuptools", "wheel", "setuptools_dso", "epicscorelibs>=7.0.6.99.1.0a1"]
+requires = ["setuptools", "wheel", "setuptools_dso>=2.1", "epicscorelibs>=7.0.6.99.1.0a1"]
 build-backend = "setuptools.build_meta:__legacy__"

pyproject.toml

@@ -6,7 +6,6 @@
 import epicscorelibs.version
 from setuptools_dso import Extension, setup
 from epicscorelibs.config import get_config_var
-from wheel.bdist_wheel import bdist_wheel
 
 # Place the directory containing _version_git on the path
 for path, _, filenames in os.walk(os.path.dirname(os.path.abspath(__file__))):
@@ -100,18 +99,9 @@ def install_for_development(self):
             os.symlink(os.path.join(self.install_dir, "epicscorelibs"), link)
 
 
-class Wheel(bdist_wheel):
-    def get_tag(self):
-        impl, abi_tag, plat_name = bdist_wheel.get_tag(self)
-        # We want to produce manylinux tagged builds, but can't use
-        # auditwheel as it isn't compatible with setuptools_dso
-        # override the tag here as cibuildwheel won't let us do this
-        plat_name = os.environ.get("AUDITWHEEL_PLAT", plat_name)
-        return (impl, abi_tag, plat_name)
-
 
 setup(
-    cmdclass=dict(develop=Develop, bdist_wheel=Wheel, **get_cmdclass()),
+    cmdclass=dict(develop=Develop, **get_cmdclass()),
     version=__version__,
     ext_modules = [ext],
     install_requires = [