Python typing.TypedDict: Describe Dictionary Shapes

TypedDict describes the expected keys and value types of ordinary dictionaries.

What It Does and Why It Matters

TypedDict describes the expected keys and value types of ordinary dictionaries. A type checker checks shapes, but constructing a TypedDict does not create a runtime validation object.

Annotations guide static tools; by default they do not validate external input or change the return value at runtime.

Step-by-Step Example

Start with the complete example below. Read the inputs and predict what the final print statement will show before you run it.

from typing import TypedDict
class InventoryItem(TypedDict):
    name: str
    count: int
stock_item: InventoryItem = {'name': 'folders', 'count': 8}
print(stock_item['name'])

How the Code Works

• The imports make these standard-library tools available: typing.
• The definition of InventoryItem creates reusable behavior; its body runs only when called or instantiated as appropriate.
• The name stock_item receives the value of {'name': 'folders', 'count': 8}. Changing this input lets you explore a different case.
• The print calls display the results. Compare these results with the method’s documented return type and the input used.
• The annotations describe intended types for editors and checkers. They are not a replacement for validating input values when the function runs.

Expected output:

folders

For the demonstrated inputs, Python displays 'folders'. This result follows from the operation described above; change one input at a time to understand which rule matters.

What to Notice

Pay attention to the accepted input types, the returned value and the boundary behavior. Predict what changes if you replace the example input with an empty, zero, negative or missing value, where that value is meaningful for this operation.

If the task uses a library function, inspect its documented exceptions and return type before reusing it inside a larger function.

Where You Would Use This

This helps maintain larger projects where functions and data shapes cross module boundaries. Check the code with a static analyzer, and still validate data received from files, users or remote APIs. Annotation constructs do not normally enforce types automatically at runtime.

Practice Exercise

Define a typed employee record containing a name and employee number.

Before running your edited example, write down the result you expect. Then test at least one valid boundary or deliberately invalid value, using appropriate exception handling where necessary.

Reference: official Python documentation for the complete API contract and version notes.

Common Beginner Mistakes

• Assuming TypedDict prevents unknown keys or automatically rejects incorrectly typed values at runtime.
• Overlooking the documented condition: a type checker checks shapes, but constructing a TypedDict does not create a runtime validation object.

Key Takeaways

• TypedDict describes the expected keys and value types of ordinary dictionaries.
• Define a typed employee record containing a name and employee number.
• Annotations guide static tools; by default they do not validate external input or change the return value at runtime.