From cf76945a83256a968d30fc4ec67071cf2afeecc0 Mon Sep 17 00:00:00 2001 From: kalmengr <46006289+kalmengr@users.noreply.github.com> Date: Mon, 23 Dec 2019 12:44:06 -0500 Subject: [PATCH] Create a new update_profile method to update a user's own profile (#277) * Create a new update_profile method to update a users own profile * Update update_profile.py * Update update_profile.py * Update update_profile.py * Update update_profile.py Co-authored-by: Dan <14043624+delivrance@users.noreply.github.com> --- .../client/methods/users/update_profile.py | 70 +++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 pyrogram/client/methods/users/update_profile.py diff --git a/pyrogram/client/methods/users/update_profile.py b/pyrogram/client/methods/users/update_profile.py new file mode 100644 index 00000000..c543156d --- /dev/null +++ b/pyrogram/client/methods/users/update_profile.py @@ -0,0 +1,70 @@ +# Pyrogram - Telegram MTProto API Client Library for Python +# Copyright (C) 2017-2019 Dan Tès +# +# 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 . + +from pyrogram.api import functions +from ...ext import BaseClient + + +class UpdateProfile(BaseClient): + def update_profile( + self, + first_name: str = None, + last_name: str = None, + bio: str = None + ) -> bool: + """Update your profile details such as first name, last name and bio. + + You can omit the parameters you don't want to change. + + Parameters: + first_name (``str``, *optional*): + The new first name. + + last_name (``str``, *optional*): + The new last name. + Pass "" (empty string) to remove it. + + bio (``str``, *optional*): + The new bio, also known as "about". Max 70 characters. + Pass "" (empty string) to remove it. + + Returns: + ``bool``: True on success. + + Example: + .. code-block:: python + + # Update your first name only + app.update_bio(first_name="Pyrogram") + + # Update first name and bio + app.update_bio(first_name="Pyrogram", bio="https://docs.pyrogram.org/") + + # Remove the last name + app.update_bio(last_name="") + """ + + return bool( + self.send( + functions.account.UpdateProfile( + first_name=first_name, + last_name=last_name, + about=bio + ) + ) + )