Skip to content

gh-64595: Fix write file logic in Argument Clinic #104507

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
erlend-aasland merged 2 commits into from
May 16, 2023
Merged

gh-64595: Fix write file logic in Argument Clinic #104507

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15bf463
gh-64595: Fix write file logic in Argument Clinic
erlend-aasland May 15, 2023
2a20f90
Alternative implementation
erlend-aasland May 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
gh-64595: Fix write file logic in Argument Clinic 
Check if any clinic output actually changes any of the output files
before deciding if we should touch the source file. This needs to be
done before we eventually update the source file.
  • Loading branch information
@erlend-aasland
erlend-aasland committed May 15, 2023
commit 15bf463f6722646a34a730a2de99ecbadb88503b
18 changes: 11 additions & 7 deletions Tools/clinic/clinic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1965,16 +1965,20 @@ def dump(self):
return_converters = {}


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

if old_contents == new_contents and not force:
# no change: avoid modifying the file modification time
return
return old_contents != new_contents
except FileNotFoundError:
pass
return True


def write_file(filename: str, new_contents: str, force=False):
if not force and not file_changed(filename, new_contents):
# no change: avoid modifying the file modification time
return

# Atomic write using a temporary file and os.replace()
filename_new = f"{filename}.new"
Expand Down Expand Up @@ -2238,7 +2242,7 @@ def parse_file(filename, *, verify=True, output=None):
src_out, clinic_out = clinic.parse(raw)

# If clinic output changed, force updating the source file as well.
force = bool(clinic_out)
force = any(file_changed(fn, data) for fn, data in clinic_out)
write_file(output, src_out, force=force)
for fn, data in clinic_out:
write_file(fn, data)
Expand Down