send project-specific User-Agent HTTP header #853 (#1075)

Author: jakob-keller

CHANGES.rst

@@ -1,6 +1,10 @@
 Changes
 -------
 
+2.11.0 (2024-01-19)
+^^^^^^^^^^^^^^^^^^^
+* send project-specific `User-Agent` HTTP header #853
+
 2.10.0 (2024-01-18)
 ^^^^^^^^^^^^^^^^^^^
 * bump botocore dependency specification

aiobotocore/__init__.py

@@ -1 +1 @@
-__version__ = '2.10.0'
+__version__ = '2.11.0'

aiobotocore/session.py

@@ -1,10 +1,12 @@
-from botocore import UNSIGNED, translate
+from botocore import UNSIGNED
+from botocore import __version__ as botocore_version
+from botocore import translate
 from botocore.exceptions import PartialCredentialsError
 from botocore.session import EVENT_ALIASES, ServiceModel
 from botocore.session import Session as _SyncSession
 from botocore.session import UnknownServiceError, copy
 
-from . import retryhandler
+from . import __version__, retryhandler
 from .client import AioBaseClient, AioClientCreator
 from .configprovider import AioSmartDefaultsConfigStoreFactory
 from .credentials import AioCredentials, create_credential_resolver
@@ -43,6 +45,16 @@ def __init__(
             session_vars, event_hooks, include_builtin_handlers, profile
         )
 
+        self._set_user_agent_for_session()
+
+    def _set_user_agent_for_session(self):
+        # Mimic approach taken by AWS's aws-cli project
+        # https://github.com/aws/aws-cli/blob/b862122c76a3f280ff34e93c9dcafaf964e7bf9b/awscli/clidriver.py#L84
+
+        self.user_agent_name = 'aiobotocore'
+        self.user_agent_version = __version__
+        self.user_agent_extra = 'botocore/%s' % botocore_version
+
     def _create_token_resolver(self):
         return create_token_resolver(self)
 

tests/test_session.py

@@ -3,7 +3,7 @@
 import pytest
 from _pytest.logging import LogCaptureFixture
 
-from aiobotocore import httpsession
+from aiobotocore import __version__, httpsession
 from aiobotocore.config import AioConfig
 from aiobotocore.session import AioSession
 
@@ -52,3 +52,10 @@ async def test_retry(
             await client.get_object(Bucket='foo', Key='bar')
 
         assert 'sleeping for' in caplog.text
+
+
+@pytest.mark.moto
+async def test_set_user_agent_for_session(session: AioSession):
+    assert session.user_agent_name == "aiobotocore"
+    assert session.user_agent_version == __version__
+    assert session.user_agent_extra.startswith("botocore/")