Moved Cloudant argument messages to _messages.py

- Updated error messages in _messages.py and test cases for consistency
- Added CloudantViewException to error.py
- Moved view exception messages to _messages.py

Author: emlaver

src/cloudant/_common_util.py

@@ -174,33 +174,21 @@ def py_to_couch_validate(key, val):
     Validates the individual parameter key and value.
     """
     if key not in RESULT_ARG_TYPES:
-        msg = 'Invalid argument {0}'.format(key)
-        raise CloudantArgumentError(msg)
+        raise CloudantArgumentError(116, key)
     # pylint: disable=unidiomatic-typecheck
     # Validate argument values and ensure that a boolean is not passed in
     # if an integer is expected
     if (not isinstance(val, RESULT_ARG_TYPES[key]) or
             (type(val) is bool and int in RESULT_ARG_TYPES[key])):
-        msg = 'Argument {0} not instance of expected type: {1}'.format(
-            key,
-            RESULT_ARG_TYPES[key]
-        )
-        raise CloudantArgumentError(msg)
+        raise CloudantArgumentError(117, key, RESULT_ARG_TYPES[key])
     if key == 'keys':
         for key_list_val in val:
             if (not isinstance(key_list_val, RESULT_ARG_TYPES['key']) or
                     type(key_list_val) is bool):
-                msg = 'Key list element not of expected type: {0}'.format(
-                    RESULT_ARG_TYPES['key']
-                )
-                raise CloudantArgumentError(msg)
+                raise CloudantArgumentError(134, RESULT_ARG_TYPES['key'])
     if key == 'stale':
         if val not in ('ok', 'update_after'):
-            msg = (
-                'Invalid value for stale option {0} '
-                'must be ok or update_after'
-            ).format(val)
-            raise CloudantArgumentError(msg)
+            raise CloudantArgumentError(135, val)
 
 def _py_to_couch_translate(key, val):
     """
@@ -216,8 +204,7 @@ def _py_to_couch_translate(key, val):
             arg_converter = TYPE_CONVERTERS.get(type(val))
             return {key: arg_converter(val)}
     except Exception as ex:
-        msg = 'Error converting argument {0}: {1}'.format(key, ex)
-        raise CloudantArgumentError(msg)
+        raise CloudantArgumentError(136, key, ex)
 
 def type_or_none(typerefs, value):
     """

src/cloudant/_messages.py

@@ -16,19 +16,71 @@
 Module that contains exception messages for the Cloudant Python client
 library.
 """
