#------------------------------------------------------------------------------ # Copyright (c) 2020, 2022, Oracle and/or its affiliates. # # This software is dual-licensed to you under the Universal Permissive License # (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License # 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose # either license. # # If you elect to accept the software under the Apache License, Version 2.0, # the following applies: # # 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 # # https://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. #------------------------------------------------------------------------------ #------------------------------------------------------------------------------ # errors.py # # Contains the _Error class and all of the errors that are raised explicitly by # the package. Oracle Database errors and ODPI-C errors (when using thick mode) # are only referenced here if they are transformed into package specific # errors. #------------------------------------------------------------------------------ import re from . import exceptions class _Error: """ Error class which is used for all errors that are raised by the driver. """ def __init__(self, message: str=None, context: str=None, isrecoverable: bool=False, iswarning: bool=False, code: int=0, offset: int=0) -> None: self.message = message self.context = context self.isrecoverable = isrecoverable self.iswarning = iswarning self.code = code self.offset = offset self.is_session_dead = False self.full_code = "" self._make_adjustments() def _make_adjustments(self): """ Make adjustments to the error, if needed, and calculate the full_code attribute. """ if self.message is not None: pos = self.message.find(":") if pos > 0: self.full_code = self.message[:pos] if self.code != 0 or self.full_code.startswith("DPI-"): args = {} if self.code != 0: driver_error_info = ERR_ORACLE_ERROR_XREF.get(self.code) else: error_num = int(self.full_code[4:]) driver_error_info = ERR_DPI_ERROR_XREF.get(error_num) if driver_error_info is not None: if isinstance(driver_error_info, tuple): driver_error_num, pattern = driver_error_info args = re.search(pattern, self.message).groupdict() else: driver_error_num = driver_error_info if driver_error_num == ERR_CONNECTION_CLOSED: self.is_session_dead = True driver_error = _get_error_text(driver_error_num, **args) self.message = f"{driver_error}\n{self.message}" self.full_code = f"{ERR_PREFIX}-{driver_error_num:04}" def __str__(self): return self.message def _get_error_text(error_num: int, **args) -> str: """ Return the error text for the driver specific error number. """ message_format = ERR_MESSAGE_FORMATS.get(error_num) if message_format is None: message_format = "missing error {error_num}" args = dict(error_num=error_num) error_num = ERR_MISSING_ERROR message = message_format.format(**args) return f"{ERR_PREFIX}-{error_num:04}: {message}" def _raise_err(error_num: int, context_error_message: str=None, cause: Exception=None, **args) -> None: """ Raises a driver specific exception from the specified error number and supplied arguments. """ message = _get_error_text(error_num, **args) if context_error_message is not None: message = f"{message}\n{context_error_message}" exc_type = ERR_EXCEPTION_TYPES[error_num // 1000] raise exc_type(_Error(message)) from cause def _raise_from_string(exc_type: Exception, message: str) -> None: """ Raises an exception from a given string. This ensures that an _Error object is created for all exceptions that are raised. """ raise exc_type(_Error(message)) from None # prefix used for all error messages ERR_PREFIX = "DPY" # error numbers that result in InterfaceError ERR_MISSING_ERROR = 1000 ERR_NOT_CONNECTED = 1001 ERR_POOL_NOT_OPEN = 1002 ERR_NOT_A_QUERY = 1003 ERR_NO_STATEMENT_EXECUTED = 1004 ERR_POOL_HAS_BUSY_CONNECTIONS = 1005 ERR_CURSOR_NOT_OPEN = 1006 # error numbers that result in ProgrammingError ERR_MESSAGE_HAS_NO_PAYLOAD = 2000 ERR_NO_STATEMENT = 2001 ERR_NO_STATEMENT_PREPARED = 2002 ERR_WRONG_EXECUTE_PARAMETERS_TYPE = 2003 ERR_WRONG_EXECUTEMANY_PARAMETERS_TYPE = 2004 ERR_ARGS_AND_KEYWORD_ARGS = 2005 ERR_MIXED_POSITIONAL_AND_NAMED_BINDS = 2006 ERR_EXPECTING_TYPE = 2007 ERR_WRONG_OBJECT_TYPE = 2008 ERR_WRONG_SCROLL_MODE = 2009 ERR_MIXED_ELEMENT_TYPES = 2010 ERR_WRONG_ARRAY_DEFINITION = 2011 ERR_ARGS_MUST_BE_LIST_OR_TUPLE = 2012 ERR_KEYWORD_ARGS_MUST_BE_DICT = 2013 ERR_DUPLICATED_PARAMETER = 2014 ERR_EXPECTING_VAR = 2015 ERR_INCORRECT_VAR_ARRAYSIZE = 2016 ERR_LIBRARY_ALREADY_INITIALIZED = 2017 ERR_WALLET_FILE_MISSING = 2018 ERR_THIN_CONNECTION_ALREADY_CREATED = 2019 ERR_INVALID_MAKEDSN_ARG = 2020 ERR_INIT_ORACLE_CLIENT_NOT_CALLED = 2021 ERR_INVALID_OCI_ATTR_TYPE = 2022 ERR_INVALID_CONN_CLASS = 2023 ERR_INVALID_CONNECT_PARAMS = 2025 ERR_INVALID_POOL_CLASS = 2026 ERR_INVALID_POOL_PARAMS = 2027 ERR_EXPECTING_LIST_FOR_ARRAY_VAR = 2028 ERR_HTTPS_PROXY_REQUIRES_TCPS = 2029 ERR_INVALID_LOB_OFFSET = 2030 ERR_INVALID_ACCESS_TOKEN_PARAM = 2031 ERR_INVALID_ACCESS_TOKEN_RETURNED = 2032 ERR_EXPIRED_ACCESS_TOKEN = 2033 ERR_ACCESS_TOKEN_REQUIRES_TCPS = 2034 ERR_INVALID_OBJECT_TYPE_NAME = 2035 ERR_OBJECT_IS_NOT_A_COLLECTION = 2036 ERR_MISSING_TYPE_NAME_FOR_OBJECT_VAR = 2037 # error numbers that result in NotSupportedError ERR_TIME_NOT_SUPPORTED = 3000 ERR_FEATURE_NOT_SUPPORTED = 3001 ERR_PYTHON_VALUE_NOT_SUPPORTED = 3002 ERR_PYTHON_TYPE_NOT_SUPPORTED = 3003 ERR_UNSUPPORTED_TYPE_SET = 3004 ERR_ARRAYS_OF_ARRAYS = 3005 ERR_ORACLE_TYPE_NOT_SUPPORTED = 3006 ERR_DB_TYPE_NOT_SUPPORTED = 3007 ERR_UNSUPPORTED_INBAND_NOTIFICATION = 3008 ERR_SELF_BIND_NOT_SUPPORTED = 3009 ERR_SERVER_VERSION_NOT_SUPPORTED = 3010 ERR_NCHAR_CS_NOT_SUPPORTED = 3012 ERR_UNSUPPORTED_PYTHON_TYPE_FOR_DB_TYPE = 3013 ERR_LOB_OF_WRONG_TYPE = 3014 ERR_UNSUPPORTED_VERIFIER_TYPE = 3015 ERR_NO_CRYPTOGRAPHY_PACKAGE = 3016 ERR_ORACLE_TYPE_NAME_NOT_SUPPORTED = 3017 ERR_TDS_TYPE_NOT_SUPPORTED = 3018 # error numbers that result in DatabaseError ERR_TNS_ENTRY_NOT_FOUND = 4000 ERR_NO_CREDENTIALS = 4001 ERR_COLUMN_TRUNCATED = 4002 ERR_ORACLE_NUMBER_NO_REPR = 4003 ERR_INVALID_NUMBER = 4004 ERR_POOL_NO_CONNECTION_AVAILABLE = 4005 ERR_ARRAY_DML_ROW_COUNTS_NOT_ENABLED = 4006 ERR_INCONSISTENT_DATATYPES = 4007 ERR_INVALID_BIND_NAME = 4008 ERR_WRONG_NUMBER_OF_POSITIONAL_BINDS = 4009 ERR_MISSING_BIND_VALUE = 4010 ERR_CONNECTION_CLOSED = 4011 ERR_NUMBER_WITH_INVALID_EXPONENT = 4012 ERR_NUMBER_STRING_OF_ZERO_LENGTH = 4013 ERR_NUMBER_STRING_TOO_LONG = 4014 ERR_NUMBER_WITH_EMPTY_EXPONENT = 4015 ERR_CONTENT_INVALID_AFTER_NUMBER = 4016 ERR_INVALID_CONNECT_DESCRIPTOR = 4017 ERR_CANNOT_PARSE_CONNECT_STRING = 4018 ERR_INVALID_REDIRECT_DATA = 4019 ERR_INVALID_PROTOCOL = 4021 ERR_INVALID_POOL_PURITY = 4022 ERR_CALL_TIMEOUT_EXCEEDED = 4024 ERR_INVALID_REF_CURSOR = 4025 ERR_TNS_NAMES_FILE_MISSING = 4026 ERR_NO_CONFIG_DIR = 4027 ERR_INVALID_SERVER_TYPE = 4028 # error numbers that result in InternalError ERR_MESSAGE_TYPE_UNKNOWN = 5000 ERR_BUFFER_LENGTH_INSUFFICIENT = 5001 ERR_INTEGER_TOO_LARGE = 5002 ERR_UNEXPECTED_NEGATIVE_INTEGER = 5003 ERR_UNEXPECTED_DATA = 5004 ERR_UNEXPECTED_REFUSE = 5005 ERR_UNEXPECTED_END_OF_DATA = 5006 ERR_UNEXPECTED_XML_TYPE = 5007 # error numbers that result in OperationalError ERR_LISTENER_REFUSED_CONNECTION = 6000 ERR_INVALID_SERVICE_NAME = 6001 ERR_INVALID_SERVER_CERT_DN = 6002 ERR_INVALID_SID = 6003 ERR_PROXY_FAILURE = 6004 ERR_CONNECTION_FAILED = 6005 # Oracle error number cross reference ERR_ORACLE_ERROR_XREF = { 28: ERR_CONNECTION_CLOSED, 600: ERR_CONNECTION_CLOSED, 1005: ERR_NO_CREDENTIALS, 22303: (ERR_INVALID_OBJECT_TYPE_NAME, 'type "(?P[^"]*"."[^"]*)"'), 24422: ERR_POOL_HAS_BUSY_CONNECTIONS, 24349: ERR_ARRAY_DML_ROW_COUNTS_NOT_ENABLED, 24459: ERR_POOL_NO_CONNECTION_AVAILABLE, 24496: ERR_POOL_NO_CONNECTION_AVAILABLE, 24338: ERR_INVALID_REF_CURSOR, } # ODPI-C error number cross reference ERR_DPI_ERROR_XREF = { 1010: ERR_CONNECTION_CLOSED, 1043: ERR_INVALID_NUMBER, 1044: ERR_ORACLE_NUMBER_NO_REPR, 1067: (ERR_CALL_TIMEOUT_EXCEEDED, "call timeout of (?P\d+) ms"), 1080: ERR_CONNECTION_CLOSED, } # error message exception types (multiples of 1000) ERR_EXCEPTION_TYPES = { 1: exceptions.InterfaceError, 2: exceptions.ProgrammingError, 3: exceptions.NotSupportedError, 4: exceptions.DatabaseError, 5: exceptions.InternalError, 6: exceptions.OperationalError } # error message formats ERR_MESSAGE_FORMATS = { ERR_ACCESS_TOKEN_REQUIRES_TCPS: 'access_token requires use of the tcps protocol', ERR_ARGS_MUST_BE_LIST_OR_TUPLE: 'arguments must be a list or tuple', ERR_ARGS_AND_KEYWORD_ARGS: 'expecting positional arguments or keyword arguments, not both', ERR_ARRAY_DML_ROW_COUNTS_NOT_ENABLED: 'array DML row counts mode is not enabled', ERR_ARRAYS_OF_ARRAYS: 'arrays of arrays are not supported', ERR_BUFFER_LENGTH_INSUFFICIENT: 'internal error: buffer of length {actual_buffer_len} ' 'insufficient to hold {required_buffer_len} bytes', ERR_CALL_TIMEOUT_EXCEEDED: 'call timeout of {timeout} ms exceeded', ERR_CANNOT_PARSE_CONNECT_STRING: 'cannot parse connect string "{data}"', ERR_COLUMN_TRUNCATED: 'column truncated to {col_value_len} {unit}. ' 'Untruncated was {actual_len}', ERR_CONNECTION_FAILED: 'cannot connect to database. Connection failed with "{exception}"', ERR_CONTENT_INVALID_AFTER_NUMBER: 'invalid number (content after number)', ERR_CURSOR_NOT_OPEN: 'cursor is not open', ERR_DB_TYPE_NOT_SUPPORTED: 'database type "{name}" is not supported', ERR_DUPLICATED_PARAMETER: '"{deprecated_name}" and "{new_name}" cannot be specified together', ERR_EXPECTING_LIST_FOR_ARRAY_VAR: 'expecting list when setting array variables', ERR_EXPECTING_TYPE: 'expected a type', ERR_EXPECTING_VAR: 'type handler should return None or the value returned by a call ' 'to cursor.var()', ERR_EXPIRED_ACCESS_TOKEN: 'access token has expired', ERR_FEATURE_NOT_SUPPORTED: '{feature} is only supported in python-oracledb {driver_type} mode', ERR_HTTPS_PROXY_REQUIRES_TCPS: 'https_proxy requires use of the tcps protocol', ERR_INCONSISTENT_DATATYPES: 'cannot convert from data type {input_type} to {output_type}', ERR_INCORRECT_VAR_ARRAYSIZE: 'variable array size of {var_arraysize} is ' 'too small (should be at least {required_arraysize})', ERR_INIT_ORACLE_CLIENT_NOT_CALLED: 'init_oracle_client() must be called first', ERR_INTEGER_TOO_LARGE: 'internal error: read integer of length {length} when expecting ' 'integer of no more than length {max_length}', ERR_INVALID_ACCESS_TOKEN_PARAM: 'invalid access token: value must be a string (for OAuth), a ' '2-tuple containing the token and private key strings (for IAM), ' 'or a callable that returns a string or 2-tuple', ERR_INVALID_ACCESS_TOKEN_RETURNED: 'invalid access token returned from callable: value must be a ' 'string (for OAuth) or a 2-tuple containing the token and private ' 'key strings (for IAM)', ERR_INVALID_BIND_NAME: 'no bind placeholder named ":{name}" was found in the SQL text', ERR_INVALID_CONN_CLASS: 'invalid connection class', ERR_INVALID_CONNECT_DESCRIPTOR: 'invalid connect descriptor "{data}"', ERR_INVALID_CONNECT_PARAMS: 'invalid connection params', ERR_INVALID_LOB_OFFSET: 'LOB offset must be greater than zero', ERR_INVALID_MAKEDSN_ARG: '"{name}" argument contains invalid values', ERR_INVALID_NUMBER: 'invalid number', ERR_INVALID_OBJECT_TYPE_NAME: 'invalid object type name: "{name}"', ERR_INVALID_OCI_ATTR_TYPE: 'invalid OCI attribute type {attr_type}', ERR_INVALID_POOL_CLASS: 'invalid connection pool class', ERR_INVALID_POOL_PARAMS: 'invalid pool params', ERR_INVALID_POOL_PURITY: 'invalid DRCP purity {purity}', ERR_INVALID_PROTOCOL: 'invalid protocol "{protocol}"', ERR_INVALID_REDIRECT_DATA: 'invalid redirect data {data}', ERR_INVALID_REF_CURSOR: 'invalid REF CURSOR: never opened in PL/SQL', ERR_INVALID_SERVER_CERT_DN: 'cannot connect to database. The distinguished name (DN) on ' 'the server certificate does not match the expected value', ERR_INVALID_SERVER_TYPE: 'invalid server_type: {server_type}', ERR_INVALID_SERVICE_NAME: 'cannot connect to database. Service "{service_name}" is not ' 'registered with the listener at host "{host}" port {port}. ' '(Similar to ORA-12514)', ERR_INVALID_SID: 'cannot connect to database. SID "{sid}" is not registered ' 'with the listener at host "{host}" port {port}. ' '(Similar to ORA-12505)', ERR_KEYWORD_ARGS_MUST_BE_DICT: '"keyword_parameters" argument must be a dict', ERR_LIBRARY_ALREADY_INITIALIZED: 'init_oracle_client() was already called with different arguments', ERR_LISTENER_REFUSED_CONNECTION: 'cannot connect to database. Listener refused connection. ' '(Similar to ORA-{error_code})', ERR_LOB_OF_WRONG_TYPE: 'LOB is of type {actual_type_name} but must be of type ' '{expected_type_name}', ERR_MESSAGE_HAS_NO_PAYLOAD: 'message has no payload', ERR_MESSAGE_TYPE_UNKNOWN: 'internal error: unknown protocol message type {message_type}', ERR_MISSING_BIND_VALUE: 'a bind variable replacement value for placeholder ":{name}" was ' 'not provided', ERR_MISSING_TYPE_NAME_FOR_OBJECT_VAR: 'no object type specified for object variable', ERR_MIXED_ELEMENT_TYPES: 'element {element} is not the same data type as previous elements', ERR_MIXED_POSITIONAL_AND_NAMED_BINDS: 'positional and named binds cannot be intermixed', ERR_NCHAR_CS_NOT_SUPPORTED: 'national character set id {charset_id} is not supported by ' 'python-oracledb in thin mode', ERR_NO_CONFIG_DIR: 'no configuration directory to search for tnsnames.ora', ERR_NO_CREDENTIALS: 'no credentials specified', ERR_NO_CRYPTOGRAPHY_PACKAGE: 'python-oracledb thin mode cannot be used because the ' 'cryptography package is not installed', ERR_NO_STATEMENT: 'no statement specified and no prior statement prepared', ERR_NO_STATEMENT_EXECUTED: 'no statement executed', ERR_NO_STATEMENT_PREPARED: 'statement must be prepared first', ERR_NOT_A_QUERY: 'the executed statement does not return rows', ERR_NOT_CONNECTED: 'not connected to database', ERR_NUMBER_STRING_OF_ZERO_LENGTH: 'invalid number: zero length string', ERR_NUMBER_STRING_TOO_LONG: 'invalid number: string too long', ERR_NUMBER_WITH_EMPTY_EXPONENT: 'invalid number: empty exponent', ERR_NUMBER_WITH_INVALID_EXPONENT: 'invalid number: invalid exponent', ERR_OBJECT_IS_NOT_A_COLLECTION: 'object {name} is not a collection', ERR_ORACLE_NUMBER_NO_REPR: 'value cannot be represented as an Oracle number', ERR_ORACLE_TYPE_NAME_NOT_SUPPORTED: 'Oracle data type name "{name}" is not supported', ERR_ORACLE_TYPE_NOT_SUPPORTED: 'Oracle data type {num} is not supported', ERR_POOL_HAS_BUSY_CONNECTIONS: 'connection pool cannot be closed because connections are busy', ERR_POOL_NO_CONNECTION_AVAILABLE: 'timed out waiting for the connection pool to return a connection', ERR_POOL_NOT_OPEN: 'connection pool is not open', ERR_PROXY_FAILURE: 'network proxy failed: response was {response}', ERR_PYTHON_TYPE_NOT_SUPPORTED: 'Python type {typ} is not supported', ERR_PYTHON_VALUE_NOT_SUPPORTED: 'Python value of type "{type_name}" is not supported', ERR_SELF_BIND_NOT_SUPPORTED: 'binding to self is not supported', ERR_CONNECTION_CLOSED: 'the database or network closed the connection', ERR_SERVER_VERSION_NOT_SUPPORTED: 'connections to this database server version are not supported ' 'by python-oracledb in thin mode', ERR_TDS_TYPE_NOT_SUPPORTED: 'Oracle TDS data type {num} is not supported', ERR_THIN_CONNECTION_ALREADY_CREATED: 'python-oracledb thick mode cannot be used because a thin mode ' 'connection has already been created', ERR_TIME_NOT_SUPPORTED: 'Oracle Database does not support time only variables', ERR_TNS_ENTRY_NOT_FOUND: 'cannot connect to database. Unable to find "{name}" in ' '{file_name}', ERR_TNS_NAMES_FILE_MISSING: 'cannot connect to database. File tnsnames.ora not found in ' '{config_dir}', ERR_UNEXPECTED_DATA: 'unexpected data received: {data}', ERR_UNEXPECTED_END_OF_DATA: 'unexpected end of data: want {num_bytes_wanted} bytes but ' 'only {num_bytes_available} bytes are available', ERR_UNEXPECTED_NEGATIVE_INTEGER: 'internal error: read a negative integer when expecting a ' 'positive integer', ERR_UNEXPECTED_REFUSE: 'the listener refused the connection but an unexpected error ' 'format was returned', ERR_UNEXPECTED_XML_TYPE: 'unexpected XMLType with flag {flag}', ERR_UNSUPPORTED_INBAND_NOTIFICATION: 'unsupported in-band notification with error number {err_num}', ERR_UNSUPPORTED_PYTHON_TYPE_FOR_DB_TYPE: 'unsupported Python type {py_type_name} for database type ' '{db_type_name}', ERR_UNSUPPORTED_TYPE_SET: 'type {db_type_name} does not support being set', ERR_UNSUPPORTED_VERIFIER_TYPE: 'password verifier type 0x{verifier_type:x} is not supported by ' 'python-oracledb in thin mode', ERR_WALLET_FILE_MISSING: 'cannot connect to database. Wallet file {name} was not found', ERR_WRONG_ARRAY_DEFINITION: 'expecting a list of two elements [type, numelems]', ERR_WRONG_EXECUTE_PARAMETERS_TYPE: 'expecting a dictionary, list or tuple, or keyword args', ERR_WRONG_EXECUTEMANY_PARAMETERS_TYPE: '"parameters" argument should be a list of sequences or ' 'dictionaries, or an integer specifying the number of ' 'times to execute the statement', ERR_WRONG_NUMBER_OF_POSITIONAL_BINDS: '{expected_num} positional bind values are required but ' '{actual_num} were provided', ERR_WRONG_OBJECT_TYPE: 'found object of type "{actual_schema}.{actual_name}" when ' 'expecting object of type "{expected_schema}.{expected_name}"', ERR_WRONG_SCROLL_MODE: 'scroll mode must be relative, absolute, first or last', }