[Python-checkins] commit of r41397 - peps/trunk

marc-andre.lemburg@python.org marc-andre.lemburg at python.org
Fri Nov 4 10:42:53 CET 2005


Author: marc-andre.lemburg
Date: Fri Nov  4 10:42:51 2005
New Revision: 41397

Modified:
   peps/trunk/pep-0263.txt
Log:
Add examples section to help users reading the PEP due to a parser
error which pointed them to the text.



Modified: peps/trunk/pep-0263.txt
==============================================================================
--- peps/trunk/pep-0263.txt	(original)
+++ peps/trunk/pep-0263.txt	Fri Nov  4 10:42:51 2005
@@ -67,6 +67,75 @@
     magic encoding comment, the only allowed encoding for the comment
     is 'utf-8'.  Any other encoding will cause an error.
 
+Examples
+
+    These are some examples to clarify the different styles for
+    defining the source code encoding at the top of a Python source
+    file:
+
+    1. With interpreter binary and using Emacs style file encoding
+       comment:
+
+          #!/usr/bin/python
+          # -*- coding: latin-1 -*-
+          import os, sys
+          ...
+
+          #!/usr/bin/python
+          # -*- coding: iso-8859-15 -*-
+          import os, sys
+          ...
+
+          #!/usr/bin/python
+          # -*- coding: ascii -*-
+          import os, sys
+          ...
+
+    2. Without interpreter line, using plain text:
+
+          # This Python file uses the following encoding: utf-8
+          import os, sys
+          ...
+
+    3. Text editors might have different ways of defining the file's
+       encoding, e.g.
+
+          #!/usr/local/bin/python
+          # coding: latin-1
+          import os, sys
+          ...
+
+    4. Without encoding comment, Python's parser will assume ASCII
+       text:
+
+          #!/usr/local/bin/python
+          import os, sys
+          ...
+
+    3. Encoding comments which don't work:
+
+       Missing "coding:" prefix:
+
+          #!/usr/local/bin/python
+          # latin-1
+          import os, sys
+          ...
+
+       Encoding comment not on line 1 or 2:
+
+          #!/usr/local/bin/python
+          #
+          # -*- coding: latin-1 -*-
+          import os, sys
+          ...
+
+       Unsupported encoding:
+
+          #!/usr/local/bin/python
+          # -*- coding: utf-42 -*-
+          import os, sys
+          ...
+
 Concepts
 
     The PEP is based on the following concepts which would have to be


More information about the Python-checkins mailing list