X XFediYour place in the Fediverse
XFEDI

Remote profile

ActivityPub
Profile banner

Timothée Mazzucotelli :python:

@[email protected]

Open-source developer. Lots of Python, more and more Rust. Working on @zensical!

Open remote profile ↗
Posts
↳ In reply to a post

This issue is what's making me want to remove the check: https://github.com/mkdocstrings/griffe/issues/506. In there, the user changes `__lazy_modules__`, which triggers a "value was changed" breaking change, which makes no sense.

GitHubbug: PEP 810 `__lazy_modules__`  should not be detected as a public module attribute · Issue #506 · mkdocstrings/griffeDescription of the bug Adding or removing imports can lead to changes to the contents of __lazy_modules__, which are currently detected by griffe check as a public API change: package.module:5: __l...
↩ Reply ♡ 0 · ↻ 0 ↗ Original

Can anyone of you find a case / has a real use-case where changing an attribute value in Python code could be considered a breaking change?

I'm considering removing this check from Griffe: https://mkdocstrings.github.io/griffe/guide/users/checking/#attribute-changed-value

#python

mkdocstrings.github.ioChecking - GriffeSignatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API.
↩ Reply ♡ 0 · ↻ 0 ↗ Original