Viewing file:  encoding.py (1.51 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
import tokenize
from pathlib import Path
from prospector.exceptions import CouldNotHandleEncoding, PermissionMissing
# note: annotating return type with AnyStr does not work here for reasons I can't be bothered to work out
# mypy complains with 'Incompatible return value type (got "str", expected "bytes")'
def read_py_file(filepath: Path):
# see https://docs.python.org/3/library/tokenize.html#tokenize.detect_encoding
# first just see if the file is properly encoded
try:
with open(filepath, "rb") as bfile_:
tokenize.detect_encoding(bfile_.readline)
except PermissionError as err:
raise PermissionMissing(filepath) from err
except SyntaxError as err:
# this warning is issued:
# (1) in badly authored files (contains non-utf8 in a comment line)
# (2) a coding is specified, but wrong and
# (3) no coding is specified, and the default
# 'utf-8' fails to decode.
# (4) the encoding specified by a pep263 declaration did not match
# with the encoding detected by inspecting the BOM
raise CouldNotHandleEncoding(filepath) from err
try:
with tokenize.open(filepath) as file_:
return file_.read()
# this warning is issued:
# (1) if utf-8 is specified, but latin1 is used with something like \x0e9 appearing
# (see http://stackoverflow.com/a/5552623)
except UnicodeDecodeError as err:
raise CouldNotHandleEncoding(filepath) from err
|