pyrofork/pyrogram/methods/utilities/restart.py
wulan17 1b3f0933c7
Pyrofork: Update Copyright headers
Signed-off-by: wulan17 <wulan17@nusantararom.org>
2024-02-07 20:25:08 +07:00

73 lines
2.3 KiB
Python

# Pyrofork - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
# Copyright (C) 2022-present Mayuri-Chan <https://github.com/Mayuri-Chan>
#
# This file is part of Pyrofork.
#
# Pyrofork is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Pyrofork is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrofork. If not, see <http://www.gnu.org/licenses/>.
import pyrogram
class Restart:
async def restart(
self: "pyrogram.Client",
block: bool = True
):
"""Restart the Client.
This method will first call :meth:`~pyrogram.Client.stop` and then :meth:`~pyrogram.Client.start` in a row in
order to restart a client using a single method.
Parameters:
block (``bool``, *optional*):
Blocks the code execution until the client has been restarted. It is useful with ``block=False`` in case
you want to restart the own client within an handler in order not to cause a deadlock.
Defaults to True.
Returns:
:obj:`~pyrogram.Client`: The restarted client itself.
Raises:
ConnectionError: In case you try to restart a stopped Client.
Example:
.. code-block:: python
from pyrogram import Client
app = Client("my_account")
async def main():
await app.start()
... # Invoke API methods
await app.restart()
... # Invoke other API methods
await app.stop()
app.run(main())
"""
async def do_it():
await self.stop()
await self.start()
if block:
await do_it()
else:
self.loop.create_task(do_it())
return self