codekingpro/portable-devtools
114k
1�
2 ��jv� � �^ � % S r SSKJr SSKrSSKrSSKJr SSKJ r SSK3J r SSK J
r
JrJrJrJrJr SSKJrJrJrJr SS KJrJrJrJ r J r SS4KJ r SS KJ r! SS K"J#r#J$r$ SS
K%J&r& SSK'J(r(J)r) SSK*J+r+ SSK,J-r- SSK.J/r/ SSK0J1r1 \( a SSK2q2Sr3S\4S' OSq2/ SQr5\Rl " S S5 5 r7 " S S5 r8 " S S 5 r9\ SXS j5 r: " S S \85 r; " S! S"\;5 r< " S# S$\;5 r= " S% S&\;5 r> " S' S(\;5 r? " S) S*\;5 r@ " S+ S,\;5 rA " S- S.\95 rB " S/ S0\;5 rC " S1 S2\;5 rD " S3 S4\;5 rE " S5 S6\95 rF " S7 S8\;5 rG " S9 S:\95 rH " S; S<\;5 rI " S= S>\;5 rJ " S? S@\;5 rK " SA SB\;5 rLSYSC jrM\( a \\NSD4 rOO5 " SE SF5 rO " SG SH\(R� 5 rQSIrRS\4SJ' SKrSS\4SL' SMrTS\4SN' \( a \RrU\SrV\TrWO " SO SP5 rU " SQ SR5 rV " SS ST5 rWSZSU jrX\X" 5 rYSVrZ S[SW jr[\+" \\5 r]g)\zEThe networks module contains types for common network-related fields.� )� annotationsN)�fields)� lru_cache)�version)� IPv4Address�
IPv4Interface� IPv4Network� IPv6Address�
IPv6Interface� IPv6Network)�
TYPE_CHECKING� Annotated�Any�ClassVar)�
MultiHostHost�PydanticCustomError�$PydanticSerializationUnexpectedValue�SchemaSerializer� core_schema)� MultiHostUrl)�Url)�Self� TypeAlias)�PydanticUserError� )�_repr�_schema_generation_shared)�getattr_migration)�GetCoreSchemaHandler)�JsonSchemaValue�� TypeAdapterz7str | bytes | int | tuple[str | bytes | int, str | int]r � NetworkType)�AnyUrl�6AnyHttpUrl�FileUrl�FtpUrl�HttpUrl� WebsocketUrl�AnyWebsocketUrl�UrlConstraints�EmailStr� NameEmail�
IPvAnyAddress�IPvAnyInterface�
IPvAnyNetwork� PostgresDsn� CockroachDsn�AmqpDsn�RedisDsn�MongoDsn�KafkaDsn�NatsDsn�validate_email�MySQLDsn�7MariaDBDsn�
ClickHouseDsn� SnowflakeDsnc � � \ rS rSr% SrSrS\S' SrS\S' SrS\S ' Sr S8\S ' Sr9S\S ' Sr S10\S
' Sr S\S' SS jr
\SS j5 rSS jrSrg)r+ �F a� Url constraints.11 12Attributes:13 max_length: The maximum length of the url. Defaults to `None`.14 allowed_schemes: The allowed schemes. Defaults to `None`.15 host_required: Whether the host is required. Defaults to `None`.16 default_host: The default host. Defaults to `None`.17 default_port: The default port. Defaults to `None`.18 default_path: The default path. Defaults to `None`.19 preserve_empty_path: Whether to preserve empty URL paths. Defaults to `None`.20N�21int | None�22max_lengthzlist[str] | None�allowed_schemesz bool | None�
host_required�23str | None� default_host� default_port� default_path�preserve_empty_pathc �� � [ U R U R b [ U R 5 OS U R U R24 U R U R U R 45 $ �N) �hashr@ rA �tuplerB rD rE rF rG ��selfs �WD:\code\apps\devtools\python\user_packages\Python313\site-packages\pydantic/networks.py�__hash__�UrlConstraints.__hash__\ sd � �����/3�/C�/C�/O��d�*�*�+�UY��"�"��!�!��!�!��!�!��(�(�
�2526� 27 28� c � � [ U 5 Vs0 s H* n[ XR 5 =nc M UR U_M, sn$ s snf )zeFetch a key / value mapping of constraints to values that are not None. Used for core schema updates.)r �getattr�name)rM �field�values rN �defined_constraints�"UrlConstraints.defined_constraintsi s? � � 06�d�|�p�|�e��QU�Wa�Wa�Ib�@b��!��29�30�E�!�|�p�p��ps31 � A�Ac � � U" U5 nUS S:X a US OUnUS =nS; a [ SU S3SS9eU R R 5 H u pgXtU' M U$ ) N�type�
function-wrap�schema)�urlzmulti-host-urlz"'UrlConstraints' cannot annotate 'z'.zinvalid-annotated-type)�code)r rW �items)rM �source�handlerr\ �schema_to_mutate�annotated_type�constraint_key�constraint_values rN � __get_pydantic_core_schema__�+UrlConstraints.__get_pydantic_core_schema__n s� � ��� ��32 06�f�~� �/P�6�(�+�V\�� .�v� 6� 6�N�?X� X�#�4�^�4D�B�G�Nf��
� 15�0H�0H�0N�0N�0P� ,�N�/?�^� ,� 1Q��
rQ � ��return�int)rj zdict[str, Any])r` r ra r rj �core_schema.CoreSchema)�__name__�33__module__� __qualname__�__firstlineno__�__doc__r@ �__annotations__rA rB rD rE rF rG rO �propertyrW rf �__static_attributes__rh rQ rN r+ r+ F sq � �34� "�J�35�!�(,�O�%�,�!%�M�;�%� #�L�*�#� #�L�*�#� #�L�*�#�'+���+� 36� �q� �q�
rQ r+ c �T � \ rS rSr% \" 5 rS\S' S\S' S%S jr\S&S j5 r \S'S j5 r37\S'S j5 r \S'S38 j5 r S'S jr
\S(S j5 r\S'S
j5 r\S'S j5 rS)S jr\S'S j5 rS&S jrS&S jrS&S jrS&S jrS*S jrS+S jrS+S jrS+S jrS+S jrS+S jr S,S jr S,S jr \ S S S S S S S . S-S jj5 r \ S.S j5 r!\ S/S! j5 r"\ S0S" j5 r#\$" \%RL " \%RN " 5 S#95 r(S$r)g )1�_BaseUrl�~ �ClassVar[UrlConstraints]� _constraints�_CoreUrl�_urlc �j � [ U R 5 R U5 R U l g rI ��_build_type_adapter� __class__�validate_pythonr{ �rM r] s rN �__init__�_BaseUrl.__init__� �# � �'����7�G�G��L�Q�Q�� rQ c �. � U R R $ )z_The scheme part of the URL.39 40e.g. `https` in `https://user:pass@host:port/path?query#fragment`41�r{ �schemerL s rN r� �_BaseUrl.scheme� � � � �y�y� � � rQ c �. � U R R $ )zkThe username part of the URL, or `None`.42 43e.g. `user` in `https://user:pass@host:port/path?query#fragment`44)r{ �usernamerL s rN r� �_BaseUrl.username� � � � �y�y�!�!�!rQ c �. � U R R $ )zkThe password part of the URL, or `None`.45 46e.g. `pass` in `https://user:pass@host:port/path?query#fragment`47)r{ �passwordrL s rN r� �_BaseUrl.password� r� rQ c �. � U R R $ )u� The host part of the URL, or `None`.48 49If the URL must be punycode encoded, this is the encoded host, e.g if the input URL is `https://£££.com`,50`host` will be `xn--9aaa.com`51�r{ �hostrL s rN r� �
_BaseUrl.host� s � � �y�y�~�~� rQ c �6 � U R R 5 $ )u The host part of the URL as a unicode string, or `None`.52 53e.g. `host` in `https://user:pass@host:port/path?query#fragment`54 55If the URL must be punycode encoded, this is the decoded host, e.g if the input URL is `https://£££.com`,56`unicode_host()` will be `£££.com`57)r{ � unicode_hostrL s rN r� �_BaseUrl.unicode_host� s � � �y�y�%�%�'�'rQ c �. � U R R $ )zgThe port part of the URL, or `None`.58 59e.g. `port` in `https://user:pass@host:port/path?query#fragment`60)r{ �portrL s rN r� �
_BaseUrl.port� � � � �y�y�~�~� rQ c �. � U R R $ )zhThe path part of the URL, or `None`.61 62e.g. `/path` in `https://user:pass@host:port/path?query#fragment`63�r{ �pathrL s rN r� �
_BaseUrl.path� r� rQ c �. � U R R $ )ziThe query part of the URL, or `None`.64 65e.g. `query` in `https://user:pass@host:port/path?query#fragment`66�r{ �queryrL s rN r� �_BaseUrl.query� � � � �y�y��� rQ c �6 � U R R 5 $ )z�The query part of the URL as a list of key-value pairs.67 68e.g. `[('foo', 'bar')]` in `https://user:pass@host:port/path?foo=bar#fragment`69�r{ � query_paramsrL s rN r� �_BaseUrl.query_params� � � �70 �y�y�%�%�'�'rQ c �. � U R R $ )zoThe fragment part of the URL, or `None`.71 72e.g. `fragment` in `https://user:pass@host:port/path?query#fragment`73�r{ �fragmentrL s rN r� �_BaseUrl.fragment� r� rQ c �6 � U R R 5 $ )u� The URL as a unicode string, unlike `__str__()` this will not punycode encode the host.74 75If the URL must be punycode encoded, this is the decoded string, e.g if the input URL is `https://£££.com`,76`unicode_string()` will be `https://£££.com`77�r{ �unicode_stringrL s rN r� �_BaseUrl.unicode_string� s � � �y�y�'�'�)�)rQ c � � [ U 5 $ �zThe URL's encoded string representation via __str__().78 79This returns the punycode-encoded host version of the URL as a string.80��strrL s rN �encoded_string�_BaseUrl.encoded_string� � � �81 �4�y�rQ c �, � [ U R 5 $ �zDThe URL as a string, this will punycode encode the host if required.�r� r{ rL s rN �__str__�_BaseUrl.__str__� � � ��4�9�9�~� rQ c �b � U R R S[ U R 5 < S3$ �N�(�)�r rm r� r{ rL s rN �__repr__�_BaseUrl.__repr__� �) � ��.�.�)�)�*�!�C�� � �N�+=�Q�?�?rQ c �8 � U R U R 5 $ rI �r r{ �rM �memos rN � __deepcopy__�_BaseUrl.__deepcopy__� � � ��~�~�d�i�i�(�(rQ c �r � U R UR L =( a U R UR :H $ rI r� �rM �others rN �__eq__�_BaseUrl.__eq__� �' � ��~�~�� � �0�L�T�Y�Y�%�*�*�5L�LrQ c �r � U R UR L =( a U R UR : $ rI r� r� s rN �__lt__�_BaseUrl.__lt__� �' � ��~�~�� � �0�K�T�Y�Y����5K�KrQ c �r � U R UR L =( a U R UR :� $ rI r� r� s rN �__gt__�_BaseUrl.__gt__� r� rQ c �r � U R UR L =( a U R UR :* $ rI r� r� s rN �__le__�_BaseUrl.__le__� r� rQ c �r � U R UR L =( a U R UR :� $ rI r� r� s rN �__ge__�_BaseUrl.__ge__� r� rQ c �, � [ U R 5 $ rI �rJ r{ rL s rN rO �_BaseUrl.__hash__� � � ��D�I�I�� rQ c �> � [ [ U R 5 5 $ rI ��lenr� r{ rL s rN �__len__�_BaseUrl.__len__ � � ��3�t�y�y�>�"�"rQ N)r� r� r� r� r� r� c
�D � U " [ R " UUUUUUUUS95 $ )a& Build a new `Url` instance from its component parts.82 83Args:84 scheme: The scheme part of the URL.85 username: The username part of the URL, or omit for no username.86 password: The password part of the URL, or omit for no password.87 host: The host part of the URL.88 port: The port part of the URL, or omit for no port.89 path: The path part of the URL, or omit for no path.90 query: The query part of the URL, or omit for no query.91 fragment: The fragment part of the URL, or omit for no fragment.92 93Returns:94 An instance of URL95)r� r� r� r� r� r� r� r� )rz �build) �clsr� r� r� r� r� r� r� r� s rN r� �_BaseUrl.build s5 � �8 � �N�N� �!�!�����!�
� 96� 97rQ c � � [ X5 ( d [ SU S[ U5 SU S35 eUR S:X a [ U5 $ U$ �Nz98Expected `z ` but got `z` with value `'z-'` - serialized value may not be as expected.�json��99isinstancer rZ �moder� �r� r] �infos rN �
serialize_url�_BaseUrl.serialize_url. �S � ��#�#�#�6� �S�E��T�#�Y�K��s�e�Kx�y��
� �9�9�� ��s�8�O��100rQ c 101 �� ^� U4S jn[ R " U[ R " S0 U R R D6[ R102 " U R SSS9S9$ )Nc � >� [ U T5 ( a U $ [ U [ 5 ( a [ U 5 n U" U 5 nTR T5 nX#l U$ rI )r� rv r� �__new__r{ ��v�h�core_url�instancer` s �rN �wrap_val�7_BaseUrl.__get_pydantic_core_schema__.<locals>.wrap_val< sL �� ��!�V�$�$����!�X�&�&���F����t�H� �~�~�f�-�H� $�M��OrQ T�always��info_arg� when_used�r\ �
serializationrh )r � no_info_wrap_validator_function�103url_schemary rW �$plain_serializer_function_ser_schemar� �r� r` ra r s ` rN rf �%_BaseUrl.__get_pydantic_core_schema__8 sX �� � � �:�:� � �)�)�Q�C�,<�,<�,P�,P�Q�%�J�J��!�!�D�H��104� 105rQ c �2 � US S:X a US OUnU" U5 $ �NrZ r[ r\ rh �r� r ra � inner_schemas rN � __get_pydantic_json_schema__�%_BaseUrl.__get_pydantic_json_schema__N �( � � 1<�F�0C��0V�{�8�,�\g� ��|�$�$rQ �r �r{ )r] zstr | _CoreUrl | _BaseUrlrj �None�rj r� �rj rC )rj r? �rj zlist[tuple[str, str]]�r� �dictrj r �r� r rj �boolri )r� r� r� rC r� rC r� r� r� r? r� rC r� rC r� rC rj r �r] r r� z core_schema.SerializationInforj z106str | Self)r` ztype[_BaseUrl]ra r rj rl �r rl ra z._schema_generation_shared.GetJsonSchemaHandlerrj r )*rm rn ro rp r+ ry rr r� rs r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� rO r� � classmethodr� r� rf r r r �107any_schema�to_string_ser_schema�__pydantic_serializer__rt rh rQ rN rv rv ~ s � �-;�-=�L�*�=�108�N�R� � � � � �"� �"� �"� �"� � � � �(� � � � � � � � � � � � �(� �"� �"�*�� �@�)�M�L�L�M�M� �#� �109 $� #� � � � #�&110� �&111� � &112�113 � &114� �
&115� �&116� �&117� �&118� �&119� 120�&121� �&122�P �� �� �123�#�124�.B�125� �126� �127�* �%�0�%�;i�%� �%� �%� /�{�/E�/E�T_�Tt�Tt�Tv�/w� x�rQ rv c 128 �� � \ rS rSr% \" 5 rS\S' S\S' S S jr\S S j5 r \S S j5 r129\S S j5 r S S130 jr \S S j5 r
S!S jrS S
jrS S jrS S jrS S jrS"S jrS#S jrS$S jrS$S jr\SSSSSSSSS. S%S jj5 r\S&S j5 r\ S'S j5 r\ S(S j5 r\ " \ R< " \ R> " 5 S95 r S r!g))�_BaseMultiHostUrliZ rx ry �_CoreMultiHostUrlr{ c �j � [ U R 5 R U5 R U l g rI r} r� s rN r� �_BaseMultiHostUrl.__init__^ r� rQ c �. � U R R $ )z[The scheme part of the URL.131 132e.g. `https` in `https://foo.com,bar.com/path?query#fragment`133r� rL s rN r� �_BaseMultiHostUrl.schemea r� rQ c �. � U R R $ )zdThe path part of the URL, or `None`.134 135e.g. `/path` in `https://foo.com,bar.com/path?query#fragment`136r� rL s rN r� �_BaseMultiHostUrl.pathi r� rQ c �. � U R R $ )zeThe query part of the URL, or `None`.137 138e.g. `query` in `https://foo.com,bar.com/path?query#fragment`139r� rL s rN r� �_BaseMultiHostUrl.queryq r� rQ c �6 � U R R 5 $ )z�The query part of the URL as a list of key-value pairs.140 141e.g. `[('foo', 'bar')]` in `https://foo.com,bar.com/path?foo=bar#fragment`142r� rL s rN r� � _BaseMultiHostUrl.query_paramsy r� rQ c �. � U R R $ )zkThe fragment part of the URL, or `None`.143 144e.g. `fragment` in `https://foo.com,bar.com/path?query#fragment`145r� rL s rN r� �_BaseMultiHostUrl.fragment� r� rQ c �6 � U R R 5 $ )a� The hosts of the `MultiHostUrl` as [`MultiHostHost`][pydantic_core.MultiHostHost] typed dicts.146 147```python148from pydantic_core import MultiHostUrl149 150mhu = MultiHostUrl('https://foo.com:123,foo:bar@bar.com/path')151print(mhu.hosts())152"""153[154 {'username': None, 'password': None, 'host': 'foo.com', 'port': 123},155 {'username': 'foo', 'password': 'bar', 'host': 'bar.com', 'port': 443}156]157```158Returns:159 A list of dicts, each representing a host.160)r{ �hostsrL s rN r6 �_BaseMultiHostUrl.hosts� s � �" �y�y��� � rQ c � � [ U 5 $ r� r� rL s rN r� � _BaseMultiHostUrl.encoded_string� r� rQ c �6 � U R R 5 $ )zXThe URL as a unicode string, unlike `__str__()` this will not punycode encode the hosts.r� rL s rN r� � _BaseMultiHostUrl.unicode_string� s � ��y�y�'�'�)�)rQ c �, � [ U R 5 $ r� r� rL s rN r� �_BaseMultiHostUrl.__str__� r� rQ c �b � U R R S[ U R 5 < S3$ r� r� rL s rN r� �_BaseMultiHostUrl.__repr__� r� rQ c �8 � U R U R 5 $ rI r� r� s rN r� � _BaseMultiHostUrl.__deepcopy__� r� rQ c �r � U R UR L =( a U R UR :H $ rI r� r� s rN r� �_BaseMultiHostUrl.__eq__� r� rQ c �, � [ U R 5 $ rI r� rL s rN rO �_BaseMultiHostUrl.__hash__� r� rQ c �> � [ [ U R 5 5 $ rI r� rL s rN r� �_BaseMultiHostUrl.__len__� r� rQ N)r6 r� r� r� r� r� r� r� c �F � U " [ R " UUUUUUUUU S9 5 $ )a� Build a new `MultiHostUrl` instance from its component parts.161 162This method takes either `hosts` - a list of `MultiHostHost` typed dicts, or the individual components163`username`, `password`, `host` and `port`.164 165Args:166 scheme: The scheme part of the URL.167 hosts: Multiple hosts to build the URL from.168 username: The username part of the URL.169 password: The password part of the URL.170 host: The host part of the URL.171 port: The port part of the URL.172 path: The path part of the URL.173 query: The query part of the URL, or omit for no query.174 fragment: The fragment part of the URL, or omit for no fragment.175 176Returns:177 An instance of `MultiHostUrl`178) r� r6 r� r� r� r� r� r� r� )r( r� )179r� r� r6 r� r� r� r� r� r� r� s180 rN r� �_BaseMultiHostUrl.build� s; � �B � � #� #� ��!�!�����!�181
� 182� 183rQ c � � [ X5 ( d [ SU S[ U5 SU S35 eUR S:X a [ U5 $ U$ r� r� r� s rN r� � _BaseMultiHostUrl.serialize_url� r� rQ c 184 �� ^� U4S jn[ R " U[ R " S0 U R R D6[ R185 " U R SSS9S9$ )Nc � >� [ U T5 ( a U $ [ U [ 5 ( a [ U 5 n U" U 5 nTR T5 nX#l U$ rI )r� r' r� r� r{ r� s �rN r �@_BaseMultiHostUrl.__get_pydantic_core_schema__.<locals>.wrap_val� sM �� ��!�V�$�$����!� .�/�/���F����t�H� �~�~�f�-�H� $�M��OrQ Tr r r rh )r r186 �multi_host_url_schemary rW r r� r
s ` rN rf �._BaseMultiHostUrl.__get_pydantic_core_schema__� sX �� � � �:�:� � �4�4�\�s�7G�7G�7[�7[�\�%�J�J��!�!�D�H��187� 188rQ c �2 � US S:X a US OUnU" U5 $ r rh r s rN r �._BaseMultiHostUrl.__get_pydantic_json_schema__ r rQ r r )r] z+str | _CoreMultiHostUrl | _BaseMultiHostUrlrj r r r r )rj zlist[MultiHostHost]r r ri )r� r� r6 zlist[MultiHostHost] | Noner� rC r� rC r� rC r� r? r� rC r� rC r� rC rj r r )r` ztype[_BaseMultiHostUrl]ra r rj rl r! )"rm rn ro rp r+ ry rr r� rs r� r� r� r� r� r6 r� r� r� r� r� r� rO r� r" r� r� rf r r r r# r$ r% rt rh rQ rN r' r' Z s� � �-;�-=�L�*�=�189��R� � � � � � � � � � � � �(� �"� �"�!�&�*� �@�)�M� �#� �190 -1� #� #� � � � � #�,191� �,192� *� ,193�194 � ,195� �
,196� �,197� �,198� �,199� �,200� �,201� 202�,203� �,204�\ �� �� �205�,�206�7K�207� �208� �209�* �%�0�%�;i�%� �%� �%� /�{�/E�/E�T_�Tt�Tt�Tv�/w� x�rQ r' c � � [ U 5 $ rI r! )r� s rN r~ r~ s
� � �s� �rQ c � � \ rS rSrSrSrg)r$ i a� Base type for all URLs.210 211* Any scheme allowed212* Top-level domain (TLD) not required213* Host not required214 215Assuming an input URL of `http://samuel:pass@example.com:8000/the/path/?query=here#fragment=is;this=bit`,216the types export the following properties:217 218- `scheme`: the URL scheme (`http`), always set.219- `host`: the URL host (`example.com`).220- `username`: optional username if included (`samuel`).221- `password`: optional password if included (`pass`).222- `port`: optional port (`8000`).223- `path`: optional path (`/the/path/`).224- `query`: optional URL query (for example, `GET` arguments or "search string", such as `query=here`).225- `fragment`: optional fragment (`fragment=is;this=bit`).226rh N)rm rn ro rp rq rt rh rQ rN r$ r$ s � �rQ r$ c �( � \ rS rSrSr\" SS/S9rSrg)r% i2 zWA type that will accept any http or https URL.227 228* TLD not required229* Host not required230�http�https�rA rh N�rm rn ro rp rq r+ ry rt rh rQ rN r% r% 2 s � �� "�6�7�2C�D�LrQ r% c �* � \ rS rSrSr\" SSS/S9rSrg) r( i< u� A type that will accept any http or https URL.231 232* TLD not required233* Host not required234* Max length 2083235 236```python237from pydantic import BaseModel, HttpUrl, ValidationError238 239class MyModel(BaseModel):240 url: HttpUrl241 242m = MyModel(url='http://www.example.com') # (1)!243print(m.url)244#> http://www.example.com/245 246try:247 MyModel(url='ftp://invalid.url')248except ValidationError as e:249 print(e)250 '''251 1 validation error for MyModel252 url253 URL scheme should be 'http' or 'https' [type=url_scheme, input_value='ftp://invalid.url', input_type=str]254 '''255 256try:257 MyModel(url='not a url')258except ValidationError as e:259 print(e)260 '''261 1 validation error for MyModel262 url263 Input should be a valid URL, relative URL without a base [type=url_parsing, input_value='not a url', input_type=str]264 '''265```266 2671. Note: mypy would prefer `m = MyModel(url=HttpUrl('http://www.example.com'))`, but Pydantic will convert the string to an HttpUrl instance anyway.268 269"International domains" (e.g. a URL where the host or TLD includes non-ascii characters) will be encoded via270[punycode](https://en.wikipedia.org/wiki/Punycode) (see271[this article](https://www.xudongz.com/blog/2017/idn-phishing/) for a good description of why this is important):272 273```python274from pydantic import BaseModel, HttpUrl275 276class MyModel(BaseModel):277 url: HttpUrl278 279m1 = MyModel(url='http://puny£code.com')280print(m1.url)281#> http://xn--punycode-eja.com/282m2 = MyModel(url='https://www.аррӏе.com/')283print(m2.url)284#> https://www.xn--80ak6aa92e.com/285m3 = MyModel(url='https://www.example.珠宝/')286print(m3.url)287#> https://www.example.xn--pbt977c/288```289 290 291!!! warning "Underscores in Hostnames"292 In Pydantic, underscores are allowed in all parts of a domain except the TLD.293 Technically this might be wrong - in theory the hostname cannot have underscores, but subdomains can.294 295 To explain this; consider the following two cases:296 297 - `exam_ple.co.uk`: the hostname is `exam_ple`, which should not be allowed since it contains an underscore.298 - `foo_bar.example.com` the hostname is `example`, which should be allowed since the underscore is in the subdomain.299 300 Without having an exhaustive list of TLDs, it would be impossible to differentiate between these two. Therefore301 underscores are allowed, but you can always do further validation in a validator if desired.302 303 Also, Chrome, Firefox, and Safari all currently accept `http://exam_ple.com` as a URL, so we're in good304 (or at least big) company.305�# rV rW �r@ rA rh NrY rh rQ rN r( r( < s � �K�Z "�T�F�G�CT�U�LrQ r( c �( � \ rS rSrSr\" SS/S9rSrg)r* i� zSA type that will accept any ws or wss URL.306 307* TLD not required308* Host not required309�ws�wssrX rh NrY rh rQ rN r* r* � s � �� "�4��-�@�LrQ r* c �* � \ rS rSrSr\" SSS/S9rSrg) r) i� zeA type that will accept any ws or wss URL.310 311* TLD not required312* Host not required313* Max length 2083314r[ r^ r_ r\ rh NrY rh rQ rN r) r) � s � �� "�T�D�%�=�Q�LrQ r) c �& � \ rS rSrSr\" S/S9rSrg)r& i� z;A type that will accept any file URL.315 316* Host not required317�filerX rh NrY rh rQ rN r& r& � s � ��318 "�6�(�;�LrQ r& c �& � \ rS rSrSr\" S/S9rSrg)r' i� zIA type that will accept ftp URL.319 320* TLD not required321* Host not required322�ftprX rh NrY rh rQ rN r' r' � s � �� "�5�'�:�LrQ r' c �> � \ rS rSrSr\" S/ SQS9r\S S j5 rSr g)323r1 i� a~ A type that will accept any Postgres DSN.324 325* User info required326* TLD not required327* Host required328* Supports multiple hosts329 330If further validation is required, these properties can be used by validators to enforce specific behaviour:331 332```python333from pydantic import (334 BaseModel,335 HttpUrl,336 PostgresDsn,337 ValidationError,338 field_validator,339)340 341class MyModel(BaseModel):342 url: HttpUrl343 344m = MyModel(url='http://www.example.com')345 346# the repr() method for a url will display all properties of the url347print(repr(m.url))348#> HttpUrl('http://www.example.com/')349print(m.url.scheme)350#> http351print(m.url.host)352#> www.example.com353print(m.url.port)354#> 80355 356class MyDatabaseModel(BaseModel):357 db: PostgresDsn358 359 @field_validator('db')360 def check_db_name(cls, v):361 assert v.path and len(v.path) > 1, 'database must be provided'362 return v363 364m = MyDatabaseModel(db='postgres://user:pass@localhost:5432/foobar')365print(m.db)366#> postgres://user:pass@localhost:5432/foobar367 368try:369 MyDatabaseModel(db='postgres://user:pass@localhost:5432')370except ValidationError as e:371 print(e)372 '''373 1 validation error for MyDatabaseModel374 db375 Assertion failed, database must be provided376 assert (None)377 + where None = PostgresDsn('postgres://user:pass@localhost:5432').path [type=assertion_error, input_value='postgres://user:pass@localhost:5432', input_type=str]378 '''379```380T) �postgres�381postgresqlzpostgresql+asyncpgzpostgresql+pg8000zpostgresql+psycopgzpostgresql+psycopg2zpostgresql+psycopg2cffizpostgresql+py-postgresqlzpostgresql+pygresql�rB rA c �. � U R R $ �zThe required URL host.r� rL s rN r� �PostgresDsn.host � � � �y�y�~�~� rQ rh Nr �382rm rn ro rp rq r+ ry rs r� rt rh rQ rN r1 r1 � s0 � �9�v "��383384�
�L� � � � rQ r1 c �> � \ rS rSrSr\" S/ SQS9r\S S j5 rSr g)385r2 i zdA type that will accept any Cockroach DSN.386 387* User info required388* TLD not required389* Host required390T)� cockroachdbzcockroachdb+psycopg2zcockroachdb+asyncpgrh c �. � U R R $ rj r� rL s rN r� �CockroachDsn.host rl rQ rh Nr rm rh rQ rN r2 r2 s/ � �� "��391��L� � � � rQ r2 c �( � \ rS rSrSr\" SS/S9rSrg)r3 i zcA type that will accept any AMQP DSN.392 393* User info required394* TLD not required395* Host not required396�amqp�amqpsrX rh NrY rh rQ rN r3 r3 s � �� "�6�7�2C�D�LrQ r3 c �D � \ rS rSrSr\" SS/SSSSS 9r\S
S397 j5 rS r g )r4 i( z�A type that will accept any Redis DSN.398 399* User info required400* TLD not required401* Host required (e.g., `rediss://:pass@localhost`)402�redis�rediss� localhosti� z/0T)rA rD rE rF rB c �. � U R R $ rj r� rL s rN r� �
RedisDsn.host8 rl rQ rh Nr rm rh rQ rN r4 r4 ( s; � �� "� �(�+� ���� �L� � � � rQ r4 c �* � \ rS rSrSr\" SS/SS9rSrg) r5 i> a� A type that will accept any MongoDB DSN.403 404* User info not required405* Database name not required406* Port not required407* User info may be passed without user part (e.g., `mongodb://mongodb0.example.com:27017`).408 409!!! warning410 If a port isn't specified, the default MongoDB port `27017` will be used. If this behavior is411 undesirable, you can use the following:412 413 ```python414 from typing import Annotated415 416 from pydantic_core import MultiHostUrl417 418 from pydantic import UrlConstraints419 420 MongoDsnNoDefaultPort = Annotated[421 MultiHostUrl,422 UrlConstraints(allowed_schemes=['mongodb', 'mongodb+srv']),423 ]424 ```425�mongodbz mongodb+srvi�i �rA rE rh NrY rh rQ rN r5 r5 > s � ��2 "�9�m�2L�[`�a�LrQ r5 c �* � \ rS rSrSr\" S/SSS9rSrg) r6 i[ zdA type that will accept any Kafka DSN.426 427* User info required428* TLD not required429* Host not required430�kafkarx i�# �rA rD rE rh NrY rh rQ rN r6 r6 [ s � �� "�7�)�+�dh�i�LrQ r6 c �, � \ rS rSrSr\" / SQSSS9rSrg) r7 if a8 A type that will accept any NATS DSN.431 432NATS is a connective technology built for the ever increasingly hyper-connected world.433It is a single technology that enables applications to securely communicate across434any combination of cloud vendors, on-premise, edge, web and mobile, and devices.435More: https://nats.io436)�nats�tlsr^ r_ rx i~ r� rh NrY rh rQ rN r7 r7 f s � �� "�4�;�]a��LrQ r7 c �, � \ rS rSrSr\" / SQSSS9rSrg) r9 it zdA type that will accept any MySQL DSN.437 438* User info required439* TLD not required440* Host not required441)�mysqlzmysql+mysqlconnectorzmysql+aiomysqlz
mysql+asyncmyz
mysql+mysqldbz
mysql+pymysqlz
mysql+cymysqlz mysql+pyodbc�� T)rA rE rB rh NrY rh rQ rN r9 r9 t s � �� "� 442� ��
�LrQ r9 c �* � \ rS rSrSr\" / SQSS9rSrg)r: i� zfA type that will accept any MariaDB DSN.443 444* User info required445* TLD not required446* Host not required447)�mariadbzmariadb+mariadbconnectorzmariadb+pymysqlr� r} rh NrY rh rQ rN r: r: � s � �� "�R���LrQ r: c �, � \ rS rSrSr\" / SQSSS9rSrg) r; i� ziA type that will accept any ClickHouse DSN.448 449* User info required450* TLD not required451* Host not required452)zclickhouse+nativezclickhouse+asynchzclickhouse+http�453clickhouse� clickhouses� clickhousedbrx i(# r� rh NrY rh rQ rN r; r; � s � �� "�454� !�� �LrQ r; c �< � \ rS rSrSr\" S/SS9r\S S j5 rSr g)455r< i� zdA type that will accept any Snowflake DSN.456 457* User info required458* TLD not required459* Host required460� snowflakeT)rA rB c �. � U R R $ rj r� rL s rN r� �SnowflakeDsn.host� rl rQ rh Nr rm rh rQ rN r< r< � s/ � �� "�$�
���L�461 � � � rQ r< c � � SS K q [ S5 R S5 S S:X d [ S5 eg ! [ a n [ S5 U eS n A ff = f)Nr zEemail-validator is not installed, run `pip install 'pydantic[email]'`zemail-validator�.�2zKemail-validator version >= 2.0 required, run pip install -U email-validator)�email_validator� ImportErrorr � partition)�es rN �import_email_validatorr� � s_ � �j� � �$� %� /� /�� 4�Q� 7�3� >��g�h�h� ?�� � j��a�b�hi�i��j�s �3 �462A� A � A.c �l � \ rS rSrSr\ SS j5 r\ S S j5 r\S463S j5 rSr g) r, i� a� 464Info:465 To use this type, you need to install the optional466 [`email-validator`](https://github.com/JoshData/python-email-validator) package:467 468 ```bash469 pip install email-validator470 ```471 472Validate email addresses.473 474```python475from pydantic import BaseModel, EmailStr476 477class Model(BaseModel):478 email: EmailStr479 480print(Model(email='contact@mail.com'))481#> email='contact@mail.com'482```483c �~ � [ 5 [ R " U R [ R " 5 5 $ rI )r� r � no_info_after_validator_function� _validate�484str_schema�r� �_source�_handlers rN rf �%EmailStr.__get_pydantic_core_schema__� s* � �
#� $� �?�?��
�
�{�Oe�Oe�Og�h� hrQ c �6 � U" U5 nUR SSS9 U$ )N�string�email�rZ �format��update�r� r ra � field_schemas rN r �%EmailStr.__get_pydantic_json_schema__� s' � � #�;�/�L� � � �X�g� � >� � rQ c � � [ U5 S $ )Nr )r8 �r� � input_values rN r� �EmailStr._validate� s � �!�+�.�q�1� 1rQ rh N�r� z type[Any]r� r rj rl r! )r� r� rj r� )485rm rn ro rp rq r" rf r r� rt rh rQ rN r, r, � s| � � �, 486� i� � i� +� i� $� i� 487� i� 488� � 4� �?m� �
� � 489� � 490� 2� 491� 2rQ r, c � � \ rS rSrSrSrS S jrS
S jr\ SS j5 r \ SS j5 r492\SS j5 r SS jr S493r
g )r- i� ad 494Info:495 To use this type, you need to install the optional496 [`email-validator`](https://github.com/JoshData/python-email-validator) package:497 498 ```bash499 pip install email-validator500 ```501 502Validate a name and email address combination, as specified by503[RFC 5322](https://datatracker.ietf.org/doc/html/rfc5322#section-3.4).504 505The `NameEmail` has two properties: `name` and `email`.506In case the `name` is not provided, it's inferred from the email address.507 508```python509from pydantic import BaseModel, NameEmail510 511class User(BaseModel):512 email: NameEmail513 514user = User(email='Fred Bloggs <fred.bloggs@example.com>')515print(user.email)516#> Fred Bloggs <fred.bloggs@example.com>517print(user.email.name)518#> Fred Bloggs519 520user = User(email='fred.bloggs@example.com')521print(user.email)522#> fred.bloggs <fred.bloggs@example.com>523print(user.email.name)524#> fred.bloggs525```526�rT r� c � � Xl X l g rI r� )rM rT r� s rN r� �NameEmail.__init__$ s � �� ��527rQ c � � [ U[ 5 =( a1 U R U R 4UR UR 4:H $ rI )r� r- rT r� r� s rN r� �NameEmail.__eq__( s6 � ��%��+�d����D�J�J�0G�E�J�J�X]�Xc�Xc�Kd�0d�drQ c �6 � U" U5 nUR SSS9 U$ )Nr� z528name-emailr� r� r� s rN r �&NameEmail.__get_pydantic_json_schema__+ s' � � �{�+� �����,��?��rQ c �F � [ 5 [ R " U R [ R " [ R529 " 5 [ R " [ R " U 5 [ R530 " 5 /SSS9[ R " 5 S95 $ )N�name_email_typez Input is not a valid NameEmail)�custom_error_type�custom_error_message)� json_schema�
python_schemar ) r� r r� r� �json_or_python_schemar� � union_schema�is_instance_schemar$ r� s rN rf �&NameEmail.__get_pydantic_core_schema__3 s| � � � ��;�;� �M�M� � -� -� '� 2� 2� 4� )� 6� 6� �3�3�C�8�+�:P�:P�:R�S�&7�)I� �531 *� >� >� @�
� 532� 533rQ c �Z � [ U[ 5 ( a [ U5 u p#U " X#5 $ U$ rI )r� r� r8 )r� r� rT r� s rN r� �NameEmail._validateH s, � � �k�3� '� '�(��5�K�D��t�#� #� � rQ c � � SU R ; a SU R SU R S3$ U R SU R S3$ )N�@�"z" <�>z <r� rL s rN r� �NameEmail.__str__P sF � � �$�)�)� ��t�y�y�k��T�Z�Z�L��2� 2��)�)��B�t�z�z�l�!�,�,rQ )r� rT N)rT r� r� r� r r! r� )r� z534Self | strrj r r )rm rn ro rp rq � __slots__r� r� r" r rf r� r� rt rh rQ rN r- r- � s� � �!�F �I��e� � �0� �;i� � � � � � �535��536� '�537� 538 � 539� �540�( � � � �-rQ r- zIPv4Address | IPv6Address�IPvAnyAddressTypez IPv4Interface | IPv6Interface�IPvAnyInterfaceTypezIPv4Network | IPv6Network�IPvAnyNetworkTypec �z � \ rS rSrSrSrS S jr\ S541S j5 r\ S S j5 r \S S j5 r542Sr g)
r. ia a* Validate an IPv4 or IPv6 address.543 544```python545from pydantic import BaseModel546from pydantic.networks import IPvAnyAddress547 548class IpModel(BaseModel):549 ip: IPvAnyAddress550 551print(IpModel(ip='127.0.0.1'))552#> ip=IPv4Address('127.0.0.1')553 554try:555 IpModel(ip='http://www.example.com')556except ValueError as e:557 print(e.errors())558 '''559 [560 {561 'type': 'ip_any_address',562 'loc': ('ip',),563 'msg': 'value is not a valid IPv4 or IPv6 address',564 'input': 'http://www.example.com',565 }566 ]567 '''568```569rh c � � [ U5 $ ! [ a Of = f [ U5 $ ! [ a
[ SS5 ef = f)z!Validate an IPv4 or IPv6 address.�ip_any_addressz)value is not a valid IPv4 or IPv6 address)r �570ValueErrorr571 r �r� rV s rN r� �IPvAnyAddress.__new__� sU � �
�"�5�)�)�� �
��
��
i�"�5�)�)�� �
i�)�*:�<g�h�h�
i�� �572
�573��574) �A c �* � 0 nUR SSS9 U$ )Nr� �
ipvanyaddressr� r� r� s rN r �*IPvAnyAddress.__get_pydantic_json_schema__� �" � � �L� � � �X�o� � F� � rQ c �f � [ R " U R [ R " 5 S9$ �Nr �r � no_info_plain_validator_functionr� r$ r� s rN rf �*IPvAnyAddress.__get_pydantic_core_schema__� �) � � �?�?��
�
�[�-M�-M�-O��
rQ c � � U " U5 $ rI rh r� s rN r� �IPvAnyAddress._validate� �
� ��{�#� #rQ N)rV r rj r� r! r� )r� r rj r� � rm rn ro rp rq r� r� r" r rf r� rt rh rQ rN r. r. a s� � � �: � �575 i� 576� � 4� �?m� �
� � 577� � 578� � � � +� � $� � 579� � 580� $� 581� $rQ r. c �z � \ rS rSrSrSrS S jr\ S582S j5 r\ S S j5 r \S S j5 r583Sr g)
r/ i� �#Validate an IPv4 or IPv6 interface.rh c � � [ U5 $ ! [ a Of = f [ U5 $ ! [ a
[ SS5 ef = f)r� �ip_any_interfacez+value is not a valid IPv4 or IPv6 interface)r r� r r r� s rN r� �IPvAnyInterface.__new__� sU � �
�$�U�+�+�� �
��
��
m�$�U�+�+�� �
m�)�*<�>k�l�l�
m�r� c �* � 0 nUR SSS9 U$ )Nr� �ipvanyinterfacer� r� r� s rN r �,IPvAnyInterface.__get_pydantic_json_schema__� s# � � �L� � � �X�6G� � H� � rQ c �f � [ R " U R [ R " 5 S9$ r� r� r� s rN rf �,IPvAnyInterface.__get_pydantic_core_schema__� r� rQ c � � U " U5 $ rI rh r� s rN r� �IPvAnyInterface._validate� r� rQ N)rV r# rj r� r! r� )r� r# rj r� r� rh rQ rN r/ r/ � s� � �1�� �584 m� 585� � 4� �?m� �
� � 586� � 587� � � � +� � $� � 588� � 589� $� 590� $rQ r/ c �z � \ rS rSrSrSrS S jr\ S591S j5 r\ S S j5 r \S S j5 r592Sr g)
r0 i� �!Validate an IPv4 or IPv6 network.rh c � � [ U5 $ ! [ a Of = f [ U5 $ ! [ a
[ SS5 ef = f)r� �ip_any_networkz)value is not a valid IPv4 or IPv6 network)r r� r r r� s rN r� �IPvAnyNetwork.__new__� sU � �
�"�5�)�)�� �
��
��
i�"�5�)�)�� �
i�)�*:�<g�h�h�
i�r� c �* � 0 nUR SSS9 U$ )Nr� �
ipvanynetworkr� r� r� s rN r �*IPvAnyNetwork.__get_pydantic_json_schema__� r� rQ c �f � [ R " U R [ R " 5 S9$ r� r� r� s rN rf �*IPvAnyNetwork.__get_pydantic_core_schema__� r� rQ c � � U " U5 $ rI rh r� s rN r� �IPvAnyNetwork._validate� r� rQ N)rV r# rj r� r! r� )r� r# rj r� r� rh rQ rN r0 r0 � s� � �/�� � i� 593� � 4� �?m� �
� � 594� � 595� � � � +� � $� � 596� � 597� $� 598� $rQ r0 c �` � Sn SU SU S3nSnSn[ R " SU SU S U S59935 $ ) Nz[\w!#$%&\'*+\-/=?^_`{|}~]z((?:z+\s+)*z+)z"((?:[^"]|\")+)"z<(.+)>z\s*(?:�|z)?\s*z\s*)�re�compile)�600name_chars�unquoted_name_group�quoted_name_group� email_groups rN �_build_pretty_email_regexr � sP � �-�J� !�*� �V�J�<�r�B��+���K�
�:�:�� 3� 4�A�6G�5H��k�]�Z]�^� _�_rQ i c 601 � � [ c602 [ 5 [ U 5 [ :� a [ SSSS[ S305 e[603 R
U 5 nSnU( a UR 5 u p4n U=( d UnU R 5 n [ R " USS9nUR nUc eU=( d UR nX%4$ ! [ R a+ n[ SSS[ UR S 5 05 UeSnAff = f)604a) Email address validation using [email-validator](https://pypi.org/project/email-validator/).605 606Returns:607 A tuple containing the local part of the email (or the name for "pretty" email addresses)608 and the normalized email.609 610Raises:611 PydanticCustomError: If the email is invalid.612 613Note:614 Note that:615 616 * Raw IP address (literal) domain parts are not allowed.617 * `"John Doe <local_part@domain.com>"` style "pretty" email addresses are processed.618 * Spaces are striped from the beginning and end of addresses, but no error is raised.619N� value_errorz,value is not a valid email address: {reason}�reasonzLength must not exceed z charactersF)�check_deliverabilityr )r� r� r� �MAX_EMAIL_LENGTHr �pretty_email_regex� fullmatch�groups�stripr8 �EmailNotValidErrorr� �args�620normalized�621local_part)rV �mrT �
unquoted_name� quoted_namer� �partsr� s rN r8 r8 s � �" � � � �622�5�z�$�$�!� � :�
�0�1A�0B�+�N� O�623� 624� �$�$�U�+�A��D��,-�H�H�J�)�
�E� �+� �� �K�K�M�E�� �.�.�u�5�Q��
� � �E� � � � � � #�5�#�#�D� �;��� � -� -� �!� �I�H�VY�Z[�Z`�Z`�ab�Zc�Vd�Ke�625�� ���s � C �D�&D�D)r� z"type[_BaseUrl | _BaseMultiHostUrl]rj r" )rj r )rj zre.Pattern[str])rV r� rj ztuple[str, str])^rq �626__future__r � _annotations� dataclasses� _dataclassesr� r � functoolsr �importlib.metadatar � ipaddressr r r r627 r r �typingr
r r r �
pydantic_corer r r r r r r( r rz �typing_extensionsr r �pydantic.errorsr � _internalr r �628_migrationr �annotated_handlersr r� r � type_adapterr" r� r# rr �__all__� dataclassr+ rv r' r~ r$ r% r( r* r) r& r' r1 r2 r3 r4 r5 r6 r7 r9 r: r; r< r� r� r, �Representationr- r� r� r� r. r/ r0 r r r r8 rm � __getattr__rh rQ rN �<module>r( sk �� K� 2� "� � � � &� f� f� :� :�� � <� )� -� -� 7� )� 4� (� %��� V�K��V� �O� ��: ���4� 4� �4�nYy� Yy�xwy� wy�t � � � ��X� �2E�� E�NV�f� NV�bA�f� A�R�6� R�<�f� <�;�V� ;�N �#� N �b �6� �.E�f� E� �v� �,b� � b�:j�v� j� � � � �v� �0 �� � �F� �, �6� �&i� ���c��"�H�*2� *2�ZV-��$�$� V-�r ;� �9� :�!@� �Y� @� :� �9� :��%�M�)�O�%�M�@$� @$�D%$� %$�N'$� '$�T`� /�0� �� ��629-�` ��)� rQ