Switched to pyproject; support collections.abc types

Author: patrick-kidger

.flake8

@@ -0,0 +1 @@
+github: [patrick-kidger]

.github/FUNDING.yml

@@ -0,0 +1,23 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Release
+        uses: patrick-kidger/action_update_python_project@v2
+        with:
+            python-version: "3.11"
+            test-script: ""
+            pypi-token: ${{ secrets.pypi_token }}
+            github-user: patrick-kidger
+            github-token: ${{ github.token }}
+            email-user: ${{ secrets.email_user }}
+            email-token: ${{ secrets.email_token }}
+            email-server: ${{ secrets.email_server }}
+            email-target: ${{ secrets.email_target }}

.github/workflows/release.yml

@@ -3,11 +3,13 @@ repos:
     rev: 22.3.0
     hooks:
     - id: black
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: 'v0.0.255'
     hooks:
-    - id: isort
-  - repo: https://github.com/pycqa/flake8
-    rev: 4.0.1
+      - id: ruff
+        args: ["--fix"]
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.314
     hooks:
-    - id: flake8
+    - id: pyright
+      additional_dependencies: ["pytkdocs==0.15.0"]

.isort.cfg

@@ -0,0 +1,43 @@
+[project]
+name = "pytkdocs_tweaks"
+version = "0.0.7"
+description = "Some custom tweaks to the results produced by pytkdocs (part of mkdocstrings)."
+readme = "README.md"
+requires-python ="~=3.8"
+license = {file = "LICENSE"}
+authors = [
+  {name = "Patrick Kidger", email = "[email protected]"},
+]
+keywords = ["documentation", "mkdocs", "mkdocs-material", "mkdocstrings"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+]
+urls = {repository = "https://github.com/patrick-kidger/pytkdocs_tweaks" }
+dependencies = ["pytkdocs>=0.15.0"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build]
+include = ["pytkdocs_tweaks/*"]
+
+[tool.ruff]
+select = ["E", "F", "I001"]
+ignore = ["E402", "E721", "E731", "E741", "F722"]
+ignore-init-module-imports = true
+fixable = ["I001", "F401"]
+
+[tool.ruff.isort]
+combine-as-imports = true
+lines-after-imports = 2
+extra-standard-library = ["typing_extensions"]
+order-by-type = false
+
+[tool.pyright]
+reportIncompatibleMethodOverride = true
+include = ["pytkdocs_tweaks"]

.pre-commit-config.yaml

@@ -3,7 +3,6 @@
 import inspect
 import json
 import pathlib
-import sys
 import traceback
 import typing
 import warnings
@@ -89,11 +88,17 @@ def _postprocess(data, cache, bases):
                     parameter["annotation"] = parameter["annotation"].replace(
                         p, p.rsplit(".", 1)[1]
                     )
+                parameter["annotation"] = parameter["annotation"].replace(
+                    "collections.abc.", ""
+                )
         if "return_annotation" in signature:
             for p in cache:
                 signature["return_annotation"] = signature["return_annotation"].replace(
                     p, p.rsplit(".", 1)[1]
                 )
+            signature["return_annotation"] = signature["return_annotation"].replace(
+                "collections.abc.", ""
+            )
 
     if "bases" in data:
         # Find those base classes which are part of our public documentation.
@@ -155,6 +160,7 @@ def _postprocess(data, cache, bases):
             if isinstance(_base_obj, property):
                 # Property objects don't inherit module or qualname
                 _base_obj = _base_obj.fget
+            assert _base_obj is not None
             _base_path = _base_obj.__module__ + "." + _base_obj.__qualname__
             _base_config = {"objects": [{"path": _base_path}]}
             _base_result = pytkdocs.cli.process_config(_base_config)
@@ -250,8 +256,10 @@ def serialize_signature_parameter(parameter):
 
     # By default pytkdocs has some really weird behaviour in which the docstring for
     # inherited magic methods are removed. This removes that behaviour.
-    pytkdocs.loader.RE_SPECIAL = argparse.Namespace(match=lambda _: False)
+    pytkdocs.loader.RE_SPECIAL = argparse.Namespace(  # pyright: ignore
+        match=lambda _: False
+    )
 
     # Set a flag to say we're generating documentation, which the library can use to
     # customise how its types are displayed.
-    typing.GENERATING_DOCUMENTATION = True
+    typing.GENERATING_DOCUMENTATION = True  # pyright: ignore