Stop raising generic RuntimeError on unexpected conditions

Instead, use InternalClientError (or its subclasses) consistently.

Author: elprans

asyncpg/exceptions/_base.py

@@ -222,7 +222,11 @@ def __init__(self, msg, *, detail=None, hint=None):
 
 
 class InternalClientError(Exception):
-    pass
+    """All unexpected errors not classified otherwise."""
+
+
+class ProtocolError(InternalClientError):
+    """Unexpected condition in the handling of PostgreSQL protocol input."""
 
 
 class OutdatedSchemaCacheError(InternalClientError):

asyncpg/protocol/buffer.pyx

@@ -8,10 +8,13 @@
 from cpython cimport Py_buffer
 from libc.string cimport memcpy
 
+from asyncpg import exceptions
 
-class BufferError(Exception):
+
+class BufferError(exceptions.InternalClientError):
     pass
 
+
 @cython.no_gc_clear
 @cython.final
 @cython.freelist(_MEMORY_FREELIST_SIZE)
@@ -49,7 +52,7 @@ cdef class WriteBuffer:
             self._size = 0
 
         if self._view_count:
-            raise RuntimeError(
+            raise BufferError(
                 'Deallocating buffer with attached memoryviews')
 
     def __getbuffer__(self, Py_buffer *buffer, int flags):
@@ -292,7 +295,7 @@ cdef class ReadBuffer:
 
         if ASYNCPG_DEBUG:
             if self._len0 < 1:
-                raise RuntimeError(
+                raise BufferError(
                     'debug: second buffer of ReadBuffer is empty')
 
     cdef inline const char* _try_read_bytes(self, ssize_t nbytes):
@@ -381,7 +384,7 @@ cdef class ReadBuffer:
 
         if ASYNCPG_DEBUG:
             if not self._buf0:
-                raise RuntimeError(
+                raise BufferError(
                     'debug: first buffer of ReadBuffer is empty')
 
         self._ensure_first_buf()

asyncpg/protocol/codecs/array.pyx

@@ -7,6 +7,8 @@
 
 from collections.abc import Iterable as IterableABC, Sized as SizedABC
 
+from asyncpg import exceptions
+
 
 DEF ARRAY_MAXDIM = 6  # defined in postgresql/src/includes/c.h
 
@@ -285,7 +287,7 @@ cdef inline array_decode(ConnectionSettings settings, FastReadBuffer buf,
         return result
 
     if ndims > ARRAY_MAXDIM:
-        raise RuntimeError(
+        raise exceptions.ProtocolError(
             'number of array dimensions ({}) exceed the maximum expected ({})'.
             format(ndims, ARRAY_MAXDIM))
 
@@ -337,7 +339,8 @@ cdef _nested_array_decode(ConnectionSettings settings,
 
     if ASYNCPG_DEBUG:
         if ndims <= 0:
-            raise RuntimeError('unexpected ndims value: {}'.format(ndims))
+            raise exceptions.ProtocolError(
+                'unexpected ndims value: {}'.format(ndims))
 
     for i in range(ndims):
         array_len *= dims[i]
@@ -409,7 +412,7 @@ cdef textarray_decode(ConnectionSettings settings, FastReadBuffer buf,
         return _textarray_decode(
             settings, array_text, decoder, decoder_arg, typdelim)
     except ValueError as e:
-        raise ValueError(
+        raise exceptions.ProtocolError(
             'malformed array literal {!r}: {}'.format(s, e.args[0]))
     finally:
         PyMem_Free(array_text)
@@ -845,7 +848,8 @@ cdef arraytext_decode(ConnectionSettings settings, FastReadBuffer buf):
 cdef anyarray_decode(ConnectionSettings settings, FastReadBuffer buf):
     # Instances of anyarray (or any other polymorphic pseudotype) are
     # never supposed to be returned from actual queries.
-    raise RuntimeError('unexpected instance of \'anyarray\' type')
+    raise exceptions.ProtocolError(
+        'unexpected instance of \'anyarray\' type')
 
 
 cdef init_array_codecs():

asyncpg/protocol/codecs/base.pyx

@@ -5,7 +5,7 @@
 # the Apache 2.0 License: http://www.apache.org/licenses/LICENSE-2.0
 
 
-from asyncpg.exceptions import OutdatedSchemaCacheError
+from asyncpg import exceptions
 
 
 cdef void* binary_codec_map[(MAXSUPPORTEDOID + 1) * 2]
@@ -62,14 +62,14 @@ cdef class Codec:
                 self.decoder = <codec_decode_func>&self.decode_array_text
         elif type == CODEC_RANGE:
             if format != PG_FORMAT_BINARY:
-                raise RuntimeError(
+                raise NotImplementedError(
                     'cannot encode type "{}"."{}": text encoding of '
                     'range types is not supported'.format(schema, name))
             self.encoder = <codec_encode_func>&self.encode_range
             self.decoder = <codec_decode_func>&self.decode_range
         elif type == CODEC_COMPOSITE:
             if format != PG_FORMAT_BINARY:
-                raise RuntimeError(
+                raise NotImplementedError(
                     'cannot encode type "{}"."{}": text encoding of '
                     'composite types is not supported'.format(schema, name))
             self.encoder = <codec_encode_func>&self.encode_composite
@@ -78,7 +78,8 @@ cdef class Codec:
             self.encoder = <codec_encode_func>&self.encode_in_python
             self.decoder = <codec_decode_func>&self.decode_in_python
         else:
-            raise RuntimeError('unexpected codec type: {}'.format(type))
+            raise exceptions.InternalClientError(
+                'unexpected codec type: {}'.format(type))
 
     cdef Codec copy(self):
         cdef Codec codec
@@ -150,12 +151,12 @@ cdef class Codec:
             elif self.format == PG_FORMAT_TEXT:
                 text_encode(settings, buf, data)
             else:
-                raise RuntimeError(
+                raise exceptions.InternalClientError(
                     'unexpected data format: {}'.format(self.format))
         elif self.xformat == PG_XFORMAT_TUPLE:
             self.c_encoder(settings, buf, data)
         else:
-            raise RuntimeError(
+            raise exceptions.InternalClientError(
                 'unexpected exchange format: {}'.format(self.xformat))
 
     cdef encode(self, ConnectionSettings settings, WriteBuffer buf,
@@ -193,7 +194,7 @@ cdef class Codec:
 
         elem_count = <ssize_t><uint32_t>hton.unpack_int32(buf.read(4))
         if elem_count != len(self.element_type_oids):
-            raise OutdatedSchemaCacheError(
+            raise exceptions.OutdatedSchemaCacheError(
                 'unexpected number of attributes of composite type: '
                 '{}, expected {}'
                     .format(
@@ -209,7 +210,7 @@ cdef class Codec:
             received_elem_typ = <uint32_t>hton.unpack_int32(buf.read(4))
 
             if received_elem_typ != elem_typ:
-                raise OutdatedSchemaCacheError(
+                raise exceptions.OutdatedSchemaCacheError(
                     'unexpected data type of composite type attribute {}: '
                     '{!r}, expected {!r}'
                         .format(
@@ -243,12 +244,12 @@ cdef class Codec:
             elif self.format == PG_FORMAT_TEXT:
                 data = text_decode(settings, buf)
             else:
-                raise RuntimeError(
+                raise exceptions.InternalClientError(
                     'unexpected data format: {}'.format(self.format))
         elif self.xformat == PG_XFORMAT_TUPLE:
             data = self.c_decoder(settings, buf)
         else:
-            raise RuntimeError(
+            raise exceptions.InternalClientError(
                 'unexpected exchange format: {}'.format(self.xformat))
 
         return self.py_decoder(data)
@@ -455,7 +456,7 @@ cdef class DataCodecConfig:
 
             elif ti['kind'] == b'c':
                 if not comp_type_attrs:
-                    raise RuntimeError(
+                    raise exceptions.InternalClientError(
                         'type record missing field types for '
                         'composite {}'.format(oid))
 
@@ -469,7 +470,7 @@ cdef class DataCodecConfig:
                         elem_codec = self.get_codec(typoid, PG_FORMAT_TEXT)
                         has_text_elements = True
                     if elem_codec is None:
-                        raise RuntimeError(
+                        raise exceptions.InternalClientError(
                             'no codec for composite attribute type {}'.format(
                                 typoid))
                     comp_elem_codecs.append(elem_codec)
@@ -490,7 +491,7 @@ cdef class DataCodecConfig:
                 # Domain type
 
                 if not base_type:
-                    raise RuntimeError(
+                    raise exceptions.InternalClientError(
                         'type record missing base type for domain {}'.format(
                             oid))
 
@@ -506,7 +507,7 @@ cdef class DataCodecConfig:
                 # Range type
 
                 if not range_subtype_oid:
-                    raise RuntimeError(
+                    raise exceptions.InternalClientError(
                         'type record missing base type for range {}'.format(
                             oid))
 
@@ -542,7 +543,7 @@ cdef class DataCodecConfig:
         if xformat == PG_XFORMAT_TUPLE:
             core_codec = get_any_core_codec(oid, format, xformat)
             if core_codec is None:
-                raise ValueError(
+                raise exceptions.InterfaceError(
                     "{} type does not support 'tuple' exchange format".format(
                         typename))
             c_encoder = core_codec.c_encoder
@@ -593,7 +594,8 @@ cdef class DataCodecConfig:
             self._custom_type_codecs[typeoid] = codec
             break
         else:
-            raise ValueError('unknown alias target: {}'.format(alias_to))
+            raise exceptions.InterfaceError(
+                'invalid builtin codec reference: {}'.format(alias_to))
 
     def set_builtin_type_codec(self, typeoid, typename, typeschema, typekind,
                                alias_to, format=PG_FORMAT_ANY):
@@ -707,7 +709,7 @@ cdef register_core_codec(uint32_t oid,
                          ClientExchangeFormat xformat=PG_XFORMAT_OBJECT):
 
     if oid > MAXSUPPORTEDOID:
-        raise RuntimeError(
+        raise exceptions.InternalClientError(
             'cannot register core codec for OID {}: it is greater '
             'than MAXSUPPORTEDOID ({})'.format(oid, MAXSUPPORTEDOID))
 
@@ -729,7 +731,8 @@ cdef register_core_codec(uint32_t oid,
     elif format == PG_FORMAT_TEXT:
         text_codec_map[oid * xformat] = <void*>codec
     else:
-        raise RuntimeError('invalid data format: {}'.format(format))
+        raise exceptions.InternalClientError(
+            'invalid data format: {}'.format(format))
 
 
 cdef register_extra_codec(str name,

asyncpg/protocol/codecs/record.pyx

@@ -5,6 +5,9 @@
 # the Apache 2.0 License: http://www.apache.org/licenses/LICENSE-2.0
 
 
+from asyncpg import exceptions
+
+
 cdef inline record_encode_frame(ConnectionSettings settings, WriteBuffer buf,
                                 WriteBuffer elem_data, int32_t elem_count):
     buf.write_int32(4 + elem_data.len())
@@ -36,7 +39,7 @@ cdef anonymous_record_decode(ConnectionSettings settings, FastReadBuffer buf):
         else:
             elem_codec = settings.get_data_codec(elem_typ)
             if elem_codec is None or not elem_codec.has_decoder():
-                raise RuntimeError(
+                raise exceptions.InternalClientError(
                     'no decoder for composite type element in '
                     'position {} of type OID {}'.format(i, elem_typ))
             elem = elem_codec.decode(settings,

asyncpg/protocol/coreproto.pyx

@@ -113,7 +113,7 @@ cdef class CoreProtocol:
                         # Sync point, self to push the result
                         if self.result_type != RESULT_FAILED:
                             self.result_type = RESULT_FAILED
-                            self.result = RuntimeError(
+                            self.result = apg_exc.InternalClientError(
                                 'unknown error in protocol implementation')
 
                         self._push_result()

asyncpg/protocol/prepared_stmt.pyx

@@ -30,7 +30,8 @@ cdef class PreparedStatementState:
         for oid in self.parameters_desc:
             codec = self.settings.get_data_codec(oid)
             if codec is None:
-                raise RuntimeError
+                raise exceptions.InternalClientError(
+                    'missing codec information for OID {}'.format(oid))
             result.append(apg_types.Type(
                 oid, codec.name, codec.kind, codec.schema))
 
@@ -49,7 +50,8 @@ cdef class PreparedStatementState:
 
             codec = self.settings.get_data_codec(oid)
             if codec is None:
-                raise RuntimeError
+                raise exceptions.InternalClientError(
+                    'missing codec information for OID {}'.format(oid))
 
             name = name.decode(self.settings._encoding)
 
@@ -199,7 +201,8 @@ cdef class PreparedStatementState:
             oid = row[3]
             codec = self.settings.get_data_codec(oid)
             if codec is None or not codec.has_decoder():
-                raise RuntimeError('no decoder for OID {}'.format(oid))
+                raise exceptions.InternalClientError(
+                    'no decoder for OID {}'.format(oid))
             if not codec.is_binary():
                 self.have_text_cols = True
 
@@ -223,7 +226,8 @@ cdef class PreparedStatementState:
             p_oid = self.parameters_desc[i]
             codec = self.settings.get_data_codec(p_oid)
             if codec is None or not codec.has_encoder():
-                raise RuntimeError('no encoder for OID {}'.format(p_oid))
+                raise exceptions.InternalClientError(
+                    'no encoder for OID {}'.format(p_oid))
             if codec.type not in {}:
                 self.have_text_args = True
 
@@ -257,16 +261,11 @@ cdef class PreparedStatementState:
         fnum = hton.unpack_int16(rbuf.read(2))
 
         if fnum != self.cols_num:
-            raise RuntimeError(
-                'number of columns in result ({}) is '
+            raise exceptions.ProtocolError(
+                'the number of columns in the result row ({}) is '
                 'different from what was described ({})'.format(
                     fnum, self.cols_num))
 
-        if rows_codecs is None or len(rows_codecs) < fnum:
-            if fnum > 0:
-                # It's OK to have no rows_codecs for empty records
-                raise RuntimeError('invalid rows_codecs')
-
         dec_row = record.ApgRecord_New(self.cols_desc, fnum)
         for i in range(fnum):
             flen = hton.unpack_int32(rbuf.read(4))