Merge pull request #68 from tcalmant/uv-update

Configured repo to be usable with uv/ruff

Author: tcalmant

.github/workflows/build-24.04.yml

@@ -30,7 +30,6 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install flake8 pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

.gitignore

@@ -11,18 +11,20 @@ __pycache__
 # VS Code
 .vscode
 .cache
-.mypy_cache
+.*_cache
 
 # Tox
 .tox/
 .coverage
+.coverage.*
 htmlcov/
 
 # Nosetests
 .noseids
 nosetests.xml
 
 # Development environment
+.venv/
 venv*/
 
 # When installed in develop mode
@@ -32,3 +34,6 @@ venv*/
 build/*
 dist/*
 *.egg-info/
+
+# uv lock file
+uv.lock

jsonrpclib/SimpleJSONRPCServer.py

@@ -425,7 +425,7 @@ def _dispatch(self, method, params, config=None):
                 )
                 _logger.warning("Invalid call parameters: %s", fault)
                 return fault
-            except:
+            except BaseException:
                 # Method exception
                 err_lines = traceback.format_exception(*sys.exc_info())
                 trace_string = "{0} | {1}".format(
@@ -502,7 +502,7 @@ def do_POST(self):
 
             # No exception: send a 200 OK
             self.send_response(200)
-        except:
+        except BaseException:
             # Exception: send 500 Server Error
             self.send_response(500)
             err_lines = traceback.format_exception(*sys.exc_info())

pyproject.toml

@@ -44,5 +44,14 @@ Issues = "https://github.com/tcalmant/jsonrpclib/issues"
 Documentation = "https://jsonrpclib-pelix.readthedocs.io/"
 Source = "https://github.com/tcalmant/jsonrpclib/"
 
+[dependency-groups]
+dev = [
+    "coverage>=6.2",
+    "pytest>=7.0.1",
+]
+
 [tool.black]
 line-length = 80
+
+[tool.ruff]
+line-length = 80

run_tests.sh

@@ -1,44 +1,83 @@
 #!/bin/bash
 #
-# Script to execute tests in Docker
+# Script to execute tests in Docker / CI / UV environment
 #
 
+if [ -z "$UV" ]
+then
+    echo "UV is not set"
+else
+    echo "Using UV at $UV"
+fi
+
+run_pip_install() {
+    if [ -z "$UV" ]
+    then
+        pip install "$@"
+        return $?
+    else
+        uv pip install "$@"
+        return $?
+    fi
+}
+
+run_pip_uninstall() {
+    if [ -z "$UV" ]
+    then
+        pip uninstall -y "$@"
+        return $?
+    else
+        uv pip uninstall "$@"
+        return $?
+    fi
+}
+
+run_coverage() {
+    if [ -z "$UV" ]
+    then
+        coverage "$@"
+        return $?
+    else
+        uv run coverage "$@"
+        return $?
+    fi
+}
+
+run_lib_tests() {
+    export JSONRPCLIB_TEST_EXPECTED_LIB="$1"
+    run_pip_install "$2"
+    if [ $? -ne 0 ]
+    then
+        echo "Failed to install $2"
+        return 0
+    fi
+
+    run_coverage run -m pytest tests/test_jsonlib.py
+    rc=$?
+    run_pip_uninstall "$2"
+    return $rc
+}
+
 echo "Installing dependencies..."
-pip install pytest coverage || exit 1
+run_pip_install pytest coverage || exit 1
 export COVERAGE_PROCESS_START=".coveragerc"
 
 echo "Initial tests..."
 export JSONRPCLIB_TEST_EXPECTED_LIB=json
-coverage run -m pytest || exit 1
+run_coverage run -m pytest || exit 1
 
 echo "orJson tests..."
-pip install orjson && (
-    export JSONRPCLIB_TEST_EXPECTED_LIB=orjson
-    coverage run -m pytest tests/test_jsonlib.py || exit 1
-    pip uninstall -y orjson
-)
+run_lib_tests orjson orjson || exit 1
 
 echo "uJson tests..."
-pip install ujson && (
-    export JSONRPCLIB_TEST_EXPECTED_LIB=ujson
-    coverage run -m pytest tests/test_jsonlib.py || exit 1
-    pip uninstall -y ujson
-)
+run_lib_tests ujson ujson || exit 1
 
 echo "cJson tests..."
-pip install python-cjson && (
-    export JSONRPCLIB_TEST_EXPECTED_LIB=cjson
-    coverage run -m pytest tests/test_jsonlib.py || exit 1
-    pip uninstall -y python-cjson
-)
+run_lib_tests cjson python-cjson || exit 1
 
 echo "simplejson tests..."
-pip install simplejson && (
-    export JSONRPCLIB_TEST_EXPECTED_LIB=simplejson
-    coverage run -m pytest tests/test_jsonlib.py || exit 1
-    pip uninstall -y simplejson
-)
+run_lib_tests simplejson simplejson || exit 1
 
 echo "Combine results..."
-coverage combine || exit $?
-coverage report
+run_coverage combine || exit $?
+run_coverage report

tests/cgi-bin/cgi_server.py

@@ -10,7 +10,7 @@
 root_dir = os.path.dirname(os.path.dirname(current_dir))
 sys.path.insert(0, root_dir)
 
-from jsonrpclib.SimpleJSONRPCServer import CGIJSONRPCRequestHandler
+from jsonrpclib.SimpleJSONRPCServer import CGIJSONRPCRequestHandler  # noqa: E402
 
 
 def add(a, b):

tests/test_headers.py

@@ -74,15 +74,15 @@ def captured_headers(self, check_duplicates=True):
         # Extract the sent request content
         request_lines = f.getvalue().splitlines()
         request_lines = list(
-            filter(lambda l: l.startswith("send:"), request_lines)
+            filter(lambda line: line.startswith("send:"), request_lines)
         )
         request_line = request_lines[0].split("send: ")[-1]
 
         # Convert it to a string
         try:
             # Use eval to convert the representation into a string
             request_line = from_bytes(eval(request_line))
-        except:
+        except Exception:
             # Keep the received version
             pass
 

tests/test_jsonlib.py

@@ -89,30 +89,30 @@ def test_best(self):
         available = {"json"}
 
         try:
-            import cjson  # pylint: disable=unused-import,import-outside-toplevel
+            import cjson
 
-            available.add("cjson")
+            available.add(cjson.__name__)
         except ImportError:
             pass
 
         try:
-            import ujson  # pylint: disable=unused-import,import-outside-toplevel
+            import ujson
 
-            available.add("ujson")
+            available.add(ujson.__name__)
         except ImportError:
             pass
 
         try:
-            import simplejson  # pylint: disable=unused-import,import-outside-toplevel
+            import simplejson
 
-            available.add("simplejson")
+            available.add(simplejson.__name__)
         except ImportError:
             pass
 
         try:
-            import orjson  # pylint: disable=unused-import,import-outside-toplevel
+            import orjson
 
-            available.add("orjson")
+            available.add(orjson.__name__)
         except ImportError:
             pass
 

tests/test_unix.py

@@ -65,7 +65,7 @@ def test_full_path(self):
             # Clean up
             try:
                 os.remove(socket_name)
-            except:
+            except IOError:
                 pass
 
     def test_host_only(self):
@@ -105,5 +105,5 @@ def test_host_only(self):
             # Clean up
             try:
                 os.remove(socket_name)
-            except:
+            except IOError:
                 pass