falconry/falcon

Advanced typing of ASGI `scope` dict

Open

#2628 opened on Apr 25, 2026

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (9,293 stars) (925 forks)batch import
enhancementgood first issuetyping

Description

Create a more advanced TypedDict or similar for annotating ASGI scope.

We could probably draw inspiration from the relevant parts of asgiref: https://github.com/django/asgiref/blob/main/asgiref/typing.py. Since these annotations are really trivial, we probably want just to reimplement the part that we use.

This would allow us to get rid of a bunch of typing ignores, see #2599.

Contributor guide

Tech stack
python
Domain
backendapi
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python type hintsASGI basicsTypedDict usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Look at the asgiref typing module linked in the issue (https://github.com/django/asgiref/blob/main/asgiref/typing.py) to understand the TypedDict structure for ASGI scope. Identify which parts of the scope are used in Falcon and create a custom TypedDict subclass. Then update type annotations in the codebase to use it, removing any '# type: ignore' comments. The issue references #2599 for context.