Merge remote-tracking branch 'tmr232/references-object'

Author: jdavid

docs/references.rst

@@ -4,16 +4,21 @@ References
 
 .. contents::
 
-.. automethod:: pygit2.Repository.listall_reference_objects
-.. automethod:: pygit2.Repository.listall_references
-.. automethod:: pygit2.Repository.lookup_reference
+.. autoattribute:: pygit2.Repository.references
 
 Example::
 
-    >>> all_refs = repo.listall_references()
+    >>> all_refs = list(repo.references)
+
     >>> master_ref = repo.lookup_reference("refs/heads/master")
     >>> commit = master_ref.get_object() # or repo[master_ref.target]
 
+    # Create a reference
+    >>> ref = repo.references.create('refs/tags/version1', LAST_COMMIT)
+
+    # Delete a reference
+    >>> repo.references.delete('refs/tags/version1')
+
 
 The Reference type
 ====================
@@ -116,7 +121,9 @@ The reference log
 
 Example::
 
-    >>> head = repo.lookup_reference('refs/heads/master')
+    >>> head = repo.references.get('refs/heads/master')  # Returns None if not found
+    >>> # Almost equivalent to
+    >>> head = repo.references['refs/heads/master']  # Raises KeyError if not found
     >>> for entry in head.log():
     ...     print(entry.message)
 

pygit2/repository.py

@@ -1037,13 +1037,38 @@ def delete(self, name):
         self[name].delete()
 
     def __contains__(self, name):
-        try:
-            # If the lookup succeeds, the name is present.
-            _ = self[name]
-            return True
+        return self.get(name) is not None
+
 
+class References(object):
+    def __init__(self, repository):
+        self._repository = repository
+
+    def __getitem__(self, name):
+        return self._repository.lookup_reference(name)
+
+    def get(self, key):
+        try:
+            return self[key]
         except KeyError:
-            return False
+            return None
+
+    def __iter__(self):
+        for ref_name in self._repository.listall_references():
+            yield ref_name
+
+    def create(self, name, target, force=False):
+        return self._repository.create_reference(name, target, force)
+
+    def delete(self, name):
+        self[name].delete()
+
+    def __contains__(self, name):
+        return self.get(name) is not None
+
+    @property
+    def objects(self):
+        return self._repository.listall_reference_objects()
 
 
 class Repository(BaseRepository):
@@ -1055,6 +1080,7 @@ def __init__(self, path, *args, **kwargs):
         super(Repository, self).__init__(backend=path_backend, *args, **kwargs)
 
         self.branches = Branches(self)
+        self.references = References(self)
 
     @classmethod
     def _from_c(cls, ptr, owned):