+ARGUMENT_ERROR = {
+    100: 'A general Cloudant argument error was raised.',
+    # Client
+    101: 'Invalid year and/or month supplied.  Found: year - {0}, month - {1}',
+    # Database
+    102: 'Invalid role(s) provided: {0}.  Valid roles are: {1}',
+    103: 'Invalid index type: {0}.  Index type must be '
+         'either \"json\" or \"text\".',
+    104: 'A single query/q parameter is required.  Found: {0}',
+    105: 'Invalid argument: {0}',
+    106: 'Argument {0} is not an instance of expected type: {1}',
+    # Design document
+    107: 'View {0} already exists in this design doc.',
+    108: 'An index with name {0} already exists in this design doc.',
+    109: 'A list with name {0} already exists in this design doc.',
+    110: 'A show function with name {0} already exists in this design doc.',
+    111: 'View {0} does not exist in this design doc.',
+    112: 'An index with name {0} does not exist in this design doc.',
+    113: 'A list with name {0} does not exist in this design doc.',
+    114: 'A show function with name {0} does not exist in this design doc.',
+    # Feed
+    115: 'Error converting argument {0}: {1}',
+    116: 'Invalid argument {0}',
+    117: 'Argument {0} not instance of expected type: {1}',
+    118: 'Argument {0} must be > 0.  Found: {1}',
+    119: 'Invalid value ({0}) for feed option.  Must be one of {1}',
+    120: 'Invalid value ({0}) for style option.  Must be main_only, '
+         'or all_docs.',
+    121: 'Invalid infinite feed option: {0}.  Must be set to continuous.',
+    # Index
+    122: 'The design document id: {0} is not a string.',
+    123: 'The index name: {0} is not a string.',
+    124: '{0} provided as argument(s).  A JSON index requires that '
+         'only a \'fields\' argument is provided.',
+    125: 'Deleting an index requires a design document id be provided.',
+    126: 'Deleting an index requires an index name be provided.',
+    127: 'Invalid argument: {0}',
+    128: 'Argument {0} is not an instance of expected type: {1}',
+    # Query
+    129: 'Invalid argument: {0}',
+    130: 'Argument {0} is not an instance of expected type: {1}',
+    131: 'No selector in the query or the selector was empty.  '
+         'Add a selector to define the query and retry.',
+    # View
+    132: 'The map property must be a dictionary.',
+    133: 'The reduce property must be a string.',
+    # Common_util
+    134: 'Key list element not of expected type: {0}',
+    135: 'Invalid value for stale option {0} must be ok or update_after.',
+    136: 'Error converting argument {0}: {1}'
+}
+
 CLIENT = {
     100: 'A general Cloudant client exception was raised.',
-    101: 'Value must be set to a Database object. Found type: {0}.',
+    101: 'Value must be set to a Database object. Found type: {0}',
     102: 'You must provide a url or an account.',
     404: 'Database {0} does not exist. Verify that the client is valid and try again.',
     409: 'Database {0} already exists.'
 }
 
 DATABASE = {
     100: 'A general Cloudant database exception was raised.',
-    101: 'Unexpected index type. Found: {0}.',
+    101: 'Unexpected index type. Found: {0}',
     400: 'Invalid database name during creation. Found: {0}',
-    401: 'Unauthorized to create database {0}.',
+    401: 'Unauthorized to create database {0}',
     409: 'Document with id {0} already exists.'
 }
 
@@ -74,7 +126,16 @@
 RESULT = {
     100: 'A general result exception was raised.',
     101: 'Failed to interpret the argument {0} as a valid key value or as a valid slice.',
-    102: 'Cannot use {0} when performing key access or key slicing. Found {1}.',
-    103: 'Cannot use {0} for iteration. Found {1}.',
+    102: 'Cannot use {0} when performing key access or key slicing. Found {1}',
+    103: 'Cannot use {0} for iteration. Found {1}',
     104: 'Invalid page_size: {0}'
 }
+
+VIEW = {
+    100: 'A general view exception was raised.',
+    101: 'A QueryIndexView is not callable.  If you wish to execute a query '
+         'use the database \'get_query_result\' convenience method.',
+    102: 'Cannot create a custom result context manager using a '
+         'QueryIndexView.  If you wish to execute a query use the '
+         'database \'get_query_result\' convenience method instead.'
+}

src/cloudant/client.py

@@ -549,9 +549,7 @@ def _usage_endpoint(self, endpoint, year=None, month=None):
                 err = True
 
         if err:
-            msg = ('Invalid year and/or month supplied.  '
-                   'Found: year - {0}, month - {1}').format(year, month)
-            raise CloudantArgumentError(msg)
+            raise CloudantArgumentError(101, year, month)
         else:
             resp.raise_for_status()
             return resp.json()

src/cloudant/database.py

@@ -986,10 +986,7 @@ def share_database(self, username, roles=None):
             perms = list(set(roles))
 
         if not perms:
-            msg = (
-                'Invalid role(s) provided: {0}.  Valid roles are: {1}.'
-            ).format(roles, valid_roles)
-            raise CloudantArgumentError(msg)
+            raise CloudantArgumentError(102, roles, valid_roles)
 
         data[username] = perms
         doc['cloudant'] = data
