Remove gettext.install() from nova/__init__.py

The gettext.install() function installs a builtin _() function which
translates a string in the translation domain supplied to the install()
function. If gettext.install() is called multiple times, it's the last
call to the function which wins and the last supplied translation domain
which is used e.g.

 >>> import os
 >>> os.environ['LANG'] = 'ja.UTF-8'
 >>> import gettext
 >>> gettext.install('keystone', unicode=1, localedir='/opt/stack/keystone/keystone/locale')
 >>> print _('Invalid syslog facility')
 無効な syslog ファシリティ
 >>> gettext.install('nova', unicode=1, localedir='/opt/stack/nova/nova/locale')
 >>> print _('Invalid syslog facility')
 Invalid syslog facility

Usually this function is called early on in a toplevel script and we
assume that no other code will call it and override the installed _().
However, in Nova, we have taken a shortcut to avoid having to call it
explicitly from each script and instead call it from nova/__init__.py.

This shortcut would be perfectly fine if we were absolutely sure that
nova modules would never be imported from another program. It's probably
quite incorrect for a program to use nova code (indeed, if we wanted to
support this, Nova code shouldn't use the default _() function) but
nevertheless there are some corner cases where it happens. For example,
the keystoneclient auth_token middleware tries to import cfg from
nova.openstack.common and this in turn causes gettext.install('nova')
in other projects like glance or quantum.

To avoid any doubt here, let's just rip out the shortcut and always
call gettext.install() from the top-level script.

Change-Id: If4125d6bcbde63df95de129ac5c83b4a6d6f130a

bin/nova-all

@@ -30,6 +30,7 @@ continue attempting to launch the rest of the services.
 import eventlet
 eventlet.monkey_patch(os=False)
 
+import gettext
 import os
 import sys
 
@@ -40,6 +41,7 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(
 if os.path.exists(os.path.join(possible_topdir, "nova", "__init__.py")):
     sys.path.insert(0, possible_topdir)
 
+gettext.install('nova', unicode=1)
 
 from nova import config
 from nova.objectstore import s3server

bin/nova-api

@@ -26,6 +26,7 @@ Starts both the EC2 and OpenStack APIs in separate greenthreads.
 import eventlet
 eventlet.monkey_patch(os=False)
 
+import gettext
 import os
 import sys
 
@@ -36,6 +37,7 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(
 if os.path.exists(os.path.join(possible_topdir, "nova", "__init__.py")):
     sys.path.insert(0, possible_topdir)
 
+gettext.install('nova', unicode=1)
 
 from nova import config
 from nova.openstack.common import log as logging

bin/nova-api-ec2

@@ -22,6 +22,7 @@
 import eventlet
 eventlet.monkey_patch(os=False)
 
+import gettext
 import os
 import sys
 
@@ -31,6 +32,7 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(
 if os.path.exists(os.path.join(possible_topdir, "nova", "__init__.py")):
     sys.path.insert(0, possible_topdir)
 
+gettext.install('nova', unicode=1)
 
 from nova import config
 from nova.openstack.common import log as logging

bin/nova-api-metadata

@@ -22,6 +22,7 @@
 import eventlet
 eventlet.monkey_patch(os=False)
 
+import gettext
 import os
 import sys
 
@@ -31,6 +32,7 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(
 if os.path.exists(os.path.join(possible_topdir, "nova", "__init__.py")):
     sys.path.insert(0, possible_topdir)
 
+gettext.install('nova', unicode=1)
 
 from nova import config
 from nova.openstack.common import log as logging

bin/nova-api-os-compute

@@ -22,6 +22,7 @@
 import eventlet
 eventlet.monkey_patch(os=False)
 
+import gettext
 import os
 import sys
 
@@ -31,6 +32,7 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(
 if os.path.exists(os.path.join(possible_topdir, "nova", "__init__.py")):
     sys.path.insert(0, possible_topdir)
 
+gettext.install('nova', unicode=1)
 
 from nova import config
 from nova.openstack.common import log as logging

bin/nova-baremetal-deploy-helper

@@ -23,6 +23,7 @@ import eventlet
 if __name__ == '__main__':
     eventlet.monkey_patch()
 
+import gettext
 import os
 import sys
 import threading
@@ -36,6 +37,8 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
     sys.path.insert(0, possible_topdir)
 
+gettext.install('nova', unicode=1)
+
 import cgi
 import Queue
 import re

bin/nova-cells

@@ -21,6 +21,7 @@
 import eventlet
 eventlet.monkey_patch()
 
+import gettext
 import os
 import sys
 
@@ -34,6 +35,8 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
     sys.path.insert(0, possible_topdir)
 
+gettext.install('nova', unicode=1)
+
 from nova import config
 from nova.openstack.common import log as logging
 from nova import service

bin/nova-cert

@@ -20,6 +20,7 @@
 import eventlet
 eventlet.monkey_patch()
 
+import gettext
 import os
 import sys
 
@@ -33,6 +34,7 @@ POSSIBLE_TOPDIR = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(POSSIBLE_TOPDIR, 'nova', '__init__.py')):
     sys.path.insert(0, POSSIBLE_TOPDIR)
 
+gettext.install('nova', unicode=1)
 
 from nova import config
 from nova.openstack.common import log as logging

bin/nova-compute

@@ -29,6 +29,7 @@ if os.name == 'nt':
 else:
     eventlet.monkey_patch()
 
+import gettext
 import os
 import sys
 import traceback
@@ -43,6 +44,7 @@ POSSIBLE_TOPDIR = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(POSSIBLE_TOPDIR, 'nova', '__init__.py')):
     sys.path.insert(0, POSSIBLE_TOPDIR)
 
+gettext.install('nova', unicode=1)
 
 from nova import config
 import nova.db.api

bin/nova-conductor

@@ -20,6 +20,7 @@
 import eventlet
 eventlet.monkey_patch()
 
+import gettext
 import os
 import sys
 
@@ -33,6 +34,7 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
     sys.path.insert(0, possible_topdir)
 
+gettext.install('nova', unicode=1)
 
 from nova import config
 from nova.openstack.common import log as logging

bin/nova-console

@@ -21,6 +21,7 @@
 import eventlet
 eventlet.monkey_patch()
 
+import gettext
 import os
 import sys
 
@@ -34,6 +35,7 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
     sys.path.insert(0, possible_topdir)
 
+gettext.install('nova', unicode=1)
 
 from nova import config
 from nova.openstack.common import log as logging

bin/nova-consoleauth

@@ -21,6 +21,7 @@
 import eventlet
 eventlet.monkey_patch()
 
+import gettext
 import os
 import sys
 
@@ -32,6 +33,7 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
     sys.path.insert(0, possible_topdir)
 
+gettext.install('nova', unicode=1)
 
 from nova import config
 from nova.consoleauth import manager

bin/nova-network

@@ -22,6 +22,7 @@
 import eventlet
 eventlet.monkey_patch()
 
+import gettext
 import os
 import sys
 
@@ -35,6 +36,7 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
     sys.path.insert(0, possible_topdir)
 
+gettext.install('nova', unicode=1)
 
 from nova import config
 from nova.openstack.common import log as logging

bin/nova-novncproxy

@@ -21,11 +21,14 @@ Websocket proxy that is compatible with OpenStack Nova
 noVNC consoles. Leverages websockify.py by Joel Martin
 """
 
+import gettext
 import os
 import sys
 
 from oslo.config import cfg
 
+gettext.install('nova', unicode=1)
+
 from nova import config
 from nova.console import websocketproxy
 

bin/nova-objectstore

@@ -22,6 +22,7 @@
 import eventlet
 eventlet.monkey_patch()
 
+import gettext
 import os
 import sys
 
@@ -33,6 +34,7 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
     sys.path.insert(0, possible_topdir)
 
+gettext.install('nova', unicode=1)
 
 from nova import config
 from nova.objectstore import s3server

bin/nova-spicehtml5proxy

@@ -21,11 +21,14 @@ Websocket proxy that is compatible with OpenStack Nova
 SPICE HTML5 consoles. Leverages websockify.py by Joel Martin
 """
 
+import gettext
 import os
 import sys
 
 from oslo.config import cfg
 
+gettext.install('nova', unicode=1)
+
 from nova import config
 from nova.console import websocketproxy
 

bin/nova-xvpvncproxy

@@ -21,6 +21,7 @@
 import eventlet
 eventlet.monkey_patch()
 
+import gettext
 import os
 import sys
 
@@ -30,6 +31,7 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(possible_topdir, 'nova', '__init__.py')):
     sys.path.insert(0, possible_topdir)
 
+gettext.install('nova', unicode=1)
 
 from nova import config
 from nova.openstack.common import log as logging

doc/source/devref/il8n.rst

@@ -27,8 +27,7 @@ The ``_()`` function is brought into the global scope by doing::
     import gettext
     gettext.install("nova", unicode=1)
 
-In general, you shouldn't need to add these to any nova files, since the lines
-are present in ``nova/__init__.py``. However, if this code is missing, it may
-result in an error that looks like like::
+These lines are needed in any toplevel script before any nova modules are
+imported. If this code is missing, it may result in an error that looks like::
 
     NameError: name '_' is not defined

nova/__init__.py

@@ -24,8 +24,3 @@
    :platform: Unix
    :synopsis: Infrastructure-as-a-Service Cloud platform.
 """
-
-import gettext
-
-
-gettext.install('nova', unicode=1)

tools/hacking.py

@@ -21,6 +21,7 @@
 Built on top of pep8.py
 """
 
+import gettext
 import imp
 import inspect
 import logging
@@ -643,6 +644,7 @@ imports_on_separate_lines_N301_compliant = r"""
     """
 
 if __name__ == "__main__":
+    gettext.install('nova', unicode=1)
     #include nova path
     sys.path.append(os.getcwd())
     #Run once tests (not per line)