Repository navigation
Releases
Releases · mkdocstrings/griffe
2.4.1
2.4.0
2.4.0 - 2026-10-19
Features
Bug Fixes
- Preserve standalone named expression parentheses (dc6300d by Alperen). PR-488, Co-authored-by: Timothée Mazzucotelli [email protected]
- Propagate
publicvalue to inherited members (aliases) (8b94205 by Timothée Mazzucotelli). Issue-495, PR-503, Co-authored-by: Sydney Duckworth [email protected]
Performance Improvements
2.3.2
2.3.1
2.3.0
2.3.0 - 2026-09-04
Features
- Add option to give precedence to docstrings in stubs vs. source (09a2a13 by Timothée Mazzucotelli). Issue-447, PR-481
Bug Fixes
- Preserve nested tuple parentheses (e095a7c by Alperen). PR-487, Co-authored-by: Timothée Mazzucotelli [email protected]
- Preserve nested f-string format specs (38921b7 by Alperen). PR-486
- Disable all docstring warnings when passing
warnings=False(5cb0ae2 by Timothée Mazzucotelli).
Performance Improvements
- Reuse computed parent in
is_imported(092ac31 by Timothée Mazzucotelli). - Only build debug messages at debug level (8f05a4a by Timothée Mazzucotelli).
- Avoid creating new sets when handling labels (06cd02e by Timothée Mazzucotelli).
- Maintain map of AST node type to visitor function (e21851e by Timothée Mazzucotelli).
- Avoid cyclic refs in ASTs to allow garbage-collecting them (b968de0 by Timothée Mazzucotelli).
- Cache per-module path-related properties during serialization (8bd6cc4 by Timothée Mazzucotelli).
- Do not fire load events when no extension has hooked them (0e2ae7c by Timothée Mazzucotelli).
- Compute costly message lazily in alias resolution errors (1e391b8 by Timothée Mazzucotelli).
- Avoid iterating many times over function parameters when merging stubs (03cae74 by Timothée Mazzucotelli).
- Avoid iterating many times over function parameters when diff'ing (d3cf2c4 by Timothée Mazzucotelli).
- Improve efficiency of AST parameter extraction (1e37cd4 by Timothée Mazzucotelli).
- Cache serializable expression fields (f9e48c1 by Timothée Mazzucotelli).
- Use maps to make JSON encoder faster (b7de96f by Timothée Mazzucotelli).
- Avoid recomputing inherited members when diff'ing (a29e028 by Timothée Mazzucotelli).
- Make Google, Numpy and Sphinx docstring parsers faster (7f39373 by Timothée Mazzucotelli).
- Pre-compile patterns for docstring style detection (ad58ad5 by Timothée Mazzucotelli).
- LRU-cache parsing of type annotations in docstrings (1671e59 by Timothée Mazzucotelli).
2.2.0
2.2.0 - 2026-08-16
Features
- Support
awaitexpressions (6b3caab by Vincent Gao). PR-479 - Support unpacking in dict comprehensions (2d39391 by mushitoriami). PR-475
Bug Fixes
- Forward
warn_missing_typesto Sphinx return section reader (a15e782 by Timothée Mazzucotelli). Issue-mkdocstrings-python-337 - Make stringified expressions valid and faithful Python (eb85f0d by Vincent Gao). PR-478
- Empty tuples can never be implicit (82e728d by Vincent Gao). PR-474, Co-authored-by: Timothée Mazzucotelli [email protected]
- Render f-strings and t-strings with correct quote delimiters (90e28d4 by Bartosz Sławecki). Issue-444, PR-455
- Detect basic admonitions 'example', 'note' and 'warning' in Google/Numpy docstrings when inferring style (f30306f by Timothée Mazzucotelli).
- Render dict
**-unpacking as**valueinstead ofNone: value(74ddbbf by Vincent Gao). PR-467
2.1.0
2.1.0 - 2026-06-19
Build
- Add tests to source distributions for
griffecliandgriffelibpackages. Issue-452
Features
- Add logging format for Azure Devops (82526e4 by Carsten Igel). PR-457, Co-authored-by: Timothée Mazzucotelli [email protected]
Bug Fixes
2.0.2
2.0.1
2.0.1 - 2026-03-23
Bug Fixes
1.15.0
1.15.0 - 2025-11-10
Features
- Prefer stub over target object if not the same kind (196bcf4 by Kattni). Discussion-mkdocstrings-803, PR-422
- Parse keywords in class declarations (0709f0d by Timothée Mazzucotelli).
- Support unpacking typed dicts in signatures and docstrings (60cbb5f by Timothée Mazzucotelli). Issue-mkdocstrings-python-207, Issue-284
- Support checking packages from PyPI directly (e04a5cf by Timothée Mazzucotelli).
- Support expression modernization (4ae5d25 by Timothée Mazzucotelli).
- Support
autodocstring style (infer from docstring) (4d0a9ee by Timothée Mazzucotelli).
Bug Fixes
- Make type aliases available at runtime (9debb52 by sgt). Discussion-425, PR-426
- Fix loading namespace packages from JSON (3cccf27 by Bartosz Sławecki). Issue-407, PR-413
- Catch error when computing relative filepath for serialization (92a23d4 by Timothée Mazzucotelli).
- Defer creating module finder until first load (c52dd22 by Bartosz Sławecki). Issue-410, PR-411, Co-authored-by: Timothée Mazzucotelli [email protected]
- Always return a string or
NonefromObjectNode.module_path(06c2f2f by Frank David Martínez M). PR-419, Co-authored-by: Timothée Mazzucotelli [email protected] - Don't add parentheses around comprehension target (implicit) tuple (cbdb6a9 by Timothée Mazzucotelli). Issue-mkdocstrings-python-311
- Add missing space in dictionary comprehension (3a6dc36 by Nicolas IOOSS). Issue-mkdocstrings-python-311, PR-420
- Do not ignore stderr in case there is a problem in a git call. (#416) (9a5d014 by Muhammet Soytürk). Issue-415, PR-416
Code Refactoring
- Update code base for Python 3.10 (37aaf06 by Timothée Mazzucotelli).
- Improve handling of typed dicts (5bed1be by Timothée Mazzucotelli). Issue-284, Issue-mkdocstrings-python-207, PR-414
- Reuse private method to append search path to reduce code duplication (0a82cf5 by Timothée Mazzucotelli).
- Don't produce an empty text section when "parsing" an empty unstyled docstring (90bd71c by Timothée Mazzucotelli).
- Don't produce empty text section when parsing an empty Google-style docstring (1cbf2a3 by Timothée Mazzucotelli).
- Use plain ANSI codes, don't import them from Colorama (90978b4 by Timothée Mazzucotelli).