Update to follow our code standards more closely (#4)

* Added editorconfig based on that in nvaccess/nvda

* lf instead of crlf

* Add initial ruff configuration, based on that of NVDA

* remove explicit inheritance from `object`

* Initial run ov monkeytype over the code base

* Remove inheritance from object

* Fix a couple of type annotations

* Rename and improve ruff.toml

* Fix up type annotations by removing Optional, Union, Dict, List etc

* Read certificates as binary

* Move type hints into server.py

* Fix logging

* Fix ambiguous name

* Fix some typing issues

* Docstrings for channel

* Docstrings for Handler

* Docstrings for User

* Docstrings for ServerState

* Add some comments

* Enable pyright, with all failing tests disabled

* Fix reportDeprecated

* Fix unannotated functions

* Resolved several type issues

* Move to pyproject.toml for ruff config

* Remove no longer needed type stubs

* Update pre-commit config for CI

* Pre-commit updates

* Remove pyrightCI and remove pyrightLocal alias

* Experimental pyright GHA

* Try using uvx to run pyright

* Update deps

* Try running with uv run

* Sync environment then use uvx

* Include dev

* Use uv run

* Apply suggestions from code review

Co-authored-by: Sean Budd <[email protected]>

* Update .github/workflows/pyright.yml

Co-authored-by: Sean Budd <[email protected]>

* Fix pyright error in server.py

* Fix typ annotations on test.TestGenerateKey._test

* Silence pyright errors caused by incorrect types in ttwisted/Zope interfaces

* Bring coverage back up to 100%

* camelCase variables, methods and attributes in server.Channel

* camelCase attributes, methods and variables in server.Handler

* camelCase attributes, methods and variables in server.User

* camelCase attributes, methods and variables in server.RemoteServerFactory

* camelCase attributes, methods and variables in server.ServerState

* Fix some straggling snake_case

* Minor sweeks

* Try using a composite setup action for coverage

* Add default shell to actions/setup-environment

* run -> runs

* Move shell to steps with runs

* Use setup-environment with pyright ci

* Add pyright output to GHA summary

* Test restricting perms

* Test restricting perms

* Restrict perms of pyright action

---------

Co-authored-by: Sean Budd <[email protected]>

Author: SaschaCowley

.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.py]
+charset = utf-8
+indent_style = tab
+tab_width = 4
+trim_trailing_whitespace = true
+max_line_length = 110
+
+[*.{yml,yaml}]
+indent_style = space
+charset = utf-8
+indent_size = 2
+trim_trailing_whitespace = true

.github/actions/setup-environment/action.yml

@@ -0,0 +1,11 @@
+name: 'Setup CI Environment'
+description: 'Setup the environment in which CI scripts for the NVDA Remote Access server can be run'
+
+runs:
+  using: "composite"
+  steps:
+    - name: Install the latest version of uv
+      uses: astral-sh/[email protected]
+    - name: Setup environment
+      shell: bash
+      run: uv sync --dev

.github/workflows/coverage.yml

@@ -6,14 +6,10 @@ jobs:
   coverage:
     name: Check coverage with coverage.py
     runs-on: ubuntu-latest
-    permissions:
-      pull-requests: write
+    permissions: {}
     steps:
       - uses: actions/[email protected]
-      - name: Install the latest version of uv
-        uses: astral-sh/[email protected]
-      - name: Setup environment
-        run: uv sync --dev
+      - uses: ./.github/actions/setup-environment
       - name: Run unit tests
         run: uv run coverage run
       - name: Report coverage

.github/workflows/pyright.yml

@@ -0,0 +1,21 @@
+name: Check types with Pyright
+
+on:
+  push:
+    branches:
+    - main
+
+  pull_request:
+    branches:
+    - main
+
+jobs:
+  pyright:
+    name: Check types with pyright
+    runs-on: ubuntu-latest
+    permissions: {}
+    steps:
+      - uses: actions/[email protected]
+      - uses: ./.github/actions/setup-environment
+      - name: Run pyright
+        run: uv run pyright >> $GITHUB_STEP_SUMMARY

pyproject.toml

@@ -49,6 +49,7 @@ reportOptionalMemberAccess = false
 # The following option causes problems due to dynamic member access
 reportUnknownArgumentType = false
 
+
 [tool.ruff]
 line-length = 110