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

Public Member Functions

def __init__ (self, repo, path, check_path=True)
 
def __str__ (self)
 
def set_object (self, object, logmsg=None)
 
def name (self)
 
def iter_items (cls, repo, common_path=None)
 
def remote_name (self)
 
def remote_head (self)
 
- Public Member Functions inherited from SymbolicReference
def __init__ (self, repo, path)
 
def __repr__ (self)
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def __hash__ (self)
 
def abspath (self)
 
def dereference_recursive (cls, repo, ref_path)
 
def set_commit (self, commit, 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 from_path (cls, repo, path)
 
def is_remote (self)
 
- Public Member Functions inherited from Iterable
def list_items (cls, repo, *args, **kwargs)
 
def iter_items (cls, repo, *args, **kwargs)
 

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

Represents a named reference to any object. Subclasses may apply restrictions though,
i.e. Heads can only point to commits.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  repo,
  path,
  check_path = True 
)
Initialize this instance
:param repo: Our parent repository

:param path:
    Path relative to the .git/ directory pointing to the ref in question, i.e.
    refs/heads/master
:param check_path: if False, you can provide any path. Otherwise the path must start with the
    default path prefix of this type.

Member Function Documentation

◆ __str__()

def __str__ (   self)

Reimplemented from SymbolicReference.

◆ iter_items()

def iter_items (   cls,
  repo,
  common_path = None 
)
Equivalent to SymbolicReference.iter_items, but will return non-detached
references as well.

Reimplemented from SymbolicReference.

◆ name()

def name (   self)
:return: (shortest) Name of this reference - it may contain path components

Reimplemented from SymbolicReference.

◆ remote_head()

def remote_head (   self)
:return: Name of the remote head itself, i.e. master.
:note: The returned name is usually not qualified enough to uniquely identify
    a branch

◆ remote_name()

def remote_name (   self)
:return:
    Name of the remote we are a reference of, such as 'origin' for a reference
    named 'origin/master'

◆ set_object()

def set_object (   self,
  object,
  logmsg = None 
)
Special version which checks if the head-log needs an update as well
:return: self

Reimplemented from SymbolicReference.


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