chore: check in a Pyright config and lxml type stubs (#17)

Author: danieyal

pyproject.toml

@@ -63,6 +63,7 @@ dev = [
     "respx>=0.21",
     "ruff>=0.7",
     "mypy>=1.13",
+    "lxml-stubs>=0.5.1",
 ]
 
 [tool.ruff]
@@ -90,10 +91,6 @@ init_typed = false
 warn_required_dynamic_outputs = true
 warn_untyped_fields = true
 
-[[tool.mypy.overrides]]
-module = ["lxml.*"]
-ignore_missing_imports = true
-
 [tool.pytest.ini_options]
 minversion = "8.0"
 testpaths = ["tests"]

pyrightconfig.json

@@ -0,0 +1,13 @@
+{
+  "//": "Pyright/Pylance config. Without this, a fresh clone reports ~78 phantom",
+  "//2": "'could not be resolved' errors for httpx/pydantic/lxml/cryptography,",
+  "//3": "because Pyright does not find .venv on its own. Checked in so the IDE",
+  "//4": "and the command line agree for everyone.",
+  "venvPath": ".",
+  "venv": ".venv",
+  "include": ["src", "tests", "scripts"],
+  "exclude": ["**/__pycache__", ".venv", "dist"],
+  "pythonVersion": "3.11",
+  "typeCheckingMode": "standard",
+  "reportMissingTypeStubs": false
+}

src/myinvois/ubl/builders/xml.py

@@ -70,8 +70,15 @@ def build_xml(self) -> str:
 
         # Root element owns all four xmlns declarations. lxml uses ``None`` as
         # the nsmap key for the default namespace so the root tag is unprefixed.
+        #
+        # `lxml-stubs` types nsmap as Mapping[str, str], which cannot express
+        # that None key -- a gap in the stubs, not in lxml: passing None is the
+        # documented way to declare a default namespace, and the golden
+        # fixtures depend on it emitting `<Invoice xmlns="...">`. Suppressed
+        # narrowly rather than widening the annotation, which would hide real
+        # misuse of this call.
         nsmap = {None: ns_url, "cac": _NS_CAC, "cbc": _NS_CBC, "ext": _NS_EXT}
-        root = etree.Element(f"{{{ns_url}}}{tag_name}", nsmap=nsmap)
+        root = etree.Element(f"{{{ns_url}}}{tag_name}", nsmap=nsmap)  # type: ignore[arg-type]
 
         content = self._content_dump()
         self._stamp_currency(content, self._document_currency_code())