codekingpro/portable-devtools

1from typing import TypeAlias, overload
2
3import numpy as np
4from numpy._globals import _NoValueType
5from numpy._typing import (
6    NDArray,
7    _AnyShape,
8    _ArrayLikeAnyString_co as UST_co,
9    _ArrayLikeBytes_co as S_co,
10    _ArrayLikeInt_co as i_co,
11    _ArrayLikeStr_co as U_co,
12    _ArrayLikeString_co as T_co,
13    _SupportsArray,
14)
15
16__all__ = [
17    "add",
18    "capitalize",
19    "center",
20    "count",
21    "decode",
22    "encode",
23    "endswith",
24    "equal",
25    "expandtabs",
26    "find",
27    "greater",
28    "greater_equal",
29    "index",
30    "isalnum",
31    "isalpha",
32    "isdecimal",
33    "isdigit",
34    "islower",
35    "isnumeric",
36    "isspace",
37    "istitle",
38    "isupper",
39    "less",
40    "less_equal",
41    "ljust",
42    "lower",
43    "lstrip",
44    "mod",
45    "multiply",
46    "not_equal",
47    "partition",
48    "replace",
49    "rfind",
50    "rindex",
51    "rjust",
52    "rpartition",
53    "rstrip",
54    "startswith",
55    "str_len",
56    "strip",
57    "swapcase",
58    "title",
59    "translate",
60    "upper",
61    "zfill",
62    "slice",
63]
64
65_StringDTypeArray: TypeAlias = np.ndarray[_AnyShape, np.dtypes.StringDType]
66_StringDTypeSupportsArray: TypeAlias = _SupportsArray[np.dtypes.StringDType]
67_StringDTypeOrUnicodeArray: TypeAlias = np.ndarray[_AnyShape, np.dtype[np.str_]] | _StringDTypeArray
68
69@overload
70def equal(x1: U_co, x2: U_co) -> NDArray[np.bool]: ...
71@overload
72def equal(x1: S_co, x2: S_co) -> NDArray[np.bool]: ...
73@overload
74def equal(x1: T_co, x2: T_co) -> NDArray[np.bool]: ...
75
76@overload
77def not_equal(x1: U_co, x2: U_co) -> NDArray[np.bool]: ...
78@overload
79def not_equal(x1: S_co, x2: S_co) -> NDArray[np.bool]: ...
80@overload
81def not_equal(x1: T_co, x2: T_co) -> NDArray[np.bool]: ...
82
83@overload
84def greater_equal(x1: U_co, x2: U_co) -> NDArray[np.bool]: ...
85@overload
86def greater_equal(x1: S_co, x2: S_co) -> NDArray[np.bool]: ...
87@overload
88def greater_equal(x1: T_co, x2: T_co) -> NDArray[np.bool]: ...
89
90@overload
91def less_equal(x1: U_co, x2: U_co) -> NDArray[np.bool]: ...
92@overload
93def less_equal(x1: S_co, x2: S_co) -> NDArray[np.bool]: ...
94@overload
95def less_equal(x1: T_co, x2: T_co) -> NDArray[np.bool]: ...
96
97@overload
98def greater(x1: U_co, x2: U_co) -> NDArray[np.bool]: ...
99@overload
100def greater(x1: S_co, x2: S_co) -> NDArray[np.bool]: ...
101@overload
102def greater(x1: T_co, x2: T_co) -> NDArray[np.bool]: ...
103
104@overload
105def less(x1: U_co, x2: U_co) -> NDArray[np.bool]: ...
106@overload
107def less(x1: S_co, x2: S_co) -> NDArray[np.bool]: ...
108@overload
109def less(x1: T_co, x2: T_co) -> NDArray[np.bool]: ...
110
111@overload
112def add(x1: U_co, x2: U_co) -> NDArray[np.str_]: ...
113@overload
114def add(x1: S_co, x2: S_co) -> NDArray[np.bytes_]: ...
115@overload
116def add(x1: _StringDTypeSupportsArray, x2: _StringDTypeSupportsArray) -> _StringDTypeArray: ...
117@overload
118def add(x1: T_co, x2: T_co) -> _StringDTypeOrUnicodeArray: ...
119
120@overload
121def multiply(a: U_co, i: i_co) -> NDArray[np.str_]: ...
122@overload
123def multiply(a: S_co, i: i_co) -> NDArray[np.bytes_]: ...
124@overload
125def multiply(a: _StringDTypeSupportsArray, i: i_co) -> _StringDTypeArray: ...
126@overload
127def multiply(a: T_co, i: i_co) -> _StringDTypeOrUnicodeArray: ...
128
129@overload
130def mod(a: U_co, value: object) -> NDArray[np.str_]: ...
131@overload
132def mod(a: S_co, value: object) -> NDArray[np.bytes_]: ...
133@overload
134def mod(a: _StringDTypeSupportsArray, value: object) -> _StringDTypeArray: ...
135@overload
136def mod(a: T_co, value: object) -> _StringDTypeOrUnicodeArray: ...
137
138def isalpha(x: UST_co) -> NDArray[np.bool]: ...
139def isalnum(a: UST_co) -> NDArray[np.bool]: ...
140def isdigit(x: UST_co) -> NDArray[np.bool]: ...
141def isspace(x: UST_co) -> NDArray[np.bool]: ...
142def isdecimal(x: U_co | T_co) -> NDArray[np.bool]: ...
143def isnumeric(x: U_co | T_co) -> NDArray[np.bool]: ...
144def islower(a: UST_co) -> NDArray[np.bool]: ...
145def istitle(a: UST_co) -> NDArray[np.bool]: ...
146def isupper(a: UST_co) -> NDArray[np.bool]: ...
147
148def str_len(x: UST_co) -> NDArray[np.int_]: ...
149
150@overload
151def find(
152    a: U_co,
153    sub: U_co,
154    start: i_co = 0,
155    end: i_co | None = None,
156) -> NDArray[np.int_]: ...
157@overload
158def find(
159    a: S_co,
160    sub: S_co,
161    start: i_co = 0,
162    end: i_co | None = None,
163) -> NDArray[np.int_]: ...
164@overload
165def find(
166    a: T_co,
167    sub: T_co,
168    start: i_co = 0,
169    end: i_co | None = None,
170) -> NDArray[np.int_]: ...
171
172@overload
173def rfind(
174    a: U_co,
175    sub: U_co,
176    start: i_co = 0,
177    end: i_co | None = None,
178) -> NDArray[np.int_]: ...
179@overload
180def rfind(
181    a: S_co,
182    sub: S_co,
183    start: i_co = 0,
184    end: i_co | None = None,
185) -> NDArray[np.int_]: ...
186@overload
187def rfind(
188    a: T_co,
189    sub: T_co,
190    start: i_co = 0,
191    end: i_co | None = None,
192) -> NDArray[np.int_]: ...
193
194@overload
195def index(
196    a: U_co,
197    sub: U_co,
198    start: i_co = 0,
199    end: i_co | None = None,
200) -> NDArray[np.int_]: ...
201@overload
202def index(
203    a: S_co,
204    sub: S_co,
205    start: i_co = 0,
206    end: i_co | None = None,
207) -> NDArray[np.int_]: ...
208@overload
209def index(
210    a: T_co,
211    sub: T_co,
212    start: i_co = 0,
213    end: i_co | None = None,
214) -> NDArray[np.int_]: ...
215
216@overload
217def rindex(
218    a: U_co,
219    sub: U_co,
220    start: i_co = 0,
221    end: i_co | None = None,
222) -> NDArray[np.int_]: ...
223@overload
224def rindex(
225    a: S_co,
226    sub: S_co,
227    start: i_co = 0,
228    end: i_co | None = None,
229) -> NDArray[np.int_]: ...
230@overload
231def rindex(
232    a: T_co,
233    sub: T_co,
234    start: i_co = 0,
235    end: i_co | None = None,
236) -> NDArray[np.int_]: ...
237
238@overload
239def count(
240    a: U_co,
241    sub: U_co,
242    start: i_co = 0,
243    end: i_co | None = None,
244) -> NDArray[np.int_]: ...
245@overload
246def count(
247    a: S_co,
248    sub: S_co,
249    start: i_co = 0,
250    end: i_co | None = None,
251) -> NDArray[np.int_]: ...
252@overload
253def count(
254    a: T_co,
255    sub: T_co,
256    start: i_co = 0,
257    end: i_co | None = None,
258) -> NDArray[np.int_]: ...
259
260@overload
261def startswith(
262    a: U_co,
263    prefix: U_co,
264    start: i_co = 0,
265    end: i_co | None = None,
266) -> NDArray[np.bool]: ...
267@overload
268def startswith(
269    a: S_co,
270    prefix: S_co,
271    start: i_co = 0,
272    end: i_co | None = None,
273) -> NDArray[np.bool]: ...
274@overload
275def startswith(
276    a: T_co,
277    prefix: T_co,
278    start: i_co = 0,
279    end: i_co | None = None,
280) -> NDArray[np.bool]: ...
281
282@overload
283def endswith(
284    a: U_co,
285    suffix: U_co,
286    start: i_co = 0,
287    end: i_co | None = None,
288) -> NDArray[np.bool]: ...
289@overload
290def endswith(
291    a: S_co,
292    suffix: S_co,
293    start: i_co = 0,
294    end: i_co | None = None,
295) -> NDArray[np.bool]: ...
296@overload
297def endswith(
298    a: T_co,
299    suffix: T_co,
300    start: i_co = 0,
301    end: i_co | None = None,
302) -> NDArray[np.bool]: ...
303
304def decode(
305    a: S_co,
306    encoding: str | None = None,
307    errors: str | None = None,
308) -> NDArray[np.str_]: ...
309def encode(
310    a: U_co | T_co,
311    encoding: str | None = None,
312    errors: str | None = None,
313) -> NDArray[np.bytes_]: ...
314
315@overload
316def expandtabs(a: U_co, tabsize: i_co = 8) -> NDArray[np.str_]: ...
317@overload
318def expandtabs(a: S_co, tabsize: i_co = 8) -> NDArray[np.bytes_]: ...
319@overload
320def expandtabs(a: _StringDTypeSupportsArray, tabsize: i_co = 8) -> _StringDTypeArray: ...
321@overload
322def expandtabs(a: T_co, tabsize: i_co = 8) -> _StringDTypeOrUnicodeArray: ...
323
324@overload
325def center(a: U_co, width: i_co, fillchar: UST_co = " ") -> NDArray[np.str_]: ...
326@overload
327def center(a: S_co, width: i_co, fillchar: UST_co = " ") -> NDArray[np.bytes_]: ...
328@overload
329def center(a: _StringDTypeSupportsArray, width: i_co, fillchar: UST_co = " ") -> _StringDTypeArray: ...
330@overload
331def center(a: T_co, width: i_co, fillchar: UST_co = " ") -> _StringDTypeOrUnicodeArray: ...
332
333@overload
334def ljust(a: U_co, width: i_co, fillchar: UST_co = " ") -> NDArray[np.str_]: ...
335@overload
336def ljust(a: S_co, width: i_co, fillchar: UST_co = " ") -> NDArray[np.bytes_]: ...
337@overload
338def ljust(a: _StringDTypeSupportsArray, width: i_co, fillchar: UST_co = " ") -> _StringDTypeArray: ...
339@overload
340def ljust(a: T_co, width: i_co, fillchar: UST_co = " ") -> _StringDTypeOrUnicodeArray: ...
341
342@overload
343def rjust(a: U_co, width: i_co, fillchar: UST_co = " ") -> NDArray[np.str_]: ...
344@overload
345def rjust(a: S_co, width: i_co, fillchar: UST_co = " ") -> NDArray[np.bytes_]: ...
346@overload
347def rjust(a: _StringDTypeSupportsArray, width: i_co, fillchar: UST_co = " ") -> _StringDTypeArray: ...
348@overload
349def rjust(a: T_co, width: i_co, fillchar: UST_co = " ") -> _StringDTypeOrUnicodeArray: ...
350
351@overload
352def lstrip(a: U_co, chars: U_co | None = None) -> NDArray[np.str_]: ...
353@overload
354def lstrip(a: S_co, chars: S_co | None = None) -> NDArray[np.bytes_]: ...
355@overload
356def lstrip(a: _StringDTypeSupportsArray, chars: T_co | None = None) -> _StringDTypeArray: ...
357@overload
358def lstrip(a: T_co, chars: T_co | None = None) -> _StringDTypeOrUnicodeArray: ...
359
360@overload
361def rstrip(a: U_co, chars: U_co | None = None) -> NDArray[np.str_]: ...
362@overload
363def rstrip(a: S_co, chars: S_co | None = None) -> NDArray[np.bytes_]: ...
364@overload
365def rstrip(a: _StringDTypeSupportsArray, chars: T_co | None = None) -> _StringDTypeArray: ...
366@overload
367def rstrip(a: T_co, chars: T_co | None = None) -> _StringDTypeOrUnicodeArray: ...
368
369@overload
370def strip(a: U_co, chars: U_co | None = None) -> NDArray[np.str_]: ...
371@overload
372def strip(a: S_co, chars: S_co | None = None) -> NDArray[np.bytes_]: ...
373@overload
374def strip(a: _StringDTypeSupportsArray, chars: T_co | None = None) -> _StringDTypeArray: ...
375@overload
376def strip(a: T_co, chars: T_co | None = None) -> _StringDTypeOrUnicodeArray: ...
377
378@overload
379def zfill(a: U_co, width: i_co) -> NDArray[np.str_]: ...
380@overload
381def zfill(a: S_co, width: i_co) -> NDArray[np.bytes_]: ...
382@overload
383def zfill(a: _StringDTypeSupportsArray, width: i_co) -> _StringDTypeArray: ...
384@overload
385def zfill(a: T_co, width: i_co) -> _StringDTypeOrUnicodeArray: ...
386
387@overload
388def upper(a: U_co) -> NDArray[np.str_]: ...
389@overload
390def upper(a: S_co) -> NDArray[np.bytes_]: ...
391@overload
392def upper(a: _StringDTypeSupportsArray) -> _StringDTypeArray: ...
393@overload
394def upper(a: T_co) -> _StringDTypeOrUnicodeArray: ...
395
396@overload
397def lower(a: U_co) -> NDArray[np.str_]: ...
398@overload
399def lower(a: S_co) -> NDArray[np.bytes_]: ...
400@overload
401def lower(a: _StringDTypeSupportsArray) -> _StringDTypeArray: ...
402@overload
403def lower(a: T_co) -> _StringDTypeOrUnicodeArray: ...
404
405@overload
406def swapcase(a: U_co) -> NDArray[np.str_]: ...
407@overload
408def swapcase(a: S_co) -> NDArray[np.bytes_]: ...
409@overload
410def swapcase(a: _StringDTypeSupportsArray) -> _StringDTypeArray: ...
411@overload
412def swapcase(a: T_co) -> _StringDTypeOrUnicodeArray: ...
413
414@overload
415def capitalize(a: U_co) -> NDArray[np.str_]: ...
416@overload
417def capitalize(a: S_co) -> NDArray[np.bytes_]: ...
418@overload
419def capitalize(a: _StringDTypeSupportsArray) -> _StringDTypeArray: ...
420@overload
421def capitalize(a: T_co) -> _StringDTypeOrUnicodeArray: ...
422
423@overload
424def title(a: U_co) -> NDArray[np.str_]: ...
425@overload
426def title(a: S_co) -> NDArray[np.bytes_]: ...
427@overload
428def title(a: _StringDTypeSupportsArray) -> _StringDTypeArray: ...
429@overload
430def title(a: T_co) -> _StringDTypeOrUnicodeArray: ...
431
432@overload
433def replace(
434    a: U_co,
435    old: U_co,
436    new: U_co,
437    count: i_co = -1,
438) -> NDArray[np.str_]: ...
439@overload
440def replace(
441    a: S_co,
442    old: S_co,
443    new: S_co,
444    count: i_co = -1,
445) -> NDArray[np.bytes_]: ...
446@overload
447def replace(
448    a: _StringDTypeSupportsArray,
449    old: _StringDTypeSupportsArray,
450    new: _StringDTypeSupportsArray,
451    count: i_co = -1,
452) -> _StringDTypeArray: ...
453@overload
454def replace(
455    a: T_co,
456    old: T_co,
457    new: T_co,
458    count: i_co = -1,
459) -> _StringDTypeOrUnicodeArray: ...
460
461@overload
462def partition(a: U_co, sep: U_co) -> NDArray[np.str_]: ...
463@overload
464def partition(a: S_co, sep: S_co) -> NDArray[np.bytes_]: ...
465@overload
466def partition(a: _StringDTypeSupportsArray, sep: _StringDTypeSupportsArray) -> _StringDTypeArray: ...
467@overload
468def partition(a: T_co, sep: T_co) -> _StringDTypeOrUnicodeArray: ...
469
470@overload
471def rpartition(a: U_co, sep: U_co) -> NDArray[np.str_]: ...
472@overload
473def rpartition(a: S_co, sep: S_co) -> NDArray[np.bytes_]: ...
474@overload
475def rpartition(a: _StringDTypeSupportsArray, sep: _StringDTypeSupportsArray) -> _StringDTypeArray: ...
476@overload
477def rpartition(a: T_co, sep: T_co) -> _StringDTypeOrUnicodeArray: ...
478
479@overload
480def translate(
481    a: U_co,
482    table: str,
483    deletechars: str | None = None,
484) -> NDArray[np.str_]: ...
485@overload
486def translate(
487    a: S_co,
488    table: str,
489    deletechars: str | None = None,
490) -> NDArray[np.bytes_]: ...
491@overload
492def translate(
493    a: _StringDTypeSupportsArray,
494    table: str,
495    deletechars: str | None = None,
496) -> _StringDTypeArray: ...
497@overload
498def translate(
499    a: T_co,
500    table: str,
501    deletechars: str | None = None,
502) -> _StringDTypeOrUnicodeArray: ...
503
504#
505@overload
506def slice(
507    a: U_co,
508    start: i_co | None = None,
509    stop: i_co | _NoValueType | None = ...,  # = np._NoValue
510    step: i_co | None = None,
511    /,
512) -> NDArray[np.str_]: ...
513@overload
514def slice(
515    a: S_co,
516    start: i_co | None = None,
517    stop: i_co | _NoValueType | None = ...,  # = np._NoValue
518    step: i_co | None = None,
519    /,
520) -> NDArray[np.bytes_]: ...
521@overload
522def slice(
523    a: _StringDTypeSupportsArray,
524    start: i_co | None = None,
525    stop: i_co | _NoValueType | None = ...,  # = np._NoValue
526    step: i_co | None = None,
527    /,
528) -> _StringDTypeArray: ...
529@overload
530def slice(
531    a: T_co,
532    start: i_co | None = None,
533    stop: i_co | _NoValueType | None = ...,  # = np._NoValue
534    step: i_co | None = None,
535    /,
536) -> _StringDTypeOrUnicodeArray: ...
537