GitPython/git/compat.py at main · MatrixMike/GitPython · GitHub

Repository navigation

History

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

# 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.

"""

import locale

import os

import sys

import warnings

from gitdb.utils.encoding import force_bytes, force_text # noqa: F401

# typing --------------------------------------------------------------------

from typing import (

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]

except KeyError:

raise AttributeError(f"module {__name__!r} has no attribute {name!r}") from None

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,

)

return value

if not TYPE_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

def safe_decode(s: None) -> None: ...

@overload

def safe_decode(s: AnyStr) -> str: ...

def safe_decode(s: Union[AnyStr, None]) -> Optional[str]:

"""Safely decode a binary string to Unicode."""

if isinstance(s, str):

return s

elif isinstance(s, bytes):

return s.decode(defenc, "surrogateescape")

elif s is None:

return None

else:

raise TypeError("Expected bytes or text, but got %r" % (s,))

@overload

def safe_encode(s: None) -> None: ...

@overload

def safe_encode(s: AnyStr) -> bytes: ...

def safe_encode(s: Optional[AnyStr]) -> Optional[bytes]:

"""Safely encode a binary string to Unicode."""

if isinstance(s, str):

return s.encode(defenc)

elif isinstance(s, bytes):

return s

elif s is None:

return None

else:

raise TypeError("Expected bytes or text, but got %r" % (s,))

@overload

def win_encode(s: None) -> None: ...

@overload

def win_encode(s: AnyStr) -> bytes: ...

def win_encode(s: Optional[AnyStr]) -> Optional[bytes]:

"""Encode Unicode strings for process arguments on Windows."""

if isinstance(s, str):

return s.encode(locale.getpreferredencoding(False))

elif isinstance(s, bytes):

return s

elif s is not None:

raise TypeError("Expected bytes or text, but got %r" % (s,))

return None

GitPython/git/compat.py at main · MatrixMike/GitPython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

compat.py

Latest commit

History

Breadcrumbs

compat.py

File metadata and controls