Skip to content

API 7.5 new classes #4311

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

Jump to bottom
Merged
merged 6 commits into from
Jun 30, 2024
Merged

API 7.5 new classes #4311

merged 6 commits into from
Jun 30, 2024

Conversation

harshil21
Copy link
Member

@harshil21 harshil21 commented Jun 20, 2024 •
edited
Loading

Checklist

  • Added .. versionadded:: NEXT.VERSION, .. versionchanged:: NEXT.VERSION or .. deprecated:: NEXT.VERSION to the docstrings for user facing changes (for methods/class descriptions, arguments and attributes)
  • Created new or adapted existing unit tests
  • Documented code changes according to the CSI standard <https://standards.mousepawmedia.com/en/stable/csi.html>__
  • Added myself alphabetically to AUTHORS.rst (optional)
  • Added new classes & modules to the docs and all suitable __all__ s
  • Checked the Stability Policy <https://docs.python-telegram-bot.org/stability_policy.html>_ in case of deprecations or changes to documented behavior

If the PR contains API changes (otherwise, you can ignore this passage)

  • Checked the Bot API specific sections of the Stability Policy

  • New classes:

    • Added self._id_attrs and corresponding documentation
    • __init__ accepts api_kwargs as kw-only

  • Added new shortcuts:

    • In :class:~telegram.Chat & :class:~telegram.User for all methods that accept chat/user_id
    • In :class:~telegram.Message for all methods that accept chat_id and message_id
    • For new :class:~telegram.Message shortcuts: Added do_quote argument if methods accepts reply_to_message_id
    • In :class:~telegram.CallbackQuery for all methods that accept either chat_id and message_id or inline_message_id

  • If relevant:

    • Added new constants at :mod:telegram.constants and shortcuts to them as class variables
    • Link new and existing constants in docstrings instead of hard-coded numbers and strings
    • Add new message types to :attr:telegram.Message.effective_attachment
    • Added new handlers for new update types
    • Add the handlers to the warning loop in the :class:~telegram.ext.ConversationHandler
    • Added new filters for new message (sub)types
    • Added or updated documentation for the changed class(es) and/or method(s)
    • Added the new method(s) to _extbot.py
    • Added or updated bot_methods.rst
    • Updated the Bot API version number in all places: README.rst and README_RAW.rst (including the badge), as well as telegram.constants.BOT_API_VERSION_INFO
    • Added logic for arbitrary callback data in :class:telegram.ext.ExtBot for new methods that either accept a reply_markup in some form or have a return type that is/contains :class:~telegram.Message

@harshil21 harshil21 added ⚙️ bot-api affected functionality: bot-api WIP labels Jun 20, 2024
@Bibo-Joshi Bibo-Joshi marked this pull request as draft June 20, 2024 16:34
Bibo-Joshi
Bibo-Joshi reviewed Jun 20, 2024
View reviewed changes
Copy link
Member

@Bibo-Joshi Bibo-Joshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey : ) I noticed the "WIP" label too late, so here you already have somen comment 😅

harshil21
harshil21 commented Jun 27, 2024
View reviewed changes
@harshil21 harshil21 marked this pull request as ready for review June 27, 2024 03:02
@harshil21 harshil21 requested a review from Bibo-Joshi June 27, 2024 03:02
Bibo-Joshi
Bibo-Joshi reviewed Jun 27, 2024
View reviewed changes
Copy link
Member

@Bibo-Joshi Bibo-Joshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, thanks for the updates! I went throug the new changes and admittedly only skimmed the tests 😅
I left a few more comments

tests/test_stars.py
@@ -133,15 +263,16 @@ def test_de_json_star_transaction_localization(self, star_transaction, tz_bot, b
assert st_bot.date.tzinfo == UTC
assert st_offset == tz_bot_offset

def test_to_dict(self, star_transaction):
def test_to_dict(self):
st = star_transaction()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you mean to use this as fixuter instead, i.e. pass it as argument? same in the other tests

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had done that before but I actually wanted to use the return value in TestStarTransactionsBase, so I kept it as a function

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mh, I see. Might something like this be of use? https://stackoverflow.com/a/63047695/10606962
I'm okay with keeping as is, but it's at least something that future-us will likely stumble over if we have re-touch tests.

@harshil21 harshil21 removed the WIP label Jun 27, 2024
@harshil21 harshil21 mentioned this pull request Jun 28, 2024
Merged
Bibo-Joshi
Bibo-Joshi approved these changes Jun 30, 2024
View reviewed changes
Copy link
Member

@Bibo-Joshi Bibo-Joshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM just left me know if you want to change something about the tests or keep it as is :)

@harshil21
Copy link
Member Author

I'll keep the tests as is for now.

@Bibo-Joshi Bibo-Joshi merged commit 9cb530c into api-7.5 Jun 30, 2024
21 of 25 checks passed
@Bibo-Joshi Bibo-Joshi deleted the api-7.5-classes branch June 30, 2024 20:10
@Bibo-Joshi Bibo-Joshi mentioned this pull request Jun 30, 2024
Merged
Bibo-Joshi added a commit that referenced this pull request Jul 1, 2024
@harshil21 @Bibo-Joshi
API 7.5 (#4312, #4311, #4315, #4328, #4316)
146ec54 
Co-authored-by: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com>
Poolitzer pushed a commit that referenced this pull request Jul 7, 2024
@harshil21 @Poolitzer
API 7.5 new classes (#4311)
8b580e7
@github-actions github-actions bot locked and limited conversation to collaborators Jul 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Bibo-Joshi Bibo-Joshi Bibo-Joshi approved these changes

Assignees
No one assigned
Labels
⚙️ bot-api affected functionality: bot-api
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@harshil21 @Bibo-Joshi