Make session var private

Author: aclark4life

pymongo/asynchronous/client_session.py

@@ -1068,7 +1068,7 @@ def __copy__(self) -> NoReturn:
         raise TypeError("A AsyncClientSession cannot be copied, create a new session instead")
 
 
-SESSION: ContextVar[Optional[AsyncClientSession]] = ContextVar("SESSION", default=None)
+_SESSION: ContextVar[Optional[AsyncClientSession]] = ContextVar("SESSION", default=None)
 
 
 class _EmptyServerSession:

pymongo/asynchronous/cursor.py

@@ -63,7 +63,7 @@
     from _typeshed import SupportsItems
 
     from bson.codec_options import CodecOptions
-    from pymongo.asynchronous.client_session import SESSION, AsyncClientSession
+    from pymongo.asynchronous.client_session import AsyncClientSession
     from pymongo.asynchronous.collection import AsyncCollection
     from pymongo.asynchronous.pool import AsyncConnection
     from pymongo.read_preferences import _ServerMode
@@ -136,13 +136,15 @@ def __init__(
         self._killed = False
         self._session: Optional[AsyncClientSession]
 
-        _SESSION = SESSION.get()
+        from .client_session import _SESSION
+
+        bound_session = _SESSION.get()
 
         if session:
             self._session = session
             self._explicit_session = True
-        elif _SESSION:
-            self._session = _SESSION
+        elif bound_session:
+            self._session = bound_session
             self._explicit_session = True
         else:
             self._session = None

pymongo/asynchronous/mongo_client.py

@@ -65,7 +65,7 @@
 from pymongo.asynchronous import client_session, database, uri_parser
 from pymongo.asynchronous.change_stream import AsyncChangeStream, AsyncClusterChangeStream
 from pymongo.asynchronous.client_bulk import _AsyncClientBulk
-from pymongo.asynchronous.client_session import SESSION, _EmptyServerSession
+from pymongo.asynchronous.client_session import _SESSION, _EmptyServerSession
 from pymongo.asynchronous.command_cursor import AsyncCommandCursor
 from pymongo.asynchronous.settings import TopologySettings
 from pymongo.asynchronous.topology import Topology, _ErrorContext
@@ -1358,7 +1358,7 @@ def _start_session(self, implicit: bool, **kwargs: Any) -> AsyncClientSession:
         bind = opts._bind
         session = client_session.AsyncClientSession(self, server_session, opts, implicit)
         if bind:
-            SESSION.set(session)
+            _SESSION.set(session)
         return session
 
     def start_session(

pymongo/synchronous/client_session.py

@@ -1063,7 +1063,7 @@ def __copy__(self) -> NoReturn:
         raise TypeError("A ClientSession cannot be copied, create a new session instead")
 
 
-SESSION: ContextVar[Optional[ClientSession]] = ContextVar("SESSION", default=None)
+_SESSION: ContextVar[Optional[ClientSession]] = ContextVar("SESSION", default=None)
 
 
 class _EmptyServerSession:

pymongo/synchronous/cursor.py

@@ -64,7 +64,7 @@
 
     from bson.codec_options import CodecOptions
     from pymongo.read_preferences import _ServerMode
-    from pymongo.synchronous.client_session import SESSION, ClientSession
+    from pymongo.synchronous.client_session import ClientSession
     from pymongo.synchronous.collection import Collection
     from pymongo.synchronous.pool import Connection
 
@@ -136,13 +136,15 @@ def __init__(
         self._killed = False
         self._session: Optional[ClientSession]
 
-        _SESSION = SESSION.get()
+        from .client_session import _SESSION
+
+        bound_session = _SESSION.get()
 
         if session:
             self._session = session
             self._explicit_session = True
-        elif _SESSION:
-            self._session = _SESSION
+        elif bound_session:
+            self._session = bound_session
             self._explicit_session = True
         else:
             self._session = None

pymongo/synchronous/mongo_client.py

@@ -107,7 +107,7 @@
 from pymongo.synchronous import client_session, database, uri_parser
 from pymongo.synchronous.change_stream import ChangeStream, ClusterChangeStream
 from pymongo.synchronous.client_bulk import _ClientBulk
-from pymongo.synchronous.client_session import SESSION, _EmptyServerSession
+from pymongo.synchronous.client_session import _SESSION, _EmptyServerSession
 from pymongo.synchronous.command_cursor import CommandCursor
 from pymongo.synchronous.settings import TopologySettings
 from pymongo.synchronous.topology import Topology, _ErrorContext
@@ -1356,7 +1356,7 @@ def _start_session(self, implicit: bool, **kwargs: Any) -> ClientSession:
         bind = opts._bind
         session = client_session.ClientSession(self, server_session, opts, implicit)
         if bind:
-            SESSION.set(session)
+            _SESSION.set(session)
         return session
 
     def start_session(

test/asynchronous/test_session.py

@@ -380,13 +380,6 @@ async def test_cursor_clone(self):
             clone = cursor.clone()
             self.assertTrue(clone.session is s)
 
-        # Explicit session via context variable.
-        async with self.client.start_session(bind=True) as s:
-            cursor = coll.find()
-            self.assertTrue(cursor.session is s)
-            clone = cursor.clone()
-            self.assertTrue(clone.session is s)
-
         # No explicit session.
         cursor = coll.find(batch_size=2)
         await anext(cursor)
@@ -401,6 +394,13 @@ async def test_cursor_clone(self):
         await cursor.close()
         await clone.close()
 
+        # Explicit session via context variable.
+        async with self.client.start_session(bind=True) as s:
+            cursor = coll.find()
+            self.assertTrue(cursor.session is s)
+            clone = cursor.clone()
+            self.assertTrue(clone.session is s)
+
     async def test_cursor(self):
         listener = self.listener
         client = self.client

test/test_session.py

@@ -380,13 +380,6 @@ def test_cursor_clone(self):
             clone = cursor.clone()
             self.assertTrue(clone.session is s)
 
-        # Explicit session via context variable.
-        with self.client.start_session(bind=True) as s:
-            cursor = coll.find()
-            self.assertTrue(cursor.session is s)
-            clone = cursor.clone()
-            self.assertTrue(clone.session is s)
-
         # No explicit session.
         cursor = coll.find(batch_size=2)
         next(cursor)
@@ -401,6 +394,13 @@ def test_cursor_clone(self):
         cursor.close()
         clone.close()
 
+        # Explicit session via context variable.
+        with self.client.start_session(bind=True) as s:
+            cursor = coll.find()
+            self.assertTrue(cursor.session is s)
+            clone = cursor.clone()
+            self.assertTrue(clone.session is s)
+
     def test_cursor(self):
         listener = self.listener
         client = self.client