@@ -1131,11 +1128,7 @@ def create_query_index(
         elif index_type == TEXT_INDEX_TYPE:
             index = TextIndex(self, design_document_id, index_name, **kwargs)
         else:
-            msg = (
-                'Invalid index type: {0}.  '
-                'Index type must be either \"json\" or \"text\"'
-            ).format(index_type)
-            raise CloudantArgumentError(msg)
+            raise CloudantArgumentError(103, index_type)
         index.create()
         return index
 
@@ -1155,11 +1148,7 @@ def delete_query_index(self, design_document_id, index_type, index_name):
         elif index_type == TEXT_INDEX_TYPE:
             index = TextIndex(self, design_document_id, index_name)
         else:
-            msg = (
-                'Invalid index type: {0}.  '
-                'Index type must be either \"json\" or \"text\"'
-            ).format(index_type)
-            raise CloudantArgumentError(msg)
+            raise CloudantArgumentError(103, index_type)
         index.delete()
 
     def get_query_result(self, selector, fields=None, raw_result=False,
@@ -1346,20 +1335,14 @@ def get_search_result(self, ddoc_id, index_name, **query_params):
         param_query = query_params.get('query')
         # Either q or query parameter is required
         if bool(param_q) == bool(param_query):
-            raise CloudantArgumentError(
-                'A single query/q parameter is required. '
-                'Found: {0}'.format(query_params))
+            raise CloudantArgumentError(104, query_params)
 
         # Validate query arguments and values
         for key, val in iteritems_(query_params):
             if key not in list(SEARCH_INDEX_ARGS.keys()):
-                msg = 'Invalid argument: {0}'.format(key)
-                raise CloudantArgumentError(msg)
+                raise CloudantArgumentError(105, key)
             if not isinstance(val, SEARCH_INDEX_ARGS[key]):
-                msg = (
-                    'Argument {0} is not an instance of expected type: {1}'
-                ).format(key, SEARCH_INDEX_ARGS[key])
-                raise CloudantArgumentError(msg)
+                raise CloudantArgumentError(106, key, SEARCH_INDEX_ARGS[key])
         # Execute query search
         headers = {'Content-Type': 'application/json'}
         ddoc = DesignDocument(self, ddoc_id)

src/cloudant/design_document.py

@@ -282,8 +282,7 @@ def add_view(self, view_name, map_func, reduce_func=None, **kwargs):
         :param str reduce_func: Optional Javascript reduce function.
         """
         if self.get_view(view_name) is not None:
-            msg = "View {0} already exists in this design doc".format(view_name)
-            raise CloudantArgumentError(msg)
+            raise CloudantArgumentError(107, view_name)
         if self.get('language', None) == QUERY_LANGUAGE:
             raise CloudantDesignDocumentException(101)
 
@@ -300,9 +299,7 @@ def add_search_index(self, index_name, search_func, analyzer=None):
         :param analyzer: Optional analyzer for this search index.
         """
         if self.get_index(index_name) is not None:
-            msg = ('An index with name {0} already exists in this design doc'
-                   .format(index_name))
-            raise CloudantArgumentError(msg)
+            raise CloudantArgumentError(108, index_name)
         if analyzer is not None:
             search = {'index': codify(search_func), 'analyzer': analyzer}
         else:
@@ -319,9 +316,7 @@ def add_list_function(self, list_name, list_func):
         :param str list_func: Javascript list function.
         """
         if self.get_list_function(list_name) is not None:
-            msg = ('A list with name {0} already exists in this design doc'
-                   .format(list_name))
-            raise CloudantArgumentError(msg)
+            raise CloudantArgumentError(109, list_name)
 
         self.lists.__setitem__(list_name, codify(list_func))
 
@@ -334,9 +329,7 @@ def add_show_function(self, show_name, show_func):
         :param show_func: Javascript show function.
         """
         if self.get_show_function(show_name) is not None:
-            msg = ('A show function with name {0} already exists in this design doc'
-                   .format(show_name))
-            raise CloudantArgumentError(msg)
+            raise CloudantArgumentError(110, show_name)
 
         self.shows.__setitem__(show_name, show_func)
 
@@ -356,8 +349,7 @@ def update_view(self, view_name, map_func, reduce_func=None, **kwargs):
         """
         view = self.get_view(view_name)
         if view is None:
-            msg = "View {0} does not exist in this design doc".format(view_name)
-            raise CloudantArgumentError(msg)
+            raise CloudantArgumentError(111, view_name)
         if isinstance(view, QueryIndexView):
             raise CloudantDesignDocumentException(102)
 
@@ -375,9 +367,7 @@ def update_search_index(self, index_name, search_func, analyzer=None):
         """
         search = self.get_index(index_name)
         if search is None:
-            msg = ('An index with name {0} does not exist in this design doc'
-                   .format(index_name))
-            raise CloudantArgumentError(msg)
+            raise CloudantArgumentError(112, index_name)
         if analyzer is not None:
             search = {'index': codify(search_func), 'analyzer': analyzer}
         else:
@@ -394,9 +384,7 @@ def update_list_function(self, list_name, list_func):
         :param str list_func: Javascript list function.
         """
         if self.get_list_function(list_name) is None:
-            msg = ('A list with name {0} does not exist in this design doc'
-                   .format(list_name))
-            raise CloudantArgumentError(msg)
+            raise CloudantArgumentError(113, list_name)
 
         self.lists.__setitem__(list_name, codify(list_func))
 
@@ -409,9 +397,7 @@ def update_show_function(self, show_name, show_func):
         :param show_func: Javascript show function.
         """
         if self.get_show_function(show_name) is None:
-            msg = ('A show function with name {0} does not exist in this design doc'
-                   .format(show_name))
-            raise CloudantArgumentError(msg)
+            raise CloudantArgumentError(114, show_name)
 
         self.shows.__setitem__(show_name, show_func)
 

src/cloudant/error.py

@@ -17,15 +17,16 @@
 library.
 """
 from cloudant._messages import (
+    ARGUMENT_ERROR,
     CLIENT,
     DATABASE,
     DESIGN_DOCUMENT,
     DOCUMENT,
     FEED,
     INDEX,
     REPLICATOR,
-    RESULT
-)
+    RESULT,
+    VIEW)
 
 class CloudantException(Exception):
     """
@@ -46,18 +47,21 @@ def __init__(self, msg, code=None):
 class CloudantArgumentError(CloudantException):
     """
     Provides a way to issue Cloudant Python client library specific exceptions
-    that pertain to invalid argument errors.  A CloudantArgumentError object is
-    instantiated with a message and optional code where the code defaults to
-    400.
+    that pertain to invalid argument errors.
 
     Note:  The intended use for this class is internal to the Cloudant Python
     client library.
 
-    :param str msg: A message that describes the exception.
     :param int code: An optional code value used to identify the exception.
-        Defaults to 400.
+        Defaults to 100.
+    :param args: A list of arguments used to format the exception message.
     """
-    def __init__(self, msg, code=400):
+    def __init__(self, code=100, *args):
+        try:
+            msg = ARGUMENT_ERROR[code].format(*args)
+        except (KeyError, IndexError):
+            code = 100
+            msg = ARGUMENT_ERROR[code]
         super(CloudantArgumentError, self).__init__(msg, code)
 
 class ResultException(CloudantException):
@@ -183,3 +187,18 @@ def __init__(self, code=100, *args):
             code = 100
             msg = REPLICATOR[code]
         super(CloudantReplicatorException, self).__init__(msg, code)
+
+class CloudantViewException(CloudantException):
+    """
+    Provides a way to issue Cloudant library view specific exceptions.
+
+    :param int code: A code value used to identify the view exception.
+    :param args: A list of arguments used to format the exception message.
+    """
+    def __init__(self, code=100, *args):
+        try:
+            msg = VIEW[code].format(*args)
+        except (KeyError, IndexError):
+            code = 100
+            msg = VIEW[code]
+        super(CloudantViewException, self).__init__(msg, code)