Merge remote-tracking branch 'origin/master' into semantic-classes

Author: Joel Collins

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,51 @@
+name: "Code scanning - action"
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 4 * * 3'
+
+jobs:
+  CodeQL-Build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+      
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      # Override language selection by uncommenting this and choosing your languages
+      # with:
+      #   languages: go, javascript, csharp, python, cpp, java
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/publish.yml

@@ -27,11 +27,15 @@ jobs:
           poetry config virtualenvs.in-project false
           poetry config virtualenvs.path ~/.virtualenvs
 
-      - name: Install Tox
-        run: pip install tox
+      - name: Install Dependencies
+        run: poetry install
 
-      - name: Run Tox
-        run: tox -e py # Run tox using the version of Python in `PATH`
+      - name: Code Quality
+        run: poetry run black . --check
+        continue-on-error: true
+
+      - name: Test with pytest
+        run: poetry run pytest
 
   publish:
     runs-on: ubuntu-latest

.github/workflows/test.yml

@@ -29,11 +29,15 @@ jobs:
           poetry config virtualenvs.in-project false
           poetry config virtualenvs.path ~/.virtualenvs
 
-      - name: Install Tox
-        run: pip install tox
+      - name: Install Dependencies
+        run: poetry install
 
-      - name: Run Tox
-        run: tox -e py # Run tox using the version of Python in `PATH`
+      - name: Code Quality
+        run: poetry run black . --check
+        continue-on-error: true
+
+      - name: Test with pytest
+        run: poetry run pytest
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v1

examples/builder.py

@@ -8,6 +8,7 @@
 
 from labthings.server.quick import create_app
 from labthings.server import semantics
+from labthings.server import fields
 
 from components.pdf_component import PdfComponent
 
@@ -42,14 +43,25 @@
     "magic_dictionary",  # Objects attribute name
     "/dictionary",  # URL to bind the property to
     description="A big dictionary of little properties",
+    schema={  # Property is a dictionary, with these value types
+        "voltage": fields.Int(),
+        "volume": fields.List(fields.Int()),
+        "mode": fields.String(),
+        "light_on": fields.Bool(),
+        "user": {"name": fields.String(), "id": fields.Int()},
+        "bytes": fields.Bytes(),
+    },
 )
 
 labthing.build_action(
     my_component.average_data,  # Python function
     "/average",  # URL to bind the action to
     description="Take an averaged measurement",
     safe=True,  # Is the state of the Thing unchanged by calling the action?
-    idempotent=True,  # Can the action be called repeatedly with the same result?
+    idempotent=True,  # Can the action be called repeatedly with the same result?,
+    args={  # How do we convert from the request input to function arguments?
+        "n": fields.Int(description="Number of averages to take", example=5, default=5)
+    },
 )
 
 

examples/components/pdf_component.py

@@ -2,8 +2,6 @@
 import math
 import time
 
-from typing import List
-
 """
 Class for our lab component functionality. This could include serial communication,
 equipment API calls, network requests, or a "virtual" device as seen here.
@@ -41,7 +39,7 @@ def data(self):
         """Return a 1D data trace."""
         return [self.noisy_pdf(x) for x in self.x_range]
 
-    def average_data(self, n: int, optlist: List[int] = [1, 2, 3]):
+    def average_data(self, n: int):
         """Average n-sets of data. Emulates a measurement that may take a while."""
         summed_data = self.data
 

poetry.lock

@@ -7,6 +7,7 @@
 
 sentinel = object()
 
+
 class RLock(_RLock):
     def locked(self):
         return self._block.locked()

src/labthings/core/lock.py

@@ -19,7 +19,10 @@ def default(self, o):
         if isinstance(o, set):
             return list(o)
         if isinstance(o, bytes):
-            return b64encode(o).decode()
+            try:  # Try unicode
+                return o.decode()
+            except UnicodeDecodeError:  # Otherwise, base64
+                return b64encode(o).decode()
         return JSONEncoder.default(self, o)
 
 
@@ -32,7 +35,7 @@ def output_json(data, code, headers=None):
     """Makes a Flask response with a JSON encoded body, using app JSON settings"""
 
     settings = current_app.config.get("LABTHINGS_JSON", {})
-    encoder = current_app.json_encoder
+    encoder = LabThingsJSONEncoder
 
     if current_app.debug:
         settings.setdefault("indent", 4)
@@ -55,7 +58,6 @@ def output_cbor(data, code, headers=None):
     """Makes a Flask response with a CBOR encoded body, using app CBOR settings"""
 
     settings = current_app.config.get("LABTHINGS_CBOR", {})
-
     dumped = encode_cbor(data, **settings)
 
     resp = make_response(dumped, code)