-
-
Notifications
You must be signed in to change notification settings - Fork 48
Expand file tree
/
Copy pathstop.py
More file actions
70 lines (52 loc) · 2.17 KB
/
stop.py
File metadata and controls
70 lines (52 loc) · 2.17 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
# 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
if TYPE_CHECKING:
import hydrogram
class Stop:
async def stop(self: "hydrogram.Client", block: bool = True):
"""Stop the Client.
This method disconnects the client from Telegram and stops the underlying tasks.
Parameters:
block (``bool``, *optional*):
Blocks the code execution until the client has been stopped. It is useful with ``block=False`` in case
you want to stop the own client *within* a handler in order not to cause a deadlock.
Defaults to True.
Returns:
:obj:`~hydrogram.Client`: The stopped client itself.
Raises:
ConnectionError: In case you try to stop an already stopped client.
Example:
.. code-block:: python
from hydrogram import Client
app = Client("my_account")
async def main():
await app.start()
... # Invoke API methods
await app.stop()
app.run(main())
"""
async def do_it():
await self.terminate()
await self.disconnect()
if block:
await do_it()
else:
self.loop.create_task(do_it())
return self