Title: [DISCUSSION] Handling of inits · Issue #2556 · python-telegram-bot/python-telegram-bot · GitHub
Open Graph Title: [DISCUSSION] Handling of inits · Issue #2556 · python-telegram-bot/python-telegram-bot
X Title: [DISCUSSION] Handling of inits · Issue #2556 · python-telegram-bot/python-telegram-bot
Description: Motivation BasePersistence and Updater currently accept a lot of parameters, which can become somewhat cluttered. For BP, this could get worse after #2524. For Updater, we mostly allow all those arguments as convenience shortcuts so that...
Open Graph Description: Motivation BasePersistence and Updater currently accept a lot of parameters, which can become somewhat cluttered. For BP, this could get worse after #2524. For Updater, we mostly allow all those ar...
X Description: Motivation BasePersistence and Updater currently accept a lot of parameters, which can become somewhat cluttered. For BP, this could get worse after #2524. For Updater, we mostly allow all those ar...
Opengraph URL: https://github.com/python-telegram-bot/python-telegram-bot/issues/2556
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[DISCUSSION] Handling of inits","articleBody":"# Motivation\r\n\r\n`BasePersistence` and `Updater` currently accept a lot of parameters, which can become somewhat cluttered. For `BP`, this could get worse after #2524.\r\n\r\nFor `Updater`, we mostly allow all those arguments as convenience shortcuts so that users don't have to pass that stuff to `Dispatcher` and `Bot` on their own. However, I have the impression that it also leads to users not understanding the difference between the three classes `Updater`, `Dispatcher` and `Bot`. Ofc, to just use them, you don't have to understand them in detail, but it also quickly leads to questions like \"how do I send a message without getting an update\"? because people don't know/remember that you can instantiate a `Bot` without an `Updater`.\r\n\r\nI'd like to think about refactoring how we handle those.\r\n\r\n# `BasePersistence`\r\n\r\nIn this case it's probably rather easy: Instead of passing `store_bot_data`, `store_user_data` etc, we can just pass a tuple or - to be more user friendly - a namedtuple:\r\n\r\n```\r\nclass PersistenceInput(typing.NamedTuple):\r\n bot_data: bool = True\r\n chat_data: bool = True\r\n ...\r\n```\r\n\r\nThis can even be reused for new parameters that #2524 proposes and *could* be done non-breaking by allowing ways as mutually exclusive variants in a deprecation phase.\r\n\r\n# `Updater`, `Dispatcher`, `Bot`\r\n\r\nUltimately, I'd like to have a pattern that is convenient for simple use cases but still separaters the three classes. \r\n\r\n## First idea\r\n\r\nPretty simple & straight forward: instead of passing all the args one by one to `Updater`, pass `bot_kwargs` & `dispatcher_kwargs` or namedtuples like above.\r\n\r\n➕ Could be done non-breaking.\r\n➖ even if you only want to pass the token, you'd have to pass `bot_params=BotParams(token=token)` or so\r\n\r\n## Second idea\r\n\r\n1. Make all of `Updater`, `Dispatcher` and `Bot` only accept what they actually need. So no changes for `Dispatcher` and `Bot`, bot `Updater` would change to `def __init__(self, dispatcher):`\r\n2. Make `update_queue` optional for `Dispatcher` and have it be build on init as `self.update_queue = update_queue or Queue()`\r\n3. Make `job_queue` such that by default a new `JobQueue` will be created, i.e. it will be opt-out instead of opt-in. For people who don't want to use threading & the `JobQueue`, this shouldn't be too bad, b/c the JQ only starts when we call `Dispatcher.start`. If they still want it to be `None`, they can pass `None`.\r\n4. Add convenience setup-methods for the \"minimal effort\" cases. These would basically initialize everything as `Updater(TOKEN)` currently does:\r\n * `Dispatcher.build_from_bot(bot)` builds a dispatcher with the default values\r\n * `Dispatcher.build_from_token(TOKEN)` builds a bot with the default values and then calls `DP.build_from_bot`\r\n * `Updater.build_from_token/bot` just calls `Dispatcher.build_from_token/bot`.\r\n\r\nThis would convert\r\n```python\r\nUpdater(token, defaults=defaults, persistence=persistence)\r\n```\r\ninto\r\n```python\r\nbot = Bot(token, defaults=defaults)\r\ndispatcher = Dispatcher(bot=bot, persistence=persistence)\r\nupdater = Updater(dispatcher)\r\n```\r\nAdmittedly, this is a bit longer, but it also makes it more clear, which parameter is relevant for which class\r\n\r\n## Builder pattern\r\n\r\nNoam suggested to use builder pattern like e.g.\r\n```python\r\nUpdaterBuilder().build() # all defaults\r\nUpdaterBuilder().jq(custom_jq).dp(custom_dp).build() # use custom jq and do. Use defaults for all other.\r\n```\r\n> Behind the scenes it can call Updater.__init__() with all the values the builder chose to use.\r\n>\r\n>We can add a kwarg Boolean to __init__ which will signify it is called by the builder.\r\n>This Boolean can be used to issue a deprecation warning if builder is not used and also to go into a simpler flow of the code which will just use all the arguments received and won't try to calculate anything.\r\n\r\nSee https://t.me/c/1494805131/16075.\r\n\r\ntbh, my first impression is that this mostly shifts the clutter from the `__init__` to a number of builder methods. But at the time of writing noam didn't have a chance to reply to my comment, so take this note wtih a grain of salt 😉 \r\n\r\n**edit:** This could in fact be combined with the second approach.\r\n\r\n---\r\n\r\nBTW, this will also be a good chance to improve type hints a bit. E.g. the type of the bot instance could go into `Updaters`/`Dispatchers`/`CallbackContexts` generics, so that in the callback you don't have to `typing.cast(ExtBot, bot)`.\r\n ","author":{"url":"https://github.com/Bibo-Joshi","@type":"Person","name":"Bibo-Joshi"},"datePublished":"2021-06-09T19:56:16Z","url":"https://github.com/python-telegram-bot/python-telegram-bot/issues/2556"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:338b1e79-33c5-e7ab-5191-16b430142c9e |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 911E:88BC0:833ECE:A44031:6B0255E5 |
| html-safe-nonce | df0e5f73da17205d29a03858afcc2ddecd4468be3743928e9667440c29599f2e |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5MTFFOjg4QkMwOjgzM0VDRTpBNDQwMzE6NkIwMjU1RTUiLCJ2aXNpdG9yX2lkIjoiMzgwNDE4NTc1Mjg2MzEzNTIwNSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 317f939cd556fa9c4ba6871b6654fff502031dfa1ce56028c47da87e75312395 |
| hovercard-subject-tag | issue:916625552 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python-telegram-bot/python-telegram-bot/2556/issue_layout |
| twitter:image | https://opengraph.githubassets.com/aeaf6a58d134adc5c9c16d8ec177b03fef5689ea434558b7fd14a2e7fef8d0eb/python-telegram-bot/python-telegram-bot/issues/2556 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/aeaf6a58d134adc5c9c16d8ec177b03fef5689ea434558b7fd14a2e7fef8d0eb/python-telegram-bot/python-telegram-bot/issues/2556 |
| og:image:alt | Motivation BasePersistence and Updater currently accept a lot of parameters, which can become somewhat cluttered. For BP, this could get worse after #2524. For Updater, we mostly allow all those ar... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | Bibo-Joshi |
| hostname | github.com |
| expected-hostname | github.com |
| None | 87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456 |
| turbo-cache-control | no-preview |
| go-import | github.com/python-telegram-bot/python-telegram-bot git https://github.com/python-telegram-bot/python-telegram-bot.git |
| octolytics-dimension-user_id | 16178365 |
| octolytics-dimension-user_login | python-telegram-bot |
| octolytics-dimension-repository_id | 38696925 |
| octolytics-dimension-repository_nwo | python-telegram-bot/python-telegram-bot |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 38696925 |
| octolytics-dimension-repository_network_root_nwo | python-telegram-bot/python-telegram-bot |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 423dbb54c5e7bfecc838eb387c1435eb3d0e760d |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width