Should I use encoding declaration in Python 3?
Question:
Python 3 uses UTF-8 encoding for source-code files by default. Should I still use the encoding declaration at the beginning of every source file? Like # -*- coding: utf-8 -*-
Answers:
Because the default is UTF-8, you only need to use that declaration when you deviate from the default, or if you rely on other tools (like your IDE or text editor) to make use of that information.
In other words, as far as Python is concerned, only when you want to use an encoding that differs do you have to use that declaration.
Other tools, such as your editor, can support similar syntax, which is why the PEP 263 specification allows for considerable flexibility in the syntax (it must be a comment, the text coding must be there, followed by either a : or = character and optional whitespace, followed by a recognised codec).
Note that it only applies to how Python reads the source code. It doesn’t apply to executing that code, so not to how printing, opening files, or any other I/O operations translate between bytes and Unicode. For more details on Python, Unicode, and encodings, I strongly urge you to read the Python Unicode HOWTO, or the very thorough Pragmatic Unicode talk by Ned Batchelder.
No, if:
- entire project use only the
UTF-8, which is a default.
- and you’re sure your IDE tool doesn’t need that encoding declaration in each file.
Yes, if
- your project relies on different encoding
- or relies on many encodings.
For multi-encodings projects:
If some files are encoded in the non-utf-8, then even for these
encoded in UTF-8 you should add encoding declaration too, because
the golden rule is Explicit is better than implicit.
Reference:
- PyCharm doesn’t need that declaration:
configuring encoding for specific file in pycharm
- vim doesn’t need that declaration, but:
# vim: set fileencoding=<encoding name> :
Python 3 uses UTF-8 encoding for source-code files by default. Should I still use the encoding declaration at the beginning of every source file? Like # -*- coding: utf-8 -*-
Because the default is UTF-8, you only need to use that declaration when you deviate from the default, or if you rely on other tools (like your IDE or text editor) to make use of that information.
In other words, as far as Python is concerned, only when you want to use an encoding that differs do you have to use that declaration.
Other tools, such as your editor, can support similar syntax, which is why the PEP 263 specification allows for considerable flexibility in the syntax (it must be a comment, the text coding must be there, followed by either a : or = character and optional whitespace, followed by a recognised codec).
Note that it only applies to how Python reads the source code. It doesn’t apply to executing that code, so not to how printing, opening files, or any other I/O operations translate between bytes and Unicode. For more details on Python, Unicode, and encodings, I strongly urge you to read the Python Unicode HOWTO, or the very thorough Pragmatic Unicode talk by Ned Batchelder.
No, if:
- entire project use only the
UTF-8, which is a default. - and you’re sure your IDE tool doesn’t need that encoding declaration in each file.
Yes, if
- your project relies on different encoding
- or relies on many encodings.
For multi-encodings projects:
If some files are encoded in the
non-utf-8, then even for these
encoded inUTF-8you should add encoding declaration too, because
the golden rule isExplicit is better than implicit.
Reference:
- PyCharm doesn’t need that declaration:
configuring encoding for specific file in pycharm
- vim doesn’t need that declaration, but:
# vim: set fileencoding=<encoding name> :