Merge pull request #1001 from allthingslinux/basedpyright

build: switch to basedpyright

Author: electron271

.devcontainer/devcontainer.json

@@ -19,7 +19,7 @@
     "vscode": {
       "extensions": [
         "ms-python.python",
-        "ms-python.vscode-pylance",
+        "detachhead.basedpyright",
         "charliermarsh.ruff",
         "prisma.prisma",
         "kevinrose.vsc-python-indent",

.github/CONTRIBUTING.md

@@ -169,7 +169,7 @@ Follow these steps to set up your local development environment. For more compre
     # Lint code using Ruff
     poetry run tux dev lint-fix
 
-    # Type-check code using Pyright
+    # Type-check code using basedpyright
     poetry run tux dev type-check
 
     # Run all pre-commit checks (includes formatting, linting, etc.)

.github/workflows/ci.yml

@@ -10,7 +10,7 @@
 # ------------------
 # 1. Smart file change detection to skip unnecessary jobs
 # 2. Parallel execution for different linting categories
-# 3. Comprehensive Python static analysis with Pyright
+# 3. Comprehensive Python static analysis with basedpyright
 # 4. Infrastructure validation (Docker, GitHub Actions, Shell)
 # 5. Markdown linting for documentation quality
 # 6. Efficient caching to reduce execution time
@@ -62,15 +62,15 @@ jobs:
   # PYTHON QUALITY CHECKS - Static Analysis and Type Checking
   # ============================================================================
   # Purpose: Ensures Python code quality through static analysis and type checking
-  # Tools: Pyright type checker with Poetry dependency management
+  # Tools: Basedpyright type checker with Poetry dependency management
   # Optimization: Only runs when Python files or dependencies change
   # ============================================================================
   python:
     name: Python Type Checking
     runs-on: ubuntu-latest
     permissions:
       contents: read          # Required for checkout
-      pull-requests: write   # Required for Pyright annotations
+      pull-requests: write   # Required for basedpyright annotations
     steps:
       # REPOSITORY CHECKOUT
       # Full history needed for accurate change detection
@@ -115,14 +115,10 @@ jobs:
           generate-prisma: 'true'
 
       # STATIC TYPE CHECKING
-      # Pyright provides comprehensive type checking for Python
+      # basedpyright provides comprehensive type checking for Python
       # Annotations appear directly in PR for developer feedback
-      - name: Run Pyright type checker
-        if: steps.python_changes.outputs.any_changed == 'true' || github.event_name
-          == 'workflow_dispatch'
-        uses: jakebailey/pyright-action@b5d50e5cde6547546a5c4ac92e416a8c2c1a1dfe # v2
-        with:
-          annotate: errors
+      - name: Run basedpyright type checker
+        run: poetry run basedpyright
 
   # ============================================================================
   # MARKDOWN DOCUMENTATION LINTING

.vscode/extensions.json

@@ -3,7 +3,7 @@
     "EditorConfig.EditorConfig",
     "ms-vscode-remote.remote-containers",
     "ms-python.python",
-    "ms-python.vscode-pylance",
+    "detachhead.basedpyright",
     "ms-azuretools.vscode-docker",
     "charliermarsh.ruff",
     "prisma.prisma",

.vscode/settings.json

@@ -11,8 +11,9 @@
       "source.organizeImports.ruff": "explicit"
     }
   },
-  "python.languageServer": "Pylance",
-  "python.analysis.typeCheckingMode": "strict",
+  "python.analysis.typeCheckingMode": "off",
+  "cursorpyright.analysis.typeCheckMode": "off",
+  "python.languageServer": "None",
   "python.analysis.autoFormatStrings": true,
   "python.analysis.completeFunctionParens": true,
   "python.analysis.autoImportCompletions": true,

README.md

@@ -58,7 +58,7 @@ It is designed to provide a variety of features to the server, including moderat
 - Python 3.13+ alongside the `discord.py` library
 - Poetry for dependency management
 - Docker and Docker Compose for optional containerized environments
-- Strict typing with `pyright` and type hints
+- Strict typing with `basedpyright` and type hints
 - Type safe ORM using `prisma`
 - Linting and formatting via `ruff`
 - Custom CLI via `click` and `poetry` scripts

poetry.lock

@@ -55,7 +55,7 @@ jinja2 = "^3.1.6"
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = "==4.2.0"
-pyright = "==1.1.403"
+basedpyright = "==1.29.5" # currently downgraded due to https://github.com/DetachHead/basedpyright/issues/1395
 ruff = "==0.12.7"
 poetry-types = "0.6.0"
 yamllint = "1.37.1"
@@ -150,7 +150,7 @@ line-ending = "lf"
 quote-style = "double"
 skip-magic-trailing-comma = false
 
-[tool.pyright]
+[tool.basedpyright]
 defineConstant = { DEBUG = true }
 enableReachabilityAnalysis = true
 exclude = ["__pypackages__", "_build", "examples", ".archive", "typings/**"]
@@ -160,6 +160,7 @@ stubPath = "typings"
 pythonPlatform = "Linux"
 pythonVersion = "3.13"
 reportImportCycles = true
+reportRedeclaration = false
 strictDictionaryInference = true
 strictListInference = true
 strictSetInference = true

pyproject.toml

@@ -30,8 +30,8 @@ def format_code() -> int:
 
 @command_registration_decorator(dev_group, name="type-check")
 def type_check() -> int:
-    """Check types with Pyright."""
-    return run_command(["pyright"])
+    """Check types with basedpyright."""
+    return run_command(["basedpyright"])
 
 
 @command_registration_decorator(dev_group, name="pre-commit")