Skip to content

Commit ec57f11

Browse files
committed
working on supporting return values
1 parent 9023ac9 commit ec57f11

6 files changed

Lines changed: 253 additions & 10 deletions

File tree

‎python_plsql/client.py‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
from typing import Any
1010
from typing import Iterator
1111
from typing import List
12+
from typing import Optional
13+
from typing import Union
1214
from typing import Tuple
1315

1416
import cx_Oracle as oracle
@@ -163,7 +165,7 @@ class Schema:
163165
def __init__(self, plsql: Database, name: str):
164166
self._plsql, self._name = plsql, name
165167

166-
def __getattr__(self, item):
168+
def __getattr__(self, item: str) -> Optional[Union[Subprogram, Package]]:
167169
item = f"{self._name}.{item}"
168170
name = self._plsql._name_resolve(item)
169171
return search_object(plsql=self._plsql, name=name, item=item)
@@ -173,7 +175,7 @@ class Package:
173175
def __init__(self, plsql: Database, name: str):
174176
self._plsql, self._name = plsql, name
175177

176-
def __getattr__(self, item):
178+
def __getattr__(self, item: str) -> Subprogram:
177179
item = f"{self._name}.{item}"
178180
name = self._plsql._name_resolve(item)
179181
return Subprogram(
@@ -222,7 +224,7 @@ def __init__(self, plsql: Database, name: ResolvedName):
222224
self._plsql, self._name = plsql, name
223225

224226

225-
def return_type(arguments: List[Argument]):
227+
def return_type(arguments: List[Argument]) -> Optional[Argument]:
226228
"""
227229
Extracts return type from list of arguments.
228230
According to Oracle documentation: "Position 0 returns the values for the return type of a function."
@@ -320,11 +322,11 @@ def overloaded(self) -> bool:
320322
return len(self.overloads) > 1
321323

322324
@property
323-
def is_function(self):
325+
def is_function(self) -> bool:
324326
return any(overload.is_function for overload in self.overloads)
325327

326328
@property
327-
def is_procedure(self):
329+
def is_procedure(self) -> bool:
328330
return any(not overload.is_function for overload in self.overloads)
329331

330332
@property
@@ -336,7 +338,9 @@ def standalone(self) -> bool:
336338
}
337339

338340

339-
def search_object(plsql: Database, name: ResolvedName, item: str):
341+
def search_object(
342+
plsql: Database, name: ResolvedName, item: str
343+
) -> Optional[Union[Subprogram, Package]]:
340344
if name.object_type in {
341345
ObjectTypes.function,
342346
ObjectTypes.procedure,
@@ -369,15 +373,15 @@ def __init__(
369373
user=user, password=password, dsn=dsn, encoding=encoding, nencoding=encoding
370374
)
371375

372-
def is_schema(self, schema_name):
376+
def is_schema(self, schema_name: str) -> bool:
373377
return bool(
374378
self.query(
375379
"""SELECT COUNT(*) FROM all_users WHERE username = UPPER(:username)""",
376380
username=schema_name,
377381
).first
378382
)
379383

380-
def __getattr__(self, item):
384+
def __getattr__(self, item) -> Union[Schema, Package, Subprogram]:
381385
try:
382386
name = self._name_resolve(item)
383387
except (oracle.DatabaseError, NotFound):

‎tests/func/test_errors.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import pytest
2-
from python_plsql import DatabaseError, NotFound
2+
3+
from python_plsql import NotFound
34

45

56
def test_error_when_object_does_not_exist(plsql):

‎tests/func/test_return_values.py‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import pytest
2+
3+
4+
@pytest.fixture(
5+
params=[
6+
"ret_varchar",
7+
"ret_number",
8+
"ret_binary_integer",
9+
"ret_clob",
10+
"ret_rowid",
11+
"ret_date",
12+
"ret_raw",
13+
"ret_long_raw",
14+
"ret_char",
15+
"ret_bool",
16+
]
17+
)
18+
def functions(plsql, request):
19+
return getattr(plsql.test_return, request.param)
20+
21+
22+
def test_return_values(functions):
23+
assert functions() is None
Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
CREATE OR REPLACE PACKAGE BODY test_return AS
2+
3+
-- 0 placeholder for procedures with no arguments -- ------||------
4+
-- 1 VARCHAR2, VARCHAR, STRING -- str
5+
FUNCTION ret_varchar
6+
RETURN VARCHAR2 IS
7+
BEGIN
8+
RETURN NULL;
9+
END;
10+
11+
-- 2 NUMBER, INTEGER, SMALLINT, REAL, FLOAT, DECIMAL -- float
12+
FUNCTION ret_number
13+
RETURN NUMBER IS
14+
BEGIN
15+
RETURN NULL;
16+
END;
17+
18+
-- 3 BINARY_INTEGER, PLS_INTEGER, POSITIVE, NATURAL -- int
19+
FUNCTION ret_binary_integer
20+
RETURN BINARY_INTEGER IS
21+
BEGIN
22+
RETURN NULL;
23+
END;
24+
25+
-- 8 LONG ?CLOB? -- str
26+
FUNCTION ret_clob
27+
RETURN CLOB IS
28+
BEGIN
29+
RETURN NULL;
30+
END;
31+
32+
-- 11 ROWID -- str
33+
FUNCTION ret_rowid
34+
RETURN ROWID IS
35+
BEGIN
36+
RETURN NULL;
37+
END;
38+
39+
-- 12 DATE -- datetime.datetime
40+
FUNCTION ret_date
41+
RETURN DATE IS
42+
BEGIN
43+
RETURN NULL;
44+
END;
45+
46+
-- 23 RAW -- bytes
47+
FUNCTION ret_raw
48+
RETURN RAW IS
49+
BEGIN
50+
RETURN NULL;
51+
END;
52+
53+
-- 24 LONG RAW -- bytes
54+
FUNCTION ret_long_raw
55+
RETURN LONG RAW IS
56+
BEGIN
57+
RETURN NULL;
58+
END;
59+
60+
-- 58 OPAQUE TYPE -- ??? XMLType in Oracle
61+
--FUNCTION ret_binary_integer
62+
--RETURN BINARY_INTEGER;
63+
64+
-- 96 CHAR (ANSI FIXED CHAR), CHARACTER -- str
65+
FUNCTION ret_char
66+
RETURN CHAR IS
67+
BEGIN
68+
RETURN NULL;
69+
END;
70+
71+
-- 106 MLSLABEL -- ??? only backwards compatibility ???
72+
--FUNCTION ret_binary_integer
73+
--RETURN BINARY_INTEGER;
74+
75+
-- 121 OBJECT -- cx_Oracle.Object ???
76+
--FUNCTION ret_binary_integer
77+
--RETURN BINARY_INTEGER;
78+
79+
-- 122 NESTED TABLE -- list
80+
--FUNCTION ret_binary_integer
81+
--RETURN BINARY_INTEGER;
82+
83+
-- 123 VARRAY -- list
84+
--FUNCTION ret_binary_integer
85+
--RETURN BINARY_INTEGER;
86+
87+
-- 178 TIME -- datetime.datetime
88+
--FUNCTION ret_binary_integer
89+
--RETURN BINARY_INTEGER;
90+
91+
-- 179 TIME WITH TIME ZONE -- datetime.datetime
92+
--FUNCTION ret_binary_integer
93+
--RETURN BINARY_INTEGER;
94+
95+
-- 180 TIMESTAMP -- datetime.datetime
96+
--FUNCTION ret_binary_integer
97+
--RETURN BINARY_INTEGER;
98+
99+
-- 181 TIMESTAMP WITH TIME ZONE -- datetime.datetime
100+
--FUNCTION ret_binary_integer
101+
--RETURN BINARY_INTEGER;
102+
103+
-- 231 TIMESTAMP WITH LOCAL TIME ZONE -- datetime.datetime
104+
--FUNCTION ret_binary_integer
105+
--RETURN BINARY_INTEGER;
106+
107+
-- 250 PL/SQL RECORD -- tuple - namedtuple
108+
--FUNCTION ret_binary_integer
109+
--RETURN BINARY_INTEGER;
110+
111+
-- 251 PL/SQL TABLE -- mapping
112+
--FUNCTION ret_binary_integer
113+
--RETURN BINARY_INTEGER;
114+
115+
-- 252 PL/SQL BOOLEAN -- bool
116+
FUNCTION ret_bool
117+
RETURN BOOLEAN IS
118+
BEGIN
119+
RETURN NULL;
120+
END;
121+
122+
123+
END test_return;
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
CREATE OR REPLACE PACKAGE test_return AS
2+
-- 0 placeholder for procedures with no arguments -- ------||------
3+
-- 1 VARCHAR2, VARCHAR, STRING -- str
4+
FUNCTION ret_varchar
5+
RETURN VARCHAR2;
6+
7+
-- 2 NUMBER, INTEGER, SMALLINT, REAL, FLOAT, DECIMAL -- float
8+
FUNCTION ret_number
9+
RETURN NUMBER;
10+
11+
-- 3 BINARY_INTEGER, PLS_INTEGER, POSITIVE, NATURAL -- int
12+
FUNCTION ret_binary_integer
13+
RETURN BINARY_INTEGER;
14+
15+
-- 8 LONG ?CLOB? -- str
16+
FUNCTION ret_clob
17+
RETURN CLOB;
18+
19+
-- 11 ROWID -- str
20+
FUNCTION ret_rowid
21+
RETURN ROWID;
22+
23+
-- 12 DATE -- datetime.datetime
24+
FUNCTION ret_date
25+
RETURN DATE;
26+
27+
-- 23 RAW -- bytes
28+
FUNCTION ret_raw
29+
RETURN RAW;
30+
31+
-- 24 LONG RAW -- bytes
32+
FUNCTION ret_long_raw
33+
RETURN LONG RAW;
34+
35+
-- 58 OPAQUE TYPE -- ??? XMLType in Oracle
36+
--FUNCTION ret_binary_integer
37+
--RETURN BINARY_INTEGER;
38+
39+
-- 96 CHAR (ANSI FIXED CHAR), CHARACTER -- str
40+
FUNCTION ret_char
41+
RETURN CHAR;
42+
43+
-- 106 MLSLABEL -- ??? only backwards compatibility ???
44+
--FUNCTION ret_binary_integer
45+
--RETURN BINARY_INTEGER;
46+
47+
-- 121 OBJECT -- cx_Oracle.Object ???
48+
--FUNCTION ret_binary_integer
49+
--RETURN BINARY_INTEGER;
50+
51+
-- 122 NESTED TABLE -- list
52+
--FUNCTION ret_binary_integer
53+
--RETURN BINARY_INTEGER;
54+
55+
-- 123 VARRAY -- list
56+
--FUNCTION ret_binary_integer
57+
--RETURN BINARY_INTEGER;
58+
59+
-- 178 TIME -- datetime.datetime
60+
--FUNCTION ret_binary_integer
61+
--RETURN BINARY_INTEGER;
62+
63+
-- 179 TIME WITH TIME ZONE -- datetime.datetime
64+
--FUNCTION ret_binary_integer
65+
--RETURN BINARY_INTEGER;
66+
67+
-- 180 TIMESTAMP -- datetime.datetime
68+
--FUNCTION ret_binary_integer
69+
--RETURN BINARY_INTEGER;
70+
71+
-- 181 TIMESTAMP WITH TIME ZONE -- datetime.datetime
72+
--FUNCTION ret_binary_integer
73+
--RETURN BINARY_INTEGER;
74+
75+
-- 231 TIMESTAMP WITH LOCAL TIME ZONE -- datetime.datetime
76+
--FUNCTION ret_binary_integer
77+
--RETURN BINARY_INTEGER;
78+
79+
-- 250 PL/SQL RECORD -- tuple - namedtuple
80+
--FUNCTION ret_binary_integer
81+
--RETURN BINARY_INTEGER;
82+
83+
-- 251 PL/SQL TABLE -- mapping
84+
--FUNCTION ret_binary_integer
85+
--RETURN BINARY_INTEGER;
86+
87+
-- 252 PL/SQL BOOLEAN -- bool
88+
FUNCTION ret_bool
89+
RETURN BOOLEAN;
90+
91+
92+
END test_return;

‎tests/unit/test_name_resolve.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import pytest
22

3-
from python_plsql import DatabaseError, NotFound
3+
from python_plsql import NotFound
44

55

66
@pytest.mark.parametrize(

0 commit comments

Comments
 (0)