python-telegram-bot/docs/source/telegram.ext.rst

telegram.ext package
====================

.. toctree::

    telegram.ext.updater
    telegram.ext.dispatcher
    telegram.ext.filters
    telegram.ext.job
    telegram.ext.jobqueue
    telegram.ext.messagequeue
    telegram.ext.delayqueue
    telegram.ext.callbackcontext

Handlers
--------

.. toctree::

    telegram.ext.handler
    telegram.ext.callbackqueryhandler
    telegram.ext.choseninlineresulthandler
    telegram.ext.conversationhandler
    telegram.ext.commandhandler
    telegram.ext.inlinequeryhandler
    telegram.ext.messagehandler
    telegram.ext.precheckoutqueryhandler
    telegram.ext.prefixhandler
    telegram.ext.regexhandler
    telegram.ext.shippingqueryhandler
    telegram.ext.stringcommandhandler
    telegram.ext.stringregexhandler
    telegram.ext.typehandler
documentation 2016-04-18 18:13:54 +02:00			`telegram.ext package`
			`====================`

			`.. toctree::`

			`telegram.ext.updater`
			`telegram.ext.dispatcher`
Docs update (#728) Amazing new documentation. 2017-07-23 22:33:08 +02:00			`telegram.ext.filters`
Add Job Class to docs (#845) * fix job class missing from docs * fix typo 2017-09-25 20:57:53 +02:00			`telegram.ext.job`
documentation 2016-04-18 18:13:54 +02:00			`telegram.ext.jobqueue`
Docs update (#728) Amazing new documentation. 2017-07-23 22:33:08 +02:00			`telegram.ext.messagequeue`
			`telegram.ext.delayqueue`
Context based callbacks (#1100) See https://github.com/python-telegram-bot/python-telegram-bot/wiki/Transition-guide-to-Version-11.0 under Context based callbacks and Filters in handlers for a good guide on the changes in this commit. * Change handlers so context is supported * Attempt to make parameter "guessing" work on py < 3.5 * Document use_context in all handlers * Add Context to docs * Minor fixes to context handling * Add tests for context stuff * Allow the signature check to work on py<3.5 with methods * Fix order of operations * Address most issues raised in CR * Make CommandHandler no longer support filter lists * Fix indent (pycharm can be an arse sometimes) * Improve readability in conversationhandler * Make context have Match instead of groups & groupdict * Remove filter list support from messagehandler too * Small fix to StringCommandHandler * More small fixes to handlers * Amend CHANGES * Fix tests and fix bugs raised by tests * Don't allow users to ignore errors without messing with the warning filters themselves * Ignore our own deprecation warnings when testing * Skipping deprecationwarning test on py2 * Forgot some changes * Handler: Improved documentation and text of deprecation warnings * HandlerContext: Keep only dispatcher and use properties; improved doc * Complete fixing the documentation. - Fixes per Eldinnie's comments. - Fixes per warnings when running sphinx. * Some small doc fixes (interlinks and optionals) * Change add_error_handler to use HandlerContext too * More context based changes Context Based Handlers -> Context Based Callbacks No longer use_context args on every single Handler Instead set dispatcher/updater .use_context=True to use Works with - Handler callbacks - Error handler callbacks - Job callbacks Change examples to context based callbacks so new users are not confused Rename and move the context object from Handlers.HandlerContext to CallbackContext, since it doesn't only apply to handlers anymore. Fix tests by adding a new fixture `cpd` which is a dispatcher with use_context=True * Forgot about conversationhandler * Forgot jobqueue * Add tests for callbackcontext & for context based callback job * Fix as per review :) 2018-05-21 15:00:47 +02:00			`telegram.ext.callbackcontext`
Docs update (#728) Amazing new documentation. 2017-07-23 22:33:08 +02:00
			`Handlers`
			`--------`

			`.. toctree::`

documentation 2016-04-18 18:13:54 +02:00			`telegram.ext.handler`
Sphinx restructuring: Now builds PDF and better HTML docs (#449) * update sphinx source files to properly build latexpdf and improve html build * fix docstrings and sphinx sources to get rid of warnings * add telegram.contrib.rst 2016-11-01 06:53:51 +01:00			`telegram.ext.callbackqueryhandler`
documentation 2016-04-18 18:13:54 +02:00			`telegram.ext.choseninlineresulthandler`
ConversationHandler (#331) * initial commit for conversationhandler and example * implement simple Promise for run_async/conversationhandler * refactor Promise._done to done * add handling for timed out Promises * correctly handle promises with None results * fix handling tuple states * update comments on example * Added a first test on the ConversationHandler. * Fixed a small typo. * Yapf'd. * add sphinx doc for conversation handler * fix title for callbackqueryhandler sphinx docs 2016-07-15 01:30:54 +02:00			`telegram.ext.conversationhandler`
documentation 2016-04-18 18:13:54 +02:00			`telegram.ext.commandhandler`
			`telegram.ext.inlinequeryhandler`
			`telegram.ext.messagehandler`
Docs update (#728) Amazing new documentation. 2017-07-23 22:33:08 +02:00			`telegram.ext.precheckoutqueryhandler`
CommandHandler overhaul and PrefixHandler added (#1114) * Commandhandler reworked * Make CommandHandler strict Only register valid botcommands, else raise ValueError * Add PrefixHandler * declare encoding on test_commandhandler * Fix some tests dependend on CommandHandler * CR changes * small docfix. * Test all possibilities for PrefixHandler 2018-05-22 21:44:20 +02:00			`telegram.ext.prefixhandler`
documentation 2016-04-18 18:13:54 +02:00			`telegram.ext.regexhandler`
Docs update (#728) Amazing new documentation. 2017-07-23 22:33:08 +02:00			`telegram.ext.shippingqueryhandler`
documentation 2016-04-18 18:13:54 +02:00			`telegram.ext.stringcommandhandler`
			`telegram.ext.stringregexhandler`
			`telegram.ext.typehandler`