Skip to content

Releases: mkdocstrings/griffe

0.32.0

13 Jul 08:36
@github-actions github-actions
0.32.0
0975044
Compare
Choose a tag to compare
0.32.0

0.32.0 - 2023-07-13

Compare with 0.31.0

Deprecations

  • Classes [InspectorExtension][griffe.extensions.base.InspectorExtension]
    and [VisitorExtension][griffe.extensions.base.VisitorExtension]
    are deprecated in favor of [Extension][griffe.extensions.base.Extension].
    As a side-effect, the [hybrid][griffe.extensions.hybrid.HybridExtension] extension
    is also deprecated. See how to use and write extensions.

Breaking Changes

  • Module griffe.agents.base was removed
  • Module griffe.docstrings.markdown was removed
  • Class ASTNode was removed
  • Class BaseInspector was removed
  • Class BaseVisitor was removed
  • Fucntion get_parameter_default was removed
  • Function load_extension was removed (made private)
  • Function patch_ast was removed
  • Function tmp_worktree was removed (made private)
  • Type [Extension][griffe.extensions.base.Extension] is now a class

Features

  • Numpy parser: handle return section items with just type, or no name and no type (bdec37d by Michael Chow). Issue #173, PR #174, Co-authored-by: Timothée Mazzucotelli pawamoy@pm.me
  • Rework extension system (dea4c83 by Timothée Mazzucotelli).
  • Parse attribute values, parameter defaults and decorators as expressions (7b653b3 by Timothée Mazzucotelli).
  • Add loader option to avoid storing source code, reducing memory footprint (d592edf by Timothée Mazzucotelli).
  • Add extra attribute to objects (707a348 by Timothée Mazzucotelli).

Bug Fixes

  • Numpy-style: don't strip spaces from the left of indented lines (f13fc0a by Timothée Mazzucotelli). Discussion #587
  • Fix relative paths for old versions when checking API (96fd45b by Timothée Mazzucotelli).

Performance Improvements

  • Don't store source when dumping as JSON (d7f314a by Timothée Mazzucotelli).
  • Stop caching properties on Object methods (15bdd74 by Timothée Mazzucotelli).
  • Stop patching AST, use functions instead (7302f17 by Timothée Mazzucotelli). Issue #171

Code Refactoring

  • Privatize/remove objects (fdeb16f by Timothée Mazzucotelli).
  • Document public objects with __all__ (db0e0e3 by Timothée Mazzucotelli).
  • Remove base visitor and inspector (bc446e4 by Timothée Mazzucotelli).
  • Auto-register module in collection within loading helpers (591bacc by Timothée Mazzucotelli). Issue #177
Loading