Check a mapping shape before treating it as TypedDict-like

TypedDict makes a mapping shape visible to type checkers, but it does not validate runtime input. At runtime, a TypedDict instance is an ordinary dict, so a boundary function must perform the checks its application needs. parse_job() first accepts only collections.abc.Mapping objects, then requires exactly the name and attempt keys. It obtains those values only after the shape check and returns a normal dictionary matching the Job annotation.

For the accepted input, the result is {"name": "compile", "attempt": 2}. A missing key is rejected as an unexpected shape. A boolean attempt is rejected because this contract uses type(attempt) is int; that deliberately excludes True, even though bool subclasses int. Choose isinstance instead if subclasses are valid for your own format.

Exact-key validation intentionally rejects extra fields. That is appropriate for a closed record but not for an extensible payload, where the check should instead allow documented optional or future keys. These checks do not sanitize values, prove a mapping is trustworthy, or replace authorization decisions.

TypedDict was added in Python 3.8. The typing documentation explains its static-only expectations, and the collections.abc documentation defines the Mapping interface used for the first runtime check.

AI-assistance disclosure: this article was drafted with AI assistance and should be adapted to the payload schema it protects.

from collections.abc import Mapping
from typing import TypedDict


class Job(TypedDict):
    name: str
    attempt: int


def parse_job(candidate: object) -> Job:
    if not isinstance(candidate, Mapping):
        raise ValueError("job must be a mapping")
    if set(candidate) != {"name", "attempt"}:
        raise ValueError("job has unexpected shape")

    name = candidate["name"]
    attempt = candidate["attempt"]
    if type(name) is not str or type(attempt) is not int:
        raise ValueError("job has invalid value types")

    return {"name": name, "attempt": attempt}


job = parse_job({"name": "compile", "attempt": 2})
assert job == {"name": "compile", "attempt": 2}

for candidate in ({"name": "compile"}, {"name": "compile", "attempt": True}):
    try:
        parse_job(candidate)
    except ValueError as error:
        print(error)

print(f"job={job['name']} attempt={job['attempt']}")
job has unexpected shape
job has invalid value types
job=compile attempt=2

Comments

Post a Comment

Popular posts from this blog

Compare Two Text Files in Python Without Modifying Them

Batu Lab Notes · Batu When comparing two versions of a configuration or notes file, “are they the same?” is only the first question. The bytes may be identical, the visible text may be equal despite different line endings, or the content may contain a real change. For small UTF-8 text files, Python’s standard library can show these distinctions without writing to either input. Quick answer For small, stable UTF-8 files, read bounded bytes, compare them first, then decode and produce a bounded unified diff. Decide explicitly whether newline differences matter. Keep both inputs read-only and review the diff for private data before sharing it. Set a limit before reading Loading an input of unknown size directly into memory is a poor default. This example checks both sizes with Path.stat() , then performs a bounded read and applies a 256 KiB limit per file. It rejects directories and other non-regular paths. If reading raises OSError , the result includes the exception ty...
Read more

Seven CSV Quality Checks to Run Before Importing Data

Batu Lab Notes · Batu A CSV file is not ready for import merely because it opens. The wrong delimiter can collapse an entire row into one column. An unexpected encoding can damage non-ASCII characters. A repeated identifier can overwrite an existing record in the destination. A short, read-only check makes these problems visible before data reaches a spreadsheet or application. Quick answer Before importing a CSV, set its encoding and delimiter, validate the exact header and every row width, distinguish empty IDs, duplicate IDs, and duplicate rows, and keep the check read-only. 1. Specify the encoding Python may open a text file with the platform’s default encoding, which can differ across machines. If the expected encoding is UTF-8, encoding="utf-8-sig" is a practical choice: it reads ordinary UTF-8 and skips an optional UTF-8 byte order mark at the start. If decoding fails, verify the source application’s export settings instead of silently trying unrelat...
Read more

Explain why SQLite transactions cannot make an HTTP call atomic

Direct answer A SQLite transaction can atomically commit database statements handled by that connection. It cannot include an HTTP service in the same commit protocol. The example commits an outbox row first, then simulates a network failure. The durable row remains pending , which is exactly the information a later delivery worker needs instead of pretending both actions succeeded or failed together. The edge case is failure after the database commit but before remote acknowledgement. Retrying then requires an idempotency design owned by the remote endpoint or a stable request key; it is not supplied by SQLite’s COMMIT . Conversely, sending the request before storing a durable intent can leave no local evidence when the process stops. This demonstration intentionally does not make an HTTP request, implement an outbox dispatcher, or prove delivery exactly once. It shows the boundary that must be designed around. Use transactions to protect the local state transition, and test remote...
Read more