Deprecate python-telegram-bot-raw (#4270)

This commit is contained in:
Bibo-Joshi 2024-06-01 21:19:38 +02:00 committed by GitHub
parent 2c299bb109
commit 57298aa076
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 38 additions and 14 deletions

View file

@ -1,6 +1,3 @@
..
Make sure to apply any changes to this file to README_RAW.rst as well!
.. image:: https://raw.githubusercontent.com/python-telegram-bot/logos/master/logo-text/png/ptb-logo-text_768.png .. image:: https://raw.githubusercontent.com/python-telegram-bot/logos/master/logo-text/png/ptb-logo-text_768.png
:align: center :align: center
:target: https://python-telegram-bot.org :target: https://python-telegram-bot.org
@ -79,13 +76,6 @@ In addition to the pure API implementation, this library features a number of hi
make the development of bots easy and straightforward. These classes are contained in the make the development of bots easy and straightforward. These classes are contained in the
``telegram.ext`` submodule. ``telegram.ext`` submodule.
A pure API implementation *without* ``telegram.ext`` is available as the standalone package ``python-telegram-bot-raw``. `See here for details. <https://github.com/python-telegram-bot/python-telegram-bot/blob/master/README_RAW.rst>`_
Note
----
Installing both ``python-telegram-bot`` and ``python-telegram-bot-raw`` in conjunction will result in undesired side-effects, so only install *one* of both.
Telegram API support Telegram API support
==================== ====================

View file

@ -1,6 +1,3 @@
..
Make sure to apply any changes to this file to README.rst as well!
.. image:: https://github.com/python-telegram-bot/logos/blob/master/logo-text/png/ptb-raw-logo-text_768.png?raw=true .. image:: https://github.com/python-telegram-bot/logos/blob/master/logo-text/png/ptb-raw-logo-text_768.png?raw=true
:align: center :align: center
:target: https://python-telegram-bot.org :target: https://python-telegram-bot.org
@ -62,6 +59,16 @@
:target: https://telegram.me/pythontelegrambotgroup :target: https://telegram.me/pythontelegrambotgroup
:alt: Telegram Group :alt: Telegram Group
⚠️ Deprecation Notice
=====================
The ``python-telegram-bot-raw`` library will no longer be updated after NEXT.VERSION.
Please instead use the ``python-telegram-bot`` `library <https://pypi.org/python-telegram-bot>`_.
The change requires no changes in your code and requires no additional dependencies.
For additional information, please see this `channel post <https://t.me/pythontelegrambotchannel/145>`_.
----
We have made you a wrapper you can't refuse We have made you a wrapper you can't refuse
We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us! We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us!

View file

@ -242,6 +242,7 @@ __all__ = (
"warnings", "warnings",
) )
from pathlib import Path
from . import _version, constants, error, helpers, request, warnings from . import _version, constants, error, helpers, request, warnings
from ._birthdate import Birthdate from ._birthdate import Birthdate
@ -442,6 +443,7 @@ from ._telegramobject import TelegramObject
from ._update import Update from ._update import Update
from ._user import User from ._user import User
from ._userprofilephotos import UserProfilePhotos from ._userprofilephotos import UserProfilePhotos
from ._utils.warnings import warn
from ._videochat import ( from ._videochat import (
VideoChatEnded, VideoChatEnded,
VideoChatParticipantsInvited, VideoChatParticipantsInvited,
@ -475,3 +477,28 @@ __bot_api_version__: str = _version.__bot_api_version__
#: #:
#: .. versionadded:: 20.0 #: .. versionadded:: 20.0
__bot_api_version_info__: constants._BotAPIVersion = _version.__bot_api_version_info__ __bot_api_version_info__: constants._BotAPIVersion = _version.__bot_api_version_info__
if not (Path(__file__).parent.resolve().absolute() / "ext").exists():
_MESSAGE = (
"Hey. You seem to be using the `python-telegram-bot-raw` library. "
"Please note that this libray has been deprecated and will no longer be updated. "
"Please instead use the `python-telegram-bot` library. The change requires no "
"changes in your code and requires no additional dependencies. For additional "
"information, please see the channel post at "
"https://t.me/pythontelegrambotchannel/145."
)
# DeprecationWarning is ignored by default in Python 3.7 and later by default outside
# __main__ modules. We use both warning categories to increase the chance of the user
# seeing the warning.
warn(
warnings.PTBDeprecationWarning(version="NEXT.VERSION", message=_MESSAGE),
stacklevel=2,
)
warn(
message=_MESSAGE,
category=warnings.PTBUserWarning,
stacklevel=2,
)

View file

@ -194,7 +194,7 @@ def extract_tzinfo_from_defaults(bot: "Bot") -> Union[dtm.tzinfo, None]:
If the bot has no default values, :obj:`None` is returned. If the bot has no default values, :obj:`None` is returned.
""" """
# We don't use `ininstance(bot, ExtBot)` here so that this works # We don't use `ininstance(bot, ExtBot)` here so that this works
# in `python-telegram-bot-raw` as well # without the job-queue extra dependencies as well
if hasattr(bot, "defaults") and bot.defaults: if hasattr(bot, "defaults") and bot.defaults:
return bot.defaults.tzinfo return bot.defaults.tzinfo
return None return None