Fix missing optional annotation in some cases.

Switch to PyPi trusted publisher.

.github/workflows/default.yml

@@ -1,36 +1,38 @@
 name: Build Documentation
 
 on:
+  pull_request:
   push:
     branches:
       - master
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-      with:
-        persist-credentials: false
-    # Standard drop-in approach that should work for most people.
-    - uses: ammaraskar/sphinx-action@master
-      env:
-        PYTHONPATH: .
-      with:
-        pre-build-command: "apt-get update -y && apt-get install -y libgl1-mesa-glx && cp stubs/2.4.0/mobase.pyi docs/mobase.py"
-        docs-folder: "docs/"
-
-    - name: Install SSH Client 🔑
-      uses: webfactory/ssh-agent@v0.4.1
-      with:
-        ssh-private-key: ${{ secrets.DEPLOY_KEY }}
-
-    - name: Deploy 🚀
-      uses: JamesIves/github-pages-deploy-action@3.7.1
-      with:
-        SSH: true
-        REPOSITORY_NAME: ModOrganizer2/python-plugins-doc
-        BRANCH: master
-        FOLDER: docs/build/html
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11
+      - uses: abatilo/actions-poetry@v2
+      - name: Install
+        run: |
+          poetry install
+      - name: Install libgl1
+        run: sudo apt install -y libgl1 libegl1 libglib2.0-0 libxkbcommon0 libdbus-1-3
+      - name: Copy stubs
+        run: cp stubs/2.5.0/mobase-stubs/__init__.pyi docs/mobase.py
+      - name: Build
+        run: poetry run sphinx-build -b html docs/source docs/build
+        env:
+          PYTHONPATH: docs
+      - if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
+        name: Deploy Documentation
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          ssh-key: ${{ secrets.DEPLOY_KEY }}
+          repository-name: ModOrganizer2/python-plugins-doc
+          branch: master
+          folder: docs/build

.github/workflows/linting.yml

@@ -5,20 +5,20 @@ on: [push, pull_request]
 jobs:
   checks:
     runs-on: ubuntu-latest
-    strategy:
-      max-parallel: 4
-      matrix:
-        python-version: [3.8]
-
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install tox
-    - name: Test with tox
-      run: tox -e py38-lint
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11
+      - uses: abatilo/actions-poetry@v2
+      - name: Install
+        run: |
+          poetry install
+      - name: Lint
+        run: |
+          poetry run black src --check --diff
+          poetry run isort -c src
+          poetry run mypy src
+          poetry run ruff src
+          poetry run pyright src

.github/workflows/pull_request.yml

@@ -1,18 +0,0 @@
-name: Check Documentation
-
-on: [pull_request]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v1
-    # Standard drop-in approach that should work for most people.
-    - uses: ammaraskar/sphinx-action@master
-      env:
-        PYTHONPATH: .
-      with:
-        pre-build-command: "apt-get update -y && apt-get install -y libgl1-mesa-glx && cp stubs/2.4.0/mobase.pyi docs/mobase.py"
-        docs-folder: "docs/"

.github/workflows/pypi-publish.yml

@@ -1,41 +1,57 @@
 # This workflows will upload a Python Package using Twine when a release is created
 # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
 
-name: Upload Python Package
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
 
 on:
   push:
     tags: ["*"]
 
 jobs:
-  deploy:
-
+  build:
+    name: Build distribution 📦
     runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Replace string
