Important

This documentation covers IPython versions 6.0 and higher. Beginning with version 6.0, IPython stopped supporting compatibility with Python versions lower than 3.3 including all versions of Python 2.7.

If you are looking for an IPython version compatible with Python 2.7, please use the IPython 5.x LTS release and refer to its documentation (LTS is the long term support release).

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

## 4 Functions¶

IPython.utils.openpy.source_to_unicode(txt, errors='replace', skip_encoding_cookie=True)

Converts a bytes string with python source code to unicode.

Unicode strings are passed through unchanged. Byte strings are checked for the python source file encoding cookie to determine encoding. txt can be either a bytes buffer or a string containing the source code.

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

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. 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. A unicode string containing the contents of the file.