Use Ruff, fix various tests

Author: JelleZijlstra

.github/workflows/publish.yml

@@ -10,27 +10,27 @@ jobs:
     name: Build and publish Python distributions to PyPI and TestPyPI
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.10
-      uses: actions/setup-python@v4
-      with:
-        python-version: "3.10"
-    - name: Install pypa/build
-      run: >-
-        python -m
-        pip install
-        build
-        --user
-    - name: Build a binary wheel and a source tarball
-      run: >-
-        python -m
-        build
-        --sdist
-        --wheel
-        --outdir dist/
-        .
-    - name: Publish distribution to PyPI
-      if: startsWith(github.ref, 'refs/tags')
-      uses: pypa/gh-action-pypi-publish@master
-      with:
-        password: ${{ secrets.PYPI_API_TOKEN }}
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+          .
+      - name: Publish distribution to PyPI
+        if: startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/test.yml

@@ -12,15 +12,15 @@ jobs:
         python-version: [3.7, 3.8, 3.9, "3.10", "3.11", "3.12"]
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-        allow-prereleases: true
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install tox tox-gh-actions
-    - name: Test with tox
-      run: tox
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox tox-gh-actions
+      - name: Test with tox
+        run: tox

.pre-commit-config.yaml

@@ -1,14 +1,32 @@
 repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.2.1
+    hooks:
+      - id: ruff
+        args: [--fix]
+
   - repo: https://github.com/psf/black
-    rev: 24.1.1
+    rev: 24.2.0
     hooks:
       - id: black
-        language_version: python3.9
-
-ci:
-    autofix_commit_msg: '[pre-commit.ci] auto fixes from pre-commit.com hooks'
-    autofix_prs: true
-    autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
-    autoupdate_schedule: weekly
-    skip: []
-    submodules: false
+        language_version: python3.12
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - types-requests
+          - aiohttp
+        exclude: ^(typeshed_client/typeshed|tests/(site-packages|typeshed))/
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v4.0.0-alpha.8
+    hooks:
+      - id: prettier
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

pyproject.toml

@@ -1,5 +1,5 @@
 [tool.black]
-target_version = ['py37', 'py38', 'py39', 'py310', 'py311']
+target_version = ['py38', 'py39', 'py310', 'py311', 'py312']
 include = '\.pyi?$'
 skip-magic-trailing-comma = true
 preview = true
@@ -50,7 +50,41 @@ disallow_any_decorated = true
 
 exclude = [
   "typeshed_client/typeshed",
+  "tests/site-packages",
   "tests/typeshed",
   "build/",
+  "thirdparty",
   ".tox/",
 ]
+
+[tool.ruff]
+
+line-length = 100
+target-version = "py38"
+
+exclude = [
+  "typeshed_client/typeshed",
+  "tests/typeshed",
+  "build/",
+  ".tox/",
+]
+
+[tool.ruff.lint]
+select = [
+  "F",
+  "E",
+  "I",  # import sorting
+  "ANN",  # enforce type annotations
+  "C4",  # flake8-comprehensions
+  "B",  # bugbear
+  "SIM",  # simplify
+  "UP",  # pyupgrade
+  "PIE",
+  "PERF",
+]
+
+ignore = [
+  "ANN101",  # missing type annotation for self in method
+  "ANN102",  # missing type annotation for cls in classmethod
+  "SIM105",  # I don't like contextlib.suppress
+]

setup.py

@@ -1,10 +1,10 @@
 import ast
 import os
-from pathlib import Path
 import re
+from pathlib import Path
 from typing import Iterable
-from setuptools import setup
 
+from setuptools import setup
 
 current_dir = Path(__file__).parent.resolve()
 ts_client_dir = current_dir / "typeshed_client"

tests/test.py

@@ -1,17 +1,18 @@
-from pathlib import Path
 import ast
+import unittest
+from pathlib import Path
+from typing import Any, Optional, Set, Type
+from unittest import mock
+
 import typeshed_client
 from typeshed_client.finder import (
-    get_search_context,
+    ModulePath,
     PythonVersion,
-    get_stub_file,
     SearchContext,
-    ModulePath,
+    get_search_context,
+    get_stub_file,
 )
 from typeshed_client.parser import get_stub_names
