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

87 lines
2.9 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 asyncio
import inspect
import pyrogram
from pyrogram.methods.utilities.idle import idle
class Run:
def run(
self: "pyrogram.Client",
coroutine=None
):
"""Start the client, idle the main script and finally stop the client.
When calling this method without any argument it acts as a convenience method that calls
:meth:`~pyrogram.Client.start`, :meth:`~pyrogram.idle` and :meth:`~pyrogram.Client.stop` in sequence.
It makes running a single client less verbose.
In case a coroutine is passed as argument, runs the coroutine until it's completed and doesn't do any client
operation. This is almost the same as :py:obj:`asyncio.run` except for the fact that Pyrogram's ``run`` uses the
current event loop instead of a new one.
If you want to run multiple clients at once, see :meth:`pyrogram.compose`.
Parameters:
coroutine (``Coroutine``, *optional*):
Pass a coroutine to run it until it completes.
Raises:
ConnectionError: In case you try to run an already started client.
Example:
.. code-block:: python
from pyrogram import Client
app = Client("my_account")
... # Set handlers up
app.run()
.. code-block:: python
from pyrogram import Client
app = Client("my_account")
async def main():
async with app:
print(await app.get_me())
app.run(main())
"""
loop = asyncio.get_event_loop()
run = loop.run_until_complete
if coroutine is not None:
run(coroutine)
else:
if inspect.iscoroutinefunction(self.start):
run(self.start())
run(idle())
run(self.stop())
else:
self.start()
run(idle())
self.stop()