← 返回首页
Replace the one use of mktemp in the git module · gitpython-developers/GitPython@9e86053 · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

Commit 9e86053

Browse files
EliahKagan
committed
Replace the one use of mktemp in the git module
This makes two related changes to git.index.util.TemporaryFileSwap: - Replace mktemp with mkstemp and then immediately closing the file. This avoids two possible name clashes: the usual name clash where the file may be created by another process between when mktemp generates the name and when the file is created, and the problem that mktemp does not check for files that contain the generated name as a part. The latter is specific to the use here, where a string generated by mktemp was manually concatenated to the base filename. This addresses that by passing the filename as the prefix for mkstemp to use. - Replace os.remove with os.replace and simplify. This is made necessary on Windows by the file already existing, due to mkstemp creating it. Deleting the file and allowing it to be recreated would reproduce the mktemp race condition in full (obscured and with extra steps). But os.replace supports an existing target file on all platforms. It is now also used in __exit__, where it allows the Windows check for the file to be removed, and (in any OS) better expresses the intent of the code to human readers. Furthermore, because one of the "look before you leap" checks in __exit__ is removed, the minor race condition in cleaning up the file is somewhat decreased. A small amount of related refactoring is included. The interface is not changed, even where it could be simplified (by letting __exit__ return None), and resource acquisition remains done on construction rather than in __enter__, because changing those aspects of the design could break some existing uses. Although the use of mktemp replaced here was in the git module and not the test suite, its use was to generate filenames for use in a directory that would ordinarily be under the user's control, such that the ability to carry out typical mktemp-related attacks would already require the ability to achieve the same goals more easily and reliably. Although TemporaryFileSwap is a public class that may be used directly by applications, it is only useful for making a temporary file in the same directory as an existing file. Thus the intended benefits of this change are mainly to code quality and a slight improvement in robustness.
1 parent 41fac85 commit 9e86053

1 file changed

Lines changed: 6 additions & 10 deletions

File tree

‎git/index/util.py‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
"""Index utilities."""
55

6+
import contextlib
67
from functools import wraps
78
import os
89
import os.path as osp
@@ -40,12 +41,10 @@ class TemporaryFileSwap:
4041

4142
def __init__(self, file_path: PathLike) -> None:
4243
self.file_path = file_path
43-
self.tmp_file_path = str(self.file_path) + tempfile.mktemp("", "", "")
44-
# It may be that the source does not exist.
45-
try:
46-
os.rename(self.file_path, self.tmp_file_path)
47-
except OSError:
48-
pass
44+
fd, self.tmp_file_path = tempfile.mkstemp(prefix=self.file_path, dir="")
45+
os.close(fd)
46+
with contextlib.suppress(OSError): # It may be that the source does not exist.
47+
os.replace(self.file_path, self.tmp_file_path)
4948

5049
def __enter__(self) -> "TemporaryFileSwap":
5150
return self
@@ -57,10 +56,7 @@ def __exit__(
5756
exc_tb: Optional[TracebackType],
5857
) -> bool:
5958
if osp.isfile(self.tmp_file_path):
60-
if os.name == "nt" and osp.exists(self.file_path):
61-
os.remove(self.file_path)
62-
os.rename(self.tmp_file_path, self.file_path)
63-
59+
os.replace(self.tmp_file_path, self.file_path)
6460
return False
6561

6662

0 commit comments

Comments
 (0)

Footer

© 2026 GitHub, Inc.