How to Declare Python Source Code Encoding Correctly?

How to Declare Python Source Code Encoding Correctly

Python source code encoding is specified in the first or second line of the script using the following syntax:

# -*- coding: <encoding-name> -*-

The encoding-name can be any valid encoding supported by Python.

Early Python versions required the specific term coding in the comment, as seen in the original syntax:

# -*- coding: <encoding-name> -*-

However, later versions of Python allow for more flexibility in the comment prefix. According to the Python documentation, any of the following prefixes are acceptable:

• coding
• encoding

Therefore, both of the following are valid ways to declare the source code encoding:

# -*- coding: utf-8 -*-
# -*- encoding: utf-8 -*-

It's important to choose a consistent style and stick to it within your project to avoid confusion. When specifying the encoding, it's recommended to use the recommended forms:

# -*- coding: <encoding-name> -*-
# vim: fileencoding=

These forms are recognized by various editing software and ensure compatibility with the Python interpreter.

The above is the detailed content of How to Declare Python Source Code Encoding Correctly?. For more information, please follow other related articles on the PHP Chinese website!