Change Log

This document records all notable changes to starlette-context. This project adheres to Semantic Versioning.

Latest Release

Fix HeaderKeys enum str() behavior inconsistency across Python versions (#192). On Python 3.11+, str(HeaderKeys.api_key) returned "HeaderKeys.api_key" instead of "X-API-Key". Now uses StrEnum for consistent behavior across all supported Python versions.

Add support for Python 3.13 and 3.14
Drop support for Python 3.9. Now only 3.10+ is supported
Migrate from Poetry to uv as the package manager and build tool
Switch build backend from poetry-core to hatchling
Replace assert with ConfigurationError in Plugin.process_request for clearer error messages
Replace Black with ruff format for code formatting
Replace deprecated HTTP_422_UNPROCESSABLE_ENTITY with HTTP_422_UNPROCESSABLE_CONTENT

Drop support for Python 3.8. Now only 3.9+ is supported ( https://github.com/tomwojcik/starlette-context/pull/152/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711R29 )
Drop support for Starlette versions below 0.27.0 ( released May 16, 2023) ( https://github.com/tomwojcik/starlette-context/pull/152/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711R30 )
Drop ContextMiddleware deprecation warning as Starlette no longer plans to deprecate it ( https://github.com/encode/starlette/discussions/2160#discussioncomment-6053386 )
Fix starlette-context potentially breaking if ContextMiddleware is used along with starlette>=0.41.3 ( https://github.com/tomwojcik/starlette-context/issues/151 )

Fix for being unable to catch some exceptions with a try/except due to base exc inheriting from the BaseException (Thanks @soundstripe) #90
Minimal Python version required is now 3.8

Add request_cycle_context. It’s a context manager that allows for easier testing and cleaner code (Thanks @hhamana) #46
Fix for accessing context during logging, outside of the request-response cycle. Technically it should raise an exception, but it makes sense to include the context by default (in logs) and if it’s not available, some logs are better than no logs. Now it will show context data if context is available, with a fallback to an empty dict (instead of raising an exc) #65
Add ContextMiddleware deprecation warning
**context context unpacking seems to be working now

Add support for custom error responses if error occurred in plugin / middleware -> fix for 500 (Thanks @hhamana)
Better (custom) exceptions with a base StarletteContextError (Thanks @hhamana)

ContextDoesNotExistError is raised when context object can’t be accessed. Previously it was RuntimeError. For backwards compatibility, it inherits from RuntimeError so it shouldn’t result in any regressions.
Added py.typed file so your mypy should never complain (Thanks @ginomempin)

Add RawContextMiddleware for Streaming and File responses
Add flake8, isort, mypy
Small refactor of the base plugin, moved directories and removed one redundant method (potentially breaking changes)

For correlation id and request id plugins, add support for enforcing the generation of a new value
For ^ plugins add support for validating uuid. It’s a default behavior so will break things for people who don’t use uuid4 there. If you don’t want this validation, you need to pass validate=False to the plugin
You can now check if context is available (Thanks @VukW)

Dropped with_plugins from the middleware as Starlette has it’s own way of doing this
Due to ^ this change some tests are simplified
If context is not available no LookupError will be raised, instead there will be RuntimeError, because this error might mean one of two things: user either didn’t use ContextMiddleware or is trying to access context object outside of request-response cycle

Changed parent of context object. More or less the API is the same but due to this change the implementation itself is way more simple and now it’s possible to use .items() or keys() like in a normal dict, out of the box. Still, unpacking **kwargs is not supported and I don’t think it ever will be. I tried to inherit from the builtin dict but nothing good came out of this. Now you access context as dict using context.data, not context.dict()
There was an issue related to not having awaitable plugins. Now both middleware and plugins are fully async compatible. It’s a breaking change as it forces to use await, hence new minor version

MVP until 0.1.4