Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork966
Expand file tree
/
Copy pathutil.py
More file actions
111 lines (79 loc) · 3.37 KB
/
util.py
File metadata and controls
111 lines (79 loc) · 3.37 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
"""Module containing index utilities"""
fromfunctoolsimportwraps
importos
importstruct
importtempfile
fromgit.compatimportis_win
importos.pathasosp
# typing ----------------------------------------------------------------------
fromtypingimport (Any,Callable,TYPE_CHECKING)
fromgit.typesimportPathLike,_T
ifTYPE_CHECKING:
fromgit.indeximportIndexFile
# ---------------------------------------------------------------------------------
__all__= ('TemporaryFileSwap','post_clear_cache','default_index','git_working_dir')
#{ Aliases
pack=struct.pack
unpack=struct.unpack
#} END aliases
classTemporaryFileSwap(object):
"""Utility class moving a file to a temporary location within the same directory
and moving it back on to where on object deletion."""
__slots__= ("file_path","tmp_file_path")
def__init__(self,file_path:PathLike)->None:
self.file_path=file_path
self.tmp_file_path=str(self.file_path)+tempfile.mktemp('','','')
# it may be that the source does not exist
try:
os.rename(self.file_path,self.tmp_file_path)
exceptOSError:
pass
def__del__(self)->None:
ifosp.isfile(self.tmp_file_path):
ifis_winandosp.exists(self.file_path):
os.remove(self.file_path)
os.rename(self.tmp_file_path,self.file_path)
# END temp file exists
#{ Decorators
defpost_clear_cache(func:Callable[...,_T])->Callable[...,_T]:
"""Decorator for functions that alter the index using the git command. This would
invalidate our possibly existing entries dictionary which is why it must be
deleted to allow it to be lazily reread later.
:note:
This decorator will not be required once all functions are implemented
natively which in fact is possible, but probably not feasible performance wise.
"""
@wraps(func)
defpost_clear_cache_if_not_raised(self:'IndexFile',*args:Any,**kwargs:Any)->_T:
rval=func(self,*args,**kwargs)
self._delete_entries_cache()
returnrval
# END wrapper method
returnpost_clear_cache_if_not_raised
defdefault_index(func:Callable[...,_T])->Callable[...,_T]:
"""Decorator assuring the wrapped method may only run if we are the default
repository index. This is as we rely on git commands that operate
on that index only. """
@wraps(func)
defcheck_default_index(self:'IndexFile',*args:Any,**kwargs:Any)->_T:
ifself._file_path!=self._index_path():
raiseAssertionError(
"Cannot call %r on indices that do not represent the default git index"%func.__name__)
returnfunc(self,*args,**kwargs)
# END wrapper method
returncheck_default_index
defgit_working_dir(func:Callable[...,_T])->Callable[...,_T]:
"""Decorator which changes the current working dir to the one of the git
repository in order to assure relative paths are handled correctly"""
@wraps(func)
defset_git_working_dir(self:'IndexFile',*args:Any,**kwargs:Any)->_T:
cur_wd=os.getcwd()
os.chdir(str(self.repo.working_tree_dir))
try:
returnfunc(self,*args,**kwargs)
finally:
os.chdir(cur_wd)
# END handle working dir
# END wrapper
returnset_git_working_dir
#} END decorators