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/refs/head.py at main · gitpython-developers/GitPython Expand file tree/ Copy pathhead.pyMore file actions 348 lines (278 loc) · 12.5 KB / Copy pathhead.pyFile metadata and controls348 lines (278 loc) · 12.5 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 # This module is part of GitPython and is released under the # 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/ """Some ref-based objects. Note the distinction between the :class:`HEAD` and :class:`Head` classes. """ __all__ = ["HEAD", "Head"] from git.config import GitConfigParser, SectionConstraint from git.exc import GitCommandError from git.util import join_path from .reference import Reference from .symbolic import SymbolicReference # typing --------------------------------------------------- from typing import Any, Sequence, TYPE_CHECKING, Union from git.cmd import Git from git.types import Commit_ish, PathLike if TYPE_CHECKING: from git.refs import RemoteReference from git.repo import Repo # ------------------------------------------------------------------- def strip_quotes(string: str) -> str: if string.startswith('"') and string.endswith('"'): return string[1:-1] return string class HEAD(SymbolicReference): """Special case of a :class:`~git.refs.symbolic.SymbolicReference` representing the repository's HEAD reference.""" _HEAD_NAME = "HEAD" _ORIG_HEAD_NAME = "ORIG_HEAD" __slots__ = () def __init__(self, repo: "Repo", path: PathLike = _HEAD_NAME) -> None: if path != self._HEAD_NAME: raise ValueError("HEAD instance must point to %r, got %r" % (self._HEAD_NAME, path)) super().__init__(repo, path) def orig_head(self) -> SymbolicReference: """ :return: :class:`~git.refs.symbolic.SymbolicReference` pointing at the ORIG_HEAD, which is maintained to contain the previous value of HEAD. """ return SymbolicReference(self.repo, self._ORIG_HEAD_NAME) def reset( self, commit: Union[Commit_ish, SymbolicReference, str] = "HEAD", index: bool = True, working_tree: bool = False, paths: Union[PathLike, Sequence[PathLike], None] = None, allow_unsafe_options: bool = False, **kwargs: Any, ) -> "HEAD": """Reset our HEAD to the given commit optionally synchronizing the index and working tree. The reference we refer to will be set to commit as well. :param commit: :class:`~git.objects.commit.Commit`, :class:`~git.refs.reference.Reference`, or string identifying a revision we should reset HEAD to. :param index: If ``True``, the index will be set to match the given commit. Otherwise it will not be touched. :param working_tree: If ``True``, the working tree will be forcefully adjusted to match the given commit, possibly overwriting uncommitted changes without warning. If `working_tree` is ``True``, `index` must be ``True`` as well. :param paths: Single path or list of paths relative to the git root directory that are to be reset. This allows to partially reset individual files. :param allow_unsafe_options: Allow unsafe options such as ``--pathspec-from-file`` to be passed to :manpage:`git-reset(1)`. :param kwargs: Additional arguments passed to :manpage:`git-reset(1)`. :return: self """ if not allow_unsafe_options: Git.check_unsafe_options( options=Git._option_candidates([commit], kwargs), unsafe_options=Git.unsafe_git_pathspec_from_file_options + ["--patch", "-p"], ) mode: Union[str, None] mode = "--soft" if index: mode = "--mixed" # Explicit "--mixed" when passing paths is deprecated since git 1.5.4. # See https://github.com/gitpython-developers/GitPython/discussions/1876. if paths: mode = None # END special case # END handle index if working_tree: mode = "--hard" if not index: raise ValueError("Cannot reset the working tree if the index is not reset as well") # END working tree handling try: oid = self.repo.rev_parse(Git._check_revision(commit)).hexsha self.repo.git._call_process_safe("reset", mode, oid, "--", paths, **kwargs) except GitCommandError as e: # git nowadays may use 1 as status to indicate there are still unstaged # modifications after the reset. if e.status != 1: raise # END handle exception return self class Head(Reference): """A Head is a named reference to a :class:`~git.objects.commit.Commit`. Every Head instance contains a name and a :class:`~git.objects.commit.Commit` object. Examples:: >>> repo = Repo("/path/to/repo") >>> head = repo.heads[0] >>> head.name 'master' >>> head.commit <git.Commit "1c09f116cbc2cb4100fb6935bb162daa4723f455"> >>> head.commit.hexsha '1c09f116cbc2cb4100fb6935bb162daa4723f455' """ _common_path_default = "refs/heads" _points_to_commits_only = True k_config_remote = "remote" k_config_remote_ref = "merge" # Branch to merge from remote. @classmethod def delete(cls, repo: "Repo", *heads: "Union[Head, str]", force: bool = False, **kwargs: Any) -> None: # type: ignore[override] """Delete the given heads. :param force: If ``True``, the heads will be deleted even if they are not yet merged into the main development stream. Default ``False``. """ flag = "-d" if force: flag = "-D" names = [Git._check_operand(head, "branch") for head in heads] for name in names: cls._get_validated_ref_path(repo, cls.to_full_path(name)) repo.git._call_process_safe("branch", flag, "--", *names) def set_tracking_branch(self, remote_reference: Union["RemoteReference", None]) -> "Head": """Configure this branch to track the given remote reference. This will alter this branch's configuration accordingly. :param remote_reference: The remote reference to track or None to untrack any references. :return: self """ from .remote import RemoteReference if remote_reference is not None and not isinstance(remote_reference, RemoteReference): raise ValueError("Incorrect parameter type: %r" % remote_reference) # END handle type with self.config_writer() as writer: if remote_reference is None: writer.remove_option(self.k_config_remote) writer.remove_option(self.k_config_remote_ref) else: writer.set_value(self.k_config_remote, remote_reference.remote_name) writer.set_value( self.k_config_remote_ref, Head.to_full_path(remote_reference.remote_head), ) return self def tracking_branch(self) -> Union["RemoteReference", "Head", None]: """ :return: The remote reference or local head we are tracking, or ``None`` if we are not a tracking branch. """ from .remote import RemoteReference reader = self.config_reader() if reader.has_option(self.k_config_remote) and reader.has_option(self.k_config_remote_ref): if reader.get_value(self.k_config_remote) == ".": # Git resolves local-upstream configuration; do not construct a # remote reference for the special local-repository selector. path = self.repo.git._call_process_safe( "rev_parse", "--symbolic-full-name", f"{self.name}@{{upstream}}" ) return Head(self.repo, path) ref = Head( self.repo, Head.to_full_path(strip_quotes(reader.get_value(self.k_config_remote_ref))), ) remote_refpath = RemoteReference.to_full_path(join_path(reader.get_value(self.k_config_remote), ref.name)) return RemoteReference(self.repo, remote_refpath) # END handle have tracking branch # We are not a tracking branch. return None def rename(self, new_path: PathLike, force: bool = False) -> "Head": """Rename self to a new path. :param new_path: Either a simple name or a path, e.g. ``new_name`` or ``features/new_name``. The prefix ``refs/heads`` is implied. :param force: If ``True``, the rename will succeed even if a head with the target name already exists. :return: self :note: Respects the ref log, as git commands are used. """ flag = "-m" if force: flag = "-M" new_name = Git._check_operand(new_path, "branch") new_full_path = "%s/%s" % (self._common_path_default, new_name) self._get_validated_ref_path(self.repo, self.path) self._get_validated_ref_path(self.repo, new_full_path) self.repo.git._call_process_safe("branch", flag, "--", self.name, new_name) self.path = new_full_path return self def checkout( self, force: bool = False, allow_unsafe_options: bool = False, **kwargs: Any, ) -> Union["HEAD", "Head"]: """Check out this head by setting the HEAD to this reference, by updating the index to reflect the tree we point to and by updating the working tree to reflect the latest index. The command will fail if changed working tree files would be overwritten. :param force: If ``True``, changes to the index and the working tree will be discarded. If ``False``, :exc:`~git.exc.GitCommandError` will be raised in that situation. :param allow_unsafe_options: Allow unsafe options such as ``--pathspec-from-file`` to be passed to :manpage:`git-checkout(1)`. Branch names are validated regardless of this setting. :param kwargs: Additional keyword arguments to be passed to git checkout, e.g. ``b="new_branch"`` to create a new branch at the given spot. :return: The active branch after the checkout operation, usually self unless a new branch has been created. If there is no active branch, as the HEAD is now detached, the HEAD reference will be returned instead. :raise git.exc.UnsafeOptionError: If the branch name starts with a dash or contains NUL, CR, or LF. :note: By default it is only allowed to checkout heads - everything else will leave the HEAD detached which is allowed and possible, but remains a special state that some tools might not be able to handle. """ if not allow_unsafe_options: Git.check_unsafe_options( options=Git._option_candidates([self], kwargs), unsafe_options=Git.unsafe_git_pathspec_from_file_options + ["--patch", "-p"], ) kwargs["f"] = force if kwargs["f"] is False: kwargs.pop("f") name = Git._check_operand(self.name, "branch") self._get_validated_ref_path(self.repo, self.path) for option in ("b", "B", "orphan"): if option in kwargs: Git._check_operand(kwargs[option], "branch") self.repo.git._call_process_safe("checkout", name, "--", **kwargs) if self.repo.head.is_detached: return self.repo.head else: return self.repo.active_branch # { Configuration def _config_parser(self, read_only: bool) -> SectionConstraint[GitConfigParser]: if read_only: parser = self.repo.config_reader() else: parser = self.repo.config_writer() # END handle parser instance return SectionConstraint(parser, GitConfigParser._public_section("branch." + self.name)) def config_reader(self) -> SectionConstraint[GitConfigParser]: """ :return: A configuration parser instance constrained to only read this instance's values. """ return self._config_parser(read_only=True) def config_writer(self) -> SectionConstraint[GitConfigParser]: """ :return: A configuration writer instance with read-and write access to options of this head. """ return self._config_parser(read_only=False) # } END configuration |
| You are visitor 01402520 — 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. |