Skip to content

Commit 8677616

Browse files
feat: improve typehint of proxy param in Client class
1 parent 374cb2c commit 8677616

2 files changed

Lines changed: 6 additions & 7 deletions

File tree

pyrogram/client.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,20 +37,19 @@
3737

3838
import pyrogram
3939
from pyrogram import __license__, __version__, enums, raw, utils
40+
from pyrogram.connection.transport.tcp import ProxyDict
4041
from pyrogram.crypto import aes
4142
from pyrogram.errors import (
4243
AuthBytesInvalid,
44+
AuthTokenExpired,
4345
BadRequest,
4446
CDNFileHashMismatch,
4547
ChannelPrivate,
46-
FloodPremiumWait,
47-
FloodWait,
4848
PersistentTimestampInvalid,
4949
PersistentTimestampOutdated,
5050
SessionPasswordNeeded,
5151
Unauthorized,
5252
VolumeLocNotFound,
53-
AuthTokenExpired
5453
)
5554
from pyrogram.handlers.handler import Handler
5655
from pyrogram.methods import Methods
@@ -117,8 +116,8 @@ class Client(Methods):
117116
after which the server address will be updated (works both ways).
118117
Defaults to False (IPv4).
119118
120-
proxy (``dict`` | ``str``, *optional*):
121-
The Proxy settings as dict.
119+
proxy (``str`` | ``dict``, *optional*):
120+
The Proxy settings as url or dict.
122121
E.g.: *dict(scheme="socks5", hostname="11.22.33.44", port=1234, username="user", password="pass")*
123122
or *"http://11.22.33.44:1234"* or *"socks5://user:pass@11.22.33.44:1234"* or *"tg://user:pass@11.22.33.44:1234"*.
124123
The *username* and *password* can be omitted if the proxy doesn't require authorization.
@@ -288,7 +287,7 @@ def __init__(
288287
lang_code: str = LANG_CODE,
289288
system_lang_code: str = SYSTEM_LANG_CODE,
290289
ipv6: Optional[bool] = False,
291-
proxy: Optional[Union[dict, str]] = None,
290+
proxy: Optional[Union[str, ProxyDict]] = None,
292291
test_mode: Optional[bool] = False,
293292
bot_token: Optional[str] = None,
294293
session_string: Optional[str] = None,

pyrogram/connection/transport/tcp/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
# You should have received a copy of the GNU Lesser General Public License
1717
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
1818

19-
from .tcp import TCP, Proxy
19+
from .tcp import TCP, Proxy, ProxyDict
2020
from .tcp_abridged import TCPAbridged
2121
from .tcp_abridged_o import TCPAbridgedO
2222
from .tcp_full import TCPFull

0 commit comments

Comments
 (0)