Skip to content

Commit

Permalink
gh-64595: Fix regression in file write logic in Argument Clinic (#106449
Browse files Browse the repository at this point in the history
)

Revert the two commits that introduced the regressions:

 - gh-104152
 - gh-104507
  • Loading branch information
erlend-aasland authored Jul 5, 2023
1 parent a941bd6 commit 9d1d4f9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 27 deletions.
7 changes: 3 additions & 4 deletions Lib/test/test_clinic.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,8 @@ 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)
lines = cooked.splitlines()
end_line = lines[2].rstrip()
cooked = c.parse(raw).splitlines()
end_line = cooked[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 @@ -261,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
35 changes: 12 additions & 23 deletions Tools/clinic/clinic.py
Original file line number Diff line number Diff line change
Expand Up @@ -2021,22 +2021,20 @@ def dump(self):
extensions['py'] = PythonLanguage


def file_changed(filename: str, new_contents: str) -> bool:
"""Return true if file contents changed (meaning we must update it)"""
def write_file(filename: str, new_contents: str) -> None:
try:
with open(filename, encoding="utf-8") as fp:
with open(filename, 'r', encoding="utf-8") as fp:
old_contents = fp.read()
return old_contents != new_contents
except FileNotFoundError:
return True


def write_file(filename: str, new_contents: str) -> None:
if old_contents == new_contents:
# no change: avoid modifying the file modification time
return
except FileNotFoundError:
pass
# Atomic write using a temporary file and os.replace()
filename_new = f"{filename}.new"
with open(filename_new, "w", encoding="utf-8") as fp:
fp.write(new_contents)

try:
os.replace(filename_new, filename)
except:
Expand Down Expand Up @@ -2214,16 +2212,13 @@ 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':
continue
output = destination.dump()

if output:

block = Block("", dsl_name="clinic", output=output)

if destination.type == 'buffer':
Expand Down Expand Up @@ -2255,11 +2250,10 @@ def parse(self, input):
block.input = 'preserve\n'
printer_2 = BlockPrinter(self.language)
printer_2.print_block(block, core_includes=True)
pair = destination.filename, printer_2.f.getvalue()
clinic_out.append(pair)
write_file(destination.filename, printer_2.f.getvalue())
continue

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


def _module_and_class(self, fields):
Expand Down Expand Up @@ -2321,14 +2315,9 @@ def parse_file(

assert isinstance(language, CLanguage)
clinic = Clinic(language, verify=verify, filename=filename)
src_out, clinic_out = clinic.parse(raw)

changes = [(fn, data) for fn, data in clinic_out if file_changed(fn, data)]
if changes:
# Always (re)write the source file.
write_file(output, src_out)
for fn, data in clinic_out:
write_file(fn, data)
cooked = clinic.parse(raw)

write_file(output, cooked)


def compute_checksum(
Expand Down

0 comments on commit 9d1d4f9

Please sign in to comment.