Add i18n and exception common files

Change-Id: I7c1fba8a061e1243448aa89c258c27931440809d

nimble/common/exception.py

@@ -0,0 +1,116 @@
+# Copyright 2016 Huawei Technologies Co.,LTD.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+"""Nimble base exception handling.
+
+SHOULD include dedicated exception logging.
+
+"""
+
+from oslo_log import log as logging
+import six
+from six.moves import http_client
+
+from nimble.common.i18n import _
+from nimble.common.i18n import _LE
+from nimble.conf import CONF
+
+LOG = logging.getLogger(__name__)
+
+
+class NimbleException(Exception):
+    """Base Nimble Exception
+
+    To correctly use this class, inherit from it and define
+    a '_msg_fmt' property. That message will get printf'd
+    with the keyword arguments provided to the constructor.
+
+    If you need to access the message from an exception you should use
+    six.text_type(exc)
+
+    """
+    _msg_fmt = _("An unknown exception occurred.")
+    code = http_client.INTERNAL_SERVER_ERROR
+    headers = {}
+    safe = False
+
+    def __init__(self, message=None, **kwargs):
+        self.kwargs = kwargs
+
+        if 'code' not in self.kwargs:
+            try:
+                self.kwargs['code'] = self.code
+            except AttributeError:
+                pass
+
+        if not message:
+            try:
+                message = self._msg_fmt % kwargs
+
+            except Exception as e:
+                # kwargs doesn't match a variable in self._msg_fmt
+                # log the issue and the kwargs
+                LOG.exception(_LE('Exception in string format operation'))
+                for name, value in kwargs.items():
+                    LOG.error("%s: %s" % (name, value))
+
+                if CONF.fatal_exception_format_errors:
+                    raise e
+                else:
+                    # at least get the core self._msg_fmt out if something
+                    # happened
+                    message = self._msg_fmt
+
+        super(NimbleException, self).__init__(message)
+
+    def __str__(self):
+        """Encode to utf-8 then wsme api can consume it as well."""
+        if not six.PY3:
+            return unicode(self.args[0]).encode('utf-8')
+
+        return self.args[0]
+
+    def __unicode__(self):
+        """Return a unicode representation of the exception message."""
+        return unicode(self.args[0])
+
+
+class NotAuthorized(NimbleException):
+    _msg_fmt = _("Not authorized.")
+    code = http_client.FORBIDDEN
+
+
+class OperationNotPermitted(NotAuthorized):
+    _msg_fmt = _("Operation not permitted.")
+
+
+class Invalid(NimbleException):
+    _msg_fmt = _("Unacceptable parameters.")
+    code = http_client.BAD_REQUEST
+
+
+class Conflict(NimbleException):
+    _msg_fmt = _('Conflict.')
+    code = http_client.CONFLICT
+
+
+class TemporaryFailure(NimbleException):
+    _msg_fmt = _("Resource temporarily unavailable, please retry.")
+    code = http_client.SERVICE_UNAVAILABLE
+
+
+class NotAcceptable(NimbleException):
+    _msg_fmt = _("Request not acceptable.")
+    code = http_client.NOT_ACCEPTABLE

nimble/common/i18n.py

@@ -0,0 +1,31 @@
+# Copyright 2016 Huawei Technologies Co.,LTD.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+import oslo_i18n as i18n
+
+_translators = i18n.TranslatorFactory(domain='nimble')
+
+# The primary translation function using the well-known name "_"
+_ = _translators.primary
+
+# Translators for log levels.
+#
+# The abbreviated names are meant to reflect the usual use of a short
+# name like '_'. The "L" is for "log" and the other letter comes from
+# the level.
+_LI = _translators.log_info
+_LW = _translators.log_warning
+_LE = _translators.log_error
+_LC = _translators.log_critical

tox.ini

@@ -62,3 +62,6 @@ show-source = True
 ignore = E123,E125
 builtins = _
 exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build
+
+[hacking]
+import_exceptions = nimble.common.i18n