utils.openpy

Module: utils.openpy

Tools to open .py files as Unicode, using the encoding specified within the file, as per PEP 263.

Much of the code is taken from the tokenize module in Python 3.2.

Functions

IPython.utils.openpy.read_py_file(filename, skip_encoding_cookie=True)

Read a Python file, using the encoding declared inside the file.

Parameters :

filename : str

The path to the file to read.

skip_encoding_cookie : bool

If True (the default), and the encoding declaration is found in the first two lines, that line will be excluded from the output - compiling a unicode string with an encoding declaration is a SyntaxError in Python 2.

Returns :

A unicode string containing the contents of the file. :

IPython.utils.openpy.read_py_url(url, errors='replace', skip_encoding_cookie=True)

Read a Python file from a URL, using the encoding declared inside the file.

Parameters :

url : str

The URL from which to fetch the file.

errors : str

How to handle decoding errors in the file. Options are the same as for bytes.decode(), but here ‘replace’ is the default.

skip_encoding_cookie : bool

If True (the default), and the encoding declaration is found in the first two lines, that line will be excluded from the output - compiling a unicode string with an encoding declaration is a SyntaxError in Python 2.

Returns :

A unicode string containing the contents of the file. :

IPython.utils.openpy.strip_encoding_cookie(filelike)

Generator to pull lines from a text-mode file, skipping the encoding cookie if it is found in the first two lines.