Complete library typing and enforce mypy strict in CI

Aperta
#722 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
ci-cd, tooling

Direzione di ricerca

Inizia riproducendo la baseline limitata alla libreria con il checkout bloccato e mypy --strict, separando gli otto pacchetti della libreria dal client di validazione generato. Esamina le esportazioni mancanti, le annotazioni incomplete, le chiamate non tipizzate e gli argomenti generici mancanti segnalati, quindi controlla i wheel installati per verificare la presenza di py.typed e gli import dei consumer. Il lavoro è completato quando tutti gli otto pacchetti superano i controlli strict in CI, i wheel tipizzati supportano controlli rappresentativi dei consumer e i test runtime esistenti continuano a superare i test.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Hi! I use LLMs to help write code, and passing strict type checks such as mypy --strict is one of my guardrails. A project I'm working on depends on this library, so more complete type information would save me a lot of troubleshooting and help catch mistakes earlier.

Is your feature request related to a problem? Please describe.

The library already has substantial type annotations and runs mypy in CI. However, strict checking still exposes gaps that affect consumers. On the checkout described below, ordinary mypy passes, while mypy --strict reports 298 errors across the eight library packages.

For example, checking this consumer code with mypy --strict example.py reports implicit-export errors for both imports, an untyped call to get_key(), and an Any return:

from kiota_abstractions.serialization import Parsable
from kiota_http.middleware.options import RetryHandlerOption


def retry_option_key() -> str:
    return RetryHandlerOption().get_key()

I also built the microsoft-kiota-bundle wheel locally and confirmed that it lacks py.typed. Mypy treats an installed import of kiota_bundle.default_request_adapter as untyped, despite the annotations in its source.

Describe the solution you'd like

Complete the existing typing support and enforce strict mypy checks for the library packages.

Suggested definition of done:

  • All eight library source packages pass mypy --strict in CI with a pinned mypy version across the supported Python versions.
  • Consumer checks against installed wheels verify public imports and representative inferred return types; all intended typed packages ship py.typed.
  • Public types remain useful, with any necessary suppressions narrowly scoped and explained, rather than broadly replacing types with Any or disabling checks.
  • Existing runtime tests pass and public behavior remains compatible.

I suggest keeping unit-test typing and adopting another checker outside the initial scope. Recurring generated-code annotation changes could be tracked separately with the generator work they require.

Describe alternatives you've considered

Local stubs or per-project mypy overrides could work around individual problems, but would leave consumers maintaining those workarounds. Completing the shared library annotations would benefit dependent projects directly.

Additional context

  • Checkout: eef36d7e72197063f234b24407edad15ad873bea; local packages report version 1.12.1.
  • Environment: Linux, Python 3.13.5, mypy 2.3.1; dependencies installed using uv, with all eight packages installed in editable mode.
  • The library-only baseline is 298 errors in 101 checked source files. The generated validation client adds 345 errors in 86 files; those are separate from the library count.
  • The largest recurring library categories are missing explicit exports, incomplete function annotations, untyped calls, and missing generic arguments.
  • Related earlier typing discussions: #355 and #333, both closed.

Would you be open to using strict mypy compliance as a tracked enhancement for the library packages?

Lingua principale
Python
Stelle
31
Fork
39
Merge medio
13h 21m
PR unite (30g)
46

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di microsoft/kiota-python

Tutte le issue di microsoft/kiota-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.