-
Notifications
You must be signed in to change notification settings - Fork 622
Fix Unpin rstcheck #2383
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ganeshhubale
wants to merge
1
commit into
ansible:devel
Choose a base branch
from
ganeshhubale:issue-rstcheck-1710
base: devel
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Fix Unpin rstcheck #2383
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,63 +1,49 @@ | ||
"""Sanity test using rstcheck and sphinx.""" | ||
"""Sanity test using rstcheck-core and sphinx.""" | ||
from __future__ import annotations | ||
|
||
import re | ||
import subprocess | ||
from rstcheck_core.runner import RstcheckMainRunner | ||
from rstcheck_core.config import RstcheckConfig | ||
import pathlib | ||
import sys | ||
|
||
|
||
def main(): | ||
paths = sys.argv[1:] or sys.stdin.read().splitlines() | ||
|
||
encoding = 'utf-8' | ||
|
||
ignore_substitutions = ( | ||
'br', | ||
# Read input paths from CLI arguments or stdin | ||
if sys.argv[1:]: | ||
raw_paths = sys.argv[1:] | ||
else: | ||
raw_paths = sys.stdin.read().splitlines() | ||
|
||
# Convert to pathlib.Path objects | ||
paths = [pathlib.Path(p) for p in raw_paths] | ||
|
||
# Handle case where no paths are provided | ||
if not paths: | ||
print("No files or directories provided for checking.", file=sys.stderr) | ||
sys.exit(1) | ||
|
||
# Define the configuration for rstcheck | ||
config = RstcheckConfig( | ||
ignore_roles=[ | ||
"ansplugin", "ansopt", "ansretval", "ansval", "ansenvvar", "ansenvvarref" | ||
], | ||
ignore_substitutions=["br"], | ||
report_level="warning", # Adjust report level as needed: "info", "warning", "error", "severe", "none" | ||
recursive=True, # Set to True to check directories recursively | ||
) | ||
|
||
cmd = [ | ||
sys.executable, | ||
'-c', 'import rstcheck; rstcheck.main();', | ||
'--report', 'warning', | ||
'--ignore-roles', 'ansplugin,ansopt,ansretval,ansval,ansenvvar,ansenvvarref', | ||
'--ignore-substitutions', ','.join(ignore_substitutions), | ||
] + paths | ||
|
||
process = subprocess.run(cmd, | ||
stdin=subprocess.DEVNULL, | ||
stdout=subprocess.PIPE, | ||
stderr=subprocess.PIPE, | ||
check=False, | ||
) | ||
|
||
if process.stdout: | ||
raise Exception(process.stdout) | ||
|
||
pattern = re.compile(r'^(?P<path>[^:]*):(?P<line>[0-9]+): \((?P<level>INFO|WARNING|ERROR|SEVERE)/[0-4]\) (?P<message>.*)$') | ||
|
||
results = parse_to_list_of_dict(pattern, process.stderr.decode(encoding)) | ||
|
||
for result in results: | ||
print('%s:%s:%s: %s' % (result['path'], result['line'], 0, result['message'])) | ||
|
||
|
||
def parse_to_list_of_dict(pattern, value): | ||
matched = [] | ||
unmatched = [] | ||
|
||
for line in value.splitlines(): | ||
match = re.search(pattern, line) | ||
|
||
if match: | ||
matched.append(match.groupdict()) | ||
else: | ||
unmatched.append(line) | ||
|
||
if unmatched: | ||
raise Exception('Pattern "%s" did not match values:\n%s' % (pattern, '\n'.join(unmatched))) | ||
|
||
return matched | ||
|
||
# Initialize the runner | ||
runner = RstcheckMainRunner( | ||
check_paths=paths, | ||
rstcheck_config=config, | ||
overwrite_config=True, | ||
) | ||
|
||
# Run the checks | ||
exit_code = runner.run() | ||
|
||
# Exit with the appropriate code | ||
sys.exit(exit_code) | ||
|
||
if __name__ == '__main__': | ||
main() |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One problem with
runner.run()
is that it prints messages in a slightly different format. First, it prints a generalsuccess
/failure
message that's not of the expected format. Then, it uses the formatFILE:LINE: MSG
instead ofFILE:LINE:COL: MSG
.It might be better to simply run
runner.check()
and handle whatrunner.print_result()
does here.