tools/gen-cpydiff: Fail CPython difference generation if output matches. #17060
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #17060 +/- ##
=======================================
Coverage 98.54% 98.54%
=======================================
Files 169 169
Lines 21890 21890
=======================================
Hits 21571 21571
Misses 319 319 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Code size report: |
|
How will this affect port-specific differences, e.g. |
Thanks for pointing this out, @AJMansfield. I've left a reply on the linked PR: https://github.com/micropython/micropython/pull/16984/files#r2008260448 |
MicroPython support for this behaviour was added in eb45d97. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>
Previously this information was recorded in a "status" field of the result, but nothing ever parsed this result which led to non-differences not being removed. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>
dpgeorge
force-pushed
the
doc/cpydiff_fail_same
branch
from
6e6a0d0 to
74a5bf9
Compare
dpgeorge
approved these changes
Apr 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
MicroPython uses a set of automated test cases (
tests/cpydiff) to generate documentation of differences between CPython and MicroPython. If a MicroPython improvement made something CPython compatible, the generation tool would print a note but would keep running as normal including generating the "difference" (with the docs containing identical generated output for CPython vs MicroPython).This PR adjusts the generation tool to fail if any differences are non-existent (which should also fail CI), and also removes one fixed difference (
str.endswith()was made compatible as of #16812 🎉).Testing
Trade-offs and Alternatives
gen-cpydiff.py, but this tool is only ever run to generate this output for the docs and almost all of the other behaviour is hard-coded for this purpose.