PYTHON-3879 Rename SocketInfo to Connection #1329

NoahStapp · 2023-07-26T22:39:48Z

No description provided.

ShaneHarvey · 2023-07-26T23:15:41Z

pymongo/pyopenssl_context.py

@@ -347,7 +347,7 @@ def wrap_socket(
        server_hostname=None,
        session=None,
    ):
-        """Wrap an existing Python socket sock and return a TLS socket
+        """Wrap an existing Python socket connector and return a TLS socket


Looks like the renaming went a little too far.

ShaneHarvey · 2023-07-26T23:18:55Z

pymongo/pool.py


    @contextlib.contextmanager
-    def get_socket(self, handler=None):
-        """Get a socket from the pool. Use with a "with" statement.
+    def get_conn(self, handler=None):


Since where changing this anyway, how do you feel about calling this "pool.checkout()" to closer to the CMAP spec?

ShaneHarvey · 2023-07-26T23:19:22Z

pymongo/pool.py


-    def return_socket(self, sock_info):
-        """Return the socket to the pool, or if it's closed discard it.
+    def return_conn(self, conn):


Same here but called "checkin"

ShaneHarvey · 2023-07-26T23:21:59Z

pymongo/aggregation.py

@@ -134,7 +134,7 @@ def get_cursor(
        self,
        session: ClientSession,
        server: Server,
-        sock_info: SocketInfo,
+        connection: Connection,


What do you think about naming this "conn: Connection" to be more succinct everywhere?

blink1073 · 2023-07-27T21:31:41Z

There's still a lot of docstrings that have unnecessary changes.

blink1073 · 2023-07-27T21:24:24Z

pymongo/collection.py

@@ -1644,11 +1644,11 @@ def find(self, *args: Any, **kwargs: Any) -> Cursor[_DocumentType]:

          - A :class:`~pymongo.cursor.Cursor` instance created with the
            :attr:`~pymongo.cursor.CursorType.EXHAUST` cursor_type requires an
-            exclusive :class:`~socket.socket` connection to MongoDB. If the
+            exclusive :class:`~socket.socket` conn to MongoDB. If the


These three docstring changes should be reverted

blink1073 · 2023-07-27T21:26:19Z

pymongo/mongo_client.py

@@ -175,7 +175,7 @@ def __init__(
                quote_plus(user), quote_plus(password), host)
            client = MongoClient(uri)

-        Unix domain sockets are also supported. The socket path must be percent
+        Unix domain conns are also supported. The socket path must be percent


blink1073 · 2023-07-27T21:26:25Z

pymongo/mongo_client.py

@@ -184,7 +184,7 @@ def __init__(

        But not when passed as a simple hostname::

-            client = MongoClient('/tmp/mongodb-27017.sock')
+            client = MongoClient('/tmp/mongodb-27017.conn')


blink1073 · 2023-07-27T21:26:30Z

pymongo/mongo_client.py

@@ -308,18 +308,18 @@ def __init__(
            seconds).
          - `waitQueueTimeoutMS`: (integer or None) How long (in milliseconds)
            a thread will wait for a socket from the pool if the pool has no
-            free sockets. Defaults to ``None`` (no timeout).
+            free conns. Defaults to ``None`` (no timeout).


blink1073 · 2023-07-27T21:26:45Z

pymongo/mongo_client.py

            query log and profile collections.
          - `driver`: (pair or None) A driver implemented on top of PyMongo can
            pass a :class:`~pymongo.driver_info.DriverInfo` to add its name,
            version, and platform to the message printed in the server log when
-            establishing a connection.
+            establishing a conn.


blink1073 · 2023-07-27T21:28:49Z

pymongo/monitoring.py

@@ -914,7 +914,7 @@ class ConnectionCheckOutFailedReason:

    CONN_ERROR = "connectionError"
    """The connection check out attempt experienced an error while setting up
-    a new connection.
+    a new conn.


blink1073 · 2023-07-27T21:29:06Z

pymongo/monitoring.py

@@ -1023,7 +1023,7 @@ def __repr__(self):


 class ConnectionCheckOutStartedEvent(_ConnectionEvent):
-    """Published when the driver starts attempting to check out a connection.
+    """Published when the driver starts attempting to check out a conn.


revert (all the docstring changes in this file).

blink1073 · 2023-07-27T21:30:13Z

pymongo/network.py

-    context = sock_info.cancel_context
-    # Only Monitor connections can be cancelled.
+    context = conn.cancel_context
+    # Only Monitor conns can be cancelled.


blink1073 · 2023-07-27T21:30:24Z

pymongo/network.py

@@ -309,33 +307,31 @@ def wait_for_read(sock_info: SocketInfo, deadline: Optional[float]) -> None:
                raise socket.timeout("timed out")


-# Errors raised by sockets (and TLS sockets) when in non-blocking mode.
+# Errors raised by conns (and TLS conns) when in non-blocking mode.


blink1073 · 2023-07-27T21:30:33Z

pymongo/network.py

        except BLOCKING_IO_ERRORS:
            raise socket.timeout("timed out")
        except OSError as exc:  # noqa: B014
            if _errno_from_exception(exc) == errno.EINTR:
                continue
            raise
        if chunk_length == 0:
-            raise OSError("connection closed")
+            raise OSError("conn closed")


pymongo/command_cursor.py

NoahStapp · 2023-07-27T23:36:25Z

Sorry for all the docstring issues, I figured out how to have PyCharm filter for that correctly. They should all be resolved now.

blink1073

LGTM!

….x (#6736) Pymongo 4.5.0 [changed the name](mongodb/mongo-python-driver#1329) of the `get_socket` function on which our integration is based. This pull request adapts the integration to work with version 4.5.0 by changing the expected function name based on the version. Fixes #6723 ## Checklist - [x] Change(s) are motivated and described in the PR description. - [x] Testing strategy is described if automated tests are not included in the PR. - [x] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) are followed. If no release note is required, add label `changelog/no-changelog`. - [x] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [x] Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. - [x] Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) --------- Co-authored-by: Teague Bick <[email protected]>

….x (#6736) Pymongo 4.5.0 [changed the name](mongodb/mongo-python-driver#1329) of the `get_socket` function on which our integration is based. This pull request adapts the integration to work with version 4.5.0 by changing the expected function name based on the version. Fixes #6723 ## Checklist - [x] Change(s) are motivated and described in the PR description. - [x] Testing strategy is described if automated tests are not included in the PR. - [x] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) are followed. If no release note is required, add label `changelog/no-changelog`. - [x] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [x] Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. - [x] Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) --------- Co-authored-by: Teague Bick <[email protected]> (cherry picked from commit 1a3c424)

… [backport 1.18] (#6775) Backport 1a3c424 from #6736 to 1.18. Pymongo 4.5.0 [changed the name](mongodb/mongo-python-driver#1329) of the `get_socket` function on which our integration is based. This pull request adapts the integration to work with version 4.5.0 by changing the expected function name based on the version. Fixes #6723 ## Checklist - [x] Change(s) are motivated and described in the PR description. - [x] Testing strategy is described if automated tests are not included in the PR. - [x] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) are followed. If no release note is required, add label `changelog/no-changelog`. - [x] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [x] Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. - [x] Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) --------- Co-authored-by: Emmett Butler <[email protected]> Co-authored-by: Munir Abdinur <[email protected]>

….x (#6736) Pymongo 4.5.0 [changed the name](mongodb/mongo-python-driver#1329) of the `get_socket` function on which our integration is based. This pull request adapts the integration to work with version 4.5.0 by changing the expected function name based on the version. Fixes #6723 ## Checklist - [x] Change(s) are motivated and described in the PR description. - [x] Testing strategy is described if automated tests are not included in the PR. - [x] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) are followed. If no release note is required, add label `changelog/no-changelog`. - [x] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [x] Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. - [x] Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) --------- Co-authored-by: Teague Bick <[email protected]>

msm416 · 2024-08-01T09:58:32Z

Hi, shouldn't this change be mentioned in the Changelog? Thanks!

ShaneHarvey · 2024-08-01T17:24:01Z

Hi, shouldn't this change be mentioned in the Changelog? Thanks!

We did not mention it because SocketInfo/Connection are private internal apis. Are you depending it for something?

msm416 · 2024-08-02T09:04:54Z

@ShaneHarvey - I see, it's alright since I've changed the import to workaround for now but will probably re-write my logic to not make use of those classes.

SocketInfo was documented in pymongo v3: https://pymongo.readthedocs.io/en/3.12.3/api/pymongo/pool.html

To me, private api == what's not documented, but I expected that if something is once documented but then removed from docs, that should appear in some changelogs for visibility.

ShaneHarvey · 2024-08-02T18:27:59Z

Yes we removed that documentation in 4.0 (part of PYTHON-2164) but even in v3, those classes were still intended to be private. An app couldn't actually access a MongoClient's Pool or Connection classes so there was no reason to document those apis. I'd still be curious to hear what you're using those classes for.

msm416 · 2024-08-03T10:26:28Z

[..] those classes were still intended to be private

I see.

I'd still be curious to hear what you're using those classes for.

I'm using the class in a test: to patch Connection.send_message with a custom method wrapper that counts the calls for this method, to give a just a brief description.

ShaneHarvey · 2024-08-05T18:13:37Z

Interesting, could your test use a CommandListener instead https://pymongo.readthedocs.io/en/stable/api/pymongo/monitoring.html?

msm416 · 2024-08-07T12:32:53Z

Thank you @ShaneHarvey ! Yes, I made it work with a Listener in the end, after following your docs (CommandLogger) 👍

NoahStapp added 3 commits July 26, 2023 14:11

PYTHON-3879 Rename SocketInfo to Connection

0ce892a

More refactoring

569e2a6

Finished first pass

5a00fb3

NoahStapp requested a review from ShaneHarvey July 26, 2023 22:39

ShaneHarvey reviewed Jul 26, 2023

View reviewed changes

Rename connection variables to conn, cleanup

c356daa

NoahStapp requested a review from ShaneHarvey July 27, 2023 18:20

blink1073 reviewed Jul 27, 2023

View reviewed changes

Docstring fixes

3da7b51

ShaneHarvey requested changes Jul 27, 2023

View reviewed changes

pymongo/command_cursor.py Outdated Show resolved Hide resolved

NoahStapp added 2 commits July 27, 2023 15:47

conn_mgr back to sock_mgr

345947d

More cleanup

0b4c32b

NoahStapp requested review from ShaneHarvey and blink1073 July 27, 2023 23:23

blink1073 approved these changes Jul 28, 2023

View reviewed changes

NoahStapp merged commit c88ae79 into mongodb:master Jul 28, 2023

NoahStapp deleted the PYTHON-3879 branch July 28, 2023 17:04

emmettbutler mentioned this pull request Aug 23, 2023

fix(pymongo): update pymongo integration for compatibility with 4.5.x DataDog/dd-trace-py#6736

Merged

16 tasks

github-actions bot mentioned this pull request Aug 28, 2023

fix(pymongo): update pymongo integration for compatibility with 4.5.x [backport 1.18] DataDog/dd-trace-py#6775

Merged

16 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PYTHON-3879 Rename SocketInfo to Connection #1329

PYTHON-3879 Rename SocketInfo to Connection #1329

NoahStapp commented Jul 26, 2023

ShaneHarvey Jul 26, 2023

ShaneHarvey Jul 26, 2023

ShaneHarvey Jul 26, 2023

ShaneHarvey Jul 26, 2023

blink1073 commented Jul 27, 2023

blink1073 Jul 27, 2023

blink1073 Jul 27, 2023

blink1073 Jul 27, 2023

blink1073 Jul 27, 2023

blink1073 Jul 27, 2023

blink1073 Jul 27, 2023

blink1073 Jul 27, 2023

blink1073 Jul 27, 2023

blink1073 Jul 27, 2023

blink1073 Jul 27, 2023

NoahStapp commented Jul 27, 2023

blink1073 left a comment

msm416 commented Aug 1, 2024 •

edited

Loading

ShaneHarvey commented Aug 1, 2024

msm416 commented Aug 2, 2024

ShaneHarvey commented Aug 2, 2024 •

edited

Loading

msm416 commented Aug 3, 2024

ShaneHarvey commented Aug 5, 2024

msm416 commented Aug 7, 2024

PYTHON-3879 Rename SocketInfo to Connection #1329

PYTHON-3879 Rename SocketInfo to Connection #1329

Conversation

NoahStapp commented Jul 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blink1073 commented Jul 27, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NoahStapp commented Jul 27, 2023

blink1073 left a comment

Choose a reason for hiding this comment

msm416 commented Aug 1, 2024 • edited Loading

ShaneHarvey commented Aug 1, 2024

msm416 commented Aug 2, 2024

ShaneHarvey commented Aug 2, 2024 • edited Loading

msm416 commented Aug 3, 2024

ShaneHarvey commented Aug 5, 2024

msm416 commented Aug 7, 2024

msm416 commented Aug 1, 2024 •

edited

Loading

ShaneHarvey commented Aug 2, 2024 •

edited

Loading