sqlalchemy-multiple-db 2.0.0__py3-none-any.whl → 2.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- sqlalchemy_multiple_db/__init__.py +2 -2
- sqlalchemy_multiple_db/helper.py +25 -23
- sqlalchemy_multiple_db/version.py +1 -1
- {sqlalchemy_multiple_db-2.0.0.dist-info → sqlalchemy_multiple_db-2.1.0.dist-info}/METADATA +6 -2
- sqlalchemy_multiple_db-2.1.0.dist-info/RECORD +10 -0
- {sqlalchemy_multiple_db-2.0.0.dist-info → sqlalchemy_multiple_db-2.1.0.dist-info}/WHEEL +1 -1
- tests/test_helper.py +54 -24
- sqlalchemy_multiple_db-2.0.0.dist-info/RECORD +0 -10
- {sqlalchemy_multiple_db-2.0.0.dist-info → sqlalchemy_multiple_db-2.1.0.dist-info}/LICENSE +0 -0
- {sqlalchemy_multiple_db-2.0.0.dist-info → sqlalchemy_multiple_db-2.1.0.dist-info}/top_level.txt +0 -0
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
from .helper import DBConfig, DBHelper, db
|
|
1
|
+
from .helper import DEFAULT_DB_NAME, DBConfig, DBHelper, db
|
|
2
2
|
|
|
3
|
-
__all__ = ["DBConfig", "DBHelper", "db"]
|
|
3
|
+
__all__ = ["DEFAULT_DB_NAME", "DBConfig", "DBHelper", "db"]
|
sqlalchemy_multiple_db/helper.py
CHANGED
|
@@ -2,9 +2,10 @@ import logging
|
|
|
2
2
|
from contextlib import contextmanager
|
|
3
3
|
from dataclasses import dataclass, field
|
|
4
4
|
from json import dumps, loads
|
|
5
|
-
from typing import Any, Dict,
|
|
5
|
+
from typing import Any, Dict, Generator, Tuple, Union
|
|
6
6
|
|
|
7
7
|
from sqlalchemy import create_engine
|
|
8
|
+
from sqlalchemy.exc import SQLAlchemyError
|
|
8
9
|
from sqlalchemy.orm import Session, scoped_session, sessionmaker
|
|
9
10
|
from sqlalchemy.sql import text
|
|
10
11
|
|
|
@@ -25,22 +26,17 @@ DEFAULT_ENGINE_OPTIONS = {
|
|
|
25
26
|
@dataclass
|
|
26
27
|
class DBConfig:
|
|
27
28
|
dsn: str
|
|
28
|
-
session_options:
|
|
29
|
-
engine_options:
|
|
29
|
+
session_options: Dict[str, Any] = field(default_factory=dict)
|
|
30
|
+
engine_options: Dict[str, Any] = field(default_factory=dict)
|
|
30
31
|
|
|
31
32
|
def __post_init__(self):
|
|
32
|
-
session_options = DEFAULT_SESSION_OPTIONS
|
|
33
|
-
|
|
34
|
-
self.session_options = session_options
|
|
35
|
-
|
|
36
|
-
engine_options = DEFAULT_ENGINE_OPTIONS
|
|
37
|
-
engine_options.update(self.engine_options or {})
|
|
38
|
-
self.engine_options = engine_options
|
|
33
|
+
self.session_options = {**DEFAULT_SESSION_OPTIONS, **self.session_options}
|
|
34
|
+
self.engine_options = {**DEFAULT_ENGINE_OPTIONS, **self.engine_options}
|
|
39
35
|
|
|
40
36
|
|
|
41
37
|
@dataclass
|
|
42
38
|
class DBHelper:
|
|
43
|
-
sessions: Dict[str,
|
|
39
|
+
sessions: Dict[str, scoped_session] = field(init=False, repr=False)
|
|
44
40
|
config: Dict[str, DBConfig] = field(init=False, repr=False)
|
|
45
41
|
|
|
46
42
|
def __getattribute__(self, db_name):
|
|
@@ -51,7 +47,7 @@ class DBHelper:
|
|
|
51
47
|
print(f"DB: You need to call setup() for getting attribute {db_name}")
|
|
52
48
|
raise exc
|
|
53
49
|
|
|
54
|
-
def create_scoped_session(self, config: DBConfig) ->
|
|
50
|
+
def create_scoped_session(self, config: DBConfig) -> scoped_session:
|
|
55
51
|
engine_options = config.engine_options or {}
|
|
56
52
|
session_options = config.session_options or {}
|
|
57
53
|
|
|
@@ -70,32 +66,38 @@ class DBHelper:
|
|
|
70
66
|
for db_name, cfg in config.items():
|
|
71
67
|
self.sessions[db_name] = self.create_scoped_session(cfg)
|
|
72
68
|
|
|
73
|
-
def shutdown(self):
|
|
69
|
+
def shutdown(self) -> None:
|
|
74
70
|
for session in self.sessions.values():
|
|
75
71
|
session.remove()
|
|
72
|
+
self.sessions.clear()
|
|
76
73
|
|
|
77
74
|
@contextmanager
|
|
78
|
-
def session_scope(self, db_name: str = DEFAULT_DB_NAME):
|
|
79
|
-
session =
|
|
75
|
+
def session_scope(self, db_name: str = DEFAULT_DB_NAME) -> Generator[Session, None, None]:
|
|
76
|
+
session = self.sessions.get(db_name)
|
|
77
|
+
if not session:
|
|
78
|
+
raise ValueError(f"No session found for database: {db_name}")
|
|
80
79
|
try:
|
|
81
|
-
yield session
|
|
80
|
+
yield session()
|
|
81
|
+
session.commit()
|
|
82
|
+
except Exception:
|
|
83
|
+
session.rollback()
|
|
84
|
+
raise
|
|
82
85
|
finally:
|
|
83
|
-
session.
|
|
86
|
+
session.remove()
|
|
84
87
|
|
|
85
|
-
def get_status_info(self) -> Tuple[Dict[str,
|
|
88
|
+
def get_status_info(self) -> Tuple[Dict[str, Dict[str, str]], bool]:
|
|
86
89
|
full_status = True
|
|
87
90
|
full_status_info = {}
|
|
88
|
-
|
|
89
91
|
for db_name, session in self.sessions.items():
|
|
90
92
|
status = True
|
|
91
93
|
try:
|
|
92
|
-
session.execute(text("
|
|
93
|
-
except
|
|
94
|
+
session.execute(text("SELECT 1"))
|
|
95
|
+
except SQLAlchemyError as e:
|
|
96
|
+
logger.exception(f"Database {db_name} connection failed: {e}")
|
|
94
97
|
status &= False
|
|
95
98
|
full_status &= False
|
|
96
|
-
logger.exception(e)
|
|
97
99
|
finally:
|
|
98
|
-
session.
|
|
100
|
+
session.remove()
|
|
99
101
|
|
|
100
102
|
full_status_info[db_name] = {"status": "OK"} if status else {"status": "FAILED"}
|
|
101
103
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: sqlalchemy-multiple-db
|
|
3
|
-
Version: 2.
|
|
3
|
+
Version: 2.1.0
|
|
4
4
|
Summary: Helper for easily connect to multiple databases.
|
|
5
5
|
Home-page: https://github.com/bigbag/sqlalchemy-multiple-db
|
|
6
6
|
Download-URL: https://pypi.python.org/pypi/sqlalchemy-multiple-db
|
|
@@ -17,6 +17,8 @@ Classifier: Programming Language :: Python :: 3.8
|
|
|
17
17
|
Classifier: Programming Language :: Python :: 3.9
|
|
18
18
|
Classifier: Programming Language :: Python :: 3.10
|
|
19
19
|
Classifier: Programming Language :: Python :: 3.11
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
20
22
|
Classifier: Operating System :: POSIX
|
|
21
23
|
Classifier: Topic :: Software Development
|
|
22
24
|
Classifier: Topic :: Software Development :: Libraries
|
|
@@ -25,7 +27,7 @@ Classifier: Intended Audience :: Developers
|
|
|
25
27
|
Requires-Python: >=3.7
|
|
26
28
|
Description-Content-Type: text/markdown
|
|
27
29
|
License-File: LICENSE
|
|
28
|
-
Requires-Dist: SQLAlchemy
|
|
30
|
+
Requires-Dist: SQLAlchemy<2.1,>=1.4
|
|
29
31
|
|
|
30
32
|
# sqlalchemy-multiple-db
|
|
31
33
|
|
|
@@ -39,6 +41,8 @@ Requires-Dist: SQLAlchemy (<2.1,>=1.4)
|
|
|
39
41
|
**sqlalchemy-multiple-db** helper for easily connect to multiple databases.
|
|
40
42
|
|
|
41
43
|
|
|
44
|
+
* [Project Changelog](CHANGELOG.md)
|
|
45
|
+
|
|
42
46
|
## Installation
|
|
43
47
|
|
|
44
48
|
sqlalchemy-multiple-db is available on PyPI.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
sqlalchemy_multiple_db/__init__.py,sha256=8PIlF8tQPslyby5BasBtkslNekUElmlO6sAMXPajHnk,121
|
|
2
|
+
sqlalchemy_multiple_db/helper.py,sha256=dnF4PELZ0GyT5k-7OfvGq7d5rj8V4gYpJWfIhZ7xXk4,3474
|
|
3
|
+
sqlalchemy_multiple_db/version.py,sha256=5YzJYv-H5stzmheyG9j5BOFBJXlOYiIVlsFApXHPWfE,39
|
|
4
|
+
tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
5
|
+
tests/test_helper.py,sha256=t3xDRrOi2FagSCsuqMSvopQgfCY1Qsd1f2mLQZC-29k,2795
|
|
6
|
+
sqlalchemy_multiple_db-2.1.0.dist-info/LICENSE,sha256=2SItc_2sUJkhdAdu-gT0T2-82dVhVafHCS6YdXBCpvY,11466
|
|
7
|
+
sqlalchemy_multiple_db-2.1.0.dist-info/METADATA,sha256=8CDr4aGUx20PpgdsafL7xWeoovTLZdYsZ5xvabj1Dl0,3055
|
|
8
|
+
sqlalchemy_multiple_db-2.1.0.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
|
|
9
|
+
sqlalchemy_multiple_db-2.1.0.dist-info/top_level.txt,sha256=WRw40xVgUf4SHgjF3460zsL23-iftOUvMcRn-dkxe-w,29
|
|
10
|
+
sqlalchemy_multiple_db-2.1.0.dist-info/RECORD,,
|
tests/test_helper.py
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
|
+
from unittest.mock import MagicMock
|
|
2
|
+
|
|
1
3
|
import pytest
|
|
2
|
-
from sqlalchemy.
|
|
3
|
-
from sqlalchemy.sql import text
|
|
4
|
+
from sqlalchemy.exc import SQLAlchemyError
|
|
4
5
|
|
|
5
|
-
from sqlalchemy_multiple_db import DBConfig, db
|
|
6
|
+
from sqlalchemy_multiple_db import DEFAULT_DB_NAME, DBConfig, DBHelper, db
|
|
6
7
|
|
|
7
8
|
|
|
8
9
|
def test_get_session_without_setup():
|
|
@@ -10,46 +11,75 @@ def test_get_session_without_setup():
|
|
|
10
11
|
db.sessions
|
|
11
12
|
|
|
12
13
|
|
|
13
|
-
|
|
14
|
-
|
|
14
|
+
@pytest.fixture
|
|
15
|
+
def db_helper():
|
|
16
|
+
helper = DBHelper()
|
|
17
|
+
config = {DEFAULT_DB_NAME: DBConfig(dsn="sqlite:///:memory:")}
|
|
18
|
+
helper.setup(config)
|
|
19
|
+
return helper
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
def test_session_scope_successful_transaction(db_helper):
|
|
23
|
+
mock_session = MagicMock()
|
|
24
|
+
mock_session_instance = MagicMock()
|
|
25
|
+
mock_session.return_value = mock_session_instance
|
|
26
|
+
db_helper.sessions = {DEFAULT_DB_NAME: mock_session}
|
|
27
|
+
|
|
28
|
+
with db_helper.session_scope() as session:
|
|
29
|
+
assert session == mock_session_instance
|
|
30
|
+
|
|
31
|
+
mock_session.assert_called_once()
|
|
32
|
+
mock_session.remove.assert_called_once()
|
|
15
33
|
|
|
16
|
-
assert "default" in db.sessions
|
|
17
|
-
assert len(db.sessions) == 1
|
|
18
|
-
assert isinstance(db.sessions["default"], scoped_session)
|
|
19
34
|
|
|
20
|
-
|
|
21
|
-
|
|
35
|
+
def test_session_scope_with_exception(db_helper):
|
|
36
|
+
mock_session = MagicMock()
|
|
37
|
+
mock_session_instance = MagicMock()
|
|
38
|
+
mock_session.return_value = mock_session_instance
|
|
39
|
+
db_helper.sessions = {DEFAULT_DB_NAME: mock_session}
|
|
22
40
|
|
|
23
|
-
|
|
41
|
+
with pytest.raises(ValueError):
|
|
42
|
+
with db_helper.session_scope():
|
|
43
|
+
raise ValueError("Test exception")
|
|
24
44
|
|
|
45
|
+
mock_session.assert_called_once()
|
|
46
|
+
mock_session.remove.assert_called_once()
|
|
25
47
|
|
|
26
|
-
def test_with__multiple_db():
|
|
27
|
-
db.setup({"test1": DBConfig(dsn="sqlite://"), "test2": DBConfig(dsn="sqlite://")})
|
|
28
48
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
49
|
+
def test_session_scope_with_non_default_db(db_helper):
|
|
50
|
+
custom_db = "custom_db"
|
|
51
|
+
mock_session = MagicMock()
|
|
52
|
+
mock_session_instance = MagicMock()
|
|
53
|
+
mock_session.return_value = mock_session_instance
|
|
54
|
+
db_helper.sessions = {custom_db: mock_session}
|
|
34
55
|
|
|
35
|
-
with
|
|
36
|
-
assert session
|
|
56
|
+
with db_helper.session_scope(db_name=custom_db) as session:
|
|
57
|
+
assert session == mock_session_instance
|
|
37
58
|
|
|
38
|
-
|
|
39
|
-
|
|
59
|
+
mock_session.assert_called_once()
|
|
60
|
+
mock_session.remove.assert_called_once()
|
|
40
61
|
|
|
41
|
-
|
|
62
|
+
|
|
63
|
+
def test_session_scope_with_invalid_db_name(db_helper):
|
|
64
|
+
invalid_db = "invalid_db"
|
|
65
|
+
|
|
66
|
+
with pytest.raises(ValueError, match=f"No session found for database: {invalid_db}"):
|
|
67
|
+
with db_helper.session_scope(db_name=invalid_db):
|
|
68
|
+
pass
|
|
42
69
|
|
|
43
70
|
|
|
44
71
|
class TestGetStatusInfo:
|
|
45
72
|
def test_error(self):
|
|
46
73
|
class MockSession:
|
|
47
74
|
def execute(self, *args, **kwargs):
|
|
48
|
-
raise
|
|
75
|
+
raise SQLAlchemyError()
|
|
49
76
|
|
|
50
77
|
def close(self, *args, **kwargs):
|
|
51
78
|
pass
|
|
52
79
|
|
|
80
|
+
def remove(self, *args, **kwargs):
|
|
81
|
+
pass
|
|
82
|
+
|
|
53
83
|
db.sessions = {"default": MockSession()}
|
|
54
84
|
|
|
55
85
|
full_status_info, full_status = db.get_status_info()
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
sqlalchemy_multiple_db/__init__.py,sha256=9byhhM_ltR8_3M580YfG03mzHTLRRfNFUZF-oEG264k,85
|
|
2
|
-
sqlalchemy_multiple_db/helper.py,sha256=a1DkX00LNebLphz89u2BgN3I-k7B_Ga6hWE0-GZZmFg,3192
|
|
3
|
-
sqlalchemy_multiple_db/version.py,sha256=QI-DBF3VUhfapTnt3i5KgRW28dWzJ5_y0KOj5wMC_K0,39
|
|
4
|
-
tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
5
|
-
tests/test_helper.py,sha256=WFT3pRsrIQRrwTG4r3hVHLQegdewcntqyVsfSgt6EVA,1806
|
|
6
|
-
sqlalchemy_multiple_db-2.0.0.dist-info/LICENSE,sha256=2SItc_2sUJkhdAdu-gT0T2-82dVhVafHCS6YdXBCpvY,11466
|
|
7
|
-
sqlalchemy_multiple_db-2.0.0.dist-info/METADATA,sha256=MtDDQ3ShlEsrCmP6tIdQeqDM6p3LZt8zU9727gtaW4Q,2919
|
|
8
|
-
sqlalchemy_multiple_db-2.0.0.dist-info/WHEEL,sha256=AtBG6SXL3KF_v0NxLf0ehyVOh0cold-JbJYXNGorC6Q,92
|
|
9
|
-
sqlalchemy_multiple_db-2.0.0.dist-info/top_level.txt,sha256=WRw40xVgUf4SHgjF3460zsL23-iftOUvMcRn-dkxe-w,29
|
|
10
|
-
sqlalchemy_multiple_db-2.0.0.dist-info/RECORD,,
|
|
File without changes
|
{sqlalchemy_multiple_db-2.0.0.dist-info → sqlalchemy_multiple_db-2.1.0.dist-info}/top_level.txt
RENAMED
|
File without changes
|