Skip to content

Commit adf6ec5

Browse files
lesnik512claude
andauthored
docs(release): notes for 3.1.1 (#15)
Curated notes for the 3.1.1 tag. Patch: nothing under modern_di_aiohttp/ changed since the last release; the release publishes the corrected README to PyPI. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 9a4ca07 commit adf6ec5

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

‎planning/releases/3.1.1.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# modern-di-aiohttp 3.1.1 — documentation catches up with modern-di 3.1
2+
3+
**No code changes.** The installed package is byte-identical to 3.1.0; nothing
4+
in `modern_di_aiohttp/` moved. This release exists to publish the corrected
5+
documentation, because the README a user reads on PyPI is rendered from the
6+
released distribution — so the fix below was invisible until now.
7+
8+
## Fix
9+
10+
- **The documented setup no longer passes `validate=True`.** modern-di 3.1 made
11+
`Container(validate=...)` a deprecated no-op that emits
12+
`ValidateArgumentWarning`. The README example therefore emitted a
13+
`DeprecationWarning` on every construction, and — more quietly — silently
14+
stopped validating anything, because that argument *was* the explicit opt-in
15+
to graph validation. This package pins `modern-di>=3`, so users reached that
16+
state on a routine upgrade.
17+
18+
The docs now build the container plain and call `container.validate()`
19+
explicitly, after `setup_di`. That ordering matters and is unchanged:
20+
`setup_di` registers this integration's providers, so validating first fails
21+
any provider with a non-optional dependency on them.
22+
23+
## Downstream
24+
25+
Nothing is required of you. If you copied the old README snippet, drop
26+
`validate=True` — it does nothing on modern-di 3.1 and warns:
27+
28+
```python
29+
container = Container(groups=[Dependencies])
30+
setup_di(...)
31+
container.validate() # optional fail-fast, after setup_di registers its providers
32+
```
33+
34+
Keeping it works, but a suite configured with `error::DeprecationWarning` will
35+
fail on it. The argument is removed in modern-di 4.0.

0 commit comments

Comments
 (0)