René's URL Explorer Experiment
Title: No title
direct link
Domain: github.com
Hey, it has address: ``. One of these helpers (``ext::``)
can be used to invoke any arbitrary command. Git also selects that helper
for ``ext://`` URLs and interprets the URL as a command path.
See:
- https://git-scm.com/docs/gitremote-helpers
- https://git-scm.com/docs/git-remote-ext
"""
match = cls.re_unsafe_protocol.match(url)
if match:
protocol = match.group(0)
raise UnsafeProtocolError(
f"The `{protocol}` protocol looks suspicious, use `allow_unsafe_protocols=True` to allow it."
)
def _check_unsafe_protocols_in_args(self, args: Sequence[Any], kwargs: Mapping[str, Any]) -> None:
"""Check positional operands and standalone values in rendered command options.
A short flag's split value can become the repository operand before ``--``.
"""
for arg in self._unpack_args(args) + self.transform_kwargs(**kwargs):
self.check_unsafe_protocols(arg)
@classmethod
def _canonicalize_option_name(cls, option: str) -> str:
"""Return the option name used for unsafe-option checks.
Examples:
``"--upload-pack=/tmp/helper"`` -> ``"upload-pack"``
``"upload_pack"`` -> ``"upload-pack"``
``"--config core.filemode=false"`` -> ``"config"``
"""
option_name = option.lstrip("-").split("=", 1)[0]
option_tokens = option_name.split(None, 1)
if not option_tokens:
return ""
return dashify(option_tokens[0])
@classmethod
def check_unsafe_options(
cls, options: List[str], unsafe_options: List[str], clusterable_short_options: str = "46flnqsv"
) -> None:
"""Raise :class:`~git.exc.UnsafeOptionError` for blocked option spellings.
In addition to exact matches, this rejects abbreviated long options accepted
by Git (for example, ``--upl`` for ``--upload-pack``) and unsafe short options
whose values are joined to the same token, including after clusterable flags
(for example, ``-uVALUE`` and ``-fuVALUE``).
A list containing only bare names is treated as normalized keyword arguments,
so multi-character names such as ``upload_p`` are checked as long-option
abbreviations. If any item starts with ``-``, the list is treated as tokenized
command-line input: bare items can be option values and are not checked as
abbreviations. Thus ``["--origin", "upload"]`` is allowed. Single-dash options
use short-option parsing rather than broad prefix matching, preserving safe
attached values such as ``-oupstream`` and ``-bcurrent``.
Some options passed to ``git `` can execute arbitrary commands and
are therefore blocked by default unless the caller explicitly allows them.
"""
# Options can be of the form `foo`, `--foo`, `--foo bar`, or `--foo=bar`.
# Git accepts any unambiguous prefix of a long option, so an abbreviated
# spelling such as `--upl` for `--upload-pack` must be rejected too. An
# option is unsafe if its canonical name is a prefix of any blocked
# option's canonical name. Only long options and multi-character kwargs
# can be abbreviations; single-character short options remain exact-match
# only.
canonical_unsafe_options = {cls._canonicalize_option_name(option): option for option in unsafe_options}
unsafe_short_options = {
canonical: option
for canonical, option in canonical_unsafe_options.items()
if option.startswith("-") and not option.startswith("--") and len(canonical) == 1
}
# These value-less Git flags can be clustered before another short option
# (for example, ``-fuVALUE``). Stop at any other character because it may
# begin an attached value, as ``o`` does in the safe option ``-oupstream``.
clusterable_short_options_set = frozenset(clusterable_short_options)
options_are_kwargs = all(not option.startswith("-") for option in options)
for option in options:
candidate = cls._canonicalize_option_name(option)
if not candidate:
continue
unsafe_option = canonical_unsafe_options.get(candidate)
if unsafe_option is not None:
raise UnsafeOptionError(f"{unsafe_option} is not allowed, use `allow_unsafe_options=True` to allow it.")
option_token = option.split("=", 1)[0].split(None, 1)[0]
if option_token.startswith("-") and not option_token.startswith("--"):
for option_char in option_token[1:]:
unsafe_option = unsafe_short_options.get(option_char)
if unsafe_option is not None:
raise UnsafeOptionError(
f"{unsafe_option} is not allowed, use `allow_unsafe_options=True` to allow it."
)
if option_char not in clusterable_short_options_set:
break
if not (option.startswith("--") or (options_are_kwargs and len(candidate) > 1)):
continue
for canonical, unsafe_option in canonical_unsafe_options.items():
if canonical.startswith(candidate):
raise UnsafeOptionError(
f"{unsafe_option} is not allowed, use `allow_unsafe_options=True` to allow it."
)
@classmethod
def _option_candidates(cls, args: Sequence[Any] = (), kwargs: Optional[Mapping[str, Any]] = None) -> List[str]:
"""Collect possible option spellings before command-line transformation."""
options = [
option for option in cls._unpack_args([arg for arg in args if arg is not None]) if option.startswith("-")
]
if kwargs:
split_single_char_options = kwargs.get("split_single_char_options", True)
for key, value in kwargs.items():
values = value if isinstance(value, (list, tuple)) else (value,)
if any(value is True or (value is not False and value is not None) for value in values):
key = str(key)
if len(key) != 1:
options.append(f"--{dashify(key)}")
elif split_single_char_options:
options.append(f"-{key}")
options.extend(
str(value)
for value in values
if value is not True and value not in (False, None) and str(value).startswith("-")
)
else:
options.extend(
f"-{key}" if value is True else f"-{key}{value}"
for value in values
if value is True or (value is not False and value is not None)
)
return options
@staticmethod
def _check_operand(value: Any, label: str = "operand") -> str:
"""Validate a single name/revision, before Git can interpret it as an option.
Paths and free-form payloads need their own validation and framing instead.
"""
value = safe_decode(value) if isinstance(value, bytes) else str(value)
if value.startswith("-") or any(char in value for char in "\0\r\n"):
raise UnsafeOptionError(f"Invalid {label}: {value!r}")
return value
@staticmethod
def _check_revision(value: Any, label: str = "revision") -> str:
"""Validate a revision, preserving a reference object's full name.
A reference converts to its short name, for which Git's revision lookup tries
other references, such as a same-named tag, before ``refs/heads/`` and
``refs/remotes/``. Verify the exact reference exists before passing its full
name, retaining its identity for reflog walks and remote archives.
"""
from git.refs.symbolic import SymbolicReference
if isinstance(value, SymbolicReference):
value.dereference_recursive(value.repo, value.path)
value = value.path
if isinstance(value, os.PathLike):
value = os.fsdecode(value)
return Git._check_operand(value, label)
def _require_version(self) -> None:
key = None
if self._version_info_token is not self._refresh_token:
key = self._version_check_key()
if key is not None:
version = self._version_check_cache.get(key)
if version is not None:
self._version_info = version
self._version_info_token = key[0]
version = self.version_info
if version < (2, 52):
raise UnsupportedOperation("GitPython requires Git 2.52 or newer for repository operations")
if key is not None and key not in self._version_check_cache:
# ponytail: clear at 128 contexts; use LRU if diverse environments churn.
if len(self._version_check_cache) >= 128:
self._version_check_cache.clear()
self._version_check_cache[key] = version
def _version_check_key(self) -> Optional[Tuple[Any, ...]]:
"""Identify the executable and context of a minimum-version probe."""
executable = self.GIT_PYTHON_GIT_EXECUTABLE
if not executable or self._git_options or self._persistent_git_options:
return None
environment = {**os.environ, "LANGUAGE": "C", "LC_ALL": "C", **self._environment}
try:
cwd = os.path.realpath(self._working_dir or os.getcwd())
if not os.access(cwd, os.X_OK):
return None
resolved: Optional[str]
if os.path.isabs(executable):
resolved = executable
elif sys.platform == "win32":
# CreateProcess searches in the parent context, unlike execvpe.
return None
elif os.path.dirname(executable):
resolved = os.path.join(cwd, executable)
else:
path = environment.get("PATH")
path = os.defpath if path is None else path
resolved = shutil.which(
executable, path=os.pathsep.join(os.path.join(cwd, p) for p in path.split(os.pathsep))
)
if resolved is None:
return None
info = os.stat(resolved)
except OSError:
return None
return (
self._refresh_token,
type(self),
executable,
resolved,
cwd,
tuple(sorted(environment.items())),
(info.st_dev, info.st_ino, info.st_size, info.st_mtime_ns, info.st_ctime_ns),
)
def _call_process_safe(
self,
method: str,
*args: Any,
_allow_hooks: bool = False,
_allow_network: bool = False,
_config: Sequence[str] = (),
**kwargs: Any,
) -> Any:
"""Run library-owned plumbing without introducing executable configuration.
Callers validate their operands and any forwarded options using the existing
command-specific guards. This does not restrict the public raw Git interface.
"""
self._check_operand(method, "command")
if kwargs.get("shell"):
raise UnsafeOptionError("Library operations cannot run through a shell")
if _allow_hooks and method != "hook":
raise UnsafeOptionError("Only explicit hook operations may enable hooks")
insertion = kwargs.get("insert_kwargs_after")
if insertion is not None and not (
method == "remote" and args and args[0] == insertion and insertion in ("add", "set-url", "update")
):
raise UnsafeOptionError("Library command options cannot be reordered past safety flags")
for setting in _config:
key, separator, value = setting.partition("=")
if not separator or (
key.lower() not in ("i18n.commitencoding", "diff.mnemonicprefix", "fetch.output", "core.abbrev")
and not (key in ("core.protectHFS", "core.protectNTFS") and value == "true")
and not (key == "protocol.file.allow" and value in ("always", "never", "user"))
and not (key in ("tar.tgz.command", "tar.tar.gz.command") and value == "git archive gzip")
):
raise UnsafeOptionError(f"Unsupported internal Git configuration: {key!r}")
for arg in self._unpack_args([arg for arg in args if arg is not None]) + self.transform_kwargs(
**{key: value for key, value in kwargs.items() if key not in execute_kwargs}
):
if "\0" in arg:
raise UnsafeOptionError("Git arguments cannot contain NUL bytes")
options = ["--no-pager", "--no-optional-locks"]
# These settings would become visible as user configuration in `config`.
if method != "config":
config = ["core.fsmonitor=false", "gc.auto=0", "maintenance.auto=false"]
if not _allow_hooks:
config.append(f"core.hooksPath={os.devnull}")
for setting in [*config, *_config]:
options.extend(("-c", setting))
elif _config:
raise ValueError("Configuration queries must not include synthetic settings")
native = _backend.dispatch(self, method, args, kwargs, _config)
if native is not NotImplemented:
return native
self._require_version()
env = dict(kwargs.pop("env", {}) or {})
env.update(LC_ALL="C", LANGUAGE="C")
if not _allow_network:
env.update(GIT_NO_LAZY_FETCH="1", GIT_TERMINAL_PROMPT="0")
return self._call_process(
method,
*args,
_safe_git_options=options,
shell=False,
env=env,
**{key: value for key, value in kwargs.items() if key != "shell"},
)
AutoInterrupt: TypeAlias = _AutoInterrupt
CatFileContentStream: TypeAlias = _CatFileContentStream
def __init__(self, working_dir: Union[None, PathLike] = None) -> None:
"""Initialize this instance with:
:param working_dir:
Git directory we should work in. If ``None``, we always work in the current
directory as returned by :func:`os.getcwd`.
This is meant to be the working tree directory if available, or the
``.git`` directory in case of bare repositories.
"""
super().__init__()
self._working_dir = expand_path(working_dir)
self._git_options: Union[List[str], Tuple[str, ...]] = ()
self._persistent_git_options: List[str] = []
# Extra environment variables to pass to git commands
self._environment: Dict[str, Optional[str]] = {}
self._repository_environment: Dict[str, Optional[str]] = {}
self._repo: Any = None # Weak reference to the Repo's native repository accessor.
# Cached version slots
self._version_info = None
self._version_info_token = None
# Cached command slots
self.cat_file_header: Union[None, TBD] = None
self.cat_file_all: Union[None, TBD] = None
def __getattr__(self, name: str) -> Any:
"""A convenience method as it allows to call the command as if it was an object.
:return:
Callable object that will execute call :meth:`_call_process` with your
arguments.
"""
if name.startswith("_"):
return super().__getattribute__(name)
return lambda *args, **kwargs: self._call_process(name, *args, **kwargs)
def set_persistent_git_options(self, **kwargs: Any) -> None:
"""Specify command line options to the git executable for subsequent
subcommand calls.
:param kwargs:
A dict of keyword arguments.
These arguments are passed as in :meth:`_call_process`, but will be passed
to the git command rather than the subcommand.
"""
self._persistent_git_options = self.transform_kwargs(split_single_char_options=True, **kwargs)
def ls_remote(
self,
*args: Any,
allow_unsafe_options: bool = False,
allow_unsafe_protocols: bool = False,
**kwargs: Any,
) -> Union[str, bytes, Tuple[int, Union[str, bytes], str], "Git.AutoInterrupt"]:
"""List references in a remote repository.
:param allow_unsafe_options:
Allow unsafe options, like ``--upload-pack`` or ``--exec``.
:param allow_unsafe_protocols:
Allow unsafe protocols to be used, like ``ext``. Positional arguments
and split short-option values are checked.
"""
if not allow_unsafe_options:
candidate_options = self._option_candidates(args, kwargs)
Git.check_unsafe_options(options=candidate_options, unsafe_options=self.unsafe_git_ls_remote_options)
if not allow_unsafe_protocols:
self._check_unsafe_protocols_in_args(args, kwargs)
return self._call_process("ls_remote", *args, **kwargs)
@property
def working_dir(self) -> Union[None, PathLike]:
""":return: Git directory we are working on"""
return self._working_dir
@property
def version_info(self) -> Tuple[int, ...]:
"""
:return: Tuple with integers representing the major, minor and additional
version numbers as parsed from :manpage:`git-version(1)`. Up to four fields
are used.
This value is generated on demand and is cached.
"""
# Refreshing is global, but version_info caching is per-instance.
refresh_token = self._refresh_token # Copy token in case of concurrent refresh.
# Use the cached version if obtained after the most recent refresh.
if self._version_info_token is refresh_token:
assert self._version_info is not None, "Bug: corrupted token-check state"
return self._version_info
# Run "git version" and parse it.
process_version = cast(str, self._call_process("version", shell=False))
version_string = process_version.split(" ")[2]
version_fields = version_string.split(".")[:4]
leading_numeric_fields = itertools.takewhile(str.isdigit, version_fields)
self._version_info = tuple(map(int, leading_numeric_fields))
# This value will be considered valid until the next refresh.
self._version_info_token = refresh_token
return self._version_info
@overload
def execute(
self,
command: Union[str, Sequence[Any]],
istream: Union[None, int, BinaryIO] = None,
*,
as_process: Literal[True],
**subprocess_kwargs: Any,
) -> "AutoInterrupt": ...
@overload
def execute(
self,
command: Union[str, Sequence[Any]],
istream: Union[None, int, BinaryIO] = None,
*,
as_process: Literal[False] = False,
with_extended_output: Literal[False] = False,
stdout_as_string: Literal[True] = True,
with_stdout: Literal[True] = True,
**subprocess_kwargs: Any,
) -> str: ...
@overload
def execute(
self,
command: Union[str, Sequence[Any]],
istream: Union[None, int, BinaryIO] = None,
*,
as_process: Literal[False] = False,
with_extended_output: Literal[False] = False,
stdout_as_string: Literal[False],
universal_newlines: Literal[False] = False,
with_stdout: Literal[True] = True,
**subprocess_kwargs: Any,
) -> bytes: ...
@overload
def execute(
self,
command: Union[str, Sequence[Any]],
istream: Union[None, int, BinaryIO] = None,
*,
as_process: Literal[False] = False,
with_extended_output: Literal[True],
stdout_as_string: Literal[True] = True,
with_stdout: Literal[True] = True,
**subprocess_kwargs: Any,
) -> Tuple[int, str, str]: ...
@overload
def execute(
self,
command: Union[str, Sequence[Any]],
istream: Union[None, int, BinaryIO] = None,
*,
as_process: Literal[False] = False,
with_extended_output: Literal[True],
stdout_as_string: Literal[False],
universal_newlines: Literal[False] = False,
with_stdout: Literal[True] = True,
**subprocess_kwargs: Any,
) -> Tuple[int, bytes, str]: ...
@overload
def execute(
self,
command: Union[str, Sequence[Any]],
istream: Union[None, int, BinaryIO] = None,
*,
as_process: Literal[False] = False,
with_extended_output: Literal[True],
**subprocess_kwargs: Any,
) -> Tuple[int, Union[str, bytes, None], str]: ...
@overload
def execute(
self,
command: Union[str, Sequence[Any]],
istream: Union[None, int, BinaryIO] = None,
*,
as_process: Literal[False] = False,
with_extended_output: Literal[False] = False,
**subprocess_kwargs: Any,
) -> Union[str, bytes, None]: ...
@overload
def execute(
self,
command: Union[str, Sequence[Any]],
istream: Union[None, int, BinaryIO] = None,
with_extended_output: bool = False,
with_exceptions: bool = True,
as_process: bool = False,
output_stream: Union[None, BinaryIO] = None,
stdout_as_string: bool = True,
kill_after_timeout: Union[None, float] = None,
with_stdout: bool = True,
universal_newlines: bool = False,
shell: Union[None, bool] = None,
env: Union[None, Mapping[str, str]] = None,
max_chunk_size: int = io.DEFAULT_BUFFER_SIZE,
strip_newline_in_stdout: bool = True,
**subprocess_kwargs: Any,
) -> Union[None, str, bytes, Tuple[int, Union[str, bytes, None], str], AutoInterrupt]: ...
def execute(
self,
command: Union[str, Sequence[Any]],
istream: Union[None, int, BinaryIO] = None,
with_extended_output: bool = False,
with_exceptions: bool = True,
as_process: bool = False,
output_stream: Union[None, BinaryIO] = None,
stdout_as_string: bool = True,
kill_after_timeout: Union[None, float] = None,
with_stdout: bool = True,
universal_newlines: bool = False,
shell: Union[None, bool] = None,
env: Union[None, Mapping[str, str]] = None,
max_chunk_size: int = io.DEFAULT_BUFFER_SIZE,
strip_newline_in_stdout: bool = True,
**subprocess_kwargs: Any,
) -> Union[None, str, bytes, Tuple[int, Union[str, bytes, None], str], AutoInterrupt]:
R"""Handle executing the command, and consume and return the returned
information (stdout).
:param command:
The command to execute. A sequence of program arguments is recommended.
A string is also accepted, but its meaning is strongly platform-dependent.
By default, a shell is not used. On Unix-like systems, a string is the whole
program name (so ``"git log -n 1"`` raises :class:`GitCommandNotFound`). On
Windows, the program parses the arguments itself, so multi-word strings can
work but are not portable.
Avoid ``shell=True``: this runs the command in
a shell, which is generally unsafe. The shell interprets metacharacters
such as ``;``, ``|``, ``&``, ``$(...)``, ``$VAR``, ``%VAR%``, and ``^``
(depending on the platform) as syntax. Any untrusted text in the command
can then execute arbitrary OS commands.
Producing a sequence automatically by :func:`shlex.split` and passing it
as the command is far safer than ``shell=True``. But :func:`shlex.split`
parses POSIX shell syntax on all systems, and the result is still unsafe
for anything but *fixed, fully trusted* strings. Do not use it on strings
built by interpolating values: whitespace or quoting in an untrusted value
can still inject arguments. For input derived in any way from untrusted
data, build the argument sequence yourself, while ensuring each argument
is fully sanitized.
:param istream:
Standard input filehandle passed to :class:`subprocess.Popen`.
:param with_extended_output:
Whether to return a (status, stdout, stderr) tuple.
:param with_exceptions:
Whether to raise an exception when git returns a non-zero status.
:param as_process:
Whether to return the created process instance directly from which
streams can be read on demand. This will render `with_extended_output`
and `with_exceptions` ineffective - the caller will have to deal with
the details. It is important to note that the process will be placed
into an :class:`AutoInterrupt` wrapper that will interrupt the process
once it goes out of scope. If you use the command in iterators, you
should pass the whole process instance instead of a single stream.
:param output_stream:
If set to a file-like object, data produced by the git command will be
copied to the given stream instead of being returned as a string.
This feature only has any effect if `as_process` is ``False``.
:param stdout_as_string:
If ``False``, the command's standard output will be bytes. Otherwise, it
will be decoded into a string using the default encoding (usually UTF-8).
The latter can fail, if the output contains binary data.
:param kill_after_timeout:
Specifies a timeout in seconds for the git command, after which the process
should be killed. This will have no effect if `as_process` is set to
``True``. It is set to ``None`` by default and will let the process run
until the timeout is explicitly specified. Uses of this feature should be
carefully considered, due to the following limitations:
1. This feature is not supported at all on Windows.
2. Enumerating child processes requires ``pgrep -P``, or a ``ps`` command
supporting the POSIX ``-A`` and ``-o`` options if ``pgrep`` is not
installed (``ps -ef`` on Cygwin). Effectiveness may vary on systems
without these commands.
3. Descendants are enumerated before signalling. Processes that detach
or spawn after enumeration may not receive signals.
4. `kill_after_timeout` uses ``SIGKILL``, which can have negative side
effects on a repository. For example, stale locks in case of
:manpage:`git-gc(1)` could render the repository incapable of accepting
changes until the lock is manually removed.
:param with_stdout:
If ``True``, default ``True``, we open stdout on the created process.
:param universal_newlines:
If ``True``, pipes are opened as text with CR, LF and CRLF newline
handling. Undecodable bytes are preserved with ``surrogateescape``
unless an explicit ``errors`` subprocess argument selects another policy.
:param shell:
Whether to invoke commands through a shell
(see :class:`Popen(..., shell=True) `).
Use a shell explicitly; the default is ``False``.
Passing ``shell=True`` to this or any other GitPython function should be
avoided, as it is unsafe under most circumstances. This is because it is
typically not feasible to fully consider and account for the effect of shell
expansions, especially when passing ``shell=True`` to other methods that
forward it to :meth:`Git.execute`. Passing ``shell=True`` is also no longer
needed (nor useful) to work around any known operating system specific
issues.
On Unix-like systems, when migrating away from passing string commands with
``shell=True``, :func:`shlex.split` may serve as a transitional step in rare
cases, with extreme care. (Drop ``shell=True`` and pass the resulting
sequence as the command.) See the `command` parameter above on the risks.
:param env:
A dictionary of environment variables to be passed to
:class:`subprocess.Popen`.
:param max_chunk_size:
Maximum number of bytes in one chunk of data passed to the `output_stream`
in one invocation of its ``write()`` method. If the given number is not
positive then the default value is used.
:param strip_newline_in_stdout:
Whether to strip the trailing ``\n`` of the command stdout.
:param subprocess_kwargs:
Keyword arguments to be passed to :class:`subprocess.Popen`. Please note
that some of the valid kwargs are already set by this method; the ones you
specify may not be the same ones.
:return:
* str(output), if `extended_output` is ``False`` (Default)
* tuple(int(status), str(stdout), str(stderr)),
if `extended_output` is ``True``
If `output_stream` is ``True``, the stdout value will be your output stream:
* output_stream, if `extended_output` is ``False``
* tuple(int(status), output_stream, str(stderr)),
if `extended_output` is ``True``
Note that git is executed with ``LC_MESSAGES="C"`` to ensure consistent
output regardless of system language.
:raise git.exc.GitCommandError:
:note:
If you add additional keyword arguments to the signature of this method, you
must update the ``execute_kwargs`` variable housed in this module.
"""
# Remove password for the command if present.
redacted_command = remove_password_if_present(command)
if self.GIT_PYTHON_TRACE and (self.GIT_PYTHON_TRACE != "full" or as_process):
_logger.info(" ".join(redacted_command))
# Allow the user to have the command executed in their working dir.
try:
cwd = self._working_dir or os.getcwd() # type: Optional[PathLike]
if not os.access(str(cwd), os.X_OK):
cwd = None
except FileNotFoundError:
cwd = None
# Start the process.
inline_env = env
environment: Dict[str, Optional[str]] = dict(os.environ)
# Attempt to force all output to plain ASCII English, which is what some parsing
# code may expect.
# According to https://askubuntu.com/a/311796, we are setting LANGUAGE as well
# just to be sure.
environment["LANGUAGE"] = "C"
environment["LC_ALL"] = "C"
redirected = subprocess_kwargs.pop("_repository_redirected", False)
automatic = self._repository_environment if redirected else {}
environment.update(
{key: value for key, value in self._environment.items() if key not in automatic or value != automatic[key]}
)
if inline_env is not None:
environment.update(inline_env)
# Internal or per-call None overrides remove inherited variables.
env = {key: value for key, value in environment.items() if value is not None}
if sys.platform == "win32":
if kill_after_timeout is not None:
raise GitCommandError(
redacted_command,
'"kill_after_timeout" feature is not supported on Windows.',
)
cmd_not_found_exception = OSError
else:
cmd_not_found_exception = FileNotFoundError
# END handle
stdout_sink = PIPE if with_stdout else getattr(subprocess, "DEVNULL", None) or open(os.devnull, "wb")
if shell is None:
shell = False
_logger.debug(
"Popen(%s, cwd=%s, stdin=%s, shell=%s, universal_newlines=%s)",
redacted_command,
cwd,
"" if istream else "None",
shell,
universal_newlines,
)
if universal_newlines:
subprocess_kwargs.setdefault("errors", "surrogateescape")
try:
proc = safer_popen(
command,
env=env,
cwd=cwd,
bufsize=-1,
stdin=(istream or DEVNULL),
stderr=PIPE,
stdout=stdout_sink,
shell=shell,
universal_newlines=universal_newlines,
encoding=defenc if universal_newlines else None,
**subprocess_kwargs,
)
except cmd_not_found_exception as err:
raise GitCommandNotFound(redacted_command, err) from err
else:
_backend.record("Git.execute", "CLI process")
# Replace with a typeguard for Popen[bytes]?
proc.stdout = cast(BinaryIO, proc.stdout)
proc.stderr = cast(BinaryIO, proc.stderr)
if as_process:
return self.AutoInterrupt(proc, command)
watchdog: Optional[threading.Timer] = None
kill_check: Optional[threading.Event] = None
timeout_error: Optional[Callable[[], Union[str, bytes]]] = None
if sys.platform != "win32" and kill_after_timeout is not None:
# Help mypy figure out this is not None even when used inside communicate().
timeout = kill_after_timeout
def kill_process(pid: int) -> None:
if _kill_process(pid):
assert kill_check is not None
kill_check.set()
def make_timeout_error() -> Union[str, bytes]:
err = f'Timeout: the command "{" ".join(redacted_command)}" did not complete in {timeout:g} secs.'
return err if universal_newlines else safe_encode(err)
def communicate() -> Tuple[Union[str, bytes, None], Union[str, bytes, None]]:
assert watchdog is not None
assert kill_check is not None
watchdog.start()
out, err = proc.communicate()
watchdog.cancel()
if kill_check.is_set():
err = make_timeout_error()
return out, err
# END helpers
kill_check = threading.Event()
watchdog = threading.Timer(timeout, kill_process, args=(proc.pid,))
timeout_error = make_timeout_error
else:
communicate = proc.communicate
# Wait for the process to return.
status = 0
stdout_value: Union[str, bytes, None] = b""
stderr_value: Union[str, bytes, None] = b""
newline = "\n" if universal_newlines else b"\n"
try:
if output_stream is None:
stdout_value, stderr_value = communicate()
# Strip trailing "\n".
if stdout_value is not None and stdout_value.endswith(newline) and strip_newline_in_stdout: # type: ignore[arg-type]
stdout_value = stdout_value[:-1]
if stderr_value is not None and stderr_value.endswith(newline): # type: ignore[arg-type]
stderr_value = stderr_value[:-1]
status = proc.returncode
else:
max_chunk_size = max_chunk_size if max_chunk_size and max_chunk_size > 0 else io.DEFAULT_BUFFER_SIZE
if watchdog is not None:
watchdog.start()
try:
if proc.stdout is not None:
stream_copy(proc.stdout, output_stream, max_chunk_size)
stdout_value = proc.stdout.read()
if proc.stderr is not None:
stderr_value = proc.stderr.read()
status = proc.wait()
finally:
if watchdog is not None:
watchdog.cancel()
# Strip trailing "\n".
if stderr_value is not None and stderr_value.endswith(newline): # type: ignore[arg-type]
stderr_value = stderr_value[:-1]
if kill_check is not None and kill_check.is_set():
assert timeout_error is not None
stderr_value = timeout_error()
# END stdout handling
finally:
if proc.stdout is not None:
proc.stdout.close()
if proc.stderr is not None:
proc.stderr.close()
if self.GIT_PYTHON_TRACE == "full":
cmdstr = " ".join(redacted_command)
def as_text(stdout_value: Union[bytes, str, None]) -> str:
return not output_stream and safe_decode(stdout_value) or ""
# END as_text
if stderr_value:
_logger.info(
"%s -> %d; stdout: '%s'; stderr: '%s'",
cmdstr,
status,
as_text(stdout_value),
safe_decode(stderr_value),
)
elif stdout_value:
_logger.info("%s -> %d; stdout: '%s'", cmdstr, status, as_text(stdout_value))
else:
_logger.info("%s -> %d", cmdstr, status)
# END handle debug printing
if with_exceptions and status != 0:
raise GitCommandError(redacted_command, status, stderr_value, stdout_value)
if isinstance(stdout_value, bytes) and stdout_as_string: # Could also be output_stream.
stdout_value = safe_decode(stdout_value)
# stderr is always captured through PIPE.
assert stderr_value is not None
# Allow access to the command's status code.
if with_extended_output:
return (status, stdout_value, safe_decode(stderr_value))
else:
return stdout_value
def environment(self) -> Dict[str, Optional[str]]:
return self._environment
def update_environment(self, **kwargs: Any) -> Dict[str, Union[str, None]]:
"""Set environment variables for future git invocations. Return all changed
values in a format that can be passed back into this function to revert the
changes.
Examples::
old_env = self.update_environment(PWD='/tmp')
self.update_environment(**old_env)
:param kwargs:
Environment variables to use for git processes.
:return:
Dict that maps environment variables to their old values
"""
old_env = {}
for key, value in kwargs.items():
self._repository_environment.pop(key, None)
# Set value if it is None.
if value is not None:
old_env[key] = self._environment.get(key)
self._environment[key] = value
# Remove key from environment if its value is None.
elif key in self._environment:
old_env[key] = self._environment[key]
del self._environment[key]
return old_env
@contextlib.contextmanager
def custom_environment(self, **kwargs: Any) -> Iterator[None]:
"""A context manager around the above :meth:`update_environment` method to
restore the environment back to its previous state after operation.
Examples::
with self.custom_environment(GIT_SSH='/bin/ssh_wrapper'):
repo.remotes.origin.fetch()
:param kwargs:
See :meth:`update_environment`.
"""
automatic = {key: self._repository_environment[key] for key in kwargs if key in self._repository_environment}
old_env = self.update_environment(**kwargs)
try:
yield
finally:
self.update_environment(**old_env)
self._repository_environment.update(automatic)
def transform_kwarg(self, name: str, value: Any, split_single_char_options: bool) -> List[str]:
if len(name) == 1:
if value is True:
return ["-%s" % name]
elif value not in (False, None):
if split_single_char_options:
return ["-%s" % name, "%s" % value]
else:
return ["-%s%s" % (name, value)]
else:
if value is True:
return ["--%s" % dashify(name)]
elif value is not False and value is not None:
return ["--%s=%s" % (dashify(name), value)]
return []
def transform_kwargs(self, split_single_char_options: bool = True, **kwargs: Any) -> List[str]:
"""Transform Python-style kwargs into git command line options."""
args = []
for k, v in kwargs.items():
if isinstance(v, (list, tuple)):
for value in v:
args += self.transform_kwarg(k, value, split_single_char_options)
else:
args += self.transform_kwarg(k, v, split_single_char_options)
return args
@classmethod
def _unpack_args(cls, arg_list: Sequence[Any]) -> List[str]:
outlist = []
if isinstance(arg_list, (list, tuple)):
for arg in arg_list:
outlist.extend(cls._unpack_args(arg))
else:
outlist.append(os.fsdecode(arg_list) if isinstance(arg_list, os.PathLike) else str(arg_list))
return outlist
def __call__(self, **kwargs: Any) -> "Git":
"""Specify command line options to the git executable for a subcommand call.
:param kwargs:
A dict of keyword arguments.
These arguments are passed as in :meth:`_call_process`, but will be passed
to the git command rather than the subcommand.
Examples::
git(work_tree='/tmp').difftool()
"""
self._git_options = self.transform_kwargs(split_single_char_options=True, **kwargs)
return self
@overload
def _call_process(
self, method: str, *args: None, **kwargs: None
) -> str: ... # If no args were given, execute the call with all defaults.
@overload
def _call_process(
self,
method: str,
istream: int,
as_process: Literal[True],
*args: Any,
**kwargs: Any,
) -> "Git.AutoInterrupt": ...
@overload
def _call_process(
self, method: str, *args: Any, **kwargs: Any
) -> Union[str, bytes, Tuple[int, Union[str, bytes], str], "Git.AutoInterrupt"]: ...
def _call_process(
self, method: str, *args: Any, **kwargs: Any
) -> Union[str, bytes, Tuple[int, Union[str, bytes], str], "Git.AutoInterrupt"]:
"""Run the given git command with the specified arguments and return the result
as a string.
:param method:
The command. Contained ``_`` characters will be converted to hyphens, such
as in ``ls_files`` to call ``ls-files``.
:param args:
The list of arguments. If ``None`` is included, it will be pruned.
This allows your commands to call git more conveniently, as ``None`` is
realized as non-existent.
Positional arguments may intentionally contain command options. Higher-level
APIs must separate their operands with ``--`` where the Git command supports
it, or reject option-shaped operands where Git reparses them internally (for
example, ``pull`` and ``remote update``). Shell quoting cannot prevent Git
from interpreting a leading-dash argument as an option.
:param kwargs:
Contains key-values for the following:
- The :meth:`execute()` kwds, as listed in ``execute_kwargs``.
- "Command options" to be converted by :meth:`transform_kwargs`.
- The ``insert_kwargs_after`` key which its value must match one of
``*args``.
It also contains any command options, to be appended after the matched arg.
Examples::
git.rev_list('master', max_count=10, header=True)
turns into::
git rev-list --max-count=10 --header master
:return:
Same as :meth:`execute`. If no args are given, used :meth:`execute`'s
default (especially ``as_process = False``, ``stdout_as_string = True``) and
return :class:`str`.
"""
# Handle optional arguments prior to calling transform_kwargs.
# Otherwise these'll end up in args, which is bad.
safe_git_options = kwargs.pop("_safe_git_options", ())
exec_kwargs = {k: v for k, v in kwargs.items() if k in execute_kwargs}
opts_kwargs = {k: v for k, v in kwargs.items() if k not in execute_kwargs}
insert_after_this_arg = opts_kwargs.pop("insert_kwargs_after", None)
# Prepare the argument list.
opt_args = self.transform_kwargs(**opts_kwargs)
ext_args = self._unpack_args([a for a in args if a is not None])
if insert_after_this_arg is None:
args_list = opt_args + ext_args
else:
try:
index = ext_args.index(insert_after_this_arg)
except ValueError as err:
raise ValueError(
"Couldn't find argument '%s' in args %s to insert cmd options after"
% (insert_after_this_arg, str(ext_args))
) from err
# END handle error
args_list = ext_args[: index + 1] + opt_args + ext_args[index + 1 :]
# END handle opts_kwargs
call = [self.GIT_PYTHON_GIT_EXECUTABLE]
# Add persistent git options.
call.extend(self._persistent_git_options)
# Add the git options, then reset to empty to avoid side effects.
call.extend(self._git_options)
self._git_options = ()
# Only global options redirect discovery. A subcommand operand named
# -C must not drop the repository locations supplied by Repo.
if any(option == "-C" for option in call[1:]):
exec_kwargs["_repository_redirected"] = True
call.extend(safe_git_options)
call.append(dashify(method))
call.extend(args_list)
return self.execute(call, **exec_kwargs)
def _parse_object_header(self, header_line: Union[str, bytes]) -> Tuple[str, str, int]:
"""
:param header_line:
A line of the form::
type_string size_as_int
:return:
(hex_sha, type_string, size_as_int)
:raise ValueError:
If the header contains indication for an error due to incorrect input sha.
"""
if isinstance(header_line, bytes):
header_line = header_line.decode("ascii", "replace")
tokens = header_line.split()
if len(tokens) != 3:
if not tokens:
err_msg = (
f"SHA is empty, possible dubious ownership in the repository "
f"""at {self._working_dir}.\n If this is unintended run:\n\n """
f""" "git config --global --add safe.directory {self._working_dir}" """
)
raise ValueError(err_msg)
else:
raise ValueError("SHA %s could not be resolved, git returned: %r" % (tokens[0], header_line.strip()))
# END handle actual return value
# END error handling
if (
not re.fullmatch(r"[0-9a-fA-F]+", tokens[0])
or len(tokens[0]) % 2
or tokens[1] not in ("blob", "tree", "commit", "tag")
or not tokens[2].isdigit()
):
raise ValueError("Failed to parse header: %r" % header_line)
return (tokens[0], tokens[1], int(tokens[2]))
def _prepare_ref(self, ref: object) -> bytes:
# `cat-file -Z` separates both requests and responses with NUL, so paths
# containing newlines cannot inject requests or desynchronize the process.
if isinstance(ref, bytes):
refstr: str = ref.decode(defenc, "surrogateescape")
elif not isinstance(ref, str):
refstr = str(ref) # Could be ref-object.
else:
refstr = ref
if "\0" in refstr or refstr.startswith("-"):
raise UnsafeOptionError("Object queries cannot contain NUL or start with '-'")
return refstr.encode(defenc, "surrogateescape") + b"\0"
def _get_persistent_cmd(self, attr_name: str, cmd_name: str, *args: Any, **kwargs: Any) -> "Git.AutoInterrupt":
cur_val = getattr(self, attr_name)
if cur_val is not None:
return cur_val
options: Dict[str, Any] = {"istream": PIPE, "as_process": True}
options.update(kwargs)
cmd = self._call_process_safe(cmd_name, *args, **options)
setattr(self, attr_name, cmd)
cmd = cast("Git.AutoInterrupt", cmd)
return cmd
def __get_object_header(self, cmd: "Git.AutoInterrupt", request: bytes) -> Tuple[str, str, int]:
if cmd.stdin and cmd.stdout:
cmd.stdin.write(request)
cmd.stdin.flush()
header = bytearray()
while True:
char = cmd.stdout.read(1)
if not char:
cmd.wait()
raise ValueError("Git closed the object stream before its response")
if char == b"\0":
break
header.extend(char)
return self._parse_object_header(bytes(header))
else:
raise ValueError("cmd stdin was empty")
def get_object_header(self, ref: Union[str, bytes]) -> Tuple[str, str, int]:
"""Use this method to quickly examine the type and size of the object behind the
given ref.
:note:
The method will only suffer from the costs of command invocation once and
reuses the command in subsequent calls.
:return:
(hexsha, type_string, size_as_int)
"""
request = self._prepare_ref(ref)
native = _backend.object_data(self, request[:-1])
if native is not NotImplemented:
return native
cmd = self._get_persistent_cmd("cat_file_header", "cat_file", batch_check=True, Z=True)
return self.__get_object_header(cmd, request)
def get_object_data(self, ref: Union[str, bytes]) -> Tuple[str, str, int, bytes]:
"""Similar to :meth:`get_object_header`, but returns object data as well.
:return:
(hexsha, type_string, size_as_int, data_string)
:note:
Not threadsafe.
"""
hexsha, typename, size, stream = self.stream_object_data(ref)
data = stream.read(size)
del stream
return (hexsha, typename, size, data)
def stream_object_data(self, ref: Union[str, bytes]) -> Tuple[str, str, int, "Git.CatFileContentStream"]:
"""Similar to :meth:`get_object_data`, but returns the data as a stream.
:return:
(hexsha, type_string, size_as_int, stream)
:note:
This method is not threadsafe. You need one independent :class:`Git`
instance per thread to be safe!
"""
request = self._prepare_ref(ref)
native = _backend.object_data(self, request[:-1], stream=True)
if native is not NotImplemented:
return native
cmd = self._get_persistent_cmd("cat_file_all", "cat_file", batch=True, Z=True)
hexsha, typename, size = self.__get_object_header(cmd, request)
cmd_stdout = cmd.stdout if cmd.stdout is not None else io.BytesIO()
return (hexsha, typename, size, self.CatFileContentStream(size, cmd_stdout))
def clear_cache(self) -> "Git":
"""Clear all kinds of internal caches to release resources.
Currently persistent commands will be interrupted.
:return:
self
"""
for cmd in (self.cat_file_all, self.cat_file_header):
if cmd:
cmd.__del__()
self.cat_file_all = None
self.cat_file_header = None
return self
Links:
URLs of crawlers that visited me.