dulwich.refs.DictRefsContainer(RefsContainer) class documentationdulwich.refs
(View In Hierarchy)
RefsContainer backed by a simple dict.
This container does not support symbolic or packed references and is not threadsafe.
| Method | __init__ | Undocumented |
| Method | allkeys | All refs present in this container. |
| Method | read_loose_ref | Read a loose reference and return its contents. |
| Method | get_packed_refs | Get contents of the packed-refs file. |
| Method | set_symbolic_ref | Make a ref point at another ref. |
| Method | set_if_equals | Set a refname to new_ref only if it currently equals old_ref. |
| Method | add_if_new | Add a new reference only if it does not already exist. |
| Method | remove_if_equals | Remove a refname only if it currently equals old_ref. |
| Method | get_peeled | Return the cached peeled value of a ref, if available. |
| Method | _update | Update multiple refs; intended only for testing. |
| Method | _update_peeled | Update cached peeled refs; intended only for testing. |
Inherited from RefsContainer:
| Method | import_refs | Undocumented |
| Method | keys | Refs present in this container. |
| Method | subkeys | Refs present in this container under a base. |
| Method | as_dict | Return the contents of this container as a dictionary. |
| Method | read_ref | Read a reference without following any references. |
| Method | follow | Follow a reference name. |
| Method | __contains__ | Undocumented |
| Method | __getitem__ | Get the SHA1 for a reference name. |
| Method | __setitem__ | Set a reference name to point to the given SHA1. |
| Method | __delitem__ | Remove a refname. |
| Method | get_symrefs | Get a dict with all symrefs in this container. |
| Method | _log | Undocumented |
| Method | _check_refname | Ensure a refname is valid and lives in refs or is HEAD. |
| Method | _follow | Undocumented |
| Parameters | name | the refname to read |
| Returns | The contents of the ref file, or None if it does not exist. | |
| Returns | Dictionary mapping ref names to SHA1s | |
| Note | Will return an empty dictionary when no packed-refs file is present. | |
| Parameters | name | Name of the ref to set |
| other | Name of the ref to point at | |
| message | Optional message |
Set a refname to new_ref only if it currently equals old_ref.
This method follows all symbolic references if applicable for the subclass, and can be used to perform an atomic compare-and-swap operation.
| Parameters | name | The refname to set. |
| old_ref | The old sha the refname must refer to, or None to set unconditionally. | |
| new_ref | The new sha the refname will refer to. | |
| message | Message for reflog | |
| Returns | True if the set was successful, False otherwise. | |
| Parameters | name | Ref name |
| ref | Ref value | |
| message | Message for reflog |
Remove a refname only if it currently equals old_ref.
This method does not follow symbolic references, even if applicable for the subclass. It can be used to perform an atomic compare-and-delete operation.
| Parameters | name | The refname to delete. |
| old_ref | The old sha the refname must refer to, or None to delete unconditionally. | |
| message | Message for reflog | |
| Returns | True if the delete was successful, False otherwise. | |
| Parameters | name | Name of the ref to peel |
| 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. | |