Repository navigation
Expand file tree
/
Copy pathutils.py
More file actions
290 lines (223 loc) · 8.58 KB
/
Copy pathutils.py
File metadata and controls
290 lines (223 loc) · 8.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
# Copyright 2010-2026 The pygit2 contributors
#
# This file is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License, version 2,
# as published by the Free Software Foundation.
#
# In addition to the permissions in the GNU General Public License,
# the authors give you unlimited permission to link the compiled
# version of this file into combinations with other programs,
# and to distribute those combinations without any restriction
# coming from the use of this file. (The General Public License
# restrictions do apply in other respects; for example, they cover
# modification of the file, and distribution when not linked into
# a combined executable.)
#
# This file is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; see the file COPYING. If not, write to
# the Free Software Foundation, 51 Franklin Street, Fifth Floor,
# Boston, MA 02110-1301, USA.
import contextlib
import os
import sys
import unicodedata
from collections.abc import Generator, Iterator, Sequence
from types import TracebackType
from typing import (
TYPE_CHECKING,
Generic,
Optional,
Protocol,
TypeVar,
Union,
overload,
)
# Import from pygit2
from .ffi import C, ffi
if TYPE_CHECKING:
from ._libgit2.ffi import ArrayC, GitStrrayC, char, char_pointer
PathStrOrBytes = str | bytes | os.PathLike[str] | os.PathLike[bytes]
def decode_string(ptr: 'char_pointer | None') -> str | None:
if not ptr:
return None
return ffi.string(ptr).decode('utf8', errors='surrogateescape')
@overload
def decode_fs_path(ptr_or_bytes: 'char_pointer | None') -> str | None: ...
@overload
def decode_fs_path(ptr_or_bytes: bytes) -> str: ...
def decode_fs_path(ptr_or_bytes: 'char_pointer | bytes | None') -> str | None:
if ptr_or_bytes is None:
return None
if isinstance(ptr_or_bytes, bytes):
return os.fsdecode(ptr_or_bytes)
if not ptr_or_bytes:
return None
return os.fsdecode(ffi.string(ptr_or_bytes))
@overload
def encode_fs_path(s: PathStrOrBytes) -> bytes: ...
@overload
def encode_fs_path(s: 'ffi.NULL_TYPE | None') -> 'ffi.NULL_TYPE': ...
def encode_fs_path(
s: 'PathStrOrBytes | ffi.NULL_TYPE | None',
) -> 'bytes | ffi.NULL_TYPE':
if s is None or s == ffi.NULL:
return ffi.NULL
return os.fsencode(s) # type: ignore[arg-type]
@overload
def encode_git_path(s: PathStrOrBytes) -> bytes: ...
@overload
def encode_git_path(s: 'ffi.NULL_TYPE | None') -> 'ffi.NULL_TYPE': ...
def encode_git_path(
s: 'PathStrOrBytes | ffi.NULL_TYPE | None',
) -> 'bytes | ffi.NULL_TYPE':
"""Encode a path that lives inside a Git repository.
str and PathLike values are encoded as UTF-8 (with surrogateescape for
round-trip of non-UTF-8 bytes). On macOS they are also normalized to NFC,
matching Git's core.precomposeunicode default behaviour.
"""
if s is None or s == ffi.NULL:
return ffi.NULL
if isinstance(s, bytes):
return s
text = os.fspath(s) # type: ignore[arg-type]
if sys.platform == 'darwin':
text = unicodedata.normalize('NFC', text)
return text.encode('utf-8', 'surrogateescape')
# TODO decode_string uses errors='surrogateescape', but encode_string defaults
# to errors='strict', so a value read from libgit2 with bad bytes cannot be
# written back without raising. Decide whether encode_string should default to
# 'surrogateescape' too, and audit every caller to make sure that's safe
# (this is a behavior change, not just a rename).
@overload
def encode_string(
s: str | bytes | os.PathLike[str] | os.PathLike[bytes],
encoding: str = 'utf-8',
errors: str = 'strict',
) -> bytes: ...
@overload
def encode_string(
s: Union['ffi.NULL_TYPE', None],
encoding: str = 'utf-8',
errors: str = 'strict',
) -> Union['ffi.NULL_TYPE']: ...
def encode_string(
s: Union[str, bytes, 'ffi.NULL_TYPE', os.PathLike[str], os.PathLike[bytes], None],
encoding: str = 'utf-8',
errors: str = 'strict',
) -> Union[bytes, 'ffi.NULL_TYPE']:
if s == ffi.NULL or s is None:
return ffi.NULL
if hasattr(s, '__fspath__'):
s = os.fspath(s)
if isinstance(s, bytes):
return s
return s.encode(encoding, errors) # type: ignore[union-attr]
def path_to_str(s: str | bytes | os.PathLike[str] | os.PathLike[bytes]) -> str:
if hasattr(s, '__fspath__'):
s = os.fspath(s)
if type(s) is str:
return s
if type(s) is bytes:
return s.decode()
raise TypeError(f'unexpected type "{repr(s)}"')
def ptr_to_bytes(ptr_cdata) -> bytes:
"""
Convert a pointer coming from C code (<cdata 'some_type *'>)
to a byte buffer containing the address that the pointer refers to.
"""
pp = ffi.new('void **', ptr_cdata)
return bytes(ffi.buffer(pp)[:])
@contextlib.contextmanager
def new_git_strarray() -> Generator['GitStrrayC', None, None]:
strarray = ffi.new('git_strarray *')
yield strarray
C.git_strarray_dispose(strarray)
def strarray_to_strings(arr) -> list[str]:
"""
Return a list of strings from a git_strarray pointer.
Free the strings contained in the git_strarry, this means it won't be usable after
calling this function.
"""
try:
return [ffi.string(arr.strings[i]).decode('utf-8') for i in range(arr.count)]
finally:
C.git_strarray_dispose(arr)
class StrArray:
"""A git_strarray wrapper
Use this in order to get a git_strarray* to pass to libgit2 out of a
list of strings. This has a context manager, which you should use, e.g.
with StrArray(list_of_strings) as arr:
C.git_function_that_takes_strarray(arr.ptr)
To make a pre-existing git_strarray point to the provided list of strings,
use the context manager's assign_to() method:
struct = ffi.new('git_strarray *', [ffi.NULL, 0])
with StrArray(list_of_strings) as arr:
arr.assign_to(struct)
The above construct is still subject to FFI scoping rules, i.e. the
contents of 'struct' only remain valid within the StrArray context.
"""
__array: 'GitStrrayC | ffi.NULL_TYPE'
__strings: list['None | ArrayC[char]']
__arr: 'ArrayC[char_pointer]'
def __init__(self, lst: None | Sequence[str | os.PathLike[str]]):
# Allow passing in None as lg2 typically considers them the same as empty
if lst is None:
self.__array = ffi.NULL
return
if not isinstance(lst, (list, tuple)):
raise TypeError('Value must be a list')
strings: list[None | 'ArrayC[char]'] = [None] * len(lst)
for i in range(len(lst)):
li = lst[i]
if not isinstance(li, str) and not hasattr(li, '__fspath__'):
raise TypeError('Value must be a string or PathLike object')
strings[i] = ffi.new('char []', encode_string(li))
self.__arr = ffi.new('char *[]', strings)
self.__strings = strings
self.__array = ffi.new('git_strarray *', [self.__arr, len(strings)]) # type: ignore[call-overload]
def __enter__(self) -> 'StrArray':
return self
def __exit__(
self,
exc_type: Optional[type[BaseException]],
exc_value: Optional[BaseException],
traceback: Optional[TracebackType],
) -> None:
pass
@property
def ptr(self) -> 'GitStrrayC | ffi.NULL_TYPE':
return self.__array
def assign_to(self, git_strarray: 'GitStrrayC') -> None:
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)
T = TypeVar('T')
U = TypeVar('U', covariant=True)
class SequenceProtocol(Protocol[U]):
def __len__(self) -> int: ...
def __getitem__(self, index: int) -> U: ...
class GenericIterator(Generic[T]):
"""Helper to easily implement an iterator.
The constructor gets a container which must implement __len__ and
__getitem__
"""
def __init__(self, container: SequenceProtocol[T]) -> None:
self.container = container
self.length = len(container)
self.idx = 0
def __iter__(self) -> Iterator[T]:
return self
def __next__(self) -> T:
idx = self.idx
if idx >= self.length:
raise StopIteration
self.idx += 1
return self.container[idx]