GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — GitPython/git/util.py at main · gitpython-developers/GitPython Expand file tree/ Copy pathutil.pyMore file actions 1421 lines (1148 loc) · 48.3 KB / Copy pathutil.pyFile metadata and controls1421 lines (1148 loc) · 48.3 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 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 # Copyright (C) 2008, 2009 Michael Trier ([email protected]) and contributors # # This module is part of GitPython and is released under the # 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/ import sys __all__ = [ "stream_copy", "join_path", "to_native_path_linux", "join_path_native", "Stats", "IterableObj", "IterableList", "BlockingLockFile", "LockFile", "Actor", "get_user_id", "assure_directory_exists", "RemoteProgress", "CallableRemoteProgress", "rmtree", "unbare_repo", ] if sys.platform == "win32": __all__.append("to_native_path_windows") import contextlib import getpass import logging import ntpath import os import os.path as osp import platform import re import shutil import stat import subprocess import time from abc import abstractmethod from functools import wraps from pathlib import Path # typing --------------------------------------------------------- from typing import ( TYPE_CHECKING, Any, AnyStr, Callable, Dict, Generator, Iterator, List, Optional, Pattern, Sequence, Tuple, Type, TypeVar, Union, cast, overload, ) from urllib.parse import urlsplit, urlunsplit # NOTE: Unused imports can be improved now that CI testing has fully resumed. Some of # these be used indirectly through other GitPython modules, which avoids having to write # gitdb all the time in their imports. They are not in __all__, at least currently, # because they could be removed or changed at any time, and so should not be considered # conceptually public to code outside GitPython. Linters of course do not like it. from gitdb.util import ( LazyMixin, # noqa: F401 LockedFD, # noqa: F401 bin_to_hex, # noqa: F401 file_contents_ro, # noqa: F401 file_contents_ro_filepath, # noqa: F401 hex_to_bin, # noqa: F401 ) if TYPE_CHECKING: from git.cmd import Git from git.config import GitConfigParser, SectionConstraint from git.remote import Remote from git.repo.base import Repo from git.compat import safe_decode from git.types import ( HSH_TD, Files_TD, Has_id_attribute, Literal, PathLike, Protocol, SupportsIndex, SupportsRead, SupportsWrite, Total_TD, runtime_checkable, ) # --------------------------------------------------------------------- T_IterableObj = TypeVar("T_IterableObj", bound=Union["IterableObj", "Has_id_attribute"], covariant=True) # So IterableList[Head] is subtype of IterableList[IterableObj]. T_Actor = TypeVar("T_Actor", bound="Actor") _logger = logging.getLogger(__name__) def to_hex_sha(sha: Union[str, bytes]) -> Union[str, bytes]: """Normalize legacy SHA-1 or SHA-256 IDs; use ``bin_to_hex`` for raw IDs.""" if len(sha) in (40, 64): hex_to_bin(sha) # Validate already hexadecimal input. return sha if isinstance(sha, bytes) and len(sha) in (20, 32): return bin_to_hex(sha) raise ValueError("Expected a binary or hexadecimal SHA-1/SHA-256 object ID") def to_bin_sha(sha: Union[str, bytes]) -> bytes: """Normalize legacy SHA-1 or SHA-256 IDs; use ``hex_to_bin`` for hex IDs.""" if isinstance(sha, bytes) and len(sha) in (20, 32): return sha if len(sha) in (40, 64): return hex_to_bin(sha) raise ValueError("Expected a binary or hexadecimal SHA-1/SHA-256 object ID") # { Utility Methods T = TypeVar("T") def unbare_repo(func: Callable[..., T]) -> Callable[..., T]: """Methods with this decorator raise :exc:`~git.exc.InvalidGitRepositoryError` if they encounter a bare repository.""" from .exc import InvalidGitRepositoryError @wraps(func) def wrapper(self: "Remote", *args: Any, **kwargs: Any) -> T: if self.repo.bare: raise InvalidGitRepositoryError("Method '%s' cannot operate on bare repositories" % func.__name__) # END bare method return func(self, *args, **kwargs) # END wrapper return wrapper @contextlib.contextmanager def cwd(new_dir: PathLike) -> Generator[PathLike, None, None]: """Context manager to temporarily change directory. This is similar to :func:`contextlib.chdir` introduced in Python 3.11, but the context manager object returned by a single call to this function is not reentrant. """ old_dir = os.getcwd() os.chdir(new_dir) try: yield new_dir finally: os.chdir(old_dir) @contextlib.contextmanager def patch_env(name: str, value: str) -> Generator[None, None, None]: """Context manager to temporarily patch an environment variable.""" old_value = os.getenv(name) os.environ[name] = value try: yield finally: if old_value is None: os.environ.pop(name, None) else: os.environ[name] = old_value def rmtree(path: PathLike) -> None: """Remove the given directory tree recursively. :note: We use :func:`shutil.rmtree` but adjust its behaviour to see whether files that couldn't be deleted are read-only. Windows will not remove them in that case. """ def handler(function: Callable[[str], Any], path: str, _excinfo: Any) -> None: """Callback for :func:`shutil.rmtree`. This works as either a ``onexc`` or ``onerror`` style callback. """ # Is the error an access error? os.chmod(path, stat.S_IWUSR) function(path) if sys.platform != "win32": shutil.rmtree(path) elif sys.version_info >= (3, 12): shutil.rmtree(path, onexc=handler) else: shutil.rmtree(path, onerror=handler) def rmfile(path: PathLike) -> None: """Ensure file deleted also on *Windows* where read-only files need special treatment.""" if osp.isfile(path): if sys.platform == "win32": os.chmod(path, stat.S_IWUSR) os.remove(path) def stream_copy(source: SupportsRead[AnyStr], destination: SupportsWrite[AnyStr], chunk_size: int = 512 * 1024) -> int: """Copy all data from the `source` stream into the `destination` stream in chunks of size `chunk_size`. Keep reading after short reads until the source returns an empty chunk. :return: Number of bytes written """ br = 0 while True: chunk = source.read(chunk_size) destination.write(chunk) br += len(chunk) if not chunk: break # END reading output stream return br def join_path(a: PathLike, *p: PathLike) -> PathLike: R"""Join path tokens together similar to osp.join, but always use ``/`` instead of possibly ``\`` on Windows. Later tokens are treated as relative, even when they start with ``/``. """ path = os.fspath(a) for b in p: b = os.fspath(b).lstrip("/") if not b: continue if path == "" or path.endswith("/"): path += b else: path += "/" + b # END for each path token to add return path if sys.platform == "win32": def to_native_path_windows(path: PathLike) -> str: path = os.fspath(path) return path.replace("/", "\\") def to_native_path_linux(path: PathLike) -> str: path = os.fspath(path) return path.replace("\\", "/") to_native_path = to_native_path_windows else: # No need for any work on Linux. def to_native_path_linux(path: PathLike) -> str: return os.fspath(path) to_native_path = to_native_path_linux def join_path_native(a: PathLike, *p: PathLike) -> PathLike: R"""Like :func:`join_path`, but makes sure an OS native path is returned. This is only needed to play it safe on Windows and to ensure nice paths that only use ``\``. """ return to_native_path(join_path(a, *p)) def _is_path_rooted(path: PathLike) -> bool: r"""Whether ``path`` has a root, including one encoded in a UNC drive. On Windows, ``\directory`` is rooted on the current drive without being absolute, while ``C:\directory`` has both a drive and a root. In contrast, ``directory`` and the drive-relative ``C:directory`` have no root. UNC paths are rooted: ``\\server\share`` stores the share in the drive returned by :func:`os.path.splitdrive`, while ``\\server\share\directory`` additionally has a rooted tail. On POSIX, which has no drive concept, this simply distinguishes absolute paths such as ``/directory`` from relative paths such as ``directory``. """ drive, tail = osp.splitdrive(os.fspath(path)) separators = (os.sep,) if os.altsep is None else (os.sep, os.altsep) return tail.startswith(separators) or drive.startswith(separators) def _to_relative_path(root: PathLike, path: PathLike) -> str: r"""Return a normalized Git-style path confined to ``root``. A Windows path such as ``\directory`` is rooted but not absolute. Resolve it against the drive of ``root`` rather than treating it as relative to ``root``. Drive-relative paths such as ``C:directory`` are rejected because their meaning depends on process-global per-drive state. For example, with ``root`` set to ``C:\repo`` on Windows: * ``directory\file`` -> ``directory/file`` * ``directory\`` -> ``directory/`` * ``C:\repo\directory\file`` -> ``directory/file`` * ``\repo\directory\file`` -> ``directory/file`` * ``C:directory\file`` -> :exc:`ValueError` * ``C:\other\file`` -> :exc:`ValueError` On POSIX, ``/repo/directory/file`` under ``/repo`` similarly becomes ``directory/file``. A trailing separator is preserved as a Git-style ``/``. """ path_str = os.fspath(path) if not path_str: return path_str drive, _tail = osp.splitdrive(path_str) rooted = _is_path_rooted(path_str) if drive and not rooted: raise ValueError("Drive-relative path %r is not supported" % path_str) root_abs = osp.abspath(os.fspath(root)) path_abs = osp.abspath(osp.join(root_abs, path_str)) try: common_path = osp.commonpath([root_abs, path_abs]) except ValueError as e: raise ValueError("Path %r is not in repository at %r" % (path_str, root_abs)) from e if common_path != root_abs: raise ValueError("Path %r is not in repository at %r" % (path_str, root_abs)) relative_path = to_native_path_linux(osp.relpath(path_abs, root_abs)) separators = (os.sep,) if os.altsep is None else (os.sep, os.altsep) if path_str.endswith(separators) and relative_path != "." and not relative_path.endswith("/"): relative_path += "/" return relative_path _HFS_IGNORABLES = str.maketrans( "", "", "\u200c\u200d\u200e\u200f\u202a\u202b\u202c\u202d\u202e\u206a\u206b\u206c\u206d\u206e\u206f\ufeff" ) # Match Git's is_ntfs_dotgitmodules in path.c on a lowercased, trimmed name. # Besides gitmod~1..4, fallback aliases have exactly eight ASCII characters: # a shrinking prefix of "gi7eba", "~", and digits with no leading zero. # Explicit digit counts avoid accepting shorter/longer names or Unicode digits. _NTFS_DOTGITMODULES_SHORT_NAME = re.compile( r"(?:gitmod~[1-4]|gi7eba~[1-9]|gi7eb~[1-9][0-9]|gi7e~[1-9][0-9]{2}|" r"gi7~[1-9][0-9]{3}|gi~[1-9][0-9]{4}|g~[1-9][0-9]{5}|~[1-9][0-9]{6})" ) def _validate_repo_path(path: PathLike, mode: Union[int, None] = None) -> None: """Reject unsafe tree/index paths without normalizing away their components. Protect Git metadata aliases on NTFS and HFS even when writing on another platform. Other POSIX filename characters, including newlines, remain valid. :param mode: Mode of the index or tree entry the path belongs to, where one is known. Git refuses a symbolic link that aliases ``.gitmodules``, since the submodule configuration would then be read through the link, so that name is only rejected once the mode says the entry is a link. """ name = os.fspath(path) if not name or "\0" in name or ntpath.splitdrive(name)[0] or name.startswith("/"): raise ValueError("Invalid repository path %r" % name) if os.name == "nt" and "\\" in name: raise ValueError("Index paths must use '/' separators: %r" % name) for component in name.split("/"): if component in ("", ".", ".."): raise ValueError("Invalid repository path %r" % name) # NTFS recognizes backslashes and alternate data streams in metadata names. for part in component.split("\\"): ntfs_name = part.split(":", 1)[0].rstrip(" .").lower() hfs_name = part.translate(_HFS_IGNORABLES).lower() if ntfs_name in (".git", "git~1") or hfs_name == ".git": raise ValueError("Repository path aliases Git metadata: %r" % name) if mode is not None and stat.S_ISLNK(mode): if ( ntfs_name == ".gitmodules" or hfs_name == ".gitmodules" or _NTFS_DOTGITMODULES_SHORT_NAME.fullmatch(ntfs_name) is not None ): raise ValueError("Symbolic link aliases the submodule configuration: %r" % name) def assure_directory_exists(path: PathLike, is_file: bool = False) -> bool: """Make sure that the directory pointed to by path exists. :param is_file: If ``True``, `path` is assumed to be a file and handled correctly. Otherwise it must be a directory. :return: ``True`` if the directory was created, ``False`` if it already existed. """ if is_file: path = osp.dirname(path) or osp.curdir # END handle file if not osp.isdir(path): os.makedirs(path, exist_ok=True) return True return False def _get_exe_extensions() -> Sequence[str]: PATHEXT = os.environ.get("PATHEXT", None) if PATHEXT: return tuple(p.upper() for p in PATHEXT.split(os.pathsep)) elif sys.platform == "win32": return (".BAT", ".COM", ".EXE") else: return () def py_where(program: str, path: Optional[PathLike] = None) -> List[str]: """Perform a path search to assist :func:`is_cygwin_git`. This is not robust for general use. It is an implementation detail of :func:`is_cygwin_git`. When a search following all shell rules is needed, :func:`shutil.which` can be used instead. :note: Neither this function nor :func:`shutil.which` will predict the effect of an executable search on a native Windows system due to a :class:`subprocess.Popen` call without ``shell=True``, because shell and non-shell executable search on Windows differ considerably. """ # From: http://stackoverflow.com/a/377028/548792 winprog_exts = _get_exe_extensions() def is_exec(fpath: str) -> bool: return ( osp.isfile(fpath) and os.access(fpath, os.X_OK) and ( sys.platform != "win32" or not winprog_exts or any(fpath.upper().endswith(ext) for ext in winprog_exts) ) ) progs = [] if not path: path = os.environ["PATH"] for folder in os.fspath(path).split(os.pathsep): folder = folder.strip('"') if folder: exe_path = osp.join(folder, program) for f in [exe_path] + ["%s%s" % (exe_path, e) for e in winprog_exts]: if is_exec(f): progs.append(f) return progs def _cygexpath(drive: Optional[str], path: str) -> str: if osp.isabs(path) and not drive: # Invoked from `cygpath()` directly with `D:Apps\123`? # It's an error, leave it alone just slashes) p = path # convert to str if AnyPath given else: p = path and osp.normpath(osp.expanduser(path)) if osp.isabs(p): if drive: # Confusing, maybe a remote system should expand vars. p = path else: p = cygpath(p) elif drive: p = "/proc/cygdrive/%s/%s" % (drive.lower(), p) p_str = os.fspath(p) # ensure it is a str and not AnyPath return p_str.replace("\\", "/") _cygpath_parsers: Tuple[Tuple[Pattern[str], Callable[..., str], bool], ...] = ( # See: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx # and: https://www.cygwin.com/cygwin-ug-net/using.html#unc-paths ( re.compile(r"\\\\\?\\UNC\\([^\\]+)\\([^\\]+)(?:\\(.*))?"), (lambda server, share, rest_path: "//%s/%s/%s" % (server, share, rest_path.replace("\\", "/"))), False, ), (re.compile(r"\\\\\?\\(\w):[/\\](.*)"), (_cygexpath), False), (re.compile(r"(\w):[/\\](.*)"), (_cygexpath), False), (re.compile(r"file:(.*)", re.I), (lambda rest_path: rest_path), True), (re.compile(r"(\w{2,}:.*)"), (lambda url: url), False), # remote URL, do nothing ) def cygpath(path: str) -> str: """Use :meth:`git.cmd.Git.polish_url` instead, that works on any environment.""" path = os.fspath(path) # Ensure is str and not AnyPath. # Fix to use Paths when 3.5 dropped. Or to be just str if only for URLs? if not path.startswith(("/cygdrive", "//", "/proc/cygdrive")): for regex, parser, recurse in _cygpath_parsers: match = regex.match(path) if match: if parser is _cygexpath: path = parser(*match.groups()) else: path = parser(*match.groups()) if recurse: path = cygpath(path) break else: path = _cygexpath(None, path) return path _decygpath_regex = re.compile(r"(?:/proc)?/cygdrive/(\w)(/.*)?") def decygpath(path: PathLike) -> str: path = os.fspath(path) m = _decygpath_regex.match(path) if m: drive, rest_path = m.groups() path = "%s:%s" % (drive.upper(), rest_path or "") return path.replace("/", "\\") #: Store boolean flags denoting if a specific Git executable #: is from a Cygwin installation. TODO: use @functools.lru_cache(user_function) _is_cygwin_cache: Dict[str, Optional[bool]] = {} def _is_cygwin_git(git_executable: str) -> bool: is_cygwin = _is_cygwin_cache.get(git_executable) # type: Optional[bool] if is_cygwin is None: is_cygwin = False try: git_dir = osp.dirname(git_executable) if not git_dir: res = py_where(git_executable) git_dir = osp.dirname(res[0]) if res else "" # Just a name given, not a real path. uname_cmd = osp.join(git_dir, "uname") if not (Path(uname_cmd).is_file() and os.access(uname_cmd, os.X_OK)): _logger.debug(f"Failed checking if running in CYGWIN: {uname_cmd} is not an executable") _is_cygwin_cache[git_executable] = is_cygwin return is_cygwin process = subprocess.Popen([uname_cmd], stdout=subprocess.PIPE, universal_newlines=True) uname_out, _ = process.communicate() # retcode = process.poll() is_cygwin = "CYGWIN" in uname_out except Exception as ex: _logger.debug("Failed checking if running in CYGWIN due to: %r", ex) _is_cygwin_cache[git_executable] = is_cygwin return is_cygwin @overload def is_cygwin_git(git_executable: None) -> Literal[False]: ... @overload def is_cygwin_git(git_executable: PathLike) -> bool: ... def is_cygwin_git(git_executable: Union[None, PathLike]) -> bool: _logger.debug(f"{sys.platform=}, {git_executable=}") if sys.platform != "cygwin": return False elif git_executable is None: return False else: return _is_cygwin_git(str(git_executable)) def get_user_id() -> str: """:return: String identifying the currently active system user as ``name@node``""" return "%s@%s" % (getpass.getuser(), platform.node()) def finalize_process(proc: Union["subprocess.Popen[Any]", "Git.AutoInterrupt"], **kwargs: Any) -> None: """Wait for the process (clone, fetch, pull or push) and handle its errors accordingly.""" # TODO: No close proc-streams?? proc.wait(**kwargs) @overload def expand_path(p: None) -> None: ... @overload def expand_path(p: PathLike) -> Optional[PathLike]: # TODO: Support for Python 3.5 has been dropped, so these overloads can be improved. ... def expand_path(p: Union[None, PathLike]) -> Optional[PathLike]: if p is None: return None try: expanded_path = osp.expanduser(os.fspath(p)) return osp.normpath(osp.abspath(expanded_path)) except Exception: return None def _redact_url_credentials(text: str) -> Optional[str]: """Return `text` with the userinfo of a URL redacted, or ``None`` if it has none.""" try: url = urlsplit(text) except ValueError: # This is not a valid URL. return None if url.password is None and url.username is None: return None # Match urllib.parse's userinfo boundary. Keeping the raw hostinfo # preserves hostname case, IPv6 brackets, and port formatting. _, _, hostinfo = url.netloc.rpartition("@") redacted = "*****:*****" if url.password is not None else "*****" return urlunsplit(url._replace(netloc=f"{redacted}@{hostinfo}")) def remove_password_if_present(cmdline: Sequence[str]) -> List[str]: """Redact credentials in URLs and HTTP Authorization extra headers in a command line. URLs are also redacted in the key and value of a configuration assignment, such as ``http.proxy=<url>``. Assignments are recognized in the ``-c <key>=<value>``, ``-c<key>=<value>``, and ``--config=<key>=<value>`` forms. If nothing is found, this just returns the command line as-is. This should be used for every log line that print a command line, as well as exception messages. """ new_cmdline = [] for to_parse in cmdline: if to_parse.startswith("--config="): option = "--config=" elif to_parse.startswith("-c"): option = "-c" else: option = "" assignment = to_parse[len(option) :] # Redact the whole URL first, before splitting on a possible '=' in userinfo. assignment = _redact_url_credentials(assignment) or assignment config_key, separator, value = assignment.partition("=") header_name, colon, _ = value.partition(":") if ( separator and colon and config_key.lower().endswith(".extraheader") and header_name.strip().lower() == "authorization" ): new_cmdline.append("%s%s%s%s%s *****" % (option, config_key, separator, header_name, colon)) continue if separator: value = _redact_url_credentials(value) or value new_cmdline.append(option + config_key + separator + value) return new_cmdline # } END utilities # { Classes class RemoteProgress: """Handler providing an interface to parse progress information emitted by :manpage:`git-push(1)` and :manpage:`git-fetch(1)` and to dispatch callbacks allowing subclasses to react to the progress.""" _num_op_codes: int = 9 ( BEGIN, END, COUNTING, COMPRESSING, WRITING, RECEIVING, RESOLVING, FINDING_SOURCES, CHECKING_OUT, ) = [1 << x for x in range(_num_op_codes)] STAGE_MASK = BEGIN | END OP_MASK = ~STAGE_MASK DONE_TOKEN = "done." TOKEN_SEPARATOR = ", " __slots__ = ( "_cur_line", "_seen_ops", "error_lines", # Lines that started with 'error:' or 'fatal:'. "other_lines", # Lines not denoting progress (i.e.g. push-infos). ) re_op_absolute = re.compile(r"(remote: )?([\w\s]+):\s+()(\d+)()(.*)") re_op_relative = re.compile(r"(remote: )?([\w\s]+):\s+(\d+)% \((\d+)/(\d+)\)(.*)") def __init__(self) -> None: self._seen_ops: List[int] = [] self._cur_line: Optional[str] = None self.error_lines: List[str] = [] self.other_lines: List[str] = [] def _parse_progress_line(self, line: AnyStr) -> Optional[object]: """Parse progress information from the given line as retrieved by :manpage:`git-push(1)` or :manpage:`git-fetch(1)`. :meta public: - Lines that do not contain progress info are stored in :attr:`other_lines`. - Lines that seem to contain an error (i.e. start with ``error:`` or ``fatal:``) are stored in :attr:`error_lines`. The base implementation returns ``None``. Subclasses may return another value for compatibility with existing overrides, but callers should treat the return value as unspecified. """ # handle # Counting objects: 4, done. # Compressing objects: 50% (1/2) # Compressing objects: 100% (2/2) # Compressing objects: 100% (2/2), done. if isinstance(line, bytes): # mypy argues about ternary assignment. line_str = safe_decode(line) else: line_str = line self._cur_line = line_str if self._cur_line.startswith(("error:", "fatal:")): self.error_lines.append(self._cur_line) return None cur_count, max_count = None, None match = self.re_op_relative.match(line_str) if match is None: match = self.re_op_absolute.match(line_str) if not match: self.line_dropped(line_str) self.other_lines.append(line_str) return None # END could not get match op_code = 0 _remote, op_name, _percent, cur_count, max_count, message = match.groups() # Get operation ID. if op_name == "Counting objects": op_code |= self.COUNTING elif op_name == "Compressing objects": op_code |= self.COMPRESSING elif op_name == "Writing objects": op_code |= self.WRITING elif op_name == "Receiving objects": op_code |= self.RECEIVING elif op_name == "Resolving deltas": op_code |= self.RESOLVING elif op_name == "Finding sources": op_code |= self.FINDING_SOURCES elif op_name == "Checking out files": op_code |= self.CHECKING_OUT else: # Note: On Windows it can happen that partial lines are sent. # Hence we get something like "CompreReceiving objects", which is # a blend of "Compressing objects" and "Receiving objects". # This can't really be prevented, so we drop the line verbosely # to make sure we get informed in case the process spits out new # commands at some point. self.line_dropped(line_str) # Note: Don't add this line to the other lines, as we have to silently # drop it. return None # END handle op code # Figure out stage. if op_code not in self._seen_ops: self._seen_ops.append(op_code) op_code |= self.BEGIN # END begin opcode if message is None: message = "" # END message handling message = message.strip() if message.endswith(self.DONE_TOKEN): op_code |= self.END message = message[: -len(self.DONE_TOKEN)] # END end message handling message = message.strip(self.TOKEN_SEPARATOR) self.update( op_code, cur_count and float(cur_count), max_count and float(max_count), message, ) return None def new_message_handler(self) -> Callable[[str], None]: """ :return: A progress handler suitable for :func:`~git.cmd.handle_process_output`, passing lines on to this progress handler in a suitable format. """ def handler(line: AnyStr) -> None: self._parse_progress_line(line.rstrip(b"\r\n") if isinstance(line, bytes) else line.rstrip("\r\n")) # END handler return handler def line_dropped(self, line: str) -> None: """Called whenever a line could not be understood and was therefore dropped.""" pass def update( self, op_code: int, cur_count: Union[str, float], max_count: Union[str, float, None] = None, message: str = "", ) -> None: """Called whenever the progress changes. :param op_code: Integer allowing to be compared against Operation IDs and stage IDs. Stage IDs are :const:`BEGIN` and :const:`END`. :const:`BEGIN` will only be set once for each Operation ID as well as :const:`END`. It may be that :const:`BEGIN` and :const:`END` are set at once in case only one progress message was emitted due to the speed of the operation. Between :const:`BEGIN` and :const:`END`, none of these flags will be set. Operation IDs are all held within the :const:`OP_MASK`. Only one Operation ID will be active per call. :param cur_count: Current absolute count of items. :param max_count: The maximum count of items we expect. It may be ``None`` in case there is no maximum number of items or if it is (yet) unknown. :param message: In case of the :const:`WRITING` operation, it contains the amount of bytes transferred. It may possibly be used for other purposes as well. :note: You may read the contents of the current line in :attr:`self._cur_line <_cur_line>`. """ pass class CallableRemoteProgress(RemoteProgress): """A :class:`RemoteProgress` implementation forwarding updates to any callable. :note: Like direct instances of :class:`RemoteProgress`, instances of this :class:`CallableRemoteProgress` class are not themselves directly callable. Rather, instances of this class wrap a callable and forward to it. This should therefore not be confused with :class:`git.types.CallableProgress`. """ __slots__ = ("_callable",) def __init__(self, fn: Callable[..., Any]) -> None: self._callable = fn super().__init__() def update(self, *args: Any, **kwargs: Any) -> None: self._callable(*args, **kwargs) class Actor: """Actors hold information about a person acting on the repository. They can be committers and authors or anything with a name and an email as mentioned in the git log entries.""" # ENVIRONMENT VARIABLES # These are read when creating new commits. env_author_name = "GIT_AUTHOR_NAME" env_author_email = "GIT_AUTHOR_EMAIL" env_committer_name = "GIT_COMMITTER_NAME" env_committer_email = "GIT_COMMITTER_EMAIL" # CONFIGURATION KEYS conf_name = "name" conf_email = "email" __slots__ = ("name", "email") def __init__(self, name: Optional[str], email: Optional[str]) -> None: self.name = name self.email = email def __eq__(self, other: Any) -> bool: return self.name == other.name and self.email == other.email def __ne__(self, other: Any) -> bool: return not (self == other) def __hash__(self) -> int: return hash((self.name, self.email)) def __str__(self) -> str: return self.name if self.name else "" def __repr__(self) -> str: return '<git.Actor "%s <%s>">' % (self.name, self.email) @classmethod def from_string(cls: Type[T_Actor], string: str) -> T_Actor: """Create an :class:`Actor` from a string. :param string: The string, which is expected to be in regular git format:: John Doe <[email protected]> :return: :class:`Actor` """ line = string.partition("\n")[0] left_bracket = line.find("<") right_bracket = line.find(">", left_bracket + 1) if left_bracket >= 0 and right_bracket >= 0: return cls(line[:left_bracket].rstrip(), line[left_bracket + 1 : right_bracket]) # Assume the best and use the whole string as name. return cls(string, None) _from_string = from_string @classmethod def _main_actor( cls, env_name: str, env_email: str, config_reader: Union[None, "GitConfigParser", "SectionConstraint[GitConfigParser]"] = None, ) -> "Actor": actor = Actor("", "") user_id = None # We use this to avoid multiple calls to getpass.getuser(). def default_email() -> str: nonlocal user_id if not user_id: user_id = get_user_id() return user_id def default_name() -> str: return default_email().split("@")[0] for attr, evar, cvar, default in ( ("name", env_name, cls.conf_name, default_name), ("email", env_email, cls.conf_email, default_email), ): try: val = os.environ[evar] setattr(actor, attr, val) except KeyError: if config_reader is not None: try: val = config_reader.get("user", cvar) except Exception: val = default() setattr(actor, attr, val) # END config-reader handling if not getattr(actor, attr): setattr(actor, attr, default()) # END handle name # END for each item to retrieve return actor @classmethod def committer( cls, config_reader: Union[None, "GitConfigParser", "SectionConstraint[GitConfigParser]"] = None ) -> "Actor": """ :return: :class:`Actor` instance corresponding to the configured committer. It behaves similar to the git implementation, such that the environment will override configuration values of `config_reader`. If no value is set at all, it will be generated. :param config_reader: ConfigReader to use to retrieve the values from in case they are not set in |
| You are visitor 01402503 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |