dulwich.refs.InfoRefsContainer

class documentation

class InfoRefsContainer(RefsContainer):

Known subclasses: dulwich.contrib.swift.SwiftInfoRefsContainer

View In Hierarchy

Refs container that reads refs from a info/refs file.

Method __init__ Undocumented
Method allkeys All refs present in this container.
Method get_packed_refs Get contents of the packed-refs file.
Method get_peeled Return the cached peeled value of a ref, if available.
Method read_loose_ref Read a loose reference and return its contents.
Instance Variable _peeled Undocumented
Instance Variable _refs Undocumented

Inherited from RefsContainer:

Method __contains__ Undocumented
Method __delitem__ Remove a refname.
Method __getitem__ Get the SHA1 for a reference name.
Method __iter__ Undocumented
Method __setitem__ Set a reference name to point to the given SHA1.
Method add_if_new Add a new reference only if it does not already exist.
Method as_dict Return the contents of this container as a dictionary.
Method follow Follow a reference name.
Method get_symrefs Get a dict with all symrefs in this container.
Method import_refs Undocumented
Method keys Refs present in this container.
Method read_ref Read a reference without following any references.
Method remove_if_equals Remove a refname only if it currently equals old_ref.
Method set_if_equals Set a refname to new_ref only if it currently equals old_ref.
Method set_symbolic_ref Make a ref point at another ref.
Method subkeys Refs present in this container under a base.
Method _check_refname Ensure a refname is valid and lives in refs or is HEAD.
Method _log Undocumented
Instance Variable _logger Undocumented
def __init__(self, f):
overrides dulwich.refs.RefsContainer.__init__
overridden in dulwich.contrib.swift.SwiftInfoRefsContainer

Undocumented

def allkeys(self):
overrides dulwich.refs.RefsContainer.allkeys
overridden in dulwich.contrib.swift.SwiftInfoRefsContainer

All refs present in this container.

def get_packed_refs(self):
overrides dulwich.refs.RefsContainer.get_packed_refs

Get contents of the packed-refs file.

Returns: Dictionary mapping ref names to SHA1s

Note: Will return an empty dictionary when no packed-refs file is
present.
def get_peeled(self, name):
overrides dulwich.refs.RefsContainer.get_peeled

Return the cached peeled value of a ref, if available.

Returns: The peeled value of the ref. If the ref is known not point to
a tag, this will be the SHA the ref refers to. If the ref may point to a tag, but no cached information is available, None is returned.
Parameters
nameName of the ref to peel
def read_loose_ref(self, name):
overrides dulwich.refs.RefsContainer.read_loose_ref

Read a loose reference and return its contents.

Returns: The contents of the ref file, or None if it does
not exist.
Parameters
namethe refname to read
_peeled: dict =

Undocumented

_refs: dict =

Undocumented