-from typing import Any, Set, Type, Optional
-from unittest import mock
-import unittest
 
 TEST_TYPESHED = Path(__file__).parent / "typeshed"
 PACKAGES = Path(__file__).parent / "site-packages"
@@ -334,7 +335,12 @@ def test(self) -> None:
         ctx = get_search_context(raise_on_warnings=True)
         for module_name, module_path in typeshed_client.get_all_stub_files(ctx):
             with self.subTest(path=module_name):
-                ast = typeshed_client.get_stub_ast(module_name, search_context=ctx)
+                try:
+                    ast = typeshed_client.get_stub_ast(module_name, search_context=ctx)
+                except SyntaxError:
+                    # idlelib for some reason ships an example stub file with a syntax error.
+                    # typeshed-client should also throw a SyntaxError in this case.
+                    pass
                 assert ast is not None
                 is_init = module_path.name == "__init__.pyi"
                 typeshed_client.parser.parse_ast(

tox.ini

@@ -9,7 +9,7 @@ commands =
 
 [testenv:black]
 deps =
-    black == 24.1.1
+    black == 24.2.0
 commands =
     black --check .
 
@@ -22,9 +22,8 @@ commands =
 
 [gh-actions]
 python =
-    3.7: py37
     3.8: py38
     3.9: py39
     3.10: py310
-    3.11: py311, black, mypy
-    3.12: py312
+    3.11: py311
+    3.12: py312, black, mypy

typeshed_client/__init__.py

@@ -1,29 +1,24 @@
 """Package for retrieving data from typeshed."""
 
-from . import finder
-from . import parser
-from . import resolver
-
 # Exported names
 from .finder import (
-    get_stub_ast,
-    get_stub_file,
+    ModulePath,
+    SearchContext,
     get_all_stub_files,
     get_search_context,
-    SearchContext,
-    ModulePath,
+    get_stub_ast,
+    get_stub_file,
 )
 from .parser import (
-    get_stub_names,
-    parse_ast,
     ImportedName,
     NameDict,
     NameInfo,
     OverloadedName,
+    get_stub_names,
+    parse_ast,
 )
 from .resolver import ImportedInfo, Resolver
 
-
 __version__ = "2.4.0"
 
 

typeshed_client/finder.py

@@ -1,13 +1,12 @@
 """This module is responsible for finding stub files."""
 
-from functools import lru_cache
-import importlib_resources
+import ast
 import json
 import os
-from pathlib import Path
 import subprocess
 import sys
-import ast
+from functools import lru_cache
+from pathlib import Path
 from typing import (
     TYPE_CHECKING,
     Dict,
@@ -22,6 +21,8 @@
     Tuple,
 )
 
+import importlib_resources
+
 PythonVersion = Tuple[int, int]
 ModulePath = NewType("ModulePath", Tuple[str, ...])
 
@@ -207,7 +208,7 @@ def _get_all_stub_files_from_directory(
     return new_seen
 
 
-@lru_cache()
+@lru_cache
 def get_search_path(typeshed_dir: Path, pyversion: Tuple[int, int]) -> Tuple[Path, ...]:
     # mirrors default_lib_path in mypy/build.py
     path: List[Path] = []
@@ -275,7 +276,7 @@ class _VersionData(NamedTuple):
     in_python2: bool
 
 
-@lru_cache()
+@lru_cache
 def get_typeshed_versions(typeshed: Path) -> Dict[str, _VersionData]:
     versions = {}
     try:
@@ -293,10 +294,7 @@ def get_typeshed_versions(typeshed: Path) -> Dict[str, _VersionData]:
             else:
                 min_version_str = version
                 max_version_str = None
-            if max_version_str:
-                max_version = _parse_version(max_version_str)
-            else:
-                max_version = None
+            max_version = _parse_version(max_version_str) if max_version_str else None
             min_version = _parse_version(min_version_str)
             python2_only = module in python2_files or module + ".pyi" in python2_files
             versions[module] = _VersionData(min_version, max_version, python2_only)