관리-도구
편집 파일: url.cpython-38.pyc
U -?�f@x � @ s` d Z ddlmZ ddlmZ ddlZddlmZ ddlm Z ddlm Z ddlm Z ddlm Z dd lm Z dd lmZ dd lmZ dd lmZ dd lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddl m Z ddl m Z ddl m Z ddl m!Z! G d d � d e�Z"d d d �d d!�Z#d"d d#�d$d%�Z$dS )&a Provides the :class:`~sqlalchemy.engine.url.URL` class which encapsulates information about a database connection specification. The URL object is created automatically when :func:`~sqlalchemy.engine.create_engine` is called with a string argument; alternatively, the URL is a public-facing construct which can be used directly and is also accepted directly by ``create_engine()``. � )� annotationsN)�Any)�cast)�Dict)�Iterable)�List)�Mapping)� NamedTuple)�Optional)�overload)�Sequence)�Tuple)�Type)�Union)� parse_qsl)�quote)� quote_plus)�unquote� )�Dialect� )�exc)�util)�plugins)�registryc @ sD e Zd ZU dZded< ded< ded< ded< ded < ded < d ed < ed d d d d ejfdddddddd d�dd��Zeddd�dd��Z edddd�dd��Z edddd�dd��Z edd d�d d ��Z deddddddd d d�d d �Z d!d d"�d#d$�Zdfdd&d d'�d(d)�Zdgd*d&d d+�d,d-�Zdhd.d&d d/�d0d1�Zd2d d3�d4d5�Zed6d7�d8d9��Ze�d:d;�did&dd=�d>d?��Zdjd&dd=�d@dA�Zdd7�dBdC�Zd d7�dDdE�Zd!d dF�dGdH�ZdId7�dJdK�Zd!d&dL�dMdN�Z d!d&dL�dOdP�Z dd7�dQdR�Z dd7�dSdT�Z dUdVdW�dXdY�Z dZd7�d[d\�Z!dkd&dZd]�d^d_�Z"dld`d!dadb�dcdd�Z#d S )m�URLa� Represent the components of a URL used to connect to a database. URLs are typically constructed from a fully formatted URL string, where the :func:`.make_url` function is used internally by the :func:`_sa.create_engine` function in order to parse the URL string into its individual components, which are then used to construct a new :class:`.URL` object. When parsing from a formatted URL string, the parsing format generally follows `RFC-1738 <https://www.ietf.org/rfc/rfc1738.txt>`_, with some exceptions. A :class:`_engine.URL` object may also be produced directly, either by using the :func:`.make_url` function with a fully formed URL string, or by using the :meth:`_engine.URL.create` constructor in order to construct a :class:`_engine.URL` programmatically given individual fields. The resulting :class:`.URL` object may be passed directly to :func:`_sa.create_engine` in place of a string argument, which will bypass the usage of :func:`.make_url` within the engine's creation process. .. versionchanged:: 1.4 The :class:`_engine.URL` object is now an immutable object. To create a URL, use the :func:`_engine.make_url` or :meth:`_engine.URL.create` function / method. To modify a :class:`_engine.URL`, use methods like :meth:`_engine.URL.set` and :meth:`_engine.URL.update_query_dict` to return a new :class:`_engine.URL` object with modifications. See notes for this change at :ref:`change_5526`. .. seealso:: :ref:`database_urls` :class:`_engine.URL` contains the following attributes: * :attr:`_engine.URL.drivername`: database backend and driver name, such as ``postgresql+psycopg2`` * :attr:`_engine.URL.username`: username string * :attr:`_engine.URL.password`: password string * :attr:`_engine.URL.host`: string hostname * :attr:`_engine.URL.port`: integer port number * :attr:`_engine.URL.database`: string database name * :attr:`_engine.URL.query`: an immutable mapping representing the query string. contains strings for keys and either strings or tuples of strings for values. �str� drivernamez Optional[str]�username�password�hostz Optional[int]�port�databasez4util.immutabledict[str, Union[Tuple[str, ...], str]]�queryNz'Mapping[str, Union[Sequence[str], str]])r r r r r! r" r# �returnc C s@ | | � |d�| �|d�|| �|d�| �|�| �|d�| �|��S )a� Create a new :class:`_engine.URL` object. .. seealso:: :ref:`database_urls` :param drivername: the name of the database backend. This name will correspond to a module in sqlalchemy/databases or a third party plug-in. :param username: The user name. :param password: database password. Is typically a string, but may also be an object that can be stringified with ``str()``. .. note:: The password string should **not** be URL encoded when passed as an argument to :meth:`_engine.URL.create`; the string should contain the password characters exactly as they would be typed. .. note:: A password-producing object will be stringified only **once** per :class:`_engine.Engine` object. For dynamic password generation per connect, see :ref:`engines_dynamic_tokens`. :param host: The name of the host. :param port: The port number. :param database: The database name. :param query: A dictionary of string keys to string values to be passed to the dialect and/or the DBAPI upon connect. To specify non-string parameters to a Python DBAPI directly, use the :paramref:`_sa.create_engine.connect_args` parameter to :func:`_sa.create_engine`. See also :attr:`_engine.URL.normalized_query` for a dictionary that is consistently string->list of string. :return: new :class:`_engine.URL` object. .. versionadded:: 1.4 The :class:`_engine.URL` object is now an **immutable named tuple**. In addition, the ``query`` dictionary is also immutable. To create a URL, use the :func:`_engine.url.make_url` or :meth:`_engine.URL.create` function/ method. To modify a :class:`_engine.URL`, use the :meth:`_engine.URL.set` and :meth:`_engine.URL.update_query` methods. r r r r" )� _assert_str�_assert_none_str� _assert_port� _str_dict)�clsr r r r r! r" r# � r* �E/opt/hc_python/lib64/python3.8/site-packages/sqlalchemy/engine/url.py�create� s 8 �z URL.create)r! r$ c C s8 |d kr d S z t |�W S tk r2 td��Y nX d S )Nz(Port argument must be an integer or None)�int� TypeError)r) r! r* r* r+ r' � s zURL._assert_port)�v� paramnamer$ c C s t |t�std| ��|S )Nz%s must be a string�� isinstancer r. �r) r/ r0 r* r* r+ r% � s zURL._assert_strc C s |d kr |S | � ||�S �N)r% r3 r* r* r+ r& � s zURL._assert_none_strziOptional[Union[Sequence[Tuple[str, Union[Sequence[str], str]]], Mapping[str, Union[Sequence[str], str]]]])�dict_r$ c s� |d krt jS tddd�dd���tddd�dd���ddd��fd d� �ddd �d d �� t|tj�rl|}n|�� }t �� �fd d�|D ��S )Nr )�valr$ c S s d S r4 r* �r6 r* r* r+ � _assert_value� s z$URL._str_dict.<locals>._assert_valuez Sequence[str]zUnion[str, Tuple[str, ...]]c S s d S r4 r* r7 r* r* r+ r8 s zUnion[str, Sequence[str]]c s< t | t�r| S t | tj�r0t� fdd�| D ��S td��d S )Nc 3 s | ]}� |�V qd S r4 r* )�.0�elem�r8 r* r+ � <genexpr> s z7URL._str_dict.<locals>._assert_value.<locals>.<genexpr>z?Query dictionary values must be strings or sequences of strings)r2 r �collections_abcr �tupler. r7 r; r* r+ r8 s �)r/ r$ c S s t | t�std��| S )Nz%Query dictionary keys must be stringsr1 )r/ r* r* r+ r% s z"URL._str_dict.<locals>._assert_strc s i | ]\}}� |��|��qS r* r* )r9 �key�value�r% r8 r* r+ � <dictcomp> s � �z!URL._str_dict.<locals>.<dictcomp>)r � EMPTY_DICTr r2 r= r �items� immutabledict)r) r5 � dict_itemsr* rA r+ r( � s ��z URL._str_dictz1Optional[Mapping[str, Union[Sequence[str], str]]]c C s� i }|dk r||d< |dk r$||d< |dk r4||d< |dk rD||d< |dk rT||d< |dk rd||d< |dk rt||d< | j f |�S ) a return a new :class:`_engine.URL` object with modifications. Values are used if they are non-None. To set a value to ``None`` explicitly, use the :meth:`_engine.URL._replace` method adapted from ``namedtuple``. :param drivername: new drivername :param username: new username :param password: new password :param host: new hostname :param port: new port :param query: new query parameters, passed a dict of string keys referring to string or sequence of string values. Fully replaces the previous list of arguments. :return: new :class:`_engine.URL` object. .. versionadded:: 1.4 .. seealso:: :meth:`_engine.URL.update_query_dict` Nr r r r r! r" r# )�_assert_replace) �selfr r r r r! r" r# �kwr* r* r+ �set( s #zURL.setr )rI r$ c K sv d|kr| � |d d� dD ] }||kr | �|| |� q d|krP| �|d � d|krj| �|d �|d< | jf |�S )z)argument checks before calling _replace()r )r r r" r! r# )r% r& r' r( �_replace)rH rI �namer* r* r+ rG ] s zURL._assert_replaceF�bool)� query_string�appendr$ c C s | j t|�|d�S )aE Return a new :class:`_engine.URL` object with the :attr:`_engine.URL.query` parameter dictionary updated by the given query string. E.g.:: >>> from sqlalchemy.engine import make_url >>> url = make_url("postgresql+psycopg2://user:pass@host/dbname") >>> url = url.update_query_string("alt_host=host1&alt_host=host2&ssl_cipher=%2Fpath%2Fto%2Fcrt") >>> str(url) 'postgresql+psycopg2://user:pass@host/dbname?alt_host=host1&alt_host=host2&ssl_cipher=%2Fpath%2Fto%2Fcrt' :param query_string: a URL escaped query string, not including the question mark. :param append: if True, parameters in the existing query string will not be removed; new parameters will be in addition to those present. If left at its default of False, keys present in the given query parameters will replace those of the existing query string. .. versionadded:: 1.4 .. seealso:: :attr:`_engine.URL.query` :meth:`_engine.URL.update_query_dict` �rO )�update_query_pairsr )rH rN rO r* r* r+ �update_query_stringl s zURL.update_query_stringz+Iterable[Tuple[str, Union[str, List[str]]]])�key_value_pairsrO r$ c s | j � i }|D ]\\}}||krLt�|| �||< td|| ��tt|�� qt|ttf�rbt|�n|||< q|r�i }|D ]>}|� kr�tt�� | �t�|| � �||< qx|| ||< qx|� � fdd�t � �� |�D �� n| j � dd� |� � D ��}| j |d�S )a� Return a new :class:`_engine.URL` object with the :attr:`_engine.URL.query` parameter dictionary updated by the given sequence of key/value pairs E.g.:: >>> from sqlalchemy.engine import make_url >>> url = make_url("postgresql+psycopg2://user:pass@host/dbname") >>> url = url.update_query_pairs([("alt_host", "host1"), ("alt_host", "host2"), ("ssl_cipher", "/path/to/crt")]) >>> str(url) 'postgresql+psycopg2://user:pass@host/dbname?alt_host=host1&alt_host=host2&ssl_cipher=%2Fpath%2Fto%2Fcrt' :param key_value_pairs: A sequence of tuples containing two strings each. :param append: if True, parameters in the existing query string will not be removed; new parameters will be in addition to those present. If left at its default of False, keys present in the given query parameters will replace those of the existing query string. .. versionadded:: 1.4 .. seealso:: :attr:`_engine.URL.query` :meth:`_engine.URL.difference_update_query` :meth:`_engine.URL.set` � List[str]c s i | ]}|� | �qS r* r* )r9 �k�Zexisting_queryr* r+ rB � s � z*URL.update_query_pairs.<locals>.<dictcomp>c S s( i | ] \}}|t |t�r t|�n|�qS r* )r2 �listr> �r9 rU r/ r* r* r+ rB � s � �r# )r# r �to_listr rO r r2 rW r> �updaterJ � difference�unionrD )rH rS rO Znew_keysr? r@ Z new_queryrU r* rV r+ rQ � s: % � �� ����zURL.update_query_pairsz#Mapping[str, Union[str, List[str]]])�query_parametersrO r$ c C s | j |�� |d�S )a� Return a new :class:`_engine.URL` object with the :attr:`_engine.URL.query` parameter dictionary updated by the given dictionary. The dictionary typically contains string keys and string values. In order to represent a query parameter that is expressed multiple times, pass a sequence of string values. E.g.:: >>> from sqlalchemy.engine import make_url >>> url = make_url("postgresql+psycopg2://user:pass@host/dbname") >>> url = url.update_query_dict({"alt_host": ["host1", "host2"], "ssl_cipher": "/path/to/crt"}) >>> str(url) 'postgresql+psycopg2://user:pass@host/dbname?alt_host=host1&alt_host=host2&ssl_cipher=%2Fpath%2Fto%2Fcrt' :param query_parameters: A dictionary with string keys and values that are either strings, or sequences of strings. :param append: if True, parameters in the existing query string will not be removed; new parameters will be in addition to those present. If left at its default of False, keys present in the given query parameters will replace those of the existing query string. .. versionadded:: 1.4 .. seealso:: :attr:`_engine.URL.query` :meth:`_engine.URL.update_query_string` :meth:`_engine.URL.update_query_pairs` :meth:`_engine.URL.difference_update_query` :meth:`_engine.URL.set` rP )rQ rD )rH r^ rO r* r* r+ �update_query_dict� s /zURL.update_query_dictz Iterable[str])�namesr$ c sT t |��� j�s� S t� j� j� j� j� j� j t � � fdd�t � j�� |�D ���S )a� Remove the given names from the :attr:`_engine.URL.query` dictionary, returning the new :class:`_engine.URL`. E.g.:: url = url.difference_update_query(['foo', 'bar']) Equivalent to using :meth:`_engine.URL.set` as follows:: url = url.set( query={ key: url.query[key] for key in set(url.query).difference(['foo', 'bar']) } ) .. versionadded:: 1.4 .. seealso:: :attr:`_engine.URL.query` :meth:`_engine.URL.update_query_dict` :meth:`_engine.URL.set` c s i | ]}|� j | �qS r* rY )r9 r? �rH r* r+ rB 4 s � z/URL.difference_update_query.<locals>.<dictcomp>) rJ � intersectionr# r r r r r r! r" r rE r\ )rH r` r* ra r+ �difference_update_query s ���zURL.difference_update_queryzMapping[str, Sequence[str]])r$ c C s t �dd� | j�� D ��S )a Return the :attr:`_engine.URL.query` dictionary with values normalized into sequences. As the :attr:`_engine.URL.query` dictionary may contain either string values or sequences of string values to differentiate between parameters that are specified multiple times in the query string, code that needs to handle multiple parameters generically will wish to use this attribute so that all parameters present are presented as sequences. Inspiration is from Python's ``urllib.parse.parse_qs`` function. E.g.:: >>> from sqlalchemy.engine import make_url >>> url = make_url("postgresql+psycopg2://user:pass@host/dbname?alt_host=host1&alt_host=host2&ssl_cipher=%2Fpath%2Fto%2Fcrt") >>> url.query immutabledict({'alt_host': ('host1', 'host2'), 'ssl_cipher': '/path/to/crt'}) >>> url.normalized_query immutabledict({'alt_host': ('host1', 'host2'), 'ssl_cipher': ('/path/to/crt',)}) c S s& i | ] \}}|t |t�s |fn|�qS r* )r2 r> rX r* r* r+ rB S s � z(URL.normalized_query.<locals>.<dictcomp>)r rE r# rD ra r* r* r+ �normalized_query; s ��zURL.normalized_query�1.4z�The :meth:`_engine.URL.__to_string__ method is deprecated and will be removed in a future release. Please use the :meth:`_engine.URL.render_as_string` method.T)� hide_passwordr$ c C s | j |d�S )z�Render this :class:`_engine.URL` object as a string. :param hide_password: Defaults to True. The password is not shown in the string unless this is set to False. )rf ��render_as_string)rH rf r* r* r+ � __to_string__Y s zURL.__to_string__c s� � j d }� jdk rZ|t� jdd�7 }� jdk rR|d|r<dntt� j�dd� 7 }|d7 }� jdk r�d� jkr�|d� j� d �7 }n |� j7 }� jdk r�|dt� j� 7 }� jdk r�|d � j 7 }� jr�t � j�}|� � |d d � � fd d�|D �� 7 }|S )aR Render this :class:`_engine.URL` object as a string. This method is used when the ``__str__()`` or ``__repr__()`` methods are used. The method directly includes additional options. :param hide_password: Defaults to True. The password is not shown in the string unless this is set to False. z://Nz +)�safe�:z***�@�[�]�/�?�&c 3 s: | ]2}t �� j| �D ] }t|�� d t|�� �V qqdS )�=N)r rZ r# r )r9 rU �elementra r* r+ r< � s �z'URL.render_as_string.<locals>.<genexpr>) r r r r r r r! r" r# rW �sort�join)rH rf �s�keysr* ra r+ rh h s2 �� � zURL.render_as_stringc C s | � � S r4 rg ra r* r* r+ �__repr__� s z URL.__repr__c C s& | j �| j| j| j| j| j| j| j�S r4 ) � __class__r, r r r r r! r" r# ra r* r* r+ �__copy__� s �z URL.__copy__)�memor$ c C s | � � S r4 )rz )rH r{ r* r* r+ � __deepcopy__� s zURL.__deepcopy__r- c C s t t| ��S r4 )�hashr ra r* r* r+ �__hash__� s z URL.__hash__)�otherr$ c C s^ t |t�o\| j|jko\| j|jko\| j|jko\| j|jko\| j|jko\| j|jko\| j|jkS r4 ) r2 r r r r r r" r# r! �rH r r* r* r+ �__eq__� s � � � � � � �z URL.__eq__c C s | |k S r4 r* r� r* r* r+ �__ne__� s z URL.__ne__c C s$ d| j kr| j S | j �d�d S dS )z�Return the backend name. This is the name that corresponds to the database backend in use, and is the portion of the :attr:`_engine.URL.drivername` that is to the left of the plus sign. �+r N)r �splitra r* r* r+ �get_backend_name� s zURL.get_backend_namec C s( d| j kr| �� jS | j �d�d S dS )a� Return the backend name. This is the name that corresponds to the DBAPI driver in use, and is the portion of the :attr:`_engine.URL.drivername` that is to the right of the plus sign. If the :attr:`_engine.URL.drivername` does not include a plus sign, then the default :class:`_engine.Dialect` for this :class:`_engine.URL` is imported in order to get the driver name. r� r N)r � get_dialectZdriverr� ra r* r* r+ �get_driver_name� s zURL.get_driver_namezMapping[str, Any]z%Tuple[URL, List[Any], Dict[str, Any]])�kwargsr$ c s� t ��j�dd��}|� �dg �7 }t� �� � �fdd�|D �}��ddg�}|D ]}|�|�}|d k rR|}qR� �dd � ||� fS )N�pluginr* r c s g | ]}t �|��� ��qS r* )r �load)r9 Z plugin_name�r� rH r* r+ � <listcomp>� s �z,URL._instantiate_plugins.<locals>.<listcomp>)r rZ r# �get�dictrc Z update_url�pop)rH r� Z plugin_namesZloaded_plugins�ur� Znew_ur* r� r+ �_instantiate_plugins� s � zURL._instantiate_plugins� Type[Dialect]c C s` d| j kr| j }n| j �dd�}t�|�}t|d�rRt|jt�rRt|jt �rR|jS t d|�S dS )z�Return the "entry point" dialect class. This is normally the dialect itself except in the case when the returned class implements the get_dialect_cls() method. r� �.�dialectr� N) r �replacer r� �hasattrr2 r� �type� issubclassr r )rH rL r) r* r* r+ �_get_entrypoint� s � � �zURL._get_entrypoint)� _is_asyncr$ c C s& | � � }|r|�| �}n |�| �}|S )zoReturn the SQLAlchemy :class:`_engine.Dialect` class corresponding to this URL's driver name. )r� Zget_async_dialect_clsZget_dialect_cls)rH r� � entrypointZ dialect_clsr* r* r+ r� s zURL.get_dialectzOptional[List[str]]zDict[str, Any])r` rI r$ c K s� |dk rt �dd� i }dddddg}|D ]h}|r>|�d �}n||krP|| }n|}|dk r*t| |d �r*|dkr�tt| |��||< q*t| |�||< q*|S ) a2 Translate url attributes into a dictionary of connection arguments. Returns attributes of this url (`host`, `database`, `username`, `password`, `port`) as a plain dictionary. The attribute names are used as the keys by default. Unset or false attributes are omitted from the final dictionary. :param \**kw: Optional, alternate key names for url attributes. :param names: Deprecated. Same purpose as the keyword-based alternate names, but correlates the name to the original positionally. NzpThe `URL.translate_connect_args.name`s parameter is deprecated. Please pass the alternate names as kw arguments.re r r" r r r! r F)r Zwarn_deprecatedr� �getattrr )rH r` rI Z translatedZattribute_namesZsnamerL r* r* r+ �translate_connect_args s$ � zURL.translate_connect_args)NNNNNNN)F)F)F)T)T)F)N)$�__name__� __module__� __qualname__�__doc__�__annotations__� classmethodr rC r, r' r% r& r( rJ rG rR rQ r_ rc �propertyrd � deprecatedri rh rx rz r| r~ r� r� r� r� r� r� r� r� r* r* r* r+ r . sz 2 � A9 � 5 �$ �P �10 � ' �r zUnion[str, URL])� name_or_urlr$ c C s@ t | t�rt| �S t | t�s8t| d�s8t�d| ����n| S dS )a� Given a string, produce a new URL instance. The format of the URL generally follows `RFC-1738 <https://www.ietf.org/rfc/rfc1738.txt>`_, with some exceptions, including that underscores, and not dashes or periods, are accepted within the "scheme" portion. If a :class:`.URL` object is passed, it is returned as is. .. seealso:: :ref:`database_urls` Z)_sqla_is_testing_if_this_is_a_mock_objectz#Expected string or URL object, got N)r2 r � _parse_urlr r� r � ArgumentError)r� r* r* r+ �make_url9 s ��r� r )rL r$ c C s2 t �dt j�}|�| �}|d k �r |�� }|d d k r�i }t|d �D ]@\}}||kr~t�|| �||< td|| �� |� qF|||< qFnd }||d< |d d k r�t |d �|d< |d d k r�t |d �|d< |� d�}|� d�}|p�||d< |� d �} |d �rt |d �|d < t j| f|�S t�d | ��d S ) Na� (?P<name>[\w\+]+):// (?: (?P<username>[^:/]*) (?::(?P<password>[^@]*))? @)? (?: (?: \[(?P<ipv6host>[^/\?]+)\] | (?P<ipv4host>[^/:\?]+) )? (?::(?P<port>[^/\?]*))? )? (?:/(?P<database>[^\?]*))? (?:\?(?P<query>.*))? r# rT r r �ipv4host�ipv6hostr rL r! z/Could not parse SQLAlchemy URL from string '%s')�re�compile�X�match� groupdictr r rZ r rO r r� r- r r, r r� ) rL �pattern�m� componentsr# r? r@ r� r� r* r* r+ r� U s< � �r� )%r� � __future__r �collections.abc�abcr= r� �typingr r r r r r r r r r r r r � urllib.parser r r r Z interfacesr � r r Zdialectsr r r r� r� r* r* r* r+ �<module> sD