+        uses: frabert/replace-string-action@v1.1
+        id: version
+        with:
+          string: ${{ github.ref_name }}
+          pattern: "v?([0-9][.][0-9][.][0-9]).*"
+          replace-with: "$1"
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.11
+      - uses: abatilo/actions-poetry@v2
+      - name: Build
+        run: |
+          cd stubs/setup
+          mkdir mobase-stubs
+          cp -r ../${{ steps.version.outputs.replaced }}/mobase-stubs/* mobase-stubs/
+          sed -i 's/__version__ = ".*"/__version__ = "${{ github.ref_name }}"/' mobase-stubs/__init__.pyi
+          TAG=${{ github.ref_name }}
+          poetry version ${TAG#v}
+          poetry build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v3
+        with:
+          name: python-package-distributions
+          path: stubs/setup/dist/
+
+  publish-to-pypi:
+    name: Publish Python 🐍 distribution 📦 to PyPI
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Replace string
-      uses: frabert/replace-string-action@v1.1
-      id: version
-      with:
-        string: ${{ github.ref_name }}
-        pattern: "v?([0-9][.][0-9][.][0-9]).*"
-        replace-with: "$1"
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.10'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-      run: |
-        cd stubs/setup
-        cp -r ../${{ steps.version.outputs.replaced }}/mobase-stubs/* mobase-stubs/
-        sed -i 's/__version__ = ".*"/__version__ = "${{ github.ref_name }}"/' mobase-stubs/__init__.pyi
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
+      - name: Download all the dists
+        uses: actions/download-artifact@v3
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

README.md

@@ -16,7 +16,7 @@ MO2.
 You can install stubs for a specific version of MO2:
 
 ```bash
-pip install mobase-stubs==2.3.2.*
+pip install mobase-stubs==2.5.*
 ```
 
 Some words of warning:
@@ -38,8 +38,8 @@ have a `python310.dll` in your MO2 installation path, then you need **Python 3.1
 To generate the stubs, you can run:
 
 ```bash
-# install the package (-e if you want editable mode)
-pip install [-e] .
+# install the package
+poetry install
 
 # change the output folder to whatever you want
 mo2-stubs-generator -c configs/config-2.4.yml -o mobase-stubs ${MO2_INSTALL_PATH}

configs/config-2.5.yml

@@ -255,7 +255,7 @@ mobase:
         type: str
         desc: Full path to the file.
       origins:
-        type: List[str]
+        type: list[str]
         desc: |
           List of origins containing providing this file. The first origin in the list
           is the highest priority one (actually providing the file).
@@ -319,7 +319,7 @@ mobase:
         __doc__: |
           The parent tree containing this entry, or a `None` if this entry is the root
           or the parent tree is unreachable.
-        type: Optional[IFileTree]
+        type: IFileTree | None
 
     path:
       __doc__: |
@@ -356,6 +356,8 @@ mobase:
       returns:
     lightPluginsAreSupported:
       returns: True if light plugins are supported, False otherwise.
+    overridePluginsAreSupported:
+      returns: True if override plugins are supported, False otherwise.
     readPluginLists:
       __doc__:
       args:
@@ -663,7 +665,7 @@ mobase:
         __doc__: |
           The entry at the given location, or `None` if the entry was not found or
           was not of the correct type.
-        type: Optional[Union[IFileTree, FileTreeEntry]]
+        type: IFileTree | FileTreeEntry | None
 
     insert:
       __doc__: |
@@ -1226,7 +1228,7 @@ mobase:
             type: MoVariant
             desc: The data that was included in the request.
           result_data:
-            type: Dict[str, MoVariant]
+            type: dict[str, MoVariant]
             desc: The data included in the response.
 
       filesAvailable:
@@ -1242,7 +1244,7 @@ mobase:
             type: MoVariant
             desc: The data that was included in the request.
           result_data:
-            type: List[ModRepositoryFileInfo]
+            type: list[ModRepositoryFileInfo]
             desc: List of file information objects.
 
       fileInfoAvailable:
@@ -1269,7 +1271,7 @@ mobase:
             type: MoVariant
             desc: The data that was included in the request.
           result_data:
-            type: Dict[str, MoVariant]
+            type: dict[str, MoVariant]
             desc: The data included in the response.
 
       downloadURLsAvailable:
@@ -1291,7 +1293,7 @@ mobase:
             type: MoVariant
             desc: The data that was included in the request.
           result_data:
-            type: Dict[str, MoVariant]
+            type: dict[str, MoVariant]
             desc: The data included in the response.
 
       endorsementsAvailable:
@@ -1990,7 +1992,7 @@ mobase:
       abstract: false
       returns:
         __doc__: A mapping from feature type to actual game features.
-        type: Dict[Type[GameFeatureType], GameFeatureType]
+        type: dict[Type[GameFeatureType], GameFeatureType]
 
     gameDirectory:
       returns: The directory containing the game installation.
@@ -2092,6 +2094,14 @@ mobase:
     savesDirectory:
       returns: The directory where save games are stored.
 
+    secondaryDataDirectories:
+      __doc__: |
+        Retrieve the list of secondary data directories. Each directories should be
+        assigned a unique name that differs from "data" which is the name of the main
+        data directory returned by dataDirectory().
+
+      returns: A mapping from unique name to secondary data directories.
+
     setGamePath:
       __doc__: |
         Set the path to the managed game.
@@ -2788,7 +2798,7 @@ mobase:
         filetree: The tree to try to fix. Can be modified during the process.
       returns:
         __doc__: The fixed tree, or a null pointer if the tree could not be fixed.
-        type: Optional["IFileTree"]
+        type: IFileTree | None
 
   ModDataContent:
     __doc__: |
@@ -2998,7 +3008,7 @@ mobase:
         parent: The parent widget.
       returns:
         __doc__: A SaveGameInfoWidget to display information about save game.
-        type: Optional[ISaveGameInfoWidget]
+        type: ISaveGameInfoWidget | None
 
   ScriptExtender:
     __doc__:
@@ -3175,7 +3185,7 @@ mobase.widgets:
         Display this dialog and wait for user-interaction to return. This is a blocking
         function.
 
-      returns:
+      returns: |
         The button clicked by the user. Without custom buttons, this return Ok,
         otherwise it returns the button set in the TaskDialogButton.
 

docs/Makefile

@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -1,35 +0,0 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=source
-set BUILDDIR=build
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd

docs/requirements.txt

@@ -1,4 +1,4 @@
 sphinx-rtd-theme
 sphinx-autodoc-typehints
 sphinx-automodapi
-PyQt5
+PyQt6

docs/source/conf.py

@@ -10,21 +10,13 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-import os
-import sys
-
-sys.path.insert(0, os.path.abspath("../../stubs/2.4.0/"))
-
 
 # -- Project information -----------------------------------------------------
 
 project = "MO2 Python Plugin API"
-copyright = "2020, Holt59"
+copyright = "2023, Holt59"
 author = "Holt59"
 
-# The full version, including alpha/beta/rc tags
-release = "2.3rc1"
-
 
 # -- General configuration ---------------------------------------------------
 
@@ -69,5 +61,5 @@ html_favicon = "mo2.ico"
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = ["_static"]
 html_extra_path = [".nojekyll"]

pyproject.toml

@@ -0,0 +1,61 @@
+[tool.poetry]
+name = "mo2-pystubs-generation"
+version = "0.1.0"
+description = ""
+authors = ["Holt59 <capelle.mikael@gmail.com>"]
+license = "MIT"
+readme = "README.md"
+packages = [{ include = "mo2", from = "src" }]
+
+[tool.poetry.scripts]
+mo2-stubs-generator = "mo2.stubs.generator.__main__:main"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+pyqt6 = "^6.5.2"
+pyyaml = "^6.0.1"
+
+
+[tool.poetry.group.dev.dependencies]
+black = "^23.9.1"
+mypy = "^1.5.1"
+pyright = "^1.1.327"
+isort = "^5.12.0"
+ruff = "^0.0.290"
+flake8 = "^6.1.0"
+flake8-black = "^0.3.6"
+flake8-pyproject = "^1.2.3"
+types-pyyaml = "^6.0.12.11"
+
+
+[tool.poetry.group.doc.dependencies]
+sphinx-rtd-theme = "^1.3.0"
+sphinx-autodoc-typehints = "^1.24.0"
+sphinx-automodapi = "^0.16.0"
+sphinx = "^7.2.6"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.flake8]
+max-line-length = 88
+extend-ignore = ["E203"]
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+
+[tool.mypy]
+warn_return_any = true
+warn_unused_configs = true
+namespace_packages = true
+
+[tool.pyright]
+# reportMissingTypeStubs = true
+# reportUntypedBaseClass = false
+typeCheckingMode = "strict"

setup.cfg

@@ -1,40 +0,0 @@
-[flake8]
-# Use black line length:
-max-line-length = 88
-extend-ignore =
-    # See https://github.com/PyCQA/pycodestyle/issues/373
-    E203,
-per-file-ignores =
-  *.pyi: E301, E302, E305, E501, E701, E741, F401, F403, F405, F822
-  # Since typing.pyi defines "overload" this is not recognized by flake8 as typing.overload.
-  # Unfortunately, flake8 does not allow to "noqa" just a specific error inside the file itself.
-  typing.pyi: E301, E302, E305, E501, E701, E741, F401, F403, F405, F811, F822
-
-[mypy]
-warn_return_any = True
-warn_unused_configs = True
-namespace_packages = True
-
-[isort]
-profile = black
-multi_line_output = 3
-
-[tox:tox]
-skipsdist = true
-envlist = py310-lint
-
-[testenv:py310-lint]
-skip_install = true
-deps =
-    black
-    mypy
-    flake8
-    flake8-black
-    git+https://github.com/TilmanK/PyQt6-stubs.git
-    types-PyYAML
-    isort
-commands =
-    black src --check --diff
-    flake8 src
-    mypy src
-    isort -c src

setup.py

@@ -1,35 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-from setuptools import find_namespace_packages, setup
-
-install_requires = ["black", "isort"]
-
-dev_requires = [
-    "black",
-    "flake8-black",
-    "flake8",
-    "types-chardet",
-]
-
-setup(
-    name="mo2-stubs-generator",
-    version="1.0.0",
-    package_dir={"": "src"},
-    packages=find_namespace_packages(where="src", include=["mo2.*"]),
-    author="Holt59",
-    author_email="capelle.mikael@gmail",
-    description="Python stubs generator for mobase (MO2 Python API).",
-    long_description=open("README.md").read(),
-    url="https://github.com/ModOrganizer2/pystubs-generation",
-    classifiers=[
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.10",
-    ],
-    license="MIT",
-    install_requires=install_requires,
-    extras_require={"dev": dev_requires},
-    entry_points={
-        "console_scripts": ["mo2-stubs-generator=mo2.stubs.generator.__main__:main"],
-    },
-)

src/mo2/stubs/generator/__init__.py

@@ -1,7 +1,7 @@
-# -*- encoding: utf-8 -*-
-
 import logging
 
+from .loader import load_mobase
+
 LOGGER = logging.getLogger(__name__)
 
-from .loader import load_mobase  # noqa: F401
+__all__ = ["load_mobase", "LOGGER"]

src/mo2/stubs/generator/__main__.py

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 import argparse
 import inspect
 import logging
@@ -10,7 +8,6 @@ from typing import Callable
 import black
 import isort
 
-from . import LOGGER
 from .loader import load_mobase
 from .mtypes import Class, PyTyping
 from .parser import is_enum
@@ -18,10 +15,11 @@ from .register import MobaseRegister
 from .utils import Settings, clean_class
 from .writer import Writer, is_list_of_functions
 
+LOGGER = logging.getLogger(__package__)
 
-def extract_objects(module: object, skips: list[str] = []) -> list[tuple[str, object]]:
 
-    objects: list[tuple[str, object]] = []
+def extract_objects(module: object, skips: list[str] = []) -> list[tuple[str, type]]:
+    objects: list[tuple[str, type]] = []
 
     assert hasattr(module, "__name__")
     module_name: str = module.__name__  # type: ignore
@@ -55,7 +53,6 @@ def add_mobase_header(writer: Writer):
             (
                 "typing",
                 [
-                    "Any",
                     "Callable",
                     "Dict",
                     "Iterator",
@@ -91,8 +88,7 @@ def add_mobase_widgets_header(writer: Writer):
     )
 
 
-def main():
-
+def main() -> None:
     parser = argparse.ArgumentParser("stubs generator for the MO2 python interface")
     parser.add_argument(
         "install_dir",
@@ -146,7 +142,7 @@ def main():
     }
 
     # list of objects directly in mobase
-    module_objects: dict[str, list[tuple[str, object]]] = {
+    module_objects: dict[str, list[tuple[str, type]]] = {
         "mobase": extract_objects(
             mobase,
             [
@@ -154,11 +150,10 @@ def main():
                 "IPlugin",
             ],
         ),
-        "mobase.widgets": extract_objects(mobase.widgets),
+        "mobase.widgets": extract_objects(getattr(mobase, "widgets")),
     }
 
     for name, objects in module_objects.items():
-
         # load settings from the configuration
         settings: Settings = Settings(register)
         if config_path is not None:
@@ -175,12 +170,10 @@ def main():
 
         # Process everything:
         for n, o in objects:
-
             # Create the corresponding object:
             c = register.make_object(n, o)
 
             if isinstance(c, Class):
-
                 # Clean the class (e.g., remove duplicates methods due to wrappers):
                 clean_class(c)
 
@@ -209,7 +202,6 @@ def main():
 
         # write everything
         with open(output_folder.joinpath("__init__.pyi"), "w") as output:
-
             writer = Writer(package=name, output=output, settings=settings)
 
             # the __future__ import must be at the beginning
@@ -219,7 +211,6 @@ def main():
             module_headers[name](writer)
 
             for n, o in objects:
-
                 # Get the corresponding object:
                 c = register.get_object(n)
 

src/mo2/stubs/generator/loader.py

@@ -1,12 +1,11 @@
-# -*- encoding: utf-8 -*-
-
 import os
 import sys
 from modulefinder import Module
 from pathlib import Path
+from typing import Any
 
 
-def load_mobase(path: os.PathLike) -> Module:
+def load_mobase(path: os.PathLike[Any]) -> Module:
     """
     Load the mobase from the given MO2 installation path and
     returns it.
@@ -30,8 +29,8 @@ def load_mobase(path: os.PathLike) -> Module:
             [str(path), str(path.joinpath("dlls")), os.environ.get("PATH", "")]
         )
     else:
-        os.add_dll_directory(str(path))
-        os.add_dll_directory(str(path.joinpath("dlls")))
+        os.add_dll_directory(str(path))  # type: ignore
+        os.add_dll_directory(str(path.joinpath("dlls")))  # type: ignore
 
     # We need to add plugins/data to sys.path, mainly for PyQt6
     sys.path.insert(1, path.joinpath("plugins", "plugin_python", "libs").as_posix())
@@ -42,7 +41,6 @@ def load_mobase(path: os.PathLike) -> Module:
 
 
 if __name__ == "__main__":
-
     import argparse
 
     parser = argparse.ArgumentParser(

src/mo2/stubs/generator/mtypes.py

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 from __future__ import annotations
 
 import re
@@ -11,15 +9,6 @@ class PyType:
     Class representing a python type.
     """
 
-    # The `MoVariant` actual type - This should be list["MoVariant"] and
-    # Dict[str, "MoVariant"], but mypy (and other type checkers) do not
-    # handle recursive definition yet:
-    MO_VARIANT = """Union[None, bool, int, str, list[Any], dict[str, Any]]"""
-
-    # File/Directory wrappers
-    FILE_WRAPPER = """Union[str, PyQt6.QtCore.QFileInfo, Path]"""
-    DIRECTORY_WRAPPER = """Union[str, PyQt6.QtCore.QDir, Path]"""
-
     name: str
 
     def __init__(self, name: str | type):
@@ -48,6 +37,9 @@ class PyType:
         if self.name == "mobase.IPluginBase":
             return "IPlugin"
 
+        # PathLike should be [] in the stubs
+        self.name = self.name.replace("os.PathLike", "os.PathLike[str]")
+
         return self.name
 
     def is_none(self) -> bool:
@@ -128,7 +120,6 @@ class Argument:
 
     @property
     def value(self) -> str | None:
-
         value = self._value
 
         if value is None:
@@ -347,7 +338,7 @@ class Class:
         for ic in self.inner_classes:
             ic.outer_class = self
 
-    def is_abstract(self):
+    def is_abstract(self) -> bool:
         """
         Returns:
             True if this class is abstract, False otherwise.
@@ -355,7 +346,7 @@ class Class:
         return self.abstract or any(bc.is_abstract() for bc in self.bases)
 
     @property
-    def canonical_name(self):
+    def canonical_name(self) -> str:
         """
         Returns:
             The canonical name of this class.
@@ -363,13 +354,13 @@ class Class:
         name = self.name
         oc = self.outer_class
         while oc is not None:
-            name = "{}.{}".format(oc.name, name)
+            name = f"{oc.name}.{name}"
             oc = oc.outer_class
 
         return name
 
     @property
-    def full_name(self):
+    def full_name(self) -> str:
         """
         Returns:
             The full name of this class, i.e., package.canonical_name.

src/mo2/stubs/generator/parser.py

@@ -1,13 +1,11 @@
-# -*- encoding: utf-8 -*-
-
 import inspect
+import logging
 import re
 import types
 from collections import OrderedDict, defaultdict
 from itertools import chain
-from typing import Iterable, cast
+from typing import Any, Iterable, cast
 
-from . import LOGGER
 from .mtypes import (
     Argument,
     Class,
@@ -22,8 +20,12 @@ from .mtypes import (
 )
 from .register import MobaseRegister
 
+LOGGER = logging.getLogger(__package__)
 
-def magic_split(value: str, sep=",", open="(<[", close=")>]"):
+
+def magic_split(
+    value: str, sep: str = ",", open: str = "(<[", close: str = ")>]"
+) -> list[str]:
     """
     Split the value according to the given separator, but keeps together elements
     within the given separator. Useful to split C++ signature function since type names
@@ -42,8 +44,8 @@ def magic_split(value: str, sep=",", open="(<[", close=")>]"):
     Returns: The list of split parts from value.
     """
     i, j = 0, 0
-    s: list[str] = []
-    r = []
+    s: list[int] = []
+    r: list[str] = []
     while i < len(value):
         j = i + 1
         while j < len(value):
@@ -96,8 +98,8 @@ def parse_python_signature(s: str, name: str) -> tuple[PyType, list[Argument]]:
     args = magic_split(m.group(1).strip(), ",", open="[", close="]")
     return_type = m.group(2)
 
-    arguments = []
-    for i, pa in enumerate(args):
+    arguments: list[Argument] = []
+    for pa in args:
         m = re.search(
             r"(?P<name>[^:]+)\s*:\s*(?P<type>[^=]+)\s*(=\s*(?P<value>[^,]+))?",
             pa.strip(),
@@ -106,9 +108,12 @@ def parse_python_signature(s: str, name: str) -> tuple[PyType, list[Argument]]:
             raise ValueError(f"invalid argument: {pa}, {s}")
 
         matches = m.groupdict()
-        arguments.append(
-            Argument(matches["name"], PyType(matches["type"]), matches["value"])
-        )
+        type_ = matches["type"]
+        if matches["value"] == "None":
+            if "None" not in type_ and "MoVariant" not in type_:
+                type_ = type_ + " | None"
+
+        arguments.append(Argument(matches["name"], PyType(type_), matches["value"]))
 
     return PyType(return_type), arguments
 
@@ -140,7 +145,7 @@ class Overload:
         self.arguments = arguments
 
 
-def parse_pybind11_function_docstring(e) -> list[Overload]:
+def parse_pybind11_function_docstring(e: type) -> list[Overload]:
     """
     Parse the docstring of the given element.
 
@@ -150,7 +155,7 @@ def parse_pybind11_function_docstring(e) -> list[Overload]:
     Returns:
         A list of overloads for the given function.
     """
-    lines = e.__doc__.strip().split("\n")
+    lines = (e.__doc__ or "").strip().split("\n")
 
     signatures: list[str]
     if len(lines) == 1:
@@ -166,7 +171,6 @@ def parse_pybind11_function_docstring(e) -> list[Overload]:
     # them...
     overloads: list[Overload] = []
     for signature in signatures:
-
         # fix MOBase:: in some places to get proper Python types
         signature = signature.replace("MOBase::", "mobase.").replace("::", ".")
 
@@ -179,7 +183,7 @@ def parse_pybind11_function_docstring(e) -> list[Overload]:
     return overloads
 
 
-def make_functions(e) -> list[Function]:
+def make_functions(e: type) -> list[Function]:
     overloads = parse_pybind11_function_docstring(e)
 
     return [
@@ -310,7 +314,9 @@ def make_class(e: type, register: MobaseRegister) -> Class:
                     for base_class in base_classes:
                         for biclass in base_class.inner_classes:
                             if isinstance(biclass, Enum) and biclass.name == base_name:
-                                arg._value = base_class.name + "." + value
+                                arg._value = (  # pyright: ignore[reportPrivateUsage]
+                                    base_class.name + "." + value
+                                )
 
             methods.append(
                 Method(
@@ -323,8 +329,8 @@ def make_class(e: type, register: MobaseRegister) -> Class:
             )
 
     # Retrieve the attributes:
-    constants = []
-    properties = []
+    constants: list[Constant] = []
+    properties: list[Property] = []
     for name, attr in all_attrs:
         if callable(attr) or isinstance(attr, type):
             continue
@@ -341,7 +347,9 @@ def make_class(e: type, register: MobaseRegister) -> Class:
     direct_bases: list[Class] = []
     for c in e.__bases__:
         if c.__module__ != "pybind11_builtins":
-            direct_bases.append(register.get_object(c.__name__))
+            b = register.get_object(c.__name__)
+            assert isinstance(b, Class)
+            direct_bases.append(b)
 
     # Forcing QWidget base for XWidget classes since these do not show up
     # and we use a trick:
@@ -356,7 +364,7 @@ def make_class(e: type, register: MobaseRegister) -> Class:
     # check if it an enum
     if is_enum(e):
         # all pybind11 enums have a .__entries attribute
-        values = e.__entries  # type: ignore
+        values = cast(dict[str, tuple[int, Any]], e.__entries)  # type: ignore
 
         # drop the __init__
         methods = [m for m in methods if m.name != "__init__"]

src/mo2/stubs/generator/register.py

@@ -12,16 +12,18 @@ class MobaseRegister:
     Class that register classes.
     """
 
-    objects: dict[str, Class | list[Function]]
+    objects: dict[str, Class | list[Function] | PyTyping]
 
-    def __init__(self):
+    def __init__(self) -> None:
         self.raw_objects: dict[str, type] = OrderedDict()
         self.objects = {}
 
-    def add_object(self, name, object):
+    def add_object(self, name: str, object: type) -> None:
         self.raw_objects[name] = object
 
-    def make_object(self, name: str, e: type | None = None) -> Class | list[Function]:
+    def make_object(
+        self, name: str, e: type | None = None
+    ) -> Class | list[Function] | PyTyping:
         """
         Construct a Function, Class or Enum for the given object.
 
@@ -52,7 +54,7 @@ class MobaseRegister:
 
         return self.objects[name]
 
-    def get_object(self, name: str):
+    def get_object(self, name: str) -> Class | list[Function] | PyTyping:
         """
         Retrieve the object if the given name. Fails if no object with this
         name exists (if `make_object(name, ...)` has never been called).

src/mo2/stubs/generator/utils.py

@@ -1,13 +1,11 @@
-# -*- encoding: utf-8 -*-
-
 from __future__ import annotations
 
+import logging
 from collections import OrderedDict, defaultdict
-from typing import TYPE_CHECKING, Final, NamedTuple, TextIO, TypedDict
+from typing import TYPE_CHECKING, Final, NamedTuple, TextIO, TypedDict, cast
 
 import yaml
 
-from . import LOGGER
 from .mtypes import (
     Argument,
     Class,
@@ -25,6 +23,8 @@ from .mtypes import (
 if TYPE_CHECKING:
     from .register import MobaseRegister
 
+LOGGER = logging.getLogger(__package__)
+
 
 class Settings:
     class YamlFunctionArgument(TypedDict, total=False):
@@ -41,19 +41,21 @@ class Settings:
         abstract: bool
         deprecated: bool
 
-        args: dict[str, Settings.YamlFunctionArgument | str | None]
-        returns: str | Settings.YamlFunctionReturn
+        args: dict[str, Settings.YamlFunctionArgument | str | None] | None
+        returns: str | Settings.YamlFunctionReturn | None
 
-        raises: dict[str, str]
+        raises: dict[str, str | None] | None
 
     class YamlClassProperty(TypedDict):
         type: str
-        desc: str
+        desc: str | None
 
+    # need to use a functional-styled TypeDict due to the invalid Python
+    # attribute names
     YamlClassSettings = TypedDict(
         "YamlClassSettings",
         {
-            "__doc__": str,
+            "__doc__": str | None,
             "__bases__": list[str],
             "__abstract__": bool,
             "properties[]": dict[str, YamlClassProperty],
@@ -63,7 +65,6 @@ class Settings:
     )
 
     class PyFunctionSettings(NamedTuple):
-
         doc: str
         args: list[Argument] | None = None
         ret: Return | None = None
@@ -90,7 +91,6 @@ class Settings:
         fp: TextIO | None = None,
         module: str | None = None,
     ):
-
         self.register = register
 
         if fp is None:
@@ -129,8 +129,8 @@ class Settings:
         return base  # type: ignore
 
     def _parse_function_settings(
-        self, settings: str | YamlFunctionSettings
-    ) -> "PyFunctionSettings":
+        self, settings: str | YamlFunctionSettings | None
+    ) -> PyFunctionSettings:
         """
         Parse settings for a function or method.
 
@@ -159,7 +159,6 @@ class Settings:
         if "args" in settings:
             args = []
             if settings["args"] is not None:
-
                 # For each argument, we either have a None value (name: ),
                 # or a string (name: Description) or a dictionary that can contain
                 # __doc__ and type.
@@ -198,7 +197,6 @@ class Settings:
 
     def patch_functions(self, fns: list[Function]):
         for i, fn in enumerate(fns):
-
             # Find the name in settings:
             if fn.has_overloads():
                 setting_name = "{}.{}".format(fn.name, i + 1)
@@ -229,7 +227,6 @@ class Settings:
 
                 # Check the return type:
                 if function_settings.ret is not None:
-
                     # Force the doc anyway:
                     fn.ret.doc = function_settings.ret.doc
 
@@ -285,7 +282,9 @@ class Settings:
                         PyClass(package=".".join(parts[:-1]), name=parts[-1])
                     )
                 else:
-                    cls.bases.append(self.register.get_object(bc))
+                    class_ = self.register.get_object(bc)
+                    assert isinstance(class_, Class)
+                    cls.bases.append(class_)
             del class_settings["__bases__"]
 
         if "__abstract__" in class_settings and class_settings["__abstract__"]:
@@ -295,7 +294,7 @@ class Settings:
         # Patch properties - Everything should be in config since property are poorly
         # documented by boost::python.
         properties: dict[str, Settings.YamlClassProperty] = class_settings.pop(
-            "properties[]", {}
+            "properties[]", cast(dict[str, Settings.YamlClassProperty], {})
         )
         for prop in cls.properties:
             if prop.name in properties:
@@ -313,7 +312,6 @@ class Settings:
 
                 # If we have a description:
                 if "desc" in settings_property:
-
                     # If desc is None, we do not warn user, because the entry is in
                     # settings, just empty:
                     if settings_property["desc"] is not None:
@@ -328,7 +326,7 @@ class Settings:
 
         # patch signals - Everything should be in config since signals are not really
         # exposed by pybind11.
-        signals: list[str] = list(class_settings.pop("signals[]", {}))
+        signals: list[str] = list(class_settings.pop("signals[]", cast(list[str], [])))
         for signal in signals:
             cls.constants.append(Constant(signal, PyType("pyqtSignal"), None))
 
@@ -340,17 +338,15 @@ class Settings:
         for m in cls.methods:
             methods[m.name].append(m)
 
-        for k, ms in methods.items():
+        for ms in methods.values():
+            missing_settings: set[str] = set()
             for i, m in enumerate(ms):
-
                 # Find the name in settings:
                 if m.has_overloads():
                     settings_name = "{}.{}".format(m.name, i + 1)
                 else:
                     settings_name = m.name
 
-                missing_settings: set[str] = set()
-
                 # If the name is in the settings:
                 if settings_name in class_settings:
                     keys[settings_name] = True
@@ -401,7 +397,6 @@ class Settings:
 
                     # Check the return type:
                     if function_settings.ret is not None:
-
                         # Force the doc anyway:
                         m.ret.doc = function_settings.ret.doc
 
@@ -466,7 +461,7 @@ def clean_class(cls: Class):
 
     # Remove duplicate methods (based on name and argument types):
     methods: dict[tuple[str, tuple[Argument, ...]], list[Method]] = OrderedDict()
-    methods_by_name = defaultdict(list)
+    methods_by_name: dict[str, list[Method]] = defaultdict(list)
     for m in cls.methods:
         k = (m.name, tuple(m.args if m.is_static() else m.args[1:]))
         if k not in methods:
@@ -479,7 +474,6 @@ def clean_class(cls: Class):
         ms = methods[name, args]
         method: Method = ms[0]
         if len(ms) > 1:
-
             # If we have more than two methods, there is a problem...
             assert len(methods[name, args]) == 2
             assert (