From f9ca17c99f0fa87df7c16c67fce4bde3a073eb3e Mon Sep 17 00:00:00 2001 From: Lonami Exo Date: Sun, 16 Jun 2019 11:44:01 +0200 Subject: [PATCH] Rename is_connected as connected Since it makes more sense this way, because the former sounds like a method when it's not. --- readthedocs/quick-references/client-reference.rst | 2 +- telethon/client/auth.py | 2 +- telethon/client/telegrambaseclient.py | 10 ++++------ telethon/client/updates.py | 4 ++-- telethon/network/mtprotosender.py | 2 +- telethon_examples/gui.py | 2 +- 6 files changed, 10 insertions(+), 12 deletions(-) diff --git a/readthedocs/quick-references/client-reference.rst b/readthedocs/quick-references/client-reference.rst index 7a3e71ef..96e4e42c 100644 --- a/readthedocs/quick-references/client-reference.rst +++ b/readthedocs/quick-references/client-reference.rst @@ -45,7 +45,7 @@ Base connect disconnect - is_connected + connected disconnected loop diff --git a/telethon/client/auth.py b/telethon/client/auth.py index 9dd9ae37..9220a5e9 100644 --- a/telethon/client/auth.py +++ b/telethon/client/auth.py @@ -137,7 +137,7 @@ class AuthMethods(MessageParseMethods, UserMethods): async def _start( self, phone, password, bot_token, force_sms, code_callback, first_name, last_name, max_attempts): - if not self.is_connected: + if not self.connected: await self.connect() if await self.is_user_authorized(): diff --git a/telethon/client/telegrambaseclient.py b/telethon/client/telegrambaseclient.py index f07bfe9e..610df378 100644 --- a/telethon/client/telegrambaseclient.py +++ b/telethon/client/telegrambaseclient.py @@ -432,20 +432,18 @@ class TelegramBaseClient(abc.ABC): self._updates_handle = self._loop.create_task(self._update_loop()) @property - def is_connected(self: 'TelegramClient') -> bool: + def connected(self: 'TelegramClient') -> bool: """ - Returns ``True`` if the user has connected. - - This method is **not** asynchronous (don't use ``await`` on it). + Property which is ``True`` if the user has connected. Example .. code-block:: python - while client.is_connected: + while client.connected: await asyncio.sleep(1) """ sender = getattr(self, '_sender', None) - return sender and sender.is_connected + return sender and sender.connected def disconnect(self: 'TelegramClient'): """ diff --git a/telethon/client/updates.py b/telethon/client/updates.py index 6a501e1d..7d2fb04e 100644 --- a/telethon/client/updates.py +++ b/telethon/client/updates.py @@ -323,7 +323,7 @@ class UpdateMethods(UserMethods): async def _update_loop(self: 'TelegramClient'): # Pings' ID don't really need to be secure, just "random" rnd = lambda: random.randrange(-2**63, 2**63) - while self.is_connected: + while self.connected: try: await asyncio.wait_for( self.disconnected, timeout=60, loop=self._loop @@ -425,7 +425,7 @@ class UpdateMethods(UserMethods): ) break except Exception as e: - if not isinstance(e, asyncio.CancelledError) or self.is_connected: + if not isinstance(e, asyncio.CancelledError) or self.connected: name = getattr(callback, '__name__', repr(callback)) self._log[__name__].exception('Unhandled exception on %s', name) diff --git a/telethon/network/mtprotosender.py b/telethon/network/mtprotosender.py index d9aafad6..95ce00a0 100644 --- a/telethon/network/mtprotosender.py +++ b/telethon/network/mtprotosender.py @@ -123,7 +123,7 @@ class MTProtoSender: self._user_connected = True @property - def is_connected(self): + def connected(self): return self._user_connected async def disconnect(self): diff --git a/telethon_examples/gui.py b/telethon_examples/gui.py index 140cd248..547ed568 100644 --- a/telethon_examples/gui.py +++ b/telethon_examples/gui.py @@ -228,7 +228,7 @@ class App(tkinter.Tk): """ Sends a message. Does nothing if the client is not connected. """ - if not self.cl.is_connected: + if not self.cl.connected: return # The user needs to configure a chat where the message should be sent.