Files
dvc/dvc/scm/git/stash.py
T
Peter Rowlands (변기호) d68f6d3696 pygit/dulwich: implement stash functionality (#5286)
* pygit2: disable set_ref with reflog message

* git: implement is_dirty in dulwich

* pygit2: implement _stash_apply

* pygit: update to 1.5.0

* enable set_ref(message=...) for pygit2

* git: replace backend reflog_delete in favor of _stash_drop

* pygit: support stash_push with custom refs

* update tests for backend stash_drop behavior

* pygit: raise MergeConflictError on failed stash apply

* pygit: reload index from disk before stash apply

* update stash_apply checkout strategy

* mark flaky test
2021-03-08 17:24:35 +02:00

74 lines
2.1 KiB
Python

"""git stash convenience wrapper."""
import logging
from typing import Optional
from dvc.scm.base import SCMError
logger = logging.getLogger(__name__)
class Stash:
"""Wrapper for representing any arbitrary Git stash ref."""
DEFAULT_STASH = "refs/stash"
def __init__(self, scm, ref: Optional[str] = None):
self.ref = ref if ref else self.DEFAULT_STASH
self.scm = scm
def __iter__(self):
yield from self.scm._stash_iter(self.ref)
def __len__(self):
return len(self.list())
def __getitem__(self, index):
return self.list()[index]
def list(self):
return list(iter(self))
def push(
self, message: Optional[str] = None, include_untracked: bool = False,
) -> Optional[str]:
if not self.scm.is_dirty(untracked_files=include_untracked):
logger.debug("No changes to stash")
return None
logger.debug("Stashing changes in '%s'", self.ref)
rev, reset = self.scm._stash_push( # pylint: disable=protected-access
self.ref, message=message, include_untracked=include_untracked
)
if reset:
self.scm.reset(hard=True)
return rev
def pop(self):
logger.debug("Popping from stash '%s'", self.ref)
ref = "{0}@{{0}}".format(self.ref)
rev = self.scm.resolve_rev(ref)
try:
self.apply(rev)
except Exception as exc:
raise SCMError("Could not apply stash commit") from exc
self.drop()
return rev
def apply(self, rev):
logger.debug("Applying stash commit '%s'", rev)
self.scm._stash_apply(rev) # pylint: disable=protected-access
def drop(self, index: int = 0):
if index < 0 or index >= len(self):
raise SCMError(f"Invalid stash ref '{self.ref}@{{{index}}}'")
logger.debug("Dropping '%s@{%d}'", self.ref, index)
self.scm._stash_drop( # pylint: disable=protected-access
self.ref, index
)
def clear(self):
logger.debug("Clear stash '%s'", self.ref)
for _ in range(len(self)):
self.drop()