Skip to content

Releases: mkdocstrings/griffe

0.41.1

01 Mar 13:44
Compare
Choose a tag to compare

0.41.1 - 2024-03-01

Compare with 0.41.0

Deprecations

  • The load_git function moved from griffe.git to griffe.loader.
    It is still importable from griffe.git, but will emit a deprecation warning.

Code Refactoring

  • Expose Git utilities, move load_git into the loader module (327cc5b by Timothée Mazzucotelli).

0.41.0

26 Feb 15:46
Compare
Choose a tag to compare

0.41.0 - 2024-02-26

Compare with 0.40.1

Features

  • Add option to append sys.path to search paths to the check command too (d153fa0 by Timothée Mazzucotelli).

Bug Fixes

  • Special case NumpyDoc "warnings" and "notes" sections (plural) (3b47cdb by Ethan Henderson). PR #236
  • Serialize line numbers even if zero (55e6e0e by Timothée Mazzucotelli).
  • Fix handling of lambda expressions (598d08a by Timothée Mazzucotelli).
  • Fix building expressions (and string values) for yield and yield from statements (439f65e by Timothée Mazzucotelli).
  • Do not create aliases pointing to themselves (356305f by Timothée Mazzucotelli).

Code Refactoring

  • Remove get_call_keyword_arguments utility function, as it is implemented with a single line and creates a cyclic depdendency with expressions (35cf170 by Timothée Mazzucotelli).
  • Further prevent cyclic dependency between node utils and expressions (9614c83 by Timothée Mazzucotelli).
  • Avoid cyclic dependency between node utils and expressions (aedf39c by Timothée Mazzucotelli).
  • Move arguments node-parsing logic into its own module (used by visitor and lambda expressions) (ad68e65 by Timothée Mazzucotelli).
  • Use canonical imports (3091660 by Timothée Mazzucotelli).
  • Use ast.unparse instead of our own unparser (6fe1316 by Timothée Mazzucotelli).
  • Only return 0 for the line number of removed objects when the location is reworked as relative (3a4d054 by Timothée Mazzucotelli).

0.40.1

08 Feb 15:17
Compare
Choose a tag to compare

0.40.1 - 2024-02-08

Compare with 0.40.0

Bug Fixes

  • Don't return properties as parameters of dataclasses (5a5c03b by Timothée Mazzucotelli). Issue #232

0.40.0

30 Jan 16:43
Compare
Choose a tag to compare

0.40.0 - 2024-01-30

Compare with 0.39.1

Features

  • Store reference to function call in keyword expressions (d72f9d3 by Timothée Mazzucotelli). PR #231

0.39.1

18 Jan 18:31
Compare
Choose a tag to compare

0.39.1 - 2024-01-18

Compare with 0.39.0

Bug Fixes

  • De-duplicate search paths in finder as they could lead to the same modules being yielded twice or more when scanning namespace packages (80a158a by Timothée Mazzucotelli).
  • Fix logic for skipping already encountered modules when scanning namespace packages (21a48d0 by Timothée Mazzucotelli). Issue mkdocstrings#646

0.39.0

16 Jan 17:44
Compare
Choose a tag to compare

0.39.0 - 2024-01-16

Compare with 0.38.1

Features

  • Support editable installs dynamically exposing modules from other directories (2c4ba75 by Timothée Mazzucotelli). Issue #229
  • Support meson-python editable modules (9123897 by Timothée Mazzucotelli).
  • Support admonitions in Numpydoc docstrings (1e311a4 by Michael Chow). Issue #214, PR #219, Co-authored-by: Timothée Mazzucotelli [email protected]
  • Expose module properties on all objects (123f8c5 by Timothée Mazzucotelli). Issue #226

Bug Fixes

  • Consider space-only lines to be empty, never break Numpydoc sections on blank lines (8c57354 by Timothée Mazzucotelli). PR #220, Related to PR #219, Numpydoc discussion
  • Allow merging stubs into alias targets (3cf7958 by Timothée Mazzucotelli).
  • Insert the right directory in front of import paths before inspecting a module (dynamically imported) (7d75c71 by Timothée Mazzucotelli).

Code Refactoring

  • Set lineno to 0 for removed objects when checking API (b660c34 by Timothée Mazzucotelli).
  • Prepare support for new output formats (styles) of the check command (f2ece1e by Timothée Mazzucotelli).
  • Transform finder's package and namespace package classes into dataclasses (16be6a4 by Timothée Mazzucotelli).

0.38.1

06 Dec 10:37
Compare
Choose a tag to compare

0.38.1 - 2023-12-06

Compare with 0.38.0

Bug Fixes

0.38.0

13 Nov 15:53
Compare
Choose a tag to compare

0.38.0 - 2023-11-13

Compare with 0.37.0

Features

  • Allow passing load parameters to the temporary package visit helper (3a7854f by Timothée Mazzucotelli).

0.37.0

12 Nov 17:51
Compare
Choose a tag to compare

0.37.0 - 2023-11-12

Compare with 0.36.9

Deprecations

  • The loader load_module method was renamed load,
    Its module parameter was renamed objspec and is now positional-only.
    This method always returned the specified object, not just modules,
    so it made more sense to rename it load and to rename the parameter
    specifying the object. Old usages (load_module and module=...)
    will continue to work for some time (a few months, a year, more),
    and will emit deprecation warnings.

Features

Bug Fixes

  • Report attributes who lost their value as "unset" (dfffa4b by Geethakrishna-Puligundla). Issue #218, PR #225
  • Don't crash when computing MRO for a class that is named after its parent (a2dd8a6 by Timothée Mazzucotelli).

Code Refactoring

  • Rename loader load_module method to load (2bfe206 by Timothée Mazzucotelli).

0.36.9

26 Oct 22:38
Compare
Choose a tag to compare

0.36.9 - 2023-10-27

Compare with 0.36.8

Bug Fixes

Code Refactoring

  • Expose parser enuemration and parser functions in top-level module (785baa0 by Timothée Mazzucotelli).