Correct way to define Python source code encoding

by

Check the docs here:

“If a comment in the first or second line of the Python script matches the regular expression coding[=:]\s*([-\w.]+), this comment is processed as an encoding declaration”

“The recommended forms of this expression are

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

which is recognized also by GNU Emacs, and

# vim:fileencoding=<encoding-name>

which is recognized by Bram Moolenaar’s VIM.”

So, you can put pretty much anything before the “coding” part, but stick to “coding” (with no prefix) if you want to be 100% python-docs-recommendation-compatible.

More specifically, you need to use whatever is recognized by Python and the specific editing software you use (if it needs/accepts anything at all). E.g. the coding form is recognized (out of the box) by GNU Emacs but not Vim (yes, without a universal agreement, it’s essentially a turf war).

More Related Contents:

  1. How to determine the encoding of text?
  2. Changing default encoding of Python?
  3. UnicodeEncodeError: ‘charmap’ codec can’t encode – character maps to , print function [duplicate]
  4. Replace non-ASCII characters with a single space
  5. How can I percent-encode URL parameters in Python?
  6. Why does Python print unicode characters when the default encoding is ASCII?
  7. Character reading from file in Python
  8. Get a list of all the encodings Python can encode to
  9. How to convert a file to utf-8 in Python?
  10. How to print UTF-8 encoded text to the console in Python < 3?
  11. ‘UCS-2’ codec can’t encode characters in position 1050-1050
  12. How to write UTF-8 in a CSV file
  13. How to handle response encoding from urllib.request.urlopen() , to avoid TypeError: can’t use a string pattern on a bytes-like object
  14. Why doesn’t Python recognize my utf-8 encoded source file?
  15. UnicodeEncodeError: ‘ascii’ codec can’t encode character at special name [duplicate]
  16. Python email quoted-printable encoding problem
  17. Python 3: How to specify stdin encoding
  18. Python ascii utf unicode
  19. Scikit-learn’s LabelBinarizer vs. OneHotEncoder
  20. SyntaxError of Non-ASCII character [duplicate]
  21. Read a base 64 encoded image from memory using OpenCv python library
  22. Python unicode codepoint to unicode character
  23. UnicodeDecodeError: ‘ascii’ codec can’t decode byte 0xc3 in position 23: ordinal not in range(128)
  24. Why does this Python program send empty emails when I encode it with utf-8? [duplicate]
  25. How to detect string byte encoding?
  26. Switching to Python 3 causing UnicodeDecodeError
  27. Changing the “locale preferred encoding” in Python 3 in Windows
  28. Who originally invented this type of syntax: -*- coding: utf-8 -*- [duplicate]
  29. UnicodeDecodeError when performing os.walk
  30. Json Encoder AND Decoder for complex numpy arrays

Leave a Comment