79 lines
3.0 KiB
Python
79 lines
3.0 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/>.
|
|
|
|
import logging
|
|
from typing import Union
|
|
|
|
from pyrogram import raw
|
|
from pyrogram import types
|
|
from pyrogram.scaffold import Scaffold
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
class SignIn(Scaffold):
|
|
async def sign_in(
|
|
self,
|
|
phone_number: str,
|
|
phone_code_hash: str,
|
|
phone_code: str
|
|
) -> Union["types.User", "types.TermsOfService", bool]:
|
|
"""Authorize a user in Telegram with a valid confirmation code.
|
|
|
|
Parameters:
|
|
phone_number (``str``):
|
|
Phone number in international format (includes the country prefix).
|
|
|
|
phone_code_hash (``str``):
|
|
Code identifier taken from the result of :meth:`~pyrogram.Client.send_code`.
|
|
|
|
phone_code (``str``):
|
|
The valid confirmation code you received (either as Telegram message or as SMS in your phone number).
|
|
|
|
Returns:
|
|
:obj:`~pyrogram.types.User` | :obj:`~pyrogram.types.TermsOfService` | bool: On success, in case the
|
|
authorization completed, the user is returned. In case the phone number needs to be registered first AND the
|
|
terms of services accepted (with :meth:`~pyrogram.Client.accept_terms_of_service`), an object containing
|
|
them is returned. In case the phone number needs to be registered, but the terms of services don't need to
|
|
be accepted, False is returned instead.
|
|
|
|
Raises:
|
|
BadRequest: In case the arguments are invalid.
|
|
SessionPasswordNeeded: In case a password is needed to sign in.
|
|
"""
|
|
phone_number = phone_number.strip(" +")
|
|
|
|
r = await self.send(
|
|
raw.functions.auth.SignIn(
|
|
phone_number=phone_number,
|
|
phone_code_hash=phone_code_hash,
|
|
phone_code=phone_code
|
|
)
|
|
)
|
|
|
|
if isinstance(r, raw.types.auth.AuthorizationSignUpRequired):
|
|
if r.terms_of_service:
|
|
return types.TermsOfService._parse(terms_of_service=r.terms_of_service)
|
|
|
|
return False
|
|
else:
|
|
await self.storage.user_id(r.user.id)
|
|
await self.storage.is_bot(False)
|
|
|
|
return types.User._parse(self, r.user)
|