Type the tree so mypy can enforce it by mbertheau · Pull Request #206 · Aiven-Open/journalpump

mbertheau · 2026-08-20T20:35:53Z

Based on #203.

Annotate the package, tests, and scripts, then turn on disallow_untyped_defs, disallow_untyped_calls, warn_unused_ignores, and disallow_any_generics. Stub packages cover typed third-party libraries; re2, systemd, and zstandard stay ignored because they ship no types.

Made with Cursor

The mypy hook ran in an isolated venv with only types-requests and types-geoip2, so everything else became Any — including packages that already ship types. It also pinned 1.19.1 while requirements.dev.txt installed a different mypy. Run mypy from the project environment, as pylint already does, over the whole tree: a whole-program checker on one file at a time is order-dependent. types-geoip2 goes away; geoip2 ships py.typed. Results now depend on the developer's installed deps, as pylint's already do. CI installs both requirements files before pre-commit, so the merge gate still sees everything. mypy's version floats with requirements.dev.txt, so a release can break lint with no change on our side. Co-authored-by: Cursor <cursoragent@cursor.com>

GeoIPProtocol declared no members, so city() and the Reader constructor were unchecked, and `type[GeoIPProtocol] | None` made construction a type error. Declare __init__(filename) and city() — plus the City/Location shapes they return, the contract the docstring already claimed — and drop | None at the only call site. Co-authored-by: Cursor <cursoragent@cursor.com>

main() stored the argparse Namespace in args, then reused that name for the remainder of an input line. The same loop rebound msg from the raw line to the dict send_message expects. action_args for the split remainder, raw for the unparsed line, msg only for the dict. Co-authored-by: Cursor <cursoragent@cursor.com>

_connect() keeps the last OSError from getaddrinfo results, then raises it. An empty list leaves that value None and the raise is TypeError. POSIX is not specified to return empty, but mypy flags it. Raise OSError so the failure stays the type the connect loop already produces. Co-authored-by: Cursor <cursoragent@cursor.com>

time.monotonic() returns float; initializing the same kind of value with 0 made mypy infer int. 0.0 is the same sentinel and still falsy for the "never failed" check. Co-authored-by: Cursor <cursoragent@cursor.com>

stats, rsyslog_client, kafka_producer, websocket, runner, and the systest rsyslogd Popen start as None. mypy infers Any | None, and Any does not narrow under `if not x`. Annotate T | None and re-check `is None` after init. The second check is also runtime: _init_* can still return None once running is False; returning False then matches the existing send-failed path instead of AttributeError. Skip the main-loop stats metric if handle_new_config has not run; _wait_until_running says so if start() was skipped. comms_channel_round rebound `task` after asyncio.wait; pending_task is a fresh name so consumer_task can stay None. Co-authored-by: Cursor <cursoragent@cursor.com>

Empty and mixed literals inferred types that rejected later operations (converters as object, the Cloud Logging body as Collection[str], empty collections with no element type). Websocket connect() cannot take those mixed kwargs as a splat; pass the known arguments by name and splat only the extras. The Cloud Logging body is dict[str, Any]: a JSON payload for a third-party API, not a structure we own. Co-authored-by: Cursor <cursoragent@cursor.com>

_generate_request_builder typed log entries as dict[str, str]; callers pass nested jsonPayload, and sometimes timestamp and severity. Empty in_queue, pending, senders, and the senders-less reader config need an element type so later appends and JournalReader construction typecheck. Co-authored-by: Cursor <cursoragent@cursor.com>

mypy skips those bodies by default, which is one reason reader.unregister_from_poll(self.poller) survived in configure_readers (the other is that readers was an untyped {}). check_untyped_defs checks them anyway. Aiven-Open#202 Co-authored-by: Cursor <cursoragent@cursor.com>

disallow_untyped_defs and disallow_incomplete_defs would fail 293 times on this tree. A global True plus per-module overrides keeps new files checked and existing modules exempt until they are annotated. Co-authored-by: Cursor <cursoragent@cursor.com>

_float_hex_to_int returns None when |f| >= 1. encode() already rejects |lat| >= 90 and wraps lon into [-180, 180), so that None is unreachable from encode; the assertions exist only for mypy. Co-authored-by: Cursor <cursoragent@cursor.com>

requests is imported inside get_requests_session on purpose (it and its dependencies are heavy), so Session is imported under TYPE_CHECKING. default_json_serialization now returns None explicitly — same value, required once the return type is written. Logplex-Msg-Count goes out as a decimal string; requests types headers as str | bytes | None. Co-authored-by: Cursor <cursoragent@cursor.com>