| Current File : //proc/self/root/usr/lib/python3/dist-packages/botocore/__pycache__/useragent.cpython-312.pyc |
�
P��e�G � �� � d Z ddlZddlZddlmZ ddlmZmZ ddlmZm Z ddl
m Z ddl
mZ eez dz Zd Zd
d iZd Zd
� Z G d� de� Z G d� d� Z ddlmZ G d� d� Zd� Zy# e$ r d� ZY �w xY w)a�
NOTE: All classes and functions in this module are considered private and are
subject to abrupt breaking changes. Please do not use them directly.
To modify the User-Agent header sent by botocore, use one of these
configuration options:
* The ``AWS_SDK_UA_APP_ID`` environment variable.
* The ``sdk_ua_app_id`` setting in the shared AWS config file.
* The ``user_agent_appid`` field in the :py:class:`botocore.config.Config`.
* The ``user_agent_extra`` field in the :py:class:`botocore.config.Config`.
� N)�copy)�
ascii_letters�digits)�
NamedTuple�Optional)� __version__)�HAS_CRTz!$%&'*+-.^_`|~)�windows�linux�macos�android�ios�watchos�tvos�other�darwinr �Botocorec �8 �� dj �fd�| D � � S )a} Replaces all not allowed characters in the string with a dash ("-").
Allowed characters are ASCII alphanumerics and ``!$%&'*+-.^_`|~``. If
``allow_hash`` is ``True``, "#"``" is also allowed.
:type raw_str: str
:param raw_str: The input string to be sanitized.
:type allow_hash: bool
:param allow_hash: Whether "#" is considered an allowed character.
� c 3 �D �K � | ] }|t v s�r|d k( r|nd�� � y�w)�#�-N)� _USERAGENT_ALLOWED_CHARACTERS)�.0�c�
allow_hashs ��4/usr/lib/python3/dist-packages/botocore/useragent.py� <genexpr>z7sanitize_user_agent_string_component.<locals>.<genexpr>A s6 �� �� � �
�
�-� -�*��c��
�
� ��s � )�join)�raw_strr s `r �$sanitize_user_agent_string_componentr! 5 s% �� � �7�7� � � � � � c �@ � e Zd ZU dZeed< eed< dZee ed< d� Zy)�UserAgentComponenta;
Component of a Botocore User-Agent header string in the standard format.
Each component consists of a prefix, a name, and a value. In the string
representation these are combined in the format ``prefix/name#value``.
This class is considered private and is subject to abrupt breaking changes.
�prefix�nameN�valuec �� � t | j d�� }t | j d�� }| j �| j dk( r|� d|� �S t | j d�� }|� d|� d|� �S )zACreate string like 'prefix/name#value' from a UserAgentComponent.T)r Fr �/r )r! r% r& r' )�self� clean_prefix�
clean_name� clean_values r � to_stringz UserAgentComponent.to_stringW s~ � �;� �K�K�D�
� � :� �I�I�%�
�
� �:�:� ����r�!1�"�^�1�Z�L�1� 1�:� �J�J�4�
� � � �q�� �A�k�]�;�;r" ) �__name__�
__module__� __qualname__�__doc__�str�__annotations__r' r r. � r" r r$ r$ I s& � ��
�K�
�I� �E�8�C�=� �
<r" r$ c � � e Zd ZdZd� Zd� Zy)�RawStringUserAgentComponentz�
UserAgentComponent interface wrapper around ``str``.
Use for User-Agent header components that are not constructed from
prefix+name+value but instead are provided as strings. No sanitization is
performed.
c � � || _ y �N��_value)r* r' s r �__init__z$RawStringUserAgentComponent.__init__p s � ��� r" c � � | j S r9 r: �r* s r r. z%RawStringUserAgentComponent.to_strings s � ��{�{�r" N)r/ r0 r1 r2 r< r. r5 r" r r7 r7 g s � �� �r" r7 )�modify_componentsc � � | S r9 r5 )�
componentss r r? r? } s � ��r" c �x � e Zd ZdZ dd�Zed� � Zd� Zd� Zd� Z d� Z
d � Z d
� Z d � Z
d � Zd
� Zd� Zd� Zd� Zd� Zy)�UserAgentStringaU
Generator for AWS SDK User-Agent header strings.
The User-Agent header format contains information from session, client, and
request context. ``UserAgentString`` provides methods for collecting the
information and ``to_string`` for assembling it into the standardized
string format.
Example usage:
ua_session = UserAgentString.from_environment()
ua_session.set_session_config(...)
ua_client = ua_session.with_client_config(Config(...))
ua_string = ua_request.to_string()
For testing or when information from all sources is available at the same
time, the methods can be chained:
ua_string = (
UserAgentString
.from_environment()
.set_session_config(...)
.with_client_config(Config(...))
.to_string()
)
Nc �� � || _ || _ || _ || _ || _ || _ || _ d| _ d| _ d| _ d| _
d| _ d| _ d| _
y)a�
:type platform_name: str
:param platform_name: Name of the operating system or equivalent
platform name. Should be sourced from :py:meth:`platform.system`.
:type platform_version: str
:param platform_version: Version of the operating system or equivalent
platform name. Should be sourced from :py:meth:`platform.version`.
:type platform_machine: str
:param platform_version: Processor architecture or machine type. For
example "x86_64". Should be sourced from :py:meth:`platform.machine`.
:type python_version: str
:param python_version: Version of the python implementation as str.
Should be sourced from :py:meth:`platform.python_version`.
:type python_implementation: str
:param python_implementation: Name of the python implementation.
Should be sourced from :py:meth:`platform.python_implementation`.
:type execution_env: str
:param execution_env: The value of the AWS execution environment.
Should be sourced from the ``AWS_EXECUTION_ENV` environment
variable.
:type crt_version: str
:param crt_version: Version string of awscrt package, if installed.
N)�_platform_name�_platform_version�_platform_machine�_python_version�_python_implementation�_execution_env� _crt_version�_session_user_agent_name�_session_user_agent_version�_session_user_agent_extra�_client_config�_uses_paginator� _uses_waiter�_uses_resource)r* �
platform_name�platform_version�platform_machine�python_version�python_implementation�
execution_env� crt_versions r r< zUserAgentString.__init__� sw � �B ,���!1�� �!1�� � -�� �&;��#� +��� '��� )-��%�+/��(�)-��&� "��� #�� � ��� "��r" c
�: � d }t rt � xs d} | t j � t j � t j
� t j � t j � t j j d� |�� S )N�Unknown�AWS_EXECUTION_ENV)rS rT rU rV rW rX rY ) r �_get_crt_version�platform�system�release�machinerV rW �os�environ�get)�clsrY s r �from_environmentz UserAgentString.from_environment� sr � �� � �*�,�9� �K��"�/�/�+� %� -� -� /� %� -� -� /�#�2�2�4�"*�"@�"@�"B� �*�*�.�.�)<�=�#�
�
r" c �0 � || _ || _ || _ | S )ax
Set the user agent configuration values that apply at session level.
:param user_agent_name: The user agent name configured in the
:py:class:`botocore.session.Session` object. For backwards
compatibility, this will always be at the beginning of the
User-Agent string, together with ``user_agent_version``.
:param user_agent_version: The user agent version configured in the
:py:class:`botocore.session.Session` object.
:param user_agent_extra: The user agent "extra" configured in the
:py:class:`botocore.session.Session` object.
)rL rM rN )r* �session_user_agent_name�session_user_agent_version�session_user_agent_extras r �set_session_configz"UserAgentString.set_session_config� s" � �$ )@��%�+E��(�)A��&�� r" c �* � t | � }||_ |S )z�
Create a copy with all original values and client-specific values.
:type client_config: botocore.config.Config
:param client_config: The client configuration object.
)r rO )r* �
client_config�cps r �with_client_configz"UserAgentString.with_client_config� s � � �$�Z�� )���� r" c �~ � d}| j rCt | j d� r| j j }n| j j }|�| j |� S g | j � �t
d� �| j � �| j � �| j � �| j � �| j � �| j � �| j � �| j � �}t |� }dj! |D �cg c] }|j# � �� c}� S c c}w )zN
Build User-Agent header string from the object's properties.
N�_supplied_user_agentzua/2.0� )rO �hasattrrq �
user_agent�_build_legacy_ua_string�_build_sdk_metadatar7 �_build_os_metadata� _build_architecture_metadata�_build_language_metadata� _build_execution_env_metadata�_build_feature_metadata�_build_config_metadata�
_build_app_id� _build_extrar? r r. )r* �config_ua_overriderA �comps r r. zUserAgentString.to_string sM � � "�� � � ��t�*�*�,B�C�%)�%8�%8�%M�%M�"�%)�%8�%8�%C�%C�"� � )��/�/�0B�C� C�
�
�
%�
%�
'�
� '�� 1�
� �
$�
$�
&�
� �
.�
.�
0�
�
�
*�
*�
,�
� �
/�
/�
1�
� �
)�
)�
+�
� �
(�
(�
*�
� �
�
�
!�
� �
�
�
�
�
� '�z�2�
��x�x�j�A�d�� � �)�A�B�B��As � D:c � � g }| j rw| j rk| j t k7 s| j t k7 rE|j t | j | j � t dt t � g� n#|j
t t t � � | j �&|j
t dd| j � � |S )at
Build the SDK name and version component of the User-Agent header.
For backwards-compatibility both session-level and client-level config
of custom tool names are honored. If this removes the Botocore
information from the start of the string, Botocore's name and version
are included as a separate field with "md" prefix.
�md�awscrt)rL rM �_USERAGENT_SDK_NAME�botocore_version�extendr$ �appendrK )r* �sdk_mds r rv z#UserAgentString._build_sdk_metadata! s� � � �� � )� )��0�0��-�-�1D�D��3�3�7G�G�
�M�M�&� �5�5� �8�8�� '� � 1�3C�� �
�
�M�M�"�#6�8H�I�
� � � � (� �M�M�"�4��4�3D�3D�E�
� �
r" c �4 � | j �
t dd� gS | j j � }|t v r|}n|t v r
t | }nd}|�t d|| j
� gS t dd� t d| j | j
� gS )a"
Build the OS/platform components of the User-Agent header string.
For recognized platform names that match or map to an entry in the list
of standardized OS names, a single component with prefix "os" is
returned. Otherwise, one component "os/other" is returned and a second
with prefix "md" and the raw platform name.
String representations of example return values:
* ``os/macos#10.13.6``
* ``os/linux``
* ``os/other``
* ``os/other md/foobar#1.2.3``
Nrb r r� )rE r$ �lower�_USERAGENT_ALLOWED_OS_NAMES�!_USERAGENT_PLATFORM_NAME_MAPPINGSrF )r* �plt_name_lower� os_familys r rw z"UserAgentString._build_os_metadataJ s� � � � � � &�&�t�W�5�6� 6� �,�,�2�2�4�� � 8� 8�&�I�
� @�
@�9�.�I�I� �I� � �"�4��D�4J�4J�K��
�
#�4��1�"��$�-�-�t�/E�/E���
r" c �j � | j r&t dd| j j � � gS g S )z�
Build architecture component of the User-Agent header string.
Returns the machine type with prefix "md" and name "arch", if one is
available. Common values include "x86_64", "arm64", "i386".
r� �arch)rG r$ r� r> s r rx z,UserAgentString._build_architecture_metadatap s< � � � !� !�"��&�$�"8�"8�">�">�"@���
�
� r" c � � t dd| j � g}| j r&|j t dd| j � � |S )a�
Build the language components of the User-Agent header string.
Returns the Python version in a component with prefix "lang" and name
"python". The Python implementation (e.g. CPython, PyPy) is returned as
separate metadata component with prefix "md" and name "pyimpl".
String representation of an example return value:
``lang/python#3.10.4 md/pyimpl#CPython``
�lang�pythonr� �pyimpl)r$ rH rI r� )r* �lang_mds r ry z(UserAgentString._build_language_metadata sM � �
�v�x��1E�1E� F�
�� � &� &� �N�N�"�4��4�3N�3N�O�
� �r" c �L � | j rt d| j � gS g S )z�
Build the execution environment component of the User-Agent header.
Returns a single component prefixed with "exec-env", usually sourced
from the environment variable AWS_EXECUTION_ENV.
zexec-env)rJ r$ r> s r rz z-UserAgentString._build_execution_env_metadata� s( � � � � �&�z�4�3F�3F�G�H� H��Ir" c � � g S )z�
Build the features components of the User-Agent header string.
Botocore currently does not report any features. This may change in a
future version.
r5 r> s r r{ z'UserAgentString._build_feature_metadata� s � � � r" c � � | j r| j j sg S | j j j d� }t dd|� g}| j j r|j t dd� � |S )a
Build the configuration components of the User-Agent header string.
Returns a list of components with prefix "cfg" followed by the config
setting name and its value. Tracked configuration settings may be
added or removed in future versions.
�mode�cfgz
retry-modezendpoint-discovery)rO �retriesrd r$ �endpoint_discovery_enabledr� )r* �
retry_mode�cfg_mds r r| z&UserAgentString._build_config_metadata� sv � � �"�"�$�*=�*=�*E�*E��I��(�(�0�0�4�4�V�<�
�$�U�L�*�E�F�� � � � 9� 9� �M�M�,�U�4H�I� J��
r" c � � | j r7| j j r!t d| j j � gS g S )a�
Build app component of the User-Agent header string.
Returns a single component with prefix "app" and value sourced from the
``user_agent_appid`` field in :py:class:`botocore.config.Config` or
the ``sdk_ua_app_id`` setting in the shared configuration file, or the
``AWS_SDK_UA_APP_ID`` environment variable. These are the recommended
ways for apps built with Botocore to insert their identifer into the
User-Agent header.
�app)rO �user_agent_appidr$ r> s r r} z UserAgentString._build_app_id� sB � � � � �4�#6�#6�#G�#G�"�5�$�*=�*=�*N�*N�O��
� �Ir" c �
� g }| j r$|j t | j � � | j rD| j j r.|j t | j j � � |S )a� User agent string components based on legacy "extra" settings.
Creates components from the session-level and client-level
``user_agent_extra`` setting, if present. Both are passed through
verbatim and should be appended at the end of the string.
Preferred ways to inject application-specific information into
botocore's User-Agent header string are the ``user_agent_appid` field
in :py:class:`botocore.config.Config`. The ``AWS_SDK_UA_APP_ID``
environment variable and the ``sdk_ua_app_id`` configuration file
setting are alternative ways to set the ``user_agent_appid`` config.
)rN r� r7 rO �user_agent_extra)r* �extras r r~ z UserAgentString._build_extra� so � � �� � )� )� �L�L�+�D�,J�,J�K�
� � � �4�#6�#6�#G�#G� �L�L�+��'�'�8�8��
�
� r" c �� � |g}| j r|j | j � | j j r%|j | j j � dj |� S )Nrr )rN r� rO r� r )r* r rA s r ru z'UserAgentString._build_legacy_ua_string� s_ � �(�)�
� � )� )� � � �d� <� <� =� � � � /� /� � � �d� 1� 1� B� B� C��x�x�
�#�#r" r9 )r/ r0 r1 r2 r< � classmethodrf rk ro r. rv rw rx ry rz r{ r| r} r~ ru r5 r" r rC rC � sk � ��H �1#�f �
� �
� �. � C�>'�R$�L
� �(
��� �$�4$r" rC c �B � ddl } | j S # t $ r Y yw xY w)z\
This function is considered private and is subject to abrupt breaking
changes.
r N)r� r �AttributeError)r� s r r] r] � s( � �
���!�!�!�� � ���s � � � )r2 rb r^ r �stringr r �typingr r �botocorer r� �botocore.compatr r r� r� r� r! r$ r7 �!botocore.customizations.useragentr? � ImportErrorrC r] r5 r" r �<module>r� s� �� �
� � � (� '� 4� #� -�� 6�9I� I� � � � &.�w�$7� !�
!� ��(<�� <�<
�
�$�C�i$� i$�X
��e � ���s �A* �*A5�4A5