GH-136155: Fail the EPUB check on fatal errors #137351
Open
+48
−27
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
AA-Turner
commented
Aug 3, 2025
The original PR had these as parallel jobs, but I asked to keep them in the same one because they have a lot of duplicate setup config :) |
|
True, though the setup for epub alone is far simpler & easier to comprehend. I think splitting is useful, without doing so the docs job takes ~2 minutes longer, which delays feedback if the PR is good to leave as-is. It's rare for doctest to fail & docs to pass. A |
m-aciek
reviewed
Aug 4, 2025
Comment on lines
+3
to
+8
| CPYTHON_ROOT = Path( | ||
| __file__, # cpython/Doc/tools/check-epub.py | ||
| '..', # cpython/Doc/tools | ||
| '..', # cpython/Doc | ||
| '..', # cpython | ||
| ).resolve() |
There was a problem hiding this comment.
Suggested change
| CPYTHON_ROOT = Path( | |
| __file__, # cpython/Doc/tools/check-epub.py | |
| '..', # cpython/Doc/tools | |
| '..', # cpython/Doc | |
| '..', # cpython | |
| ).resolve() | |
| CPYTHON_ROOT = Path(__file__).parents[2] # cpython/Doc/tools/check-epub.py -> cpython/ |
| fatal_errors = [message for message in messages if message[0] == "FATAL"] | ||
| def main() -> int: | ||
| lines = EPUBCHECK_PATH.read_text(encoding='utf-8').splitlines() | ||
| fatal_errors = [line for line in lines if line.startswith('FATAL')] | ||
|
|
There was a problem hiding this comment.
Suggested change
| errors = [line for line in lines if line.startswith('ERROR')] | |
| if errors: | |
| print() | |
| print(f'Warning: epubcheck reported {len(errors)} error(s):') | |
| print() | |
| print('\n'.join(errors)) | |
Could we start to display errors as warnings for informational purposes?
| for error in fatal_errors: | ||
| print(" - ".join(error)) | ||
| err_count = len(fatal_errors) | ||
| s = 's' * (err_count != 1) |
There was a problem hiding this comment.
Suggested change
| s = 's' * (err_count != 1) | |
| s = 's' if err_count > 1 else '' |
nit-picky: for readability/verbosity
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.
We also split
epubto a parallel job.A
📚 Documentation preview 📚: https://cpython-previews--137351.org.readthedocs.build/