mirror of
https://github.com/LonamiWebs/Telethon.git
synced 2025-08-01 10:49:58 +03:00
Add warning in docs about discouraging of using tuple proxies.
This commit is contained in:
parent
795e5c7854
commit
32f60ac28a
|
@ -131,31 +131,15 @@ with
|
||||||
|
|
||||||
(of course, replacing the IP and port with the IP and port of the proxy).
|
(of course, replacing the IP and port with the IP and port of the proxy).
|
||||||
|
|
||||||
The ``proxy=`` argument should be a tuple, a list or a dict,
|
The ``proxy=`` argument should be a dict (or tuple, for backwards compatibility),
|
||||||
consisting of parameters described `in aiosocks usage`__.
|
consisting of parameters described `in aiosocks usage`__.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
* All of these are equal:
|
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
proxy = ('socks5', '1.1.1.1', 5555, True, 'foo', 'bar')
|
|
||||||
proxy = (socks.SOCKS5, '1.1.1.1', 5555, True, 'foo', 'bar')
|
|
||||||
proxy = (2, '1.1.1.1', 5555, True, 'foo', 'bar')
|
|
||||||
|
|
||||||
* All of these are equal:
|
|
||||||
|
|
||||||
.. code-block:: python
|
|
||||||
|
|
||||||
proxy = ['socks5', '1.1.1.1', 5555, True, 'foo', 'bar']
|
|
||||||
proxy = [socks.SOCKS5, '1.1.1.1', 5555, True, 'foo', 'bar']
|
|
||||||
proxy = [2, '1.1.1.1', 5555, True, 'foo', 'bar']
|
|
||||||
|
|
||||||
* .. code-block:: python
|
|
||||||
|
|
||||||
proxy = {
|
proxy = {
|
||||||
'proxy_type': 'socks5', # (mandatory) protocol to use, allowed values: 'socks5' (or 2), 'socks4' (or 1)
|
'proxy_type': 'socks5', # (mandatory) protocol to use, allowed values: 'socks5', 'socks4'
|
||||||
'addr': '1.1.1.1', # (mandatory) proxy IP address
|
'addr': '1.1.1.1', # (mandatory) proxy IP address
|
||||||
'port': 5555, # (mandatory) proxy port number
|
'port': 5555, # (mandatory) proxy port number
|
||||||
'username': 'foo', # (optional) username if the proxy requires auth
|
'username': 'foo', # (optional) username if the proxy requires auth
|
||||||
|
@ -163,6 +147,15 @@ Example:
|
||||||
'rdns': True # (optional) whether to use remote or local resolve, default remote
|
'rdns': True # (optional) whether to use remote or local resolve, default remote
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
For backwards compatibility with ``PySocks`` the following format
|
||||||
|
is possible (but discouraged):
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
proxy = (socks.SOCKS5, '1.1.1.1', 5555, True, 'foo', 'bar')
|
||||||
|
|
||||||
|
|
||||||
.. __: https://github.com/nibrag/aiosocks#installation
|
.. __: https://github.com/nibrag/aiosocks#installation
|
||||||
.. __: https://github.com/nibrag/aiosocks#usage
|
.. __: https://github.com/nibrag/aiosocks#usage
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user