From 7f7542fcbc192fef6e4939f4eb748e941a720b2c Mon Sep 17 00:00:00 2001 From: Adam Hupp Date: Mon, 4 Oct 2021 14:46:37 -0700 Subject: Support os.PathLike types See https://github.com/ahupp/python-magic/pull/251 --- magic/__init__.py | 17 +++++++++++++++++ magic/__init__.pyi | 5 +++-- 2 files changed, 20 insertions(+), 2 deletions(-) (limited to 'magic') diff --git a/magic/__init__.py b/magic/__init__.py index 363e88f..bab7c7b 100644 --- a/magic/__init__.py +++ b/magic/__init__.py @@ -100,6 +100,7 @@ class Magic: # if we're on python3, convert buf to bytes # otherwise this string is passed as wchar* # which is not what libmagic expects + # NEXTBREAK: only take bytes if type(buf) == str and str != bytes: buf = buf.encode('utf-8', errors='replace') return maybe_decode(magic_buffer(self.cookie, buf)) @@ -229,6 +230,7 @@ def errorcheck_negative_one(result, func, args): # return str on python3. Don't want to unconditionally # decode because that results in unicode on python2 def maybe_decode(s): + # NEXTBREAK: remove if str == bytes: return s else: @@ -237,13 +239,28 @@ def maybe_decode(s): return s.decode('utf-8', 'backslashreplace') +try: + from os import PathLike + def unpath(filename): + if isinstance(filename, PathLike): + return filename.__fspath__() + else: + return filename +except ImportError: + def unpath(filename): + return filename + def coerce_filename(filename): if filename is None: return None + + filename = unpath(filename) + # ctypes will implicitly convert unicode strings to bytes with # .encode('ascii'). If you use the filesystem encoding # then you'll get inconsistent behavior (crashes) depending on the user's # LANG environment variable + # NEXTBREAK: remove is_unicode = (sys.version_info[0] <= 2 and isinstance(filename, unicode)) or \ (sys.version_info[0] >= 3 and diff --git a/magic/__init__.pyi b/magic/__init__.pyi index 8d5f38f..b6b5489 100644 --- a/magic/__init__.pyi +++ b/magic/__init__.pyi @@ -1,6 +1,7 @@ import ctypes.util import threading from typing import Any, Text, Optional, Union +from os import PathLike class MagicException(Exception): message: Any = ... @@ -12,13 +13,13 @@ class Magic: lock: threading.Lock = ... def __init__(self, mime: bool = ..., magic_file: Optional[Any] = ..., mime_encoding: bool = ..., keep_going: bool = ..., uncompress: bool = ..., raw: bool = ...) -> None: ... def from_buffer(self, buf: Union[bytes, str]) -> Text: ... - def from_file(self, filename: Union[bytes, str]) -> Text: ... + def from_file(self, filename: Union[bytes, str, PathLike]) -> Text: ... def from_descriptor(self, fd: int, mime: bool = ...) -> Text: ... def setparam(self, param: Any, val: Any): ... def getparam(self, param: Any): ... def __del__(self) -> None: ... -def from_file(filename: Union[bytes, str], mime: bool = ...) -> Text: ... +def from_file(filename: Union[bytes, str, PathLike], mime: bool = ...) -> Text: ... def from_buffer(buffer: Union[bytes, str], mime: bool = ...) -> Text: ... def from_descriptor(fd: int, mime: bool = ...) -> Text: ... -- cgit v1.2.1