Update Changelog

And small coding improvements related to git_strarray

Author: jdavid

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 - Upgrade to libgit2 v1.8.0
 
+- New `push_options` optional argument in `Repository.push(...)`
+  [#1282](https://github.com/libgit2/pygit2/pull/1282)
+
 - Remove setuptools runtime dependency
   [#1281](https://github.com/libgit2/pygit2/pull/1281)
 

pygit2/callbacks.py

@@ -699,7 +699,7 @@ def _git_checkout_options(
     if paths:
         strarray = StrArray(paths)
         refs.append(strarray)
-        opts.paths = strarray.array[0]
+        opts.paths = strarray.ptr[0]
 
     # If we want to receive any notifications, set up notify_cb in the options
     notify_flags = payload.checkout_notify_flags()

pygit2/remotes.py

@@ -33,6 +33,7 @@
 from .errors import check_error
 from .ffi import ffi, C
 from .refspec import Refspec
+from . import utils
 from .utils import maybe_string, to_bytes, strarray_to_strings, StrArray
 
 # Need BaseRepository for type hints, but don't let it cause a circular dependency
@@ -299,13 +300,10 @@ def __init__(self, repo: BaseRepository):
         self._repo = repo
 
     def __len__(self):
-        names = ffi.new('git_strarray *')
-        try:
+        with utils.new_git_strarray() as names:
             err = C.git_remote_list(names, self._repo._repo)
             check_error(err)
             return names.count
-        finally:
-            C.git_strarray_dispose(names)
 
     def __iter__(self):
         cremote = ffi.new('git_remote **')
@@ -326,14 +324,11 @@ def __getitem__(self, name):
         return Remote(self._repo, cremote[0])
 
     def _ffi_names(self):
-        names = ffi.new('git_strarray *')
-        try:
+        with utils.new_git_strarray() as names:
             err = C.git_remote_list(names, self._repo._repo)
             check_error(err)
             for i in range(names.count):
                 yield names.strings[i]
-        finally:
-            C.git_strarray_dispose(names)
 
     def names(self):
         """An iterator over the names of the available remotes."""

pygit2/repository.py

@@ -29,7 +29,6 @@
 from time import time
 import tarfile
 import typing
-import warnings
 
 # Import from pygit2
 from ._pygit2 import Repository as _Repository, init_file_backend
@@ -61,7 +60,7 @@
 from .packbuilder import PackBuilder
 from .references import References
 from .remotes import RemoteCollection
-from .submodules import Submodule, SubmoduleCollection
+from .submodules import SubmoduleCollection
 from .utils import to_bytes, StrArray
 
 
@@ -1073,7 +1072,7 @@ def stash(
 
         if paths:
             arr = StrArray(paths)
-            opts.paths = arr.array[0]
+            opts.paths = arr.ptr[0]
 
         coid = ffi.new('git_oid *')
         err = C.git_stash_save_with_opts(coid, self._repo, opts)

pygit2/utils.py

@@ -23,6 +23,7 @@
 # the Free Software Foundation, 51 Franklin Street, Fifth Floor,
 # Boston, MA 02110-1301, USA.
 
+import contextlib
 import os
 
 # Import from pygit2
@@ -72,6 +73,13 @@ def ptr_to_bytes(ptr_cdata):
     return bytes(ffi.buffer(pp)[:])
 
 
+@contextlib.contextmanager
+def new_git_strarray():
+    strarray = ffi.new('git_strarray *')
+    yield strarray
+    C.git_strarray_dispose(strarray)
+
+
 def strarray_to_strings(arr):
     """
     Return a list of strings from a git_strarray pointer.
@@ -108,7 +116,7 @@ class StrArray:
     def __init__(self, l):
         # Allow passing in None as lg2 typically considers them the same as empty
         if l is None:
-            self.array = ffi.NULL
+            self.__array = ffi.NULL
             return
 
         if not isinstance(l, (list, tuple)):
@@ -122,9 +130,9 @@ def __init__(self, l):
 
             strings[i] = ffi.new('char []', to_bytes(li))
 
-        self._arr = ffi.new('char *[]', strings)
-        self._strings = strings
-        self.array = ffi.new('git_strarray *', [self._arr, len(strings)])
+        self.__arr = ffi.new('char *[]', strings)
+        self.__strings = strings
+        self.__array = ffi.new('git_strarray *', [self.__arr, len(strings)])
 
     def __enter__(self):
         return self
@@ -134,15 +142,15 @@ def __exit__(self, type, value, traceback):
 
     @property
     def ptr(self):
-        return self.array
+        return self.__array
 
     def assign_to(self, git_strarray):
-        if self.array == ffi.NULL:
+        if self.__array == ffi.NULL:
             git_strarray.strings = ffi.NULL
             git_strarray.count = 0
         else:
-            git_strarray.strings = self._arr
-            git_strarray.count = len(self._strings)
+            git_strarray.strings = self.__arr
+            git_strarray.count = len(self.__strings)
 
 
 class GenericIterator: