Merge pull request #1499 from beamerblvd/fix-configentry-memory-safety

Refactor ConfigEntry and related iterators for safer memory management

Author: jdavid

AUTHORS.md

@@ -212,6 +212,7 @@ Authors:
     Michał Górny
     Mukunda Rao Katta
     Na'aman Hirschfeld
+    Nicholas Williams
     Nicolas Rybowski
     Nicolás Sanguinetti
     Nikita Kartashov

pygit2/_build.py

@@ -70,5 +70,13 @@ def get_libgit2_paths() -> tuple[Path, dict[str, list[str]]]:
             'libraries': ['git2'],
             'include_dirs': [str(x) for x in include_dirs],
             'library_dirs': [str(x) for x in library_dirs],
+            # For debugging memory issues (segfaults) during development, uncomment the
+            # following lines and rebuild everything. YMMV
+            # 'extra_compile_args': [
+            #     '-fsanitize=address',
+            #     '-fsanitize-address-use-after-scope',
+            #     '-fsanitize-address-use-odr-indicator',
+            # ],
+            # 'extra_link_args': ['-fsanitize=address'],
         },
     )

pygit2/_run.py

@@ -24,11 +24,10 @@
 # Boston, MA 02110-1301, USA.
 
 """
-This is an special module, it provides stuff used by by pygit2 at run-time.
+This is a special module, it provides stuff used by pygit2 at run-time.
 """
 
 # Import from the Standard Library
-import codecs
 import sys
 from pathlib import Path
 
@@ -89,9 +88,8 @@
 ]
 h_source = []
 for h_file in h_files:
-    h_file = dir_path / 'decl' / h_file  # type: ignore
-    with codecs.open(h_file, 'r', 'utf-8') as f:
-        h_source.append(f.read())
+    h_path = dir_path / 'decl' / h_file
+    h_source.append(h_path.read_text(encoding='utf-8'))
 
 C_HEADER_SRC = '\n'.join(h_source)