ee5f39374c
* Add new invite link export methods * Implement higher-level Invite type * Update Docstrings and rename Invite * Docstrings are now more consistent with other methods * Invite is now InviteLink to be less arbitrary * Add method to get exported links * `get_exported_chat_invites` * prepare `__init__` for the other InvitesV2 methods * Update returned type `str` -> `types.InviteLink` * Add method to edit invite link Since editing the link returns a slightly different type to exporting, I have made a small "hack" in the InviteLink type. * Move Invites V2 methods to their own namespace * Add get_chat_invite_importers and InviteImporter Method to fetch information on users that joined via a specific link and the type to display the information * Add methods to delete revoked links * delete_exported_chat_invite to delete a single revoked link * delete_revoked_exported_chat_invites to delete all revoked links of a specified admin * Renaming Invite(s) to InviteLink(s) As per @delivrance's request https://github.com/pyrogram/pyrogram/pull/630#issuecomment-791893890 Also sorted invites' __init__ alphabetically * Add Method to get admins with exported invite link Documentation needs an update and the respective type needs to be created. I cannot test this, as I lack Creator permissions. * Invite Links overhaul * Rearrange code Co-authored-by: Dan <14043624+delivrance@users.noreply.github.com>
69 lines
2.2 KiB
Python
69 lines
2.2 KiB
Python
# Pyrogram - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-2021 Dan <https://github.com/delivrance>
|
|
#
|
|
# This file is part of Pyrogram.
|
|
#
|
|
# Pyrogram 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.
|
|
#
|
|
# Pyrogram 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 Pyrogram. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
from pyrogram.scaffold import Scaffold
|
|
|
|
|
|
class Restart(Scaffold):
|
|
async def restart(self, 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
|
|
:emphasize-lines: 8
|
|
|
|
from pyrogram import Client
|
|
|
|
app = Client("my_account")
|
|
app.start()
|
|
|
|
... # Call API methods
|
|
|
|
app.restart()
|
|
|
|
... # Call other API methods
|
|
|
|
app.stop()
|
|
"""
|
|
|
|
async def do_it():
|
|
await self.stop()
|
|
await self.start()
|
|
|
|
if block:
|
|
await do_it()
|
|
else:
|
|
self.loop.create_task(do_it())
|
|
|
|
return self
|