Add lint workflow

.github/workflows/lint.yaml

@@ -0,0 +1,31 @@
+name: Lint
+on: [push, pull_request]
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - 3.12
+        job:
+          - mypy .
+          - ruff format --check .
+          - ruff check .
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --all-extras --all-groups
+
+      - run: uv run ${{ matrix.job }}

.gitignore

@@ -10,3 +10,6 @@ target.cfg.d
 build/
 dist/
 *.egg-info
+
+# Intellij IDEs
+.idea

pyproject.toml

@@ -0,0 +1,51 @@
+[project]
+name = "websockify"
+version = "0.13.0"
+description = "Websockify."
+readme = "README.md"
+authors = [
+    { name = "Joel Martin", email = "github@martintribe.org" }
+]
+requires-python = ">=3.6"
+dependencies = [
+    "jwcrypto>=1.5.1",
+    "numpy>=1.19.0",
+    "redis>=4.3.0",
+    "requests>=2.27.0",
+]
+classifiers = [
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+keywords = ["noVNC", "websockify"]
+license = { text = "LGPLv3" }
+
+[project.urls]
+Repository ="https://github.com/novnc/websockify"
+
+[project.scripts]
+websockify = "websockify.websocketproxy:websockify_init"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+
+[tool.hatch.build.targets.wheel]
+packages = [
+    "websockify",
+]
+
+[dependency-groups]
+dev = [
+    "mypy>=0.971",
+    "ruff>=0.0.17",
+]

setup.py

@@ -1,44 +1,44 @@
 from setuptools import setup, find_packages
 
-version = '0.13.0'
-name = 'websockify'
-long_description = open("README.md").read() + "\n" + \
-    open("CHANGES.txt").read() + "\n"
+version = "0.13.0"
+name = "websockify"
+long_description = open("README.md").read() + "\n" + open("CHANGES.txt").read() + "\n"
 
-setup(name=name,
-      version=version,
-      description="Websockify.",
-      long_description=long_description,
-      long_description_content_type="text/markdown",
-      classifiers=[
-          "Programming Language :: Python",
-          "Programming Language :: Python :: 3",
-          "Programming Language :: Python :: 3 :: Only",
-          "Programming Language :: Python :: 3.6",
-          "Programming Language :: Python :: 3.7",
-          "Programming Language :: Python :: 3.8",
-          "Programming Language :: Python :: 3.9",
-          "Programming Language :: Python :: 3.10",
-          "Programming Language :: Python :: 3.11",
-          "Programming Language :: Python :: 3.12",
-        ],
-      keywords='noVNC websockify',
-      license='LGPLv3',
-      url="https://github.com/novnc/websockify",
-      author="Joel Martin",
-      author_email="github@martintribe.org",
-
-      packages=['websockify'],
-      include_package_data=True,
-      install_requires=[
-        'numpy', 'requests',
-        'jwcrypto',
-        'redis',
-        ],
-      zip_safe=False,
-      entry_points={
-        'console_scripts': [
-            'websockify = websockify.websocketproxy:websockify_init',
+setup(
+    name=name,
+    version=version,
+    description="Websockify.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    classifiers=[
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3 :: Only",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+    ],
+    keywords="noVNC websockify",
+    license="LGPLv3",
+    url="https://github.com/novnc/websockify",
+    author="Joel Martin",
+    author_email="github@martintribe.org",
+    packages=["websockify"],
+    include_package_data=True,
+    install_requires=[
+        "numpy",
+        "requests",
+        "jwcrypto",
+        "redis",
+    ],
+    zip_safe=False,
+    entry_points={
+        "console_scripts": [
+            "websockify = websockify.websocketproxy:websockify_init",
         ]
-      },
-    )
+    },
+)

tests/echo.py

@@ -1,23 +1,26 @@
 #!/usr/bin/env python
 
-'''
+"""
 A WebSocket server that echos back whatever it receives from the client.
 Copyright 2010 Joel Martin
 Licensed under LGPL version 3 (see docs/LICENSE.LGPL-3)
 
 You can make a cert/key with openssl using:
 openssl req -new -x509 -days 365 -nodes -out self.pem -keyout self.pem
 as taken from http://docs.python.org/dev/library/ssl.html#certificates
-'''
+"""
 
 import os, sys, select, optparse, logging
-sys.path.insert(0,os.path.join(os.path.dirname(__file__), ".."))
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
 from websockify.websockifyserver import WebSockifyServer, WebSockifyRequestHandler
 
+
 class WebSocketEcho(WebSockifyRequestHandler):
     """
     WebSockets server that echos back whatever is received from the
-    client.  """
+    client."""
+
     buffer_size = 8096
 
     def new_websocket_client(self):
@@ -33,9 +36,11 @@ def new_websocket_client(self):
         while True:
             wlist = []
 
-            if cqueue or c_pend: wlist.append(self.request)
+            if cqueue or c_pend:
+                wlist.append(self.request)
             ins, outs, excepts = select.select(rlist, wlist, [], 1)
-            if excepts: raise Exception("Socket exception")
+            if excepts:
+                raise Exception("Socket exception")
 
             if self.request in outs:
                 # Send queued target data to the client
@@ -50,20 +55,27 @@ def new_websocket_client(self):
                 if closed:
                     break
 
-if __name__ == '__main__':
+
+if __name__ == "__main__":
     parser = optparse.OptionParser(usage="%prog [options] listen_port")
-    parser.add_option("--verbose", "-v", action="store_true",
-            help="verbose messages and per frame traffic")
-    parser.add_option("--cert", default="self.pem",
-            help="SSL certificate file")
-    parser.add_option("--key", default=None,
-            help="SSL key file (if separate from cert)")
-    parser.add_option("--ssl-only", action="store_true",
-            help="disallow non-encrypted connections")
+    parser.add_option(
+        "--verbose",
+        "-v",
+        action="store_true",
+        help="verbose messages and per frame traffic",
+    )
+    parser.add_option("--cert", default="self.pem", help="SSL certificate file")
+    parser.add_option(
+        "--key", default=None, help="SSL key file (if separate from cert)"
+    )
+    parser.add_option(
+        "--ssl-only", action="store_true", help="disallow non-encrypted connections"
+    )
     (opts, args) = parser.parse_args()
 
     try:
-        if len(args) != 1: raise ValueError
+        if len(args) != 1:
+            raise ValueError
         opts.listen_port = int(args[0])
     except ValueError:
         parser.error("Invalid arguments")
@@ -73,4 +85,3 @@ def new_websocket_client(self):
     opts.web = "."
     server = WebSockifyServer(WebSocketEcho, **opts.__dict__)
     server.start_server()
-

tests/echo_client.py

@@ -5,9 +5,12 @@
 import optparse
 import select
 
-sys.path.insert(0,os.path.join(os.path.dirname(__file__), ".."))
-from websockify.websocket import WebSocket, \
-    WebSocketWantReadError, WebSocketWantWriteError
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+from websockify.websocket import (
+    WebSocket,
+    WebSocketWantReadError,
+    WebSocketWantWriteError,
+)
 
 parser = optparse.OptionParser(usage="%prog URL")
 (opts, args) = parser.parse_args()
@@ -22,30 +25,37 @@
 sock.connect(URL)
 print("Connected.")
 
+
 def send(msg):
     while True:
         try:
             sock.sendmsg(msg)
             break
         except WebSocketWantReadError:
-            msg = ''
+            msg = ""
             ins, outs, excepts = select.select([sock], [], [])
-            if excepts: raise Exception("Socket exception")
+            if excepts:
+                raise Exception("Socket exception")
         except WebSocketWantWriteError:
-            msg = ''
+            msg = ""
             ins, outs, excepts = select.select([], [sock], [])
-            if excepts: raise Exception("Socket exception")
+            if excepts:
+                raise Exception("Socket exception")
+
 
 def read():
     while True:
         try:
             return sock.recvmsg()
         except WebSocketWantReadError:
             ins, outs, excepts = select.select([sock], [], [])
-            if excepts: raise Exception("Socket exception")
+            if excepts:
+                raise Exception("Socket exception")
         except WebSocketWantWriteError:
             ins, outs, excepts = select.select([], [sock], [])
-            if excepts: raise Exception("Socket exception")
+            if excepts:
+                raise Exception("Socket exception")
+
 
 counter = 1
 while True:
@@ -56,7 +66,8 @@ def read():
 
     while True:
         ins, outs, excepts = select.select([sock], [], [], 1.0)
-        if excepts: raise Exception("Socket exception")
+        if excepts:
+            raise Exception("Socket exception")
 
         if ins == []:
             break

tests/latency.py

@@ -1 +1 @@
-echo.py
+echo.py