Skip to content

gh-64595: Argument Clinic: Touch source file if any output file changed #104152

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

Merged
merged 4 commits into from
May 5, 2023
Merged

gh-64595: Argument Clinic: Touch source file if any output file changed #104152

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ca580c
gh-64595: Argument Clinic: Touch source file if any output file changed
erlend-aasland May 3, 2023
a6b0fda
Pull in main
erlend-aasland May 4, 2023
34a5770
Adapt tests to new parse() behaviour
erlend-aasland May 4, 2023
8d2aae3
Update Tools/clinic/clinic.py
erlend-aasland May 5, 2023
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
7 changes: 4 additions & 3 deletions Lib/test/test_clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,9 @@ def test_eol(self):
# the last line of the block got corrupted.
c = clinic.Clinic(clinic.CLanguage(None), filename="file")
raw = "/*[clinic]\nfoo\n[clinic]*/"
cooked = c.parse(raw).splitlines()
end_line = cooked[2].rstrip()
cooked, _ = c.parse(raw)
lines = cooked.splitlines()
end_line = lines[2].rstrip()
# this test is redundant, it's just here explicitly to catch
# the regression test so we don't forget what it looked like
self.assertNotEqual(end_line, "[clinic]*/[clinic]*/")
Expand Down Expand Up @@ -259,7 +260,7 @@ def _test_clinic(self, input, output):
c = clinic.Clinic(language, filename="file")
c.parsers['inert'] = InertParser(c)
c.parsers['copy'] = CopyParser(c)
computed = c.parse(input)
computed, _ = c.parse(input)
self.assertEqual(output, computed)

def test_clinic_1(self):
Expand Down
18 changes: 12 additions & 6 deletions Tools/clinic/clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1943,12 +1943,12 @@ def dump(self):
return_converters = {}


def write_file(filename, new_contents):
def write_file(filename, new_contents, force=False):
try:
with open(filename, 'r', encoding="utf-8") as fp:
old_contents = fp.read()

if old_contents == new_contents:
if old_contents == new_contents and not force:
# no change: avoid modifying the file modification time
return
except FileNotFoundError:
Expand Down Expand Up @@ -2112,6 +2112,8 @@ def parse(self, input):
traceback.format_exc().rstrip())
printer.print_block(block)

clinic_out = []

# these are destinations not buffers
for name, destination in self.destinations.items():
if destination.type == 'suppress':
Expand Down Expand Up @@ -2151,10 +2153,11 @@ def parse(self, input):
block.input = 'preserve\n'
printer_2 = BlockPrinter(self.language)
printer_2.print_block(block, core_includes=True)
write_file(destination.filename, printer_2.f.getvalue())
pair = destination.filename, printer_2.f.getvalue()
clinic_out.append(pair)
continue

return printer.f.getvalue()
return printer.f.getvalue(), clinic_out


def _module_and_class(self, fields):
Expand Down Expand Up @@ -2210,9 +2213,12 @@ def parse_file(filename, *, verify=True, output=None):
return

clinic = Clinic(language, verify=verify, filename=filename)
cooked = clinic.parse(raw)
src_out, clinic_out = clinic.parse(raw)

write_file(output, cooked)
force = bool(clinic_out)
write_file(output, src_out, force=force)
for fn, data in clinic_out:
write_file(fn, data)


def compute_checksum(input, length=None):
Expand Down