1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
"""
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides our database session interface.
Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Special thanks:
https://pyfunceble.github.io/#/special-thanks
Contributors:
https://pyfunceble.github.io/#/contributors
Project link:
https://github.com/funilrys/PyFunceble
Project documentation:
https://docs.pyfunceble.com
Project homepage:
https://pyfunceble.github.io/
License:
::
Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024, 2025 Nissar Chababy
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.
"""
import copy
import functools
from typing import Any, Optional
import sqlalchemy
import sqlalchemy.orm
import sqlalchemy.pool
import PyFunceble.sessions
from PyFunceble.database.credential.base import CredentialBase
class DBSession:
"""
Provides our very own database session interface and handler.
"""
credential: Optional[CredentialBase] = None
current_session: sqlalchemy.orm.Session = None
def __enter__(self) -> sqlalchemy.orm.Session:
if PyFunceble.sessions.DB_FACTORY is not None:
self.current_session = PyFunceble.sessions.DB_FACTORY()
else:
self.current_session = self.get_new_session()()
return self.current_session
def __exit__(self, exc_type, exc_val, exc_tb) -> None:
if exc_type or exc_val or exc_tb:
try:
self.current_session.rollback()
except AttributeError:
pass
self.close()
def ensure_credential_is_given(func): # pylint: disable=no-self-argument
"""
Ensures that a credential object is set before launching the
decorated method.
:raise TypeError:
When :code:`credential` is not correct.
"""
@functools.wraps(func)
def wrapper(self, *args, **kwargs):
if not isinstance(self.credential, CredentialBase):
raise TypeError(
f"<self.credential> should be {CredentialBase}, "
f"{type(self.credential)} given."
)
return func(self, *args, **kwargs) # pylint: disable=not-callable
return wrapper
def execute_if_authorized(default: Any = None): # pylint: disable=no-self-argument
"""
Executes the decorated method only if we are authorized to process.
Otherwise, apply the given :code:`default`.
"""
def inner_metdhod(func):
@functools.wraps(func)
def wrapper(self, *args, **kwargs):
if self.authorized:
return func(self, *args, **kwargs) # pylint: disable=not-callable
return self if default is None else default
return wrapper
return inner_metdhod
@property
def authorized(self) -> bool:
"""
Provides the authorization to operate.
"""
return self.credential is not None
@execute_if_authorized(None)
@ensure_credential_is_given
def init_db_sessions(self) -> "DBSession":
"""
Initiate the global session to work with.
"""
if PyFunceble.sessions.DB_ENGINE is None:
PyFunceble.sessions.DB_ENGINE = sqlalchemy.create_engine(
self.credential.get_uri(),
poolclass=sqlalchemy.pool.NullPool,
pool_pre_ping=True,
)
PyFunceble.sessions.DB_FACTORY = sqlalchemy.orm.sessionmaker(
bind=PyFunceble.sessions.DB_ENGINE,
autoflush=True,
autocommit=False,
expire_on_commit=False,
)
return self
@execute_if_authorized(None)
def get_db_session(self) -> "DBSession":
"""
Provides a new session.
"""
session_object = DBSession()
session_object.credential = copy.deepcopy(self.credential)
return session_object
@execute_if_authorized(None)
@ensure_credential_is_given
def get_new_session(self) -> sqlalchemy.orm.sessionmaker:
"""
Creates and returns a new session.
.. warning::
This method generate a new session without any pool of connections.
"""
engine = sqlalchemy.create_engine(
self.credential.get_uri(),
poolclass=sqlalchemy.pool.NullPool,
pool_pre_ping=True,
)
return sqlalchemy.orm.sessionmaker(
bind=engine,
autoflush=True,
autocommit=False,
expire_on_commit=False,
)
@execute_if_authorized(None)
@ensure_credential_is_given
def get_new_pool_session(self) -> sqlalchemy.orm.sessionmaker:
"""
Create and return a new session.
"""
engine = sqlalchemy.create_engine(self.credential.get_uri(), pool_pre_ping=True)
return sqlalchemy.orm.sessionmaker(
bind=engine,
autoflush=True,
autocommit=False,
expire_on_commit=False,
)
def close(self) -> "DBSession":
"""
Closes the session if exists.
"""
if self.current_session is not None:
self.current_session.close()
del self.current_session
self.current_session = None
return self
@execute_if_authorized(None)
def query(self, *args, **kwargs) -> Any:
"""
Makes a query.
"""
# pylint: disable=no-member
with self as db_session:
return db_session.query(*args, **kwargs)
|
