GitPython/git/compat.py at refs/heads/gix-backend · gitpython-developers/GitPython · GitHub

Repository navigation

History

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

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

Optional,

Tuple, # noqa: F401

Type, # noqa: F401

Union,

overload,

)

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

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 refs/heads/gix-backend · gitpython-developers/GitPython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

compat.py

Latest commit

History

Breadcrumbs

compat.py

File metadata and controls