Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork966
Expand file tree
/
Copy pathcompat.py
More file actions
165 lines (120 loc) · 4.42 KB
/
compat.py
File metadata and controls
165 lines (120 loc) · 4.42 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
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
#
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
"""Utilities to help provide compatibility with Python 3.
This module exists for historical reasons. Code outside GitPython may make use of public
members of this module, but is unlikely to benefit from doing so. GitPython continues to
use some of these utilities, in some cases for compatibility across different platforms.
"""
importlocale
importos
importsys
importwarnings
fromgitdb.utils.encodingimportforce_bytes,force_text# noqa: F401
# typing --------------------------------------------------------------------
fromtypingimport (
Any,# noqa: F401
AnyStr,
Dict,# noqa: F401
IO,# noqa: F401
List,
Optional,
TYPE_CHECKING,
Tuple,# noqa: F401
Type,# noqa: F401
Union,
overload,
)
# ---------------------------------------------------------------------------
_deprecated_platform_aliases= {
"is_win":os.name=="nt",
"is_posix":os.name=="posix",
"is_darwin":sys.platform=="darwin",
}
def_getattr(name:str)->Any:
try:
value=_deprecated_platform_aliases[name]
exceptKeyError:
raiseAttributeError(f"module{__name__!r} has no attribute{name!r}")fromNone
warnings.warn(
f"{__name__}.{name} and other is_<platform> aliases are deprecated. "
"Write the desired os.name or sys.platform check explicitly instead.",
DeprecationWarning,
stacklevel=2,
)
returnvalue
ifnotTYPE_CHECKING:# Preserve static checking for undefined/misspelled attributes.
__getattr__=_getattr
def__dir__()->List[str]:
return [*globals(),*_deprecated_platform_aliases]
is_win:bool
"""Deprecated alias for ``os.name == "nt"`` to check for native Windows.
This is deprecated because it is clearer to write out :attr:`os.name` or
:attr:`sys.platform` checks explicitly, especially in cases where it matters which is
used.
:note:
``is_win`` is ``False`` on Cygwin, but is often wrongly assumed ``True``. To detect
Cygwin, use ``sys.platform == "cygwin"``.
"""
is_posix:bool
"""Deprecated alias for ``os.name == "posix"`` to check for Unix-like ("POSIX") systems.
This is deprecated because it clearer to write out :attr:`os.name` or
:attr:`sys.platform` checks explicitly, especially in cases where it matters which is
used.
:note:
For POSIX systems, more detailed information is available in :attr:`sys.platform`,
while :attr:`os.name` is always ``"posix"`` on such systems, including macOS
(Darwin).
"""
is_darwin:bool
"""Deprecated alias for ``sys.platform == "darwin"`` to check for macOS (Darwin).
This is deprecated because it clearer to write out :attr:`os.name` or
:attr:`sys.platform` checks explicitly.
:note:
For macOS (Darwin), ``os.name == "posix"`` as in other Unix-like systems, while
``sys.platform == "darwin"``.
"""
defenc=sys.getfilesystemencoding()
"""The encoding used to convert between Unicode and bytes filenames."""
@overload
defsafe_decode(s:None)->None: ...
@overload
defsafe_decode(s:AnyStr)->str: ...
defsafe_decode(s:Union[AnyStr,None])->Optional[str]:
"""Safely decode a binary string to Unicode."""
ifisinstance(s,str):
returns
elifisinstance(s,bytes):
returns.decode(defenc,"surrogateescape")
elifsisNone:
returnNone
else:
raiseTypeError("Expected bytes or text, but got %r"% (s,))
@overload
defsafe_encode(s:None)->None: ...
@overload
defsafe_encode(s:AnyStr)->bytes: ...
defsafe_encode(s:Optional[AnyStr])->Optional[bytes]:
"""Safely encode a binary string to Unicode."""
ifisinstance(s,str):
returns.encode(defenc)
elifisinstance(s,bytes):
returns
elifsisNone:
returnNone
else:
raiseTypeError("Expected bytes or text, but got %r"% (s,))
@overload
defwin_encode(s:None)->None: ...
@overload
defwin_encode(s:AnyStr)->bytes: ...
defwin_encode(s:Optional[AnyStr])->Optional[bytes]:
"""Encode Unicode strings for process arguments on Windows."""
ifisinstance(s,str):
returns.encode(locale.getpreferredencoding(False))
elifisinstance(s,bytes):
returns
elifsisnotNone:
raiseTypeError("Expected bytes or text, but got %r"% (s,))
returnNone