feat: add Python version to user agent string (#333)

feat: add python version to user agent

- Add ua/2.0 component following AWS SDK user agent 2.0 specification
- Add Python version with 'lang' (language) prefix
- Update unit tests and lightning/DCP e2e tests

Example: s3torchconnector/1.4.0 ua/2.0 lang/python#3.10.12 ...

Author: jet-tong

s3torchconnector/src/s3torchconnector/_user_agent.py

@@ -1,6 +1,7 @@
 #  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #  // SPDX-License-Identifier: BSD
 from typing import List, Optional
+import platform
 
 from ._version import __version__
 
@@ -11,7 +12,10 @@ class UserAgent:
     def __init__(self, comments: Optional[List[str]] = None):
         if comments is not None and not isinstance(comments, list):
             raise ValueError("Argument comments must be a List[str]")
-        self._user_agent_prefix = f"{__package__}/{__version__}"
+        python_version = platform.python_version()
+        self._user_agent_prefix = (
+            f"{__package__}/{__version__} ua/2.0 lang/python#{python_version}"
+        )
         self._comments = comments or []
 
     @property

s3torchconnector/tst/e2e/dcp/test_e2e_s3_file_system.py

@@ -21,6 +21,7 @@
 
 import os
 import random
+import platform
 
 from s3torchconnector.dcp.s3_prefix_strategy import RoundRobinPrefixStrategy
 from test_common import _list_folders_in_bucket
@@ -122,7 +123,8 @@ def multi_process_dcp_save_load(
 
 
 def _verify_user_agent(s3fs: S3FileSystem):
-    expected_user_agent = f"s3torchconnector/{__version__} (dcp; {torch.__version__})"
+    python_version = platform.python_version()
+    expected_user_agent = f"s3torchconnector/{__version__} ua/2.0 lang/python#{python_version} (dcp; {torch.__version__})"
     assert s3fs._client.user_agent_prefix == expected_user_agent
 
 

s3torchconnector/tst/e2e/test_e2e_s3_lightning_checkpoint.py

@@ -4,6 +4,7 @@
 import pytest
 import random
 import torch
+import platform
 
 from pathlib import Path
 from typing import Dict, Any
@@ -258,7 +259,6 @@ def _verify_equal_state_dict(
 
 
 def _verify_user_agent(s3_lightning_checkpoint: S3LightningCheckpoint):
-    expected_user_agent = (
-        f"s3torchconnector/{__version__} (lightning; {lightning.__version__})"
-    )
+    python_version = platform.python_version()
+    expected_user_agent = f"s3torchconnector/{__version__} ua/2.0 lang/python#{python_version} (lightning; {lightning.__version__})"
     assert s3_lightning_checkpoint._client.user_agent_prefix == expected_user_agent

s3torchconnector/tst/unit/test_s3_client.py

@@ -2,6 +2,7 @@
 #  // SPDX-License-Identifier: BSD
 import logging
 import pytest
+import platform
 
 from hypothesis import given, example
 from hypothesis.strategies import lists, text, integers, floats
@@ -17,6 +18,10 @@
 TEST_KEY = "test-key"
 TEST_REGION = "us-east-1"
 S3_URI = f"s3://{TEST_BUCKET}/{TEST_KEY}"
+PYTHON_VERSION = platform.python_version()
+DEFAULT_USER_AGENT = (
+    f"s3torchconnector/{__version__} ua/2.0 lang/python#{PYTHON_VERSION}"
+)
 
 KiB = 1 << 10
 MiB = 1 << 20
@@ -76,18 +81,15 @@ def test_copy_object_log(s3_client: S3Client, caplog):
 
 def test_s3_client_default_user_agent():
     s3_client = S3Client(region=TEST_REGION)
-    expected_user_agent = f"s3torchconnector/{__version__}"
-    assert s3_client.user_agent_prefix == expected_user_agent
-    assert s3_client._client.user_agent_prefix == expected_user_agent
+    assert s3_client.user_agent_prefix == DEFAULT_USER_AGENT
+    assert s3_client._client.user_agent_prefix == DEFAULT_USER_AGENT
 
 
 def test_s3_client_custom_user_agent():
     s3_client = S3Client(
         region=TEST_REGION, user_agent=UserAgent(["component/version", "metadata"])
     )
-    expected_user_agent = (
-        f"s3torchconnector/{__version__} (component/version; metadata)"
-    )
+    expected_user_agent = f"{DEFAULT_USER_AGENT} (component/version; metadata)"
     assert s3_client.user_agent_prefix == expected_user_agent
     assert s3_client._client.user_agent_prefix == expected_user_agent
 

s3torchconnector/tst/unit/test_user_agent.py

@@ -3,13 +3,15 @@
 from __future__ import annotations
 
 from typing import List
+import platform
 
 import pytest
 
 from s3torchconnector._version import __version__
 from s3torchconnector._user_agent import UserAgent
 
-DEFAULT_PREFIX = f"s3torchconnector/{__version__}"
+PYTHON_VERSION = platform.python_version()
+DEFAULT_PREFIX = f"s3torchconnector/{__version__} ua/2.0 lang/python#{PYTHON_VERSION}"
 
 
 @pytest.mark.parametrize(