Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

[1.2.X] Fixed #6073 -- Made compilemessages 18n management command re…

…ject PO files with BOM.

Backport of [14125] from trunk

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 46812b4c2bdbfd791af18be066a2fa60718a3a97 1 parent fee4aa3
@ramiro ramiro authored
19 django/core/management/commands/
@@ -1,9 +1,17 @@
+import codecs
import os
import sys
from optparse import make_option
from import BaseCommand, CommandError
-def compile_messages(locale=None):
+def has_bom(fn):
+ f = open(fn, 'r')
+ sample =
+ return sample[:3] == '\xef\xbb\xbf' or \
+ sample.startswith(codecs.BOM_UTF16_LE) or \
+ sample.startswith(codecs.BOM_UTF16_BE)
+def compile_messages(stderr, locale=None):
basedirs = [os.path.join('conf', 'locale'), 'locale']
if os.environ.get('DJANGO_SETTINGS_MODULE'):
from django.conf import settings
@@ -21,8 +29,11 @@ def compile_messages(locale=None):
for dirpath, dirnames, filenames in os.walk(basedir):
for f in filenames:
if f.endswith('.po'):
- sys.stderr.write('processing file %s in %s\n' % (f, dirpath))
- pf = os.path.splitext(os.path.join(dirpath, f))[0]
+ stderr.write('processing file %s in %s\n' % (f, dirpath))
+ fn = os.path.join(dirpath, f)
+ if has_bom(fn):
+ raise CommandError("The %s file has a BOM (Byte Order Mark). Django only supports .po files encoded in UTF-8 and without any BOM." % fn)
+ pf = os.path.splitext(fn)[0]
# Store the names of the .mo and .po files in an environment
# variable, rather than doing a string replacement into the
# command, so that we can take advantage of shell quoting, to
@@ -49,4 +60,4 @@ class Command(BaseCommand):
def handle(self, **options):
locale = options.get('locale')
- compile_messages(locale)
+ compile_messages(self.stderr, locale=locale)
6 docs/topics/i18n/localization.txt
@@ -188,6 +188,12 @@ That's it. Your translations are ready for use.
``django-admin compilemessages`` works see :ref:`gettext_on_windows` for more
+.. admonition:: .po files: Encoding and BOM usage.
+ Django only supports ``.po`` files encoded in UTF-8 and without any BOM
+ (Byte Order Mark) so if your text editor adds such marks to the beginning of
+ files by default then you will need to reconfigure it.
.. _creating-message-files-from-js-code:
Creating message files from JavaScript source code
3  tests/regressiontests/makemessages/
@@ -38,3 +38,6 @@ def find_command(cmd, path=None, pathext=None):
if xversion >= (0, 15):
from extraction import *
del p
+if find_command('msgfmt'):
+ from compilation import *
Please sign in to comment.
Something went wrong with that request. Please try again.