Move Handler Files to _handlers Subdirectory (#4064)

AUTHORS.rst

@@ -76,6 +76,7 @@ The following wonderful people contributed directly or indirectly to this projec
 - `Loo Zheng Yuan <https://github.com/loozhengyuan>`_
 - `LRezende <https://github.com/lrezende>`_
 - `Luca Bellanti <https://github.com/Trifase>`_
+- `Lucas Molinari <https://github.com/lucasmolinari>`_
 - `macrojames <https://github.com/macrojames>`_
 - `Matheus Lemos <https://github.com/mlemosf>`_
 - `Michael Dix <https://github.com/Eisberge>`_

telegram/ext/__init__.py

@@ -63,32 +63,32 @@
 from ._aioratelimiter import AIORateLimiter
 from ._application import Application, ApplicationHandlerStop
 from ._applicationbuilder import ApplicationBuilder
-from ._basehandler import BaseHandler
 from ._basepersistence import BasePersistence, PersistenceInput
 from ._baseratelimiter import BaseRateLimiter
 from ._baseupdateprocessor import BaseUpdateProcessor, SimpleUpdateProcessor
 from ._callbackcontext import CallbackContext
 from ._callbackdatacache import CallbackDataCache, InvalidCallbackData
-from ._callbackqueryhandler import CallbackQueryHandler
-from ._chatjoinrequesthandler import ChatJoinRequestHandler
-from ._chatmemberhandler import ChatMemberHandler
-from ._choseninlineresulthandler import ChosenInlineResultHandler
-from ._commandhandler import CommandHandler
 from ._contexttypes import ContextTypes
-from ._conversationhandler import ConversationHandler
 from ._defaults import Defaults
 from ._dictpersistence import DictPersistence
 from ._extbot import ExtBot
-from ._inlinequeryhandler import InlineQueryHandler
+from ._handlers.basehandler import BaseHandler
+from ._handlers.callbackqueryhandler import CallbackQueryHandler
+from ._handlers.chatjoinrequesthandler import ChatJoinRequestHandler
+from ._handlers.chatmemberhandler import ChatMemberHandler
+from ._handlers.choseninlineresulthandler import ChosenInlineResultHandler
+from ._handlers.commandhandler import CommandHandler
+from ._handlers.conversationhandler import ConversationHandler
+from ._handlers.inlinequeryhandler import InlineQueryHandler
+from ._handlers.messagehandler import MessageHandler
+from ._handlers.pollanswerhandler import PollAnswerHandler
+from ._handlers.pollhandler import PollHandler
+from ._handlers.precheckoutqueryhandler import PreCheckoutQueryHandler
+from ._handlers.prefixhandler import PrefixHandler
+from ._handlers.shippingqueryhandler import ShippingQueryHandler
+from ._handlers.stringcommandhandler import StringCommandHandler
+from ._handlers.stringregexhandler import StringRegexHandler
+from ._handlers.typehandler import TypeHandler
 from ._jobqueue import Job, JobQueue
-from ._messagehandler import MessageHandler
 from ._picklepersistence import PicklePersistence
-from ._pollanswerhandler import PollAnswerHandler
-from ._pollhandler import PollHandler
-from ._precheckoutqueryhandler import PreCheckoutQueryHandler
-from ._prefixhandler import PrefixHandler
-from ._shippingqueryhandler import ShippingQueryHandler
-from ._stringcommandhandler import StringCommandHandler
-from ._stringregexhandler import StringRegexHandler
-from ._typehandler import TypeHandler
 from ._updater import Updater

telegram/ext/_application.py

@@ -64,10 +64,10 @@
 from telegram._utils.types import SCT, DVType, ODVInput
 from telegram._utils.warnings import warn
 from telegram.error import TelegramError
-from telegram.ext._basehandler import BaseHandler
 from telegram.ext._basepersistence import BasePersistence
 from telegram.ext._contexttypes import ContextTypes
 from telegram.ext._extbot import ExtBot
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._updater import Updater
 from telegram.ext._utils.stack import was_called_by
 from telegram.ext._utils.trackingdict import TrackingDict
@@ -494,7 +494,7 @@ async def initialize(self) -> None:
 
         # Unfortunately due to circular imports this has to be here
         # pylint: disable=import-outside-toplevel
-        from telegram.ext._conversationhandler import ConversationHandler
+        from telegram.ext._handlers.conversationhandler import ConversationHandler
 
         # Initialize the persistent conversation handlers with the stored states
         for handler in itertools.chain.from_iterable(self.handlers.values()):
@@ -1304,7 +1304,7 @@ def add_handler(self, handler: BaseHandler[Any, CCT], group: int = DEFAULT_GROUP
         """
         # Unfortunately due to circular imports this has to be here
         # pylint: disable=import-outside-toplevel
-        from telegram.ext._conversationhandler import ConversationHandler
+        from telegram.ext._handlers.conversationhandler import ConversationHandler
 
         if not isinstance(handler, BaseHandler):
             raise TypeError(f"handler is not an instance of {BaseHandler.__name__}")
@@ -1650,7 +1650,7 @@ async def __update_persistence(self) -> None:
 
         # Unfortunately due to circular imports this has to be here
         # pylint: disable=import-outside-toplevel
-        from telegram.ext._conversationhandler import PendingState
+        from telegram.ext._handlers.conversationhandler import PendingState
 
         for name, (key, new_state) in itertools.chain.from_iterable(
             zip(itertools.repeat(name), states_dict.pop_accessed_write_items())

telegram/ext/_callbackqueryhandler.py → telegram/ext/_handlers/callbackqueryhandler.py

@@ -24,7 +24,7 @@
 from telegram import Update
 from telegram._utils.defaultvalue import DEFAULT_TRUE
 from telegram._utils.types import DVType
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT, HandlerCallback
 
 if TYPE_CHECKING:

telegram/ext/_chatjoinrequesthandler.py → telegram/ext/_handlers/chatjoinrequesthandler.py

@@ -23,7 +23,7 @@
 from telegram import Update
 from telegram._utils.defaultvalue import DEFAULT_TRUE
 from telegram._utils.types import RT, SCT, DVType
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT, HandlerCallback
 
 

telegram/ext/_chatmemberhandler.py → telegram/ext/_handlers/chatmemberhandler.py

@@ -22,7 +22,7 @@
 from telegram import Update
 from telegram._utils.defaultvalue import DEFAULT_TRUE
 from telegram._utils.types import DVType
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT, HandlerCallback
 
 RT = TypeVar("RT")

telegram/ext/_choseninlineresulthandler.py → telegram/ext/_handlers/choseninlineresulthandler.py

@@ -23,7 +23,7 @@
 from telegram import Update
 from telegram._utils.defaultvalue import DEFAULT_TRUE
 from telegram._utils.types import DVType
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT, HandlerCallback
 
 RT = TypeVar("RT")

telegram/ext/_commandhandler.py → telegram/ext/_handlers/commandhandler.py

@@ -24,7 +24,7 @@
 from telegram._utils.defaultvalue import DEFAULT_TRUE
 from telegram._utils.types import SCT, DVType
 from telegram.ext import filters as filters_module
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT, FilterDataDict, HandlerCallback
 
 if TYPE_CHECKING:

telegram/ext/_conversationhandler.py → telegram/ext/_handlers/conversationhandler.py

@@ -42,14 +42,14 @@
 from telegram._utils.types import DVType
 from telegram._utils.warnings import warn
 from telegram.ext._application import ApplicationHandlerStop
-from telegram.ext._basehandler import BaseHandler
-from telegram.ext._callbackqueryhandler import CallbackQueryHandler
-from telegram.ext._choseninlineresulthandler import ChosenInlineResultHandler
 from telegram.ext._extbot import ExtBot
-from telegram.ext._inlinequeryhandler import InlineQueryHandler
-from telegram.ext._stringcommandhandler import StringCommandHandler
-from telegram.ext._stringregexhandler import StringRegexHandler
-from telegram.ext._typehandler import TypeHandler
+from telegram.ext._handlers.basehandler import BaseHandler
+from telegram.ext._handlers.callbackqueryhandler import CallbackQueryHandler
+from telegram.ext._handlers.choseninlineresulthandler import ChosenInlineResultHandler
+from telegram.ext._handlers.inlinequeryhandler import InlineQueryHandler
+from telegram.ext._handlers.stringcommandhandler import StringCommandHandler
+from telegram.ext._handlers.stringregexhandler import StringRegexHandler
+from telegram.ext._handlers.typehandler import TypeHandler
 from telegram.ext._utils.trackingdict import TrackingDict
 from telegram.ext._utils.types import CCT, ConversationDict, ConversationKey
 

telegram/ext/_inlinequeryhandler.py → telegram/ext/_handlers/inlinequeryhandler.py

@@ -23,7 +23,7 @@
 from telegram import Update
 from telegram._utils.defaultvalue import DEFAULT_TRUE
 from telegram._utils.types import DVType
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT, HandlerCallback
 
 if TYPE_CHECKING:

telegram/ext/_messagehandler.py → telegram/ext/_handlers/messagehandler.py

@@ -23,7 +23,7 @@
 from telegram._utils.defaultvalue import DEFAULT_TRUE
 from telegram._utils.types import DVType
 from telegram.ext import filters as filters_module
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT, HandlerCallback
 
 if TYPE_CHECKING:

telegram/ext/_pollanswerhandler.py → telegram/ext/_handlers/pollanswerhandler.py

@@ -20,7 +20,7 @@
 
 
 from telegram import Update
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT
 
 

telegram/ext/_pollhandler.py → telegram/ext/_handlers/pollhandler.py

@@ -20,7 +20,7 @@
 
 
 from telegram import Update
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT
 
 

telegram/ext/_precheckoutqueryhandler.py → telegram/ext/_handlers/precheckoutqueryhandler.py

@@ -25,7 +25,7 @@
 from telegram import Update
 from telegram._utils.defaultvalue import DEFAULT_TRUE
 from telegram._utils.types import DVType
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT, HandlerCallback
 
 RT = TypeVar("RT")

telegram/ext/_prefixhandler.py → telegram/ext/_handlers/prefixhandler.py

@@ -24,7 +24,7 @@
 from telegram._utils.defaultvalue import DEFAULT_TRUE
 from telegram._utils.types import SCT, DVType
 from telegram.ext import filters as filters_module
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT, HandlerCallback
 
 if TYPE_CHECKING:

telegram/ext/_shippingqueryhandler.py → telegram/ext/_handlers/shippingqueryhandler.py

@@ -20,7 +20,7 @@
 
 
 from telegram import Update
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT
 
 

telegram/ext/_stringcommandhandler.py → telegram/ext/_handlers/stringcommandhandler.py

@@ -22,7 +22,7 @@
 
 from telegram._utils.defaultvalue import DEFAULT_TRUE
 from telegram._utils.types import DVType
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT, RT, HandlerCallback
 
 if TYPE_CHECKING:

telegram/ext/_stringregexhandler.py → telegram/ext/_handlers/stringregexhandler.py

@@ -23,7 +23,7 @@
 
 from telegram._utils.defaultvalue import DEFAULT_TRUE
 from telegram._utils.types import DVType
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT, HandlerCallback
 
 if TYPE_CHECKING:

telegram/ext/_typehandler.py → telegram/ext/_handlers/typehandler.py

@@ -22,7 +22,7 @@
 
 from telegram._utils.defaultvalue import DEFAULT_TRUE
 from telegram._utils.types import DVType
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext._handlers.basehandler import BaseHandler
 from telegram.ext._utils.types import CCT, HandlerCallback
 
 RT = TypeVar("RT")

tests/_files/test_inputmedia.py

@@ -607,7 +607,7 @@ async def test_send_media_group_photo(self, bot, chat_id, media_group):
         assert len(messages) == 3
         assert all(isinstance(mes, Message) for mes in messages)
         assert all(mes.media_group_id == messages[0].media_group_id for mes in messages)
-        assert all(mes.caption == f"photo {idx+1}" for idx, mes in enumerate(messages))
+        assert all(mes.caption == f"photo {idx + 1}" for idx, mes in enumerate(messages))
         assert all(
             mes.caption_entities == (MessageEntity(MessageEntity.BOLD, 0, 5),) for mes in messages
         )
@@ -742,7 +742,7 @@ async def test_send_media_group_all_args(self, bot, raw_bot, chat_id, media_grou
             assert len(messages) == 3
             assert all(isinstance(mes, Message) for mes in messages)
             assert all(mes.media_group_id == messages[0].media_group_id for mes in messages)
-            assert all(mes.caption == f"photo {idx+1}" for idx, mes in enumerate(messages))
+            assert all(mes.caption == f"photo {idx + 1}" for idx, mes in enumerate(messages))
             assert all(
                 mes.caption_entities == (MessageEntity(MessageEntity.BOLD, 0, 5),)
                 for mes in messages

tests/ext/test_basehandler.py

@@ -17,7 +17,7 @@
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
 
-from telegram.ext._basehandler import BaseHandler
+from telegram.ext import BaseHandler
 from tests.auxil.slots import mro_slots
 
 

tests/ext/test_conversationhandler.py

@@ -725,7 +725,7 @@ async def callback(_, __):
             assert recwarn[0].category is PTBUserWarning
             assert (
                 Path(recwarn[0].filename)
-                == PROJECT_ROOT_PATH / "telegram" / "ext" / "_conversationhandler.py"
+                == PROJECT_ROOT_PATH / "telegram" / "ext" / "_handlers" / "conversationhandler.py"
             ), "wrong stacklevel!"
             assert (
                 str(recwarn[0].message)
@@ -1105,7 +1105,11 @@ async def test_no_running_job_queue_warning(self, app, bot, user1, recwarn, jq):
                 assert warning.category is PTBUserWarning
                 assert (
                     Path(warning.filename)
-                    == PROJECT_ROOT_PATH / "telegram" / "ext" / "_conversationhandler.py"
+                    == PROJECT_ROOT_PATH
+                    / "telegram"
+                    / "ext"
+                    / "_handlers"
+                    / "conversationhandler.py"
                 ), "wrong stacklevel!"
             # now set app.job_queue back to it's original value
 

tests/test_bot.py

@@ -3173,8 +3173,8 @@ async def test_set_and_get_my_commands(self, bot):
         assert await bot.set_my_commands(commands)
 
         for i, bc in enumerate(await bot.get_my_commands()):
-            assert bc.command == f"cmd{i+1}"
-            assert bc.description == f"descr{i+1}"
+            assert bc.command == f"cmd{i + 1}"
+            assert bc.description == f"descr{i + 1}"
 
     async def test_get_set_delete_my_commands_with_scope(self, bot, super_group_id, chat_id):
         group_cmds = [BotCommand("group_cmd", "visible to this supergroup only")]