OpenQuizz
Une application de gestion des contenus pédagogiques
HEAD Class Reference
Inheritance diagram for HEAD:
Collaboration diagram for HEAD:

Public Member Functions

def __init__ (self, repo, path=_HEAD_NAME)
 
def orig_head (self)
 
def reset (self, commit='HEAD', index=True, working_tree=False, paths=None, **kwargs)
 
- Public Member Functions inherited from SymbolicReference
def __str__ (self)
 
def __repr__ (self)
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def __hash__ (self)
 
def name (self)
 
def abspath (self)
 
def dereference_recursive (cls, repo, ref_path)
 
def set_commit (self, commit, logmsg=None)
 
def set_object (self, object, logmsg=None)
 
def set_reference (self, ref, logmsg=None)
 
def is_valid (self)
 
def is_detached (self)
 
def log (self)
 
def log_append (self, oldbinsha, message, newbinsha=None)
 
def log_entry (self, index)
 
def to_full_path (cls, path)
 
def delete (cls, repo, path)
 
def create (cls, repo, path, reference='HEAD', force=False, logmsg=None)
 
def rename (self, new_path, force=False)
 
def iter_items (cls, repo, common_path=None)
 
def from_path (cls, repo, path)
 
def is_remote (self)
 

Additional Inherited Members

- Data Fields inherited from SymbolicReference
 repo
 
 path
 
- Static Public Attributes inherited from SymbolicReference
 ref
 
- Properties inherited from SymbolicReference
 commit = property(_get_commit, set_commit, doc="Query or set commits directly")
 
 object = property(_get_object, set_object, doc="Return the object our ref currently refers to")
 
 reference = property(_get_reference, set_reference, doc="Returns the Reference we point to")
 

Detailed Description

Special case of a Symbolic Reference as it represents the repository's
HEAD reference.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  repo,
  path = _HEAD_NAME 
)

Reimplemented from SymbolicReference.

Member Function Documentation

◆ orig_head()

def orig_head (   self)
:return: SymbolicReference pointing at the ORIG_HEAD, which is maintained
    to contain the previous value of HEAD

◆ reset()

def reset (   self,
  commit = 'HEAD',
  index = True,
  working_tree = False,
  paths = None,
**  kwargs 
)
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:
    Commit object, Reference Object 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 kwargs:
    Additional arguments passed to git-reset.

:return: self

The documentation for this class was generated from the following file: