botocore 1.37.3__py3-none-any.whl → 1.37.5__py3-none-any.whl

botocore/__init__.py

@@ -16,7 +16,7 @@ import logging
 import os
 import re
 
-__version__ = '1.37.3'
+__version__ = '1.37.5'
 
 
 class NullHandler(logging.Handler):

botocore/args.py

@@ -29,7 +29,7 @@ from botocore.endpoint import EndpointCreator
 from botocore.regions import EndpointResolverBuiltins as EPRBuiltins
 from botocore.regions import EndpointRulesetResolver
 from botocore.signers import RequestSigner
-from botocore.useragent import UserAgentString
+from botocore.useragent import UserAgentString, register_feature_id
 from botocore.utils import ensure_boolean, is_s3_accelerate_url
 
 logger = logging.getLogger(__name__)
@@ -243,6 +243,8 @@ class ClientArgsCreator:
             client_config=client_config,
             endpoint_url=endpoint_url,
         )
+        if configured_endpoint_url is not None:
+            register_feature_id('ENDPOINT_OVERRIDE')
 
         endpoint_config = self._compute_endpoint_config(
             service_name=service_name,
@@ -313,6 +315,7 @@ class ClientArgsCreator:
         self._compute_sigv4a_signing_region_set_config(config_kwargs)
         self._compute_checksum_config(config_kwargs)
         self._compute_account_id_endpoint_mode_config(config_kwargs)
+        self._compute_inject_host_prefix(client_config, config_kwargs)
         s3_config = self.compute_s3_config(client_config)
 
         is_s3_service = self._is_s3_service(service_name)
@@ -335,6 +338,25 @@ class ClientArgsCreator:
             ),
         }
 
+    def _compute_inject_host_prefix(self, client_config, config_kwargs):
+        # In the cases that a Config object was not provided, or the private value
+        # remained UNSET, we should resolve the value from the config store.
+        if (
+            client_config is None
+            or client_config._inject_host_prefix == 'UNSET'
+        ):
+            configured_disable_host_prefix_injection = (
+                self._config_store.get_config_variable(
+                    'disable_host_prefix_injection'
+                )
+            )
+            if configured_disable_host_prefix_injection is not None:
+                config_kwargs[
+                    'inject_host_prefix'
+                ] = not configured_disable_host_prefix_injection
+            else:
+                config_kwargs['inject_host_prefix'] = True
+
     def _compute_configured_endpoint_url(self, client_config, endpoint_url):
         if endpoint_url is not None:
             return endpoint_url

botocore/client.py

@@ -18,6 +18,7 @@ from botocore.auth import AUTH_TYPE_MAPS, resolve_auth_type
 from botocore.awsrequest import prepare_request_dict
 from botocore.compress import maybe_compress_request
 from botocore.config import Config
+from botocore.context import with_current_context
 from botocore.credentials import RefreshableCredentials
 from botocore.discovery import (
     EndpointDiscoveryHandler,
@@ -933,11 +934,18 @@ class BaseClient:
         self.meta.events.register(
             f"request-created.{service_id}", self._request_signer.handler
         )
+        # Rebuild user agent string right before request is sent
+        # to ensure all registered features are included.
+        self.meta.events.register_last(
+            f"request-created.{service_id}",
+            self._user_agent_creator.rebuild_and_replace_user_agent_handler,
+        )
 
     @property
     def _service_model(self):
         return self.meta.service_model
 
+    @with_current_context()
     def _make_api_call(self, operation_name, api_params):
         operation_model = self._service_model.operation_model(operation_name)
         service_name = self._service_model.service_name

botocore/config.py

@@ -176,11 +176,14 @@ class Config:
     :type inject_host_prefix: bool
     :param inject_host_prefix: Whether host prefix injection should occur.
 
-        Defaults to True.
+        Defaults to None.
 
+        The default of None is equivalent to setting to True, which enables
+        the injection of operation parameters into the prefix of the hostname.
         Setting this to False disables the injection of operation parameters
-        into the prefix of the hostname. This is useful for clients providing
-        custom endpoints that should not have their host prefix modified.
+        into the prefix of the hostname. Setting this to False is useful for
+        clients providing custom endpoints that should not have their host
+        prefix modified.
 
     :type use_dualstack_endpoint: bool
     :param use_dualstack_endpoint: Setting to True enables dualstack
@@ -297,7 +300,7 @@ class Config:
             ('s3', None),
             ('retries', None),
             ('client_cert', None),
-            ('inject_host_prefix', True),
+            ('inject_host_prefix', None),
             ('endpoint_discovery_enabled', None),
             ('use_dualstack_endpoint', None),
             ('use_fips_endpoint', None),
@@ -318,11 +321,36 @@ class Config:
         'connect_timeout': None,
     }
 
+    # The original default value of the inject_host_prefix parameter was True.
+    # This prevented the ability to override the value from other locations in
+    # the parameter provider chain, like env vars or the shared configuration
+    # file. TO accomplish this, we need to disambiguate when the value was set
+    # by the user or not. This overrides the parameter with a property so the
+    # default value of inject_host_prefix is still True if it is not set by the
+    # user.
+    @property
+    def inject_host_prefix(self):
+        if self._inject_host_prefix == "UNSET":
+            return True
+
+        return self._inject_host_prefix
+
+    # Override the setter for the case where the user does supply a value;
+    # _inject_host_prefix will no longer be "UNSET".
+    @inject_host_prefix.setter
+    def inject_host_prefix(self, value):
+        self._inject_host_prefix = value
+
     def __init__(self, *args, **kwargs):
         self._user_provided_options = self._record_user_provided_options(
             args, kwargs
         )
 
+        # By default, we use a value that indicates the user did not
+        # set it. This value MUST persist on the Config object to be used
+        # elsewhere.
+        self._inject_host_prefix = 'UNSET'
+
         # Merge the user_provided options onto the default options
         config_vars = copy.copy(self.OPTION_DEFAULTS)
         defaults_mode = self._user_provided_options.get(
@@ -330,10 +358,20 @@ class Config:
         )
         if defaults_mode != 'legacy':
             config_vars.update(self.NON_LEGACY_OPTION_DEFAULTS)
+
         config_vars.update(self._user_provided_options)
 
         # Set the attributes based on the config_vars
         for key, value in config_vars.items():
+            # Default values for the Config object are set here. We don't want
+            # to use `setattr` in the case where the user already supplied a
+            # value.
+            if (
+                key == 'inject_host_prefix'
+                and 'inject_host_prefix'
+                not in self._user_provided_options.keys()
+            ):
+                continue
             setattr(self, key, value)
 
         # Validate the s3 options

botocore/configprovider.py

@@ -186,6 +186,12 @@ BOTOCORE_DEFAUT_SESSION_VARIABLES = {
         'preferred',
         None,
     ),
+    'disable_host_prefix_injection': (
+        'disable_host_prefix_injection',
+        'AWS_DISABLE_HOST_PREFIX_INJECTION',
+        None,
+        utils.ensure_boolean,
+    ),
 }
 
 # Evaluate AWS_STS_REGIONAL_ENDPOINTS settings

botocore/context.py

@@ -0,0 +1,128 @@
+# Copyright 2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+# http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+"""
+NOTE: All classes and functions in this module are considered private and are
+subject to abrupt breaking changes. Please do not use them directly.
+"""
+
+from contextlib import contextmanager
+from contextvars import ContextVar
+from copy import deepcopy
+from dataclasses import dataclass, field
+from functools import wraps
+from typing import Set
+
+
+@dataclass
+class ClientContext:
+    """
+    Encapsulation of objects tracked within the ``_context`` context variable.
+
+    ``features`` is a set responsible for storing features used during
+    preparation of an AWS request. ``botocore.useragent.register_feature_id``
+    is used to add to this set.
+    """
+
+    features: Set[str] = field(default_factory=set)
+
+
+_context = ContextVar("_context")
+
+
+def get_context():
+    """Get the current ``_context`` context variable if set, else None."""
+    return _context.get(None)
+
+
+def set_context(ctx):
+    """Set the current ``_context`` context variable.
+
+    :type ctx: ClientContext
+    :param ctx: Client context object to set as the current context variable.
+
+    :rtype: contextvars.Token
+    :returns: Token object used to revert the context variable to what it was
+        before the corresponding set.
+    """
+    token = _context.set(ctx)
+    return token
+
+
+def reset_context(token):
+    """Reset the current ``_context`` context variable.
+
+    :type token: contextvars.Token
+    :param token: Token object to reset the context variable.
+    """
+    _context.reset(token)
+
+
+@contextmanager
+def start_as_current_context(ctx=None):
+    """
+    Context manager that copies the passed or current context object and sets
+    it as the current context variable. If no context is found, a new
+    ``ClientContext`` object is created. It mainly ensures the context variable
+    is reset to the previous value once the executed code returns.
+
+    Example usage:
+
+        def my_feature():
+            with start_as_current_context():
+                register_feature_id('MY_FEATURE')
+                pass
+
+    :type ctx: ClientContext
+    :param ctx: The client context object to set as the new context variable.
+        If not provided, the current or a new context variable is used.
+    """
+    current = ctx or get_context()
+    if current is None:
+        new = ClientContext()
+    else:
+        new = deepcopy(current)
+    token = set_context(new)
+    try:
+        yield
+    finally:
+        reset_context(token)
+
+
+def with_current_context(hook=None):
+    """
+    Decorator that wraps ``start_as_current_context`` and optionally invokes a
+    hook within the newly-set context. This is just syntactic sugar to avoid
+    indenting existing code under the context manager.
+
+    Example usage:
+
+        @with_current_context(partial(register_feature_id, 'MY_FEATURE'))
+        def my_feature():
+            pass
+
+    :type hook: callable
+    :param hook: A callable that will be invoked within the scope of the
+        ``start_as_current_context`` context manager.
+    """
+
+    def decorator(func):
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            with start_as_current_context():
+                if hook:
+                    hook()
+                return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator

botocore/crt/auth.py

@@ -24,6 +24,7 @@ from botocore.auth import (
 )
 from botocore.compat import HTTPHeaders, awscrt, parse_qs, urlsplit, urlunsplit
 from botocore.exceptions import NoCredentialsError
+from botocore.useragent import register_feature_id
 from botocore.utils import percent_encode_sequence
 
 
@@ -248,6 +249,7 @@ class CrtSigV4AsymAuth(BaseSigner):
         self._expiration_in_seconds = None
 
     def add_auth(self, request):
+        register_feature_id("SIGV4A_SIGNING")
         if self.credentials is None:
             raise NoCredentialsError()