-
-
Notifications
You must be signed in to change notification settings - Fork 48
Expand file tree
/
Copy pathrun.py
More file actions
86 lines (64 loc) · 3.04 KB
/
run.py
File metadata and controls
86 lines (64 loc) · 3.04 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# Hydrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2023 Dan <https://github.com/delivrance>
# Copyright (C) 2023-present Hydrogram <https://hydrogram.org>
#
# This file is part of Hydrogram.
#
# Hydrogram 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.
#
# Hydrogram 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 Hydrogram. If not, see <http://www.gnu.org/licenses/>.
from typing import TYPE_CHECKING
from hydrogram.methods.utilities.idle import idle
if TYPE_CHECKING:
import hydrogram
class Run:
def run(self: "hydrogram.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:`~hydrogram.Client.start`, :meth:`~hydrogram.idle` and :meth:`~hydrogram.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 Hydrogram's ``run`` uses the current event loop instead of a new one.
If you want to run multiple clients at once, see :meth:`hydrogram.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 hydrogram import Client
app = Client("my_account")
... # Set handlers up
app.run()
.. code-block:: python
from hydrogram import Client
app = Client("my_account")
async def main():
async with app:
print(await app.get_me())
app.run(main())
"""
run = self.loop.run_until_complete
if coroutine is not None:
run(coroutine)
else:
if self.loop.is_running():
raise RuntimeError(
"You must call client.run() method outside of an asyncio event loop. "
"Otherwise, you can use client.start(), client.idle(), and client.stop() "
"methods. Refer to https://docs.hydrogram.org/en/latest/api/methods/run.html"
)
run(self.start())
run(idle())
run(self.stop())