FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Make Argument Clinic exit with an error if a warning was emitted by StanFromIreland · Pull Request #158930 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

Make Argument Clinic exit with an error if a warning was emitted #158930

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.

Sign up for GitHub

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
StanFromIreland wants to merge 2 commits into
base: main
Choose a base branch
Could not load branches
Branch not found: {{ refName }}

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.
from
+35 −3
Conversation 3 Commits 2 Checks 54 Files changed 3
Open

Make Argument Clinic exit with an error if a warning was emitted #158930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83721b7
Make Argument Clinic exit with an error if a warning was emitted
StanFromIreland Oct 6, 2026
52d30c5
Add test
StanFromIreland Oct 6, 2026
File filter

Filter by extension

Filter by extension .py  (3) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
17 changes: 17 additions & 0 deletions Lib/test/test_clinic.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -3739,6 +3739,23 @@ def test_no_change(self):
# if the content does not change
self.assertEqual(pre_mtime, post_mtime)

def test_warning_is_failure(self):
code = dedent("""
/*[clinic input]
@permit_long_summary
fn

Short summary.
[clinic start generated code]*/
""")
with os_helper.temp_dir() as tmp_dir:
fn = os.path.join(tmp_dir, "test.c")
with open(fn, "w", encoding="utf-8") as f:
f.write(code)
out, err = self.expect_failure(fn)
self.assertIn("Remove the @permit_long_summary decorator from 'fn'!", out)
self.assertEqual(err, "1 warning emitted\n")

TOUCH_CODE = dedent("""
/*[clinic input]
module m
Expand Down
11 changes: 8 additions & 3 deletions Tools/clinic/libclinic/cli.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

# Local imports.
import libclinic
import libclinic.cpp
import libclinic.errors
from libclinic import ClinicError
from libclinic.language import Language, PythonLanguage
from libclinic.block_parser import BlockParser
Expand Down Expand Up @@ -340,10 +340,15 @@ def run_clinic(parser: argparse.ArgumentParser, ns: argparse.Namespace) -> None:
def main(argv: list[str] | None = None) -> NoReturn:
parser = create_cli()
args = parser.parse_args(argv)
libclinic.errors.reset_warning_count()
try:
run_clinic(parser, args)
except ClinicError as exc:
sys.stderr.write(exc.report())
sys.exit(1)
else:
sys.exit(0)
count = libclinic.errors.warning_count
if count:
noun = "warning" if count == 1 else "warnings"
sys.stderr.write(f"{count} {noun} emitted\n")
sys.exit(1)
sys.exit(0)
10 changes: 10 additions & 0 deletions Tools/clinic/libclinic/errors.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,14 @@ class ParseError(ClinicError):
pass


warning_count = 0


def reset_warning_count() -> None:
global warning_count
warning_count = 0


@overload
def warn_or_fail(
*args: object,
Expand Down Expand Up @@ -54,6 +62,8 @@ def warn_or_fail(
if fail:
raise error
else:
global warning_count
warning_count += 1
print(error.report(warn_only=True))


Expand Down
Loading
Back | FazBrowse Home | New Git URL