GitPython/git/index/util.py at 3.1.62 · gitpython-developers/GitPython · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

# This module is part of GitPython and is released under the

# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

"""Index utilities."""

__all__ = ["TemporaryFileSwap", "post_clear_cache", "default_index", "git_working_dir"]

import contextlib

from functools import wraps

import os

import os.path as osp

import struct

import tempfile

from types import TracebackType

# typing ----------------------------------------------------------------------

from typing import Any, Callable, TYPE_CHECKING, Optional, Type, cast

from git.types import Literal, PathLike, _T

if TYPE_CHECKING:

from git.index import IndexFile

# ---------------------------------------------------------------------------------

# { Aliases

pack = struct.pack

unpack = struct.unpack

# } END aliases

class TemporaryFileSwap:

"""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

dirname, basename = osp.split(file_path)

fd, self.tmp_file_path = tempfile.mkstemp(prefix=basename, dir=dirname)

os.close(fd)

with contextlib.suppress(OSError): # It may be that the source does not exist.

os.replace(self.file_path, self.tmp_file_path)

def __enter__(self) -> "TemporaryFileSwap":

return self

def __exit__(

self,

exc_type: Optional[Type[BaseException]],

exc_val: Optional[BaseException],

exc_tb: Optional[TracebackType],

) -> Literal[False]:

if osp.isfile(self.tmp_file_path):

os.replace(self.tmp_file_path, self.file_path)

return False

# { Decorators

def post_clear_cache(func: Callable[..., _T]) -> Callable[..., _T]:

"""Decorator for functions that alter the index using the git command.

When a git command alters the index, this invalidates our possibly existing entries

dictionary, which is why it must be deleted to allow it to be lazily reread later.

"""

@wraps(func)

def post_clear_cache_if_not_raised(self: "IndexFile", *args: Any, **kwargs: Any) -> _T:

rval = func(self, *args, **kwargs)

self._delete_entries_cache()

return rval

# END wrapper method

return post_clear_cache_if_not_raised

def default_index(func: Callable[..., _T]) -> Callable[..., _T]:

"""Decorator ensuring 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)

def check_default_index(self: "IndexFile", *args: Any, **kwargs: Any) -> _T:

if self._file_path != self._index_path():

raise AssertionError(

"Cannot call %r on indices that do not represent the default git index" % func.__name__

)

return func(self, *args, **kwargs)

# END wrapper method

return check_default_index

def git_working_dir(func: Callable[..., _T]) -> Callable[..., _T]:

"""Decorator which changes the current working dir to the one of the git

repository in order to ensure relative paths are handled correctly."""

@wraps(func)

def set_git_working_dir(self: "IndexFile", *args: Any, **kwargs: Any) -> _T:

cur_wd = os.getcwd()

os.chdir(cast(PathLike, self.repo.working_tree_dir))

try:

return func(self, *args, **kwargs)

finally:

os.chdir(cur_wd)

# END handle working dir

# END wrapper

return set_git_working_dir

# } END decorators

GitPython/git/index/util.py at 3.1.62 · gitpython-developers/GitPython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

util.py

Latest commit

History

Breadcrumbs

util.py

File metadata and controls