143 lines
4.5 KiB
Python
143 lines
4.5 KiB
Python
# -----------------------------------------------------------------------------
|
|
# Copyright (c) 2021, 2023, 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.
|
|
# -----------------------------------------------------------------------------
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# connect_params.py
|
|
#
|
|
# Contains the ConnectParams class used for managing the parameters required to
|
|
# establish a connection to the database.
|
|
#
|
|
# # {{ generated_notice }}
|
|
# -----------------------------------------------------------------------------
|
|
|
|
import functools
|
|
from typing import Union, Callable, Any
|
|
|
|
import oracledb
|
|
|
|
from . import base_impl, utils
|
|
|
|
|
|
class ConnectParams:
|
|
"""
|
|
Contains all parameters used for establishing a connection to the
|
|
database.
|
|
"""
|
|
|
|
__module__ = oracledb.__name__
|
|
__slots__ = ["_impl"]
|
|
_impl_class = base_impl.ConnectParamsImpl
|
|
|
|
@utils.params_initer
|
|
def __init__(
|
|
# {{ params_constructor_args }}
|
|
):
|
|
"""
|
|
All parameters are optional. A brief description of each parameter
|
|
follows:
|
|
|
|
# {{ args_help_with_defaults }}
|
|
"""
|
|
pass
|
|
|
|
# {{ params_repr }}
|
|
|
|
def _address_attr(f):
|
|
"""
|
|
Helper function used to get address level attributes.
|
|
"""
|
|
|
|
@functools.wraps(f)
|
|
def wrapped(self):
|
|
values = [
|
|
getattr(a, f.__name__) for a in self._impl._get_addresses()
|
|
]
|
|
return values if len(values) > 1 else values[0]
|
|
|
|
return wrapped
|
|
|
|
def _description_attr(f):
|
|
"""
|
|
Helper function used to get description level attributes.
|
|
"""
|
|
|
|
@functools.wraps(f)
|
|
def wrapped(self):
|
|
values = [
|
|
getattr(d, f.__name__)
|
|
for d in self._impl.description_list.children
|
|
]
|
|
return values if len(values) > 1 else values[0]
|
|
|
|
return wrapped
|
|
|
|
# {{ params_properties }}
|
|
|
|
def copy(self) -> "ConnectParams":
|
|
"""
|
|
Creates a copy of the parameters and returns it.
|
|
"""
|
|
params = ConnectParams.__new__(ConnectParams)
|
|
params._impl = self._impl.copy()
|
|
return params
|
|
|
|
def get_connect_string(self) -> str:
|
|
"""
|
|
Returns a connect string generated from the parameters.
|
|
"""
|
|
return self._impl.get_connect_string()
|
|
|
|
def parse_connect_string(self, connect_string: str) -> None:
|
|
"""
|
|
Parses the connect string into its components and stores the
|
|
parameters. The connect string could be an Easy Connect string,
|
|
name-value pairs or a simple alias which is looked up in tnsnames.ora.
|
|
Any parameters found in the connect string override any currently
|
|
stored values.
|
|
"""
|
|
self._impl.parse_connect_string(connect_string)
|
|
|
|
def parse_dsn_with_credentials(self, dsn: str) -> tuple:
|
|
"""
|
|
Parses a dsn in the form <user>/<password>@<connect_string> or in the
|
|
form <user>/<password> and returns a 3-tuple containing the parsed
|
|
user, password and connect string. Empty strings are returned as the
|
|
value None. This is done automatically when a value is passed to
|
|
the dsn parameter but no value is passed to the user password when
|
|
creating a standalone connection or connection pool.
|
|
"""
|
|
return self._impl.parse_dsn_with_credentials(dsn)
|
|
|
|
@utils.params_setter
|
|
def set(
|
|
# {{ params_setter_args }}
|
|
):
|
|
"""
|
|
All parameters are optional. A brief description of each parameter
|
|
follows:
|
|
|
|
# {{ args_help_without_defaults }}
|
|
"""
|
|
pass
|