Main global settings (#215) change internal deny split to positive allow split (with false by default) - for increase readable

Author: rekby

CHANGELOG.md

@@ -1,6 +1,7 @@
-* Flag for deny split transaction
+* Added functions for global change behaviour for compatible with future sdk version: ydb.global_allow_truncated_result and global_allow_split_transactions
 
 ## 2.12.3 ##
+* Flag for deny split transaction
 * Add six package to requirements
 * Fixed error while passing date parameter in execute
 

tests/aio/test_tx.py

@@ -101,7 +101,7 @@ async def test_split_transactions_deny_split(driver, table_name):
     async with ydb.aio.SessionPool(driver, 1) as pool:
 
         async def check_transaction(s: ydb.aio.table.Session):
-            async with s.transaction(deny_split_transactions=True) as tx:
+            async with s.transaction(allow_split_transactions=False) as tx:
                 await tx.execute("INSERT INTO %s (id) VALUES (1)" % table_name)
                 await tx.commit()
 
@@ -122,7 +122,7 @@ async def test_split_transactions_allow_split(driver, table_name):
     async with ydb.aio.SessionPool(driver, 1) as pool:
 
         async def check_transaction(s: ydb.aio.table.Session):
-            async with s.transaction(deny_split_transactions=False) as tx:
+            async with s.transaction(allow_split_transactions=True) as tx:
                 await tx.execute("INSERT INTO %s (id) VALUES (1)" % table_name)
                 await tx.commit()
 

tests/table/test_tx.py

@@ -95,7 +95,7 @@ def test_split_transactions_deny_split(driver_sync, table_name):
     with ydb.SessionPool(driver_sync, 1) as pool:
 
         def check_transaction(s: ydb.table.Session):
-            with s.transaction(deny_split_transactions=True) as tx:
+            with s.transaction(allow_split_transactions=False) as tx:
                 tx.execute("INSERT INTO %s (id) VALUES (1)" % table_name)
                 tx.commit()
 
@@ -115,7 +115,7 @@ def test_split_transactions_allow_split(driver_sync, table_name):
     with ydb.SessionPool(driver_sync, 1) as pool:
 
         def check_transaction(s: ydb.table.Session):
-            with s.transaction(deny_split_transactions=False) as tx:
+            with s.transaction(allow_split_transactions=True) as tx:
                 tx.execute("INSERT INTO %s (id) VALUES (1)" % table_name)
                 tx.commit()
 

ydb/__init__.py

@@ -1,5 +1,6 @@
 from .credentials import *  # noqa
 from .driver import *  # noqa
+from .global_settings import *  # noqa
 from .table import *  # noqa
 from .issues import *  # noqa
 from .types import *  # noqa

ydb/aio/table.py

@@ -13,6 +13,7 @@
     _scan_query_request_factory,
     _wrap_scan_query_response,
     BaseTxContext,
+    _allow_split_transaction,
 )
 from . import _utilities
 from ydb import _apis, _session_impl
@@ -120,13 +121,15 @@ async def alter_table(
             set_read_replicas_settings,
         )
 
-    def transaction(self, tx_mode=None, *, deny_split_transactions=False):
+    def transaction(
+        self, tx_mode=None, *, allow_split_transactions=_allow_split_transaction
+    ):
         return TxContext(
             self._driver,
             self._state,
             self,
             tx_mode,
-            deny_split_transactions=deny_split_transactions,
+            allow_split_transactions=allow_split_transactions,
         )
 
     async def describe_table(self, path, settings=None):  # pylint: disable=W0236

ydb/global_settings.py

@@ -0,0 +1,16 @@
+from . import convert
+from . import table
+
+
+def global_allow_truncated_result(enabled: bool = True):
+    """
+    call global_allow_truncated_result(False) for more safe execution and compatible with future changes
+    """
+    convert._default_allow_truncated_result = enabled
+
+
+def global_allow_split_transactions(enabled: bool):
+    """
+    call global_allow_truncated_result(False) for more safe execution and compatible with future changes
+    """
+    table._allow_split_transaction = enabled

ydb/table.py

@@ -28,6 +28,8 @@
 except ImportError:
     interceptor = None
 
+_allow_split_transaction = True
+
 logger = logging.getLogger(__name__)
 
 ##################################################################
@@ -1182,7 +1184,9 @@ def execute_scheme(self, yql_text, settings=None):
         pass
 
     @abstractmethod
-    def transaction(self, tx_mode=None, deny_split_transactions=False):
+    def transaction(
+        self, tx_mode=None, allow_split_transactions=_allow_split_transaction
+    ):
         pass
 
     @abstractmethod
@@ -1687,13 +1691,15 @@ def execute_scheme(self, yql_text, settings=None):
             self._state.endpoint,
         )
 
-    def transaction(self, tx_mode=None, deny_split_transactions=False):
+    def transaction(
+        self, tx_mode=None, allow_split_transactions=_allow_split_transaction
+    ):
         return TxContext(
             self._driver,
             self._state,
             self,
             tx_mode,
-            deny_split_transactions=deny_split_transactions,
+            allow_split_transactions=allow_split_transactions,
         )
 
     def has_prepared(self, query):
@@ -2212,7 +2218,7 @@ class BaseTxContext(ITxContext):
         "_driver",
         "session",
         "_finished",
-        "_deny_split_transactions",
+        "_allow_split_transactions",
     )
 
     _COMMIT = "commit"
@@ -2225,7 +2231,7 @@ def __init__(
         session,
         tx_mode=None,
         *,
-        deny_split_transactions=False
+        allow_split_transactions=_allow_split_transaction
     ):
         """
         An object that provides a simple transaction context manager that allows statements execution
@@ -2250,7 +2256,7 @@ def __init__(
         self._session_state = session_state
         self.session = session
         self._finished = ""
-        self._deny_split_transactions = deny_split_transactions
+        self._allow_split_transactions = allow_split_transactions
 
     def __enter__(self):
         """
@@ -2410,7 +2416,7 @@ def _check_split(self, allow=""):
         Deny all operaions with transaction after commit/rollback.
         Exception: double commit and double rollbacks, because it is safe
         """
-        if not self._deny_split_transactions:
+        if self._allow_split_transactions:
             return
 
         if self._finished != "" and self._finished != allow: