GitPython/git/compat.py at main · Python-Repository-Hub/GitPython · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

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

import locale

import os

import sys

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

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

from typing import ( # noqa: F401

Any,

AnyStr,

Dict,

IO,

Optional,

Tuple,

Type,

Union,

overload,

)

# ---------------------------------------------------------------------------

# DEPRECATED attributes providing shortcuts to operating system checks based on os.name.

# These are deprecated because it is clearer, and helps avoid bugs, to write out the

# os.name or sys.platform checks explicitly, especially in cases where it matters which

# is used. For example, is_win is False on Cygwin, but is often assumed True. To detect

# Cygwin, use sys.platform == "cygwin". (Also, in the past, is_darwin was unreliable.)

is_win = os.name == "nt"

is_posix = os.name == "posix"

is_darwin = sys.platform == "darwin"

defenc = sys.getfilesystemencoding()

@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 · Python-Repository-Hub/GitPython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

compat.py

Latest commit

History

Breadcrumbs

compat.py

File metadata and controls