Skip to content

Commit 950220a

Browse files
anthony-tuiningaanthony-tuininga
committed
Use Optional[] for optional arguments and avoid specifying defaults
since in many cases such are inaccurate.
1 parent e4832f2 commit 950220a

File tree

9 files changed

+684
-660
lines changed

9 files changed

+684
-660
lines changed

‎src/oracledb/connect_params.py‎

Lines changed: 101 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535

3636
import functools
3737
import ssl
38-
from typing import Union, Callable, Any
38+
from typing import Union, Callable, Any, Optional
3939

4040
import oracledb
4141

@@ -56,56 +56,56 @@ class ConnectParams:
5656
def __init__(
5757
self,
5858
*,
59-
user: str = None,
60-
proxy_user: str = None,
61-
password: str = None,
62-
newpassword: str = None,
63-
wallet_password: str = None,
64-
access_token: Union[str, tuple, Callable] = None,
65-
host: str = None,
66-
port: int = 1521,
67-
protocol: str = "tcp",
68-
https_proxy: str = None,
69-
https_proxy_port: int = 0,
70-
service_name: str = None,
71-
instance_name: str = None,
72-
sid: str = None,
73-
server_type: str = None,
74-
cclass: str = None,
75-
purity: oracledb.Purity = oracledb.PURITY_DEFAULT,
76-
expire_time: int = 0,
77-
retry_count: int = 0,
78-
retry_delay: int = 1,
79-
tcp_connect_timeout: float = 20.0,
80-
ssl_server_dn_match: bool = True,
81-
ssl_server_cert_dn: str = None,
82-
wallet_location: str = None,
83-
events: bool = False,
84-
externalauth: bool = False,
85-
mode: oracledb.AuthMode = oracledb.AUTH_MODE_DEFAULT,
86-
disable_oob: bool = False,
87-
stmtcachesize: int = oracledb.defaults.stmtcachesize,
88-
edition: str = None,
89-
tag: str = None,
90-
matchanytag: bool = False,
91-
config_dir: str = oracledb.defaults.config_dir,
92-
appcontext: list = None,
93-
shardingkey: list = None,
94-
supershardingkey: list = None,
95-
debug_jdwp: str = None,
96-
connection_id_prefix: str = None,
97-
ssl_context: Any = None,
98-
sdu: int = 8192,
99-
pool_boundary: str = None,
100-
use_tcp_fast_open: bool = False,
101-
ssl_version: ssl.TLSVersion = None,
102-
program: str = oracledb.defaults.program,
103-
machine: str = oracledb.defaults.machine,
104-
terminal: str = oracledb.defaults.terminal,
105-
osuser: str = oracledb.defaults.osuser,
106-
driver_name: str = oracledb.defaults.driver_name,
107-
use_sni: bool = False,
108-
handle: int = 0,
59+
user: Optional[str] = None,
60+
proxy_user: Optional[str] = None,
61+
password: Optional[str] = None,
62+
newpassword: Optional[str] = None,
63+
wallet_password: Optional[str] = None,
64+
access_token: Optional[Union[str, tuple, Callable]] = None,
65+
host: Optional[str] = None,
66+
port: Optional[int] = None,
67+
protocol: Optional[str] = None,
68+
https_proxy: Optional[str] = None,
69+
https_proxy_port: Optional[int] = None,
70+
service_name: Optional[str] = None,
71+
instance_name: Optional[str] = None,
72+
sid: Optional[str] = None,
73+
server_type: Optional[str] = None,
74+
cclass: Optional[str] = None,
75+
purity: Optional[oracledb.Purity] = None,
76+
expire_time: Optional[int] = None,
77+
retry_count: Optional[int] = None,
78+
retry_delay: Optional[int] = None,
79+
tcp_connect_timeout: Optional[float] = None,
80+
ssl_server_dn_match: Optional[bool] = None,
81+
ssl_server_cert_dn: Optional[str] = None,
82+
wallet_location: Optional[str] = None,
83+
events: Optional[bool] = None,
84+
externalauth: Optional[bool] = None,
85+
mode: Optional[oracledb.AuthMode] = None,
86+
disable_oob: Optional[bool] = None,
87+
stmtcachesize: Optional[int] = None,
88+
edition: Optional[str] = None,
89+
tag: Optional[str] = None,
90+
matchanytag: Optional[bool] = None,
91+
config_dir: Optional[str] = None,
92+
appcontext: Optional[list] = None,
93+
shardingkey: Optional[list] = None,
94+
supershardingkey: Optional[list] = None,
95+
debug_jdwp: Optional[str] = None,
96+
connection_id_prefix: Optional[str] = None,
97+
ssl_context: Optional[Any] = None,
98+
sdu: Optional[int] = None,
99+
pool_boundary: Optional[str] = None,
100+
use_tcp_fast_open: Optional[bool] = None,
101+
ssl_version: Optional[ssl.TLSVersion] = None,
102+
program: Optional[str] = None,
103+
machine: Optional[str] = None,
104+
terminal: Optional[str] = None,
105+
osuser: Optional[str] = None,
106+
driver_name: Optional[str] = None,
107+
use_sni: Optional[bool] = None,
108+
handle: Optional[int] = None,
109109
):
110110
"""
111111
All parameters are optional. A brief description of each parameter
@@ -828,56 +828,56 @@ def parse_dsn_with_credentials(self, dsn: str) -> tuple:
828828
def set(
829829
self,
830830
*,
831-
user: str = None,
832-
proxy_user: str = None,
833-
password: str = None,
834-
newpassword: str = None,
835-
wallet_password: str = None,
836-
access_token: Union[str, tuple, Callable] = None,
837-
host: str = None,
838-
port: int = None,
839-
protocol: str = None,
840-
https_proxy: str = None,
841-
https_proxy_port: int = None,
842-
service_name: str = None,
843-
instance_name: str = None,
844-
sid: str = None,
845-
server_type: str = None,
846-
cclass: str = None,
847-
purity: oracledb.Purity = None,
848-
expire_time: int = None,
849-
retry_count: int = None,
850-
retry_delay: int = None,
851-
tcp_connect_timeout: float = None,
852-
ssl_server_dn_match: bool = None,
853-
ssl_server_cert_dn: str = None,
854-
wallet_location: str = None,
855-
events: bool = None,
856-
externalauth: bool = None,
857-
mode: oracledb.AuthMode = None,
858-
disable_oob: bool = None,
859-
stmtcachesize: int = None,
860-
edition: str = None,
861-
tag: str = None,
862-
matchanytag: bool = None,
863-
config_dir: str = None,
864-
appcontext: list = None,
865-
shardingkey: list = None,
866-
supershardingkey: list = None,
867-
debug_jdwp: str = None,
868-
connection_id_prefix: str = None,
869-
ssl_context: Any = None,
870-
sdu: int = None,
871-
pool_boundary: str = None,
872-
use_tcp_fast_open: bool = None,
873-
ssl_version: ssl.TLSVersion = None,
874-
program: str = None,
875-
machine: str = None,
876-
terminal: str = None,
877-
osuser: str = None,
878-
driver_name: str = None,
879-
use_sni: bool = None,
880-
handle: int = None,
831+
user: Optional[str] = None,
832+
proxy_user: Optional[str] = None,
833+
password: Optional[str] = None,
834+
newpassword: Optional[str] = None,
835+
wallet_password: Optional[str] = None,
836+
access_token: Optional[Union[str, tuple, Callable]] = None,
837+
host: Optional[str] = None,
838+
port: Optional[int] = None,
839+
protocol: Optional[str] = None,
840+
https_proxy: Optional[str] = None,
841+
https_proxy_port: Optional[int] = None,
842+
service_name: Optional[str] = None,
843+
instance_name: Optional[str] = None,
844+
sid: Optional[str] = None,
845+
server_type: Optional[str] = None,
846+
cclass: Optional[str] = None,
847+
purity: Optional[oracledb.Purity] = None,
848+
expire_time: Optional[int] = None,
849+
retry_count: Optional[int] = None,
850+
retry_delay: Optional[int] = None,
851+
tcp_connect_timeout: Optional[float] = None,
852+
ssl_server_dn_match: Optional[bool] = None,
853+
ssl_server_cert_dn: Optional[str] = None,
854+
wallet_location: Optional[str] = None,
855+
events: Optional[bool] = None,
856+
externalauth: Optional[bool] = None,
857+
mode: Optional[oracledb.AuthMode] = None,
858+
disable_oob: Optional[bool] = None,
859+
stmtcachesize: Optional[int] = None,
860+
edition: Optional[str] = None,
861+
tag: Optional[str] = None,
862+
matchanytag: Optional[bool] = None,
863+
config_dir: Optional[str] = None,
864+
appcontext: Optional[list] = None,
865+
shardingkey: Optional[list] = None,
866+
supershardingkey: Optional[list] = None,
867+
debug_jdwp: Optional[str] = None,
868+
connection_id_prefix: Optional[str] = None,
869+
ssl_context: Optional[Any] = None,
870+
sdu: Optional[int] = None,
871+
pool_boundary: Optional[str] = None,
872+
use_tcp_fast_open: Optional[bool] = None,
873+
ssl_version: Optional[ssl.TLSVersion] = None,
874+
program: Optional[str] = None,
875+
machine: Optional[str] = None,
876+
terminal: Optional[str] = None,
877+
osuser: Optional[str] = None,
878+
driver_name: Optional[str] = None,
879+
use_sni: Optional[bool] = None,
880+
handle: Optional[int] = None,
881881
):
882882
"""
883883
All parameters are optional. A brief description of each parameter

0 commit comments

Comments
 (0)