iartamonov/mautrix-telegram
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Add None return type to functions

Browse Source
This commit is contained in:
Kai A. Hiller
2018-07-26 15:44:33 +02:00
parent c9ffd23729
commit 08dd5b5b15
18 changed files with 237 additions and 226 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mautrix_telegram/commands/auth.py
+14 -14
View File
@@ -27,7 +27,7 @@ from ..util import format_duration
@command_handler(needs_auth=False,
help_section=SECTION_AUTH,
help_text="Check if you're logged into Telegram.")
async def ping(evt: CommandEvent):
async def ping(evt: CommandEvent) -> None:
me = await evt.sender.client.get_me() if await evt.sender.is_logged_in() else None
if me:
return await evt.reply(f"You're logged in as @{me.username}")
@@ -38,7 +38,7 @@ async def ping(evt: CommandEvent):
@command_handler(needs_auth=False, needs_puppeting=False,
help_section=SECTION_AUTH,
help_text="Get the info of the message relay Telegram bot.")
async def ping_bot(evt: CommandEvent):
async def ping_bot(evt: CommandEvent) -> None:
if not evt.tgbot:
return await evt.reply("Telegram message relay bot not configured.")
bot_info = await evt.tgbot.client.get_me()
@@ -53,7 +53,7 @@ async def ping_bot(evt: CommandEvent):
help_section=SECTION_AUTH,
help_text="Revert your Telegram account's Matrix puppet to use the default Matrix "
"account.")
async def logout_matrix(evt: CommandEvent):
async def logout_matrix(evt: CommandEvent) -> None:
puppet = pu.Puppet.get(evt.sender.tgid)
if not puppet.is_real_user:
return await evt.reply("You are not logged in with your Matrix account.")
@@ -65,7 +65,7 @@ async def logout_matrix(evt: CommandEvent):
help_section=SECTION_AUTH,
help_text="Replace your Telegram account's Matrix puppet with your own Matrix "
"account")
async def login_matrix(evt: CommandEvent):
async def login_matrix(evt: CommandEvent) -> None:
puppet = pu.Puppet.get(evt.sender.tgid)
if puppet.is_real_user:
return await evt.reply("You have already logged in with your Matrix account. "
@@ -96,7 +96,7 @@ async def login_matrix(evt: CommandEvent):
return await evt.reply("This bridge instance has been configured to not allow logging in.")
async def enter_matrix_token(evt: CommandEvent):
async def enter_matrix_token(evt: CommandEvent) -> None:
evt.sender.command_status = None
puppet = pu.Puppet.get(evt.sender.tgid)
@@ -117,7 +117,7 @@ async def enter_matrix_token(evt: CommandEvent):
help_section=SECTION_AUTH,
help_args="<_phone_> <_full name_>",
help_text="Register to Telegram")
async def register(evt: CommandEvent):
async def register(evt: CommandEvent) -> None:
if await evt.sender.is_logged_in():
return await evt.reply("You are already logged in.")
elif len(evt.args) < 1:
@@ -136,7 +136,7 @@ async def register(evt: CommandEvent):
})
async def enter_code_register(evt: CommandEvent):
async def enter_code_register(evt: CommandEvent) -> None:
if len(evt.args) == 0:
return await evt.reply("**Usage:** `$cmdprefix+sp <code>`")
try:
@@ -165,7 +165,7 @@ async def enter_code_register(evt: CommandEvent):
@command_handler(needs_auth=False, management_only=True,
help_section=SECTION_AUTH,
help_text="Get instructions on how to log in.")
async def login(evt: CommandEvent):
async def login(evt: CommandEvent) -> None:
if await evt.sender.is_logged_in():
return await evt.reply("You are already logged in.")
@@ -196,7 +196,7 @@ async def login(evt: CommandEvent):
return await evt.reply("This bridge instance has been configured to not allow logging in.")
async def request_code(evt: CommandEvent, phone_number: str, next_status: Dict[str, str]):
async def request_code(evt: CommandEvent, phone_number: str, next_status: Dict[str, str]) -> None:
ok = False
try:
await evt.sender.ensure_started(even_if_no_session=True)
@@ -228,7 +228,7 @@ async def request_code(evt: CommandEvent, phone_number: str, next_status: Dict[s
@command_handler(needs_auth=False)
async def enter_phone_or_token(evt: CommandEvent):
async def enter_phone_or_token(evt: CommandEvent) -> None:
if len(evt.args) == 0:
return await evt.reply("**Usage:** `$cmdprefix+sp enter-phone-or-token <phone-or-token>`")
elif not evt.config.get("bridge.allow_matrix_login", True):
@@ -251,7 +251,7 @@ async def enter_phone_or_token(evt: CommandEvent):
@command_handler(needs_auth=False)
async def enter_code(evt: CommandEvent):
async def enter_code(evt: CommandEvent) -> None:
if len(evt.args) == 0:
return await evt.reply("**Usage:** `$cmdprefix+sp enter-code <code>`")
elif not evt.config.get("bridge.allow_matrix_login", True):
@@ -266,7 +266,7 @@ async def enter_code(evt: CommandEvent):
@command_handler(needs_auth=False)
async def enter_password(evt: CommandEvent):
async def enter_password(evt: CommandEvent) -> None:
if len(evt.args) == 0:
return await evt.reply("**Usage:** `$cmdprefix+sp enter-password <password>`")
elif not evt.config.get("bridge.allow_matrix_login", True):
@@ -284,7 +284,7 @@ async def enter_password(evt: CommandEvent):
"Check console for more details.")
async def sign_in(evt: CommandEvent, **sign_in_info):
async def sign_in(evt: CommandEvent, **sign_in_info) -> None:
try:
await evt.sender.ensure_started(even_if_no_session=True)
user = await evt.sender.client.sign_in(**sign_in_info)
@@ -309,7 +309,7 @@ async def sign_in(evt: CommandEvent, **sign_in_info):
@command_handler(needs_auth=True,
help_section=SECTION_AUTH,
help_text="Log out from Telegram.")
async def logout(evt: CommandEvent):
async def logout(evt: CommandEvent) -> None:
if await evt.sender.log_out():
return await evt.reply("Logged out successfully.")
return await evt.reply("Failed to log out.")
mautrix_telegram/commands/clean_rooms.py
+3 -3
View File
@@ -61,7 +61,7 @@ async def _find_rooms(intent: IntentAPI) -> Tuple[ManagementRoomList, RoomIDList
@command_handler(needs_admin=True, needs_auth=False, management_only=True, name="clean-rooms",
help_section=SECTION_ADMIN,
help_text="Clean up unused portal/management rooms.")
async def clean_rooms(evt: CommandEvent):
async def clean_rooms(evt: CommandEvent) -> None:
management_rooms, unidentified_rooms, portals, empty_portals = await _find_rooms(evt.az.intent)
reply = ["#### Management rooms (M)"]
@@ -108,7 +108,7 @@ async def clean_rooms(evt: CommandEvent):
async def set_rooms_to_clean(evt, management_rooms: ManagementRoomList,
unidentified_rooms: RoomIDList, portals: List["po.Portal"],
empty_portals: List["po.Portal"]):
empty_portals: List["po.Portal"]) -> None:
command = evt.args[0]
rooms_to_clean = []
if command == "clean-recommended":
@@ -158,7 +158,7 @@ async def set_rooms_to_clean(evt, management_rooms: ManagementRoomList,
"`$cmdprefix+sp confirm-clean`.")
async def execute_room_cleanup(evt, rooms_to_clean):
async def execute_room_cleanup(evt, rooms_to_clean) -> None:
if len(evt.args) > 0 and evt.args[0] == "confirm-clean":
await evt.reply(f"Cleaning {len(rooms_to_clean)} rooms. "
"This might take a while.")
mautrix_telegram/commands/handler.py
+8 -8
View File
@@ -38,7 +38,7 @@ SECTION_ADMIN = HelpSection("Administration", 50, "")
class CommandEvent:
def __init__(self, processor: "CommandProcessor", room: str, sender: u.User, command: str,
args: List[str], is_management: bool, is_portal: bool):
args: List[str], is_management: bool, is_portal: bool) -> None:
self.az = processor.az
self.log = processor.log
self.loop = processor.loop
@@ -53,7 +53,7 @@ class CommandEvent:
self.is_management = is_management
self.is_portal = is_portal
def reply(self, message: str, allow_html: bool = False, render_markdown: bool = True):
def reply(self, message: str, allow_html: bool = False, render_markdown: bool = True) -> None:
message = message.replace("$cmdprefix+sp ",
"" if self.is_management else f"{self.command_prefix} ")
message = message.replace("$cmdprefix", self.command_prefix)
@@ -69,7 +69,7 @@ class CommandHandler:
def __init__(self, handler: Callable[[CommandEvent], None], needs_auth: bool,
needs_puppeting: bool, needs_matrix_puppeting: bool, needs_admin: bool,
management_only: bool, name: str, help_text: str, help_args: str,
help_section: HelpSection):
help_section: HelpSection) -> None:
self._handler = handler
self.needs_auth = needs_auth
self.needs_puppeting = needs_puppeting
@@ -103,7 +103,7 @@ class CommandHandler:
(not self.needs_admin or is_admin) and
(not self.needs_auth or is_logged_in))
async def __call__(self, evt: CommandEvent):
async def __call__(self, evt: CommandEvent) -> None:
error = await self.get_permission_error(evt)
if error is not None:
return await evt.reply(error)
@@ -121,10 +121,10 @@ class CommandHandler:
def command_handler(_func: Optional[Callable[[CommandEvent], None]] = None, *, needs_auth=True,
needs_puppeting=True, needs_matrix_puppeting=False, needs_admin=False,
management_only=False, name=None, help_text="", help_args="",
help_section=None):
help_section=None) -> None:
input_name = name
def decorator(func: Callable[[CommandEvent], None]):
def decorator(func: Callable[[CommandEvent], None]) -> None:
name = input_name or func.__name__.replace("_", "-")
handler = CommandHandler(func, needs_auth, needs_puppeting, needs_matrix_puppeting,
needs_admin, management_only, name, help_text, help_args,
@@ -138,13 +138,13 @@ def command_handler(_func: Optional[Callable[[CommandEvent], None]] = None, *, n
class CommandProcessor:
log = logging.getLogger("mau.commands")
def __init__(self, context: c.Context):
def __init__(self, context: c.Context) -> None:
self.az, self.db, self.config, self.loop, self.tgbot = context
self.public_website = context.public_website
self.command_prefix = self.config["bridge.command_prefix"]
async def handle(self, room: str, sender: u.User, command: str, args: List[str],
is_management: bool, is_portal: bool):
is_management: bool, is_portal: bool) -> None:
evt = CommandEvent(self, room, sender, command, args, is_management, is_portal)
orig_command = command
command = command.lower()
mautrix_telegram/commands/meta.py
+5 -5
View File
@@ -20,7 +20,7 @@ from . import command_handler, CommandEvent, _command_handlers, SECTION_GENERAL
@command_handler(needs_auth=False, needs_puppeting=False,
help_section=SECTION_GENERAL,
help_text="Cancel an ongoing action (such as login)")
def cancel(evt: CommandEvent):
def cancel(evt: CommandEvent) -> None:
if evt.sender.command_status:
action = evt.sender.command_status["action"]
evt.sender.command_status = None
@@ -30,14 +30,14 @@ def cancel(evt: CommandEvent):
@command_handler(needs_auth=False, needs_puppeting=False)
def unknown_command(evt: CommandEvent):
def unknown_command(evt: CommandEvent) -> None:
return evt.reply("Unknown command. Try `$cmdprefix+sp help` for help.")
help_cache = {}
async def _get_help_text(evt: CommandEvent):
async def _get_help_text(evt: CommandEvent) -> None:
cache_key = (evt.is_management, evt.sender.puppet_whitelisted,
evt.sender.matrix_puppet_whitelisted, evt.sender.is_admin,
await evt.sender.is_logged_in())
@@ -53,7 +53,7 @@ async def _get_help_text(evt: CommandEvent):
return help_cache[cache_key]
def _get_management_status(evt: CommandEvent):
def _get_management_status(evt: CommandEvent) -> None:
if evt.is_management:
return "This is a management room: prefixing commands with `$cmdprefix` is not required."
elif evt.is_portal:
@@ -65,5 +65,5 @@ def _get_management_status(evt: CommandEvent):
@command_handler(needs_auth=False, needs_puppeting=False,
help_section=SECTION_GENERAL,
help_text="Show this help message.")
async def help(evt: CommandEvent):
async def help(evt: CommandEvent) -> None:
return await evt.reply(_get_management_status(evt) + "\n" + await _get_help_text(evt))
mautrix_telegram/commands/portal.py
+19 -18
View File
@@ -30,7 +30,7 @@ from . import (command_handler, CommandEvent,
help_section=SECTION_ADMIN,
help_args="<_level_> [_mxid_]",
help_text="Set a temporary power level without affecting Telegram.")
async def set_power_level(evt: CommandEvent):
async def set_power_level(evt: CommandEvent) -> None:
try:
level = int(evt.args[0])
except KeyError:
@@ -49,7 +49,7 @@ async def set_power_level(evt: CommandEvent):
@command_handler(help_section=SECTION_PORTAL_MANAGEMENT,
help_text="Get a Telegram invite link to the current chat.")
async def invite_link(evt: CommandEvent):
async def invite_link(evt: CommandEvent) -> None:
portal = po.Portal.get_by_mxid(evt.room_id)
if not portal:
return await evt.reply("This is not a portal room.")
@@ -66,7 +66,8 @@ async def invite_link(evt: CommandEvent):
return await evt.reply("You don't have the permission to create an invite link.")
async def user_has_power_level(room: str, intent, sender: u.User, event: str, default: int = 50):
async def user_has_power_level(room: str, intent, sender: u.User, event: str, default: int = 50
) -> None:
if sender.is_admin:
return True
# Make sure the state store contains the power levels.
@@ -80,7 +81,7 @@ async def user_has_power_level(room: str, intent, sender: u.User, event: str, de
async def _get_portal_and_check_permission(evt: CommandEvent, permission: str,
action: Optional[str] = None):
action: Optional[str] = None) -> None:
room_id = evt.args[0] if len(evt.args) > 0 else evt.room_id
portal = po.Portal.get_by_mxid(room_id)
@@ -95,8 +96,8 @@ async def _get_portal_and_check_permission(evt: CommandEvent, permission: str,
def _get_portal_murder_function(action: str, room_id: str, function: Callable, command: str,
completed_message: str):
async def post_confirm(confirm):
completed_message: str) -> None:
async def post_confirm(confirm) -> None:
confirm.sender.command_status = None
if len(confirm.args) > 0 and confirm.args[0] == f"confirm-{command}":
await function()
@@ -116,7 +117,7 @@ def _get_portal_murder_function(action: str, room_id: str, function: Callable, c
help_text="Remove all users from the current portal room and forget the portal. "
"Only works for group chats; to delete a private chat portal, simply "
"leave the room.")
async def delete_portal(evt: CommandEvent):
async def delete_portal(evt: CommandEvent) -> None:
portal, ok = await _get_portal_and_check_permission(evt, "unbridge")
if not ok:
return
@@ -137,7 +138,7 @@ async def delete_portal(evt: CommandEvent):
@command_handler(needs_auth=False, needs_puppeting=False,
help_section=SECTION_PORTAL_MANAGEMENT,
help_text="Remove puppets from the current portal room and forget the portal.")
async def unbridge(evt: CommandEvent):
async def unbridge(evt: CommandEvent) -> None:
portal, ok = await _get_portal_and_check_permission(evt, "unbridge")
if not ok:
return
@@ -156,7 +157,7 @@ async def unbridge(evt: CommandEvent):
help_text="Bridge the current Matrix room to the Telegram chat with the given "
"ID. The ID must be the prefixed version that you get with the `/id` "
"command of the Telegram-side bot.")
async def bridge(evt: CommandEvent):
async def bridge(evt: CommandEvent) -> None:
if len(evt.args) == 0:
return await evt.reply("**Usage:** "
"`$cmdprefix+sp bridge <Telegram chat ID> [Matrix room ID]`")
@@ -222,7 +223,7 @@ async def bridge(evt: CommandEvent):
"chat to this room, use `$cmdprefix+sp continue`")
async def cleanup_old_portal_while_bridging(evt: CommandEvent, portal: "po.Portal"):
async def cleanup_old_portal_while_bridging(evt: CommandEvent, portal: "po.Portal") -> None:
if not portal.mxid:
await evt.reply("The portal seems to have lost its Matrix room between you"
"calling `$cmdprefix+sp bridge` and this command.\n\n"
@@ -245,7 +246,7 @@ async def cleanup_old_portal_while_bridging(evt: CommandEvent, portal: "po.Porta
return False, None
async def confirm_bridge(evt: CommandEvent):
async def confirm_bridge(evt: CommandEvent) -> None:
status = evt.sender.command_status
try:
portal = po.Portal.get_by_tgid(status["tgid"], peer_type=status["peer_type"])
@@ -302,7 +303,7 @@ async def confirm_bridge(evt: CommandEvent):
return await evt.reply("Bridging complete. Portal synchronization should begin momentarily.")
async def get_initial_state(intent: IntentAPI, room_id: str):
async def get_initial_state(intent: IntentAPI, room_id: str) -> None:
state = await intent.get_room_state(room_id)
title = None
about = None
@@ -328,7 +329,7 @@ async def get_initial_state(intent: IntentAPI, room_id: str):
help_text="Create a Telegram chat of the given type for the current Matrix room. "
"The type is either `group`, `supergroup` or `channel` (defaults to "
"`group`).")
async def create(evt: CommandEvent):
async def create(evt: CommandEvent) -> None:
type = evt.args[0] if len(evt.args) > 0 else "group"
if type not in {"chat", "group", "supergroup", "channel"}:
return await evt.reply(
@@ -363,7 +364,7 @@ async def create(evt: CommandEvent):
@command_handler(help_section=SECTION_PORTAL_MANAGEMENT,
help_text="Upgrade a normal Telegram group to a supergroup.")
async def upgrade(evt: CommandEvent):
async def upgrade(evt: CommandEvent) -> None:
portal = po.Portal.get_by_mxid(evt.room_id)
if not portal:
return await evt.reply("This is not a portal room.")
@@ -385,7 +386,7 @@ async def upgrade(evt: CommandEvent):
help_args="<_name_|`-`>",
help_text="Change the username of a supergroup/channel. "
"To disable, use a dash (`-`) as the name.")
async def group_name(evt: CommandEvent):
async def group_name(evt: CommandEvent) -> None:
if len(evt.args) == 0:
return await evt.reply("**Usage:** `$cmdprefix+sp group-name <name/->`")
@@ -421,7 +422,7 @@ async def group_name(evt: CommandEvent):
help_args="<`whitelist`|`blacklist`>",
help_text="Change whether the bridge will allow or disallow bridging rooms by "
"default.")
async def filter_mode(evt: CommandEvent):
async def filter_mode(evt: CommandEvent) -> None:
try:
mode = evt.args[0]
if mode not in ("whitelist", "blacklist"):
@@ -446,7 +447,7 @@ async def filter_mode(evt: CommandEvent):
help_section=SECTION_ADMIN,
help_args="<`whitelist`|`blacklist`> <_chat ID_>",
help_text="Allow or disallow bridging a specific chat.")
async def filter(evt: CommandEvent):
async def filter(evt: CommandEvent) -> None:
try:
action = evt.args[0]
if action not in ("whitelist", "blacklist", "add", "remove"):
@@ -471,7 +472,7 @@ async def filter(evt: CommandEvent):
if action in ("blacklist", "whitelist"):
action = "add" if mode == action else "remove"
def save():
def save() -> None:
evt.config["bridge.filter.list"] = list
evt.config.save()
po.Portal.filter_list = list
mautrix_telegram/commands/telegram.py
+5 -5
View File
@@ -26,7 +26,7 @@ from . import command_handler, CommandEvent, SECTION_MISC, SECTION_CREATING_PORT
@command_handler(help_section=SECTION_MISC,
help_args="[_-r|--remote_] <_query_>",
help_text="Search your contacts or the Telegram servers for users.")
async def search(evt: CommandEvent):
async def search(evt: CommandEvent) -> None:
if len(evt.args) == 0:
return await evt.reply("**Usage:** `$cmdprefix+sp search [-r|--remote] <query>`")
@@ -68,7 +68,7 @@ async def search(evt: CommandEvent):
"either the internal user ID, the username or the phone number. "
"**N.B.** The phone numbers you start chats with must already be in "
"your contacts.")
async def private_message(evt: CommandEvent):
async def private_message(evt: CommandEvent) -> None:
if len(evt.args) == 0:
return await evt.reply("**Usage:** `$cmdprefix+sp pm <user identifier>`")
@@ -87,7 +87,7 @@ async def private_message(evt: CommandEvent):
f"{pu.Puppet.get_displayname(user, False)}")
async def _join(evt: CommandEvent, arg: str):
async def _join(evt: CommandEvent, arg: str) -> None:
if arg.startswith("joinchat/"):
invite_hash = arg[len("joinchat/"):]
try:
@@ -110,7 +110,7 @@ async def _join(evt: CommandEvent, arg: str):
@command_handler(help_section=SECTION_CREATING_PORTALS,
help_args="<_link_>",
help_text="Join a chat with an invite link.")
async def join(evt: CommandEvent):
async def join(evt: CommandEvent) -> None:
if len(evt.args) == 0:
return await evt.reply("**Usage:** `$cmdprefix+sp join <invite link>`")
@@ -137,7 +137,7 @@ async def join(evt: CommandEvent):
@command_handler(help_section=SECTION_MISC,
help_args="[`chats`|`contacts`|`me`]",
help_text="Synchronize your chat portals, contacts and/or own info.")
async def sync(evt: CommandEvent):
async def sync(evt: CommandEvent) -> None:
if len(evt.args) > 0:
sync_only = evt.args[0]
if sync_only not in ("chats", "contacts", "me"):