Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add type annotations #206

Merged
merged 6 commits into from
Aug 15, 2018
Merged

Add type annotations #206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
08dd5b5
Add None return type to functions
V02460 Jul 26, 2018
01e1536
Replace star imports with literal values
V02460 Jul 26, 2018
0f8009b
Add missing type hints and fix most type errors except for Optionals.
V02460 Aug 9, 2018
e751d14
Change case of new types
V02460 Aug 9, 2018
6668315
Make SearchResult a NewType and make its List explicit
V02460 Aug 9, 2018
8153123
Replace double quote type annotations with single quotes
V02460 Aug 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions mautrix_telegram/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
from typing import Optional
from typing import Coroutine, List, Optional
import argparse
import asyncio
import logging.config
Expand Down Expand Up @@ -115,7 +115,7 @@
startup_actions = (init_puppet(context) +
init_user(context) +
[start,
context.mx.init_as_bot()])
context.mx.init_as_bot()]) # type: List[Coroutine]

if context.bot:
startup_actions.append(context.bot.start())
Expand Down
51 changes: 27 additions & 24 deletions mautrix_telegram/abstract_user.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
from .tgclient import MautrixTelegramClient

if TYPE_CHECKING:
from .types import TelegramID
from .context import Context
from .config import Config
from .bot import Bot
Expand All @@ -60,17 +61,18 @@ class AbstractUser(ABC):
bot = None # type: Bot
ignore_incoming_bot_events = True # type: bool

def __init__(self):
def __init__(self) -> None:
self.is_admin = False # type: bool
self.matrix_puppet_whitelisted = False # type: bool
self.puppet_whitelisted = False # type: bool
self.whitelisted = False # type: bool
self.relaybot_whitelisted = False # type: bool
self.client = None # type: MautrixTelegramClient
self.tgid = None # type: int
self.tgid = None # type: TelegramID
self.mxid = None # type: str
self.is_relaybot = False # type: bool
self.is_bot = False # type: bool
self.relaybot = None # type: Optional[Bot]

@property
def connected(self) -> bool:
Expand All @@ -93,7 +95,7 @@ def _proxy_settings(self) -> Optional[Tuple[int, str, str, str, str, str]]:
config["telegram.proxy.rdns"],
config["telegram.proxy.username"], config["telegram.proxy.password"])

def _init_client(self):
def _init_client(self) -> None:
self.log.debug(f"Initializing client for {self.name}")
device = f"{platform.system()} {platform.release()}"
sysversion = MautrixTelegramClient.__version__
Expand All @@ -114,18 +116,18 @@ async def update(self, update: TypeUpdate) -> bool:
return False

@abstractmethod
async def post_login(self):
async def post_login(self) -> None:
raise NotImplementedError()

@abstractmethod
def register_portal(self, portal: po.Portal):
def register_portal(self, portal: po.Portal) -> None:
raise NotImplementedError()

@abstractmethod
def unregister_portal(self, portal: po.Portal):
def unregister_portal(self, portal: po.Portal) -> None:
raise NotImplementedError()

async def _update_catch(self, update: TypeUpdate):
async def _update_catch(self, update: TypeUpdate) -> None:
try:
if not await self.update(update):
await self._update(update)
Expand Down Expand Up @@ -154,14 +156,14 @@ async def has_full_access(self, allow_bot: bool = False) -> bool:
and (not self.is_bot or allow_bot)
and await self.is_logged_in())

async def start(self, delete_unless_authenticated: bool = False) -> "AbstractUser":
async def start(self, delete_unless_authenticated: bool = False) -> 'AbstractUser':
if not self.client:
self._init_client()
await self.client.connect()
self.log.debug("%s connected: %s", self.mxid, self.connected)
return self

async def ensure_started(self, even_if_no_session=False) -> "AbstractUser":
async def ensure_started(self, even_if_no_session=False) -> 'AbstractUser':
if not self.puppet_whitelisted:
return self
self.log.debug("ensure_started(%s, connected=%s, even_if_no_session=%s, session_count=%s)",
Expand All @@ -175,13 +177,13 @@ async def ensure_started(self, even_if_no_session=False) -> "AbstractUser":
await self.start(delete_unless_authenticated=not even_if_no_session)
return self

async def stop(self):
async def stop(self) -> None:
await self.client.disconnect()
self.client = None

# region Telegram update handling

async def _update(self, update: TypeUpdate):
async def _update(self, update: TypeUpdate) -> None:
if isinstance(update, (UpdateShortChatMessage, UpdateShortMessage, UpdateNewChannelMessage,
UpdateNewMessage, UpdateEditMessage, UpdateEditChannelMessage)):
await self.update_message(update)
Expand All @@ -207,18 +209,18 @@ async def _update(self, update: TypeUpdate):
self.log.debug("Unhandled update: %s", update)

@staticmethod
async def update_pinned_messages(update: UpdateChannelPinnedMessage):
async def update_pinned_messages(update: UpdateChannelPinnedMessage) -> None:
portal = po.Portal.get_by_tgid(update.channel_id)
if portal and portal.mxid:
await portal.receive_telegram_pin_id(update.id)

@staticmethod
async def update_participants(update: UpdateChatParticipants):
async def update_participants(update: UpdateChatParticipants) -> None:
portal = po.Portal.get_by_tgid(update.participants.chat_id)
if portal and portal.mxid:
await portal.update_telegram_participants(update.participants.participants)

async def update_read_receipt(self, update: UpdateReadHistoryOutbox):
async def update_read_receipt(self, update: UpdateReadHistoryOutbox) -> None:
if not isinstance(update.peer, PeerUser):
self.log.debug("Unexpected read receipt peer: %s", update.peer)
return
Expand All @@ -235,7 +237,8 @@ async def update_read_receipt(self, update: UpdateReadHistoryOutbox):
puppet = pu.Puppet.get(update.peer.user_id)
await puppet.intent.mark_read(portal.mxid, message.mxid)

async def update_admin(self, update: Union[UpdateChatAdmins, UpdateChatParticipantAdmin]):
async def update_admin(self,
update: Union[UpdateChatAdmins, UpdateChatParticipantAdmin]) -> None:
# TODO duplication not checked
portal = po.Portal.get_by_tgid(update.chat_id, peer_type="chat")
if isinstance(update, UpdateChatAdmins):
Expand All @@ -245,15 +248,15 @@ async def update_admin(self, update: Union[UpdateChatAdmins, UpdateChatParticipa
else:
self.log.warning("Unexpected admin status update: %s", update)

async def update_typing(self, update: Union[UpdateUserTyping, UpdateChatUserTyping]):
async def update_typing(self, update: Union[UpdateUserTyping, UpdateChatUserTyping]) -> None:
if isinstance(update, UpdateUserTyping):
portal = po.Portal.get_by_tgid(update.user_id, self.tgid, "user")
else:
portal = po.Portal.get_by_tgid(update.chat_id, peer_type="chat")
sender = pu.Puppet.get(update.user_id)
await portal.handle_telegram_typing(sender, update)

async def update_others_info(self, update: Union[UpdateUserName, UpdateUserPhoto]):
async def update_others_info(self, update: Union[UpdateUserName, UpdateUserPhoto]) -> None:
# TODO duplication not checked
puppet = pu.Puppet.get(update.user_id)
if isinstance(update, UpdateUserName):
Expand All @@ -265,7 +268,7 @@ async def update_others_info(self, update: Union[UpdateUserName, UpdateUserPhoto
else:
self.log.warning("Unexpected other user info update: %s", update)

async def update_status(self, update: UpdateUserStatus):
async def update_status(self, update: UpdateUserStatus) -> None:
puppet = pu.Puppet.get(update.user_id)
if isinstance(update.status, UserStatusOnline):
await puppet.default_mxid_intent.set_presence("online")
Expand Down Expand Up @@ -300,15 +303,15 @@ def get_message_details(self, update: UpdateMessage) -> Tuple[UpdateMessageConte
return update, sender, portal

@staticmethod
async def _try_redact(portal: po.Portal, message: DBMessage):
async def _try_redact(portal: po.Portal, message: DBMessage) -> None:
if not portal:
return
try:
await portal.main_intent.redact(message.mx_room, message.mxid)
except MatrixRequestError:
pass

async def delete_message(self, update: UpdateDeleteMessages):
async def delete_message(self, update: UpdateDeleteMessages) -> None:
if len(update.messages) > MAX_DELETIONS:
return

Expand All @@ -324,7 +327,7 @@ async def delete_message(self, update: UpdateDeleteMessages):
await self._try_redact(portal, message)
self.db.commit()

async def delete_channel_message(self, update: UpdateDeleteChannelMessages):
async def delete_channel_message(self, update: UpdateDeleteChannelMessages) -> None:
if len(update.messages) > MAX_DELETIONS:
return

Expand All @@ -340,7 +343,7 @@ async def delete_channel_message(self, update: UpdateDeleteChannelMessages):
await self._try_redact(portal, message)
self.db.commit()

async def update_message(self, original_update: UpdateMessage):
async def update_message(self, original_update: UpdateMessage) -> None:
update, sender, portal = self.get_message_details(original_update)
if self.ignore_incoming_bot_events and self.bot and sender.id == self.bot.tgid:
self.log.debug(f"Ignoring relaybot-sent message %s to %s", update, portal.tgid_log)
Expand Down Expand Up @@ -369,9 +372,9 @@ async def update_message(self, original_update: UpdateMessage):
# endregion


def init(context: "Context"):
def init(context: "Context") -> None:
global config, MAX_DELETIONS
AbstractUser.az, AbstractUser.db, config, AbstractUser.loop, AbstractUser.relaybot = context
AbstractUser.az, AbstractUser.db, config, AbstractUser.loop, AbstractUser.relaybot = context.core
AbstractUser.ignore_incoming_bot_events = config["bridge.relaybot.ignore_own_incoming_events"]
AbstractUser.session_container = context.session_container
MAX_DELETIONS = config.get("bridge.max_telegram_delete", 10)
Loading