René's URL Explorer Experiment


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

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@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-profiling0
react-import-mapreact,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-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:338b1e79-33c5-e7ab-5191-16b430142c9e
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id911E:88BC0:833ECE:A44031:6B0255E5
html-safe-noncedf0e5f73da17205d29a03858afcc2ddecd4468be3743928e9667440c29599f2e
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5MTFFOjg4QkMwOjgzM0VDRTpBNDQwMzE6NkIwMjU1RTUiLCJ2aXNpdG9yX2lkIjoiMzgwNDE4NTc1Mjg2MzEzNTIwNSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmac317f939cd556fa9c4ba6871b6654fff502031dfa1ce56028c47da87e75312395
hovercard-subject-tagissue:916625552
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python-telegram-bot/python-telegram-bot/2556/issue_layout
twitter:imagehttps://opengraph.githubassets.com/aeaf6a58d134adc5c9c16d8ec177b03fef5689ea434558b7fd14a2e7fef8d0eb/python-telegram-bot/python-telegram-bot/issues/2556
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/aeaf6a58d134adc5c9c16d8ec177b03fef5689ea434558b7fd14a2e7fef8d0eb/python-telegram-bot/python-telegram-bot/issues/2556
og:image:altMotivation 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:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameBibo-Joshi
hostnamegithub.com
expected-hostnamegithub.com
None87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456
turbo-cache-controlno-preview
go-importgithub.com/python-telegram-bot/python-telegram-bot git https://github.com/python-telegram-bot/python-telegram-bot.git
octolytics-dimension-user_id16178365
octolytics-dimension-user_loginpython-telegram-bot
octolytics-dimension-repository_id38696925
octolytics-dimension-repository_nwopython-telegram-bot/python-telegram-bot
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id38696925
octolytics-dimension-repository_network_root_nwopython-telegram-bot/python-telegram-bot
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release423dbb54c5e7bfecc838eb387c1435eb3d0e760d
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/python-telegram-bot/python-telegram-bot/issues/2556#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython-telegram-bot%2Fpython-telegram-bot%2Fissues%2F2556
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython-telegram-bot%2Fpython-telegram-bot%2Fissues%2F2556
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=python-telegram-bot%2Fpython-telegram-bot
Reloadhttps://github.com/python-telegram-bot/python-telegram-bot/issues/2556
Reloadhttps://github.com/python-telegram-bot/python-telegram-bot/issues/2556
Reloadhttps://github.com/python-telegram-bot/python-telegram-bot/issues/2556
python-telegram-bothttps://github.com/python-telegram-bot
python-telegram-bothttps://github.com/python-telegram-bot/python-telegram-bot
Codehttps://github.com/python-telegram-bot/python-telegram-bot
Issues23 (23)https://github.com/python-telegram-bot/python-telegram-bot/issues
Pull requests19 (19)https://github.com/python-telegram-bot/python-telegram-bot/pulls
Discussionshttps://github.com/python-telegram-bot/python-telegram-bot/discussions
Actionshttps://github.com/python-telegram-bot/python-telegram-bot/actions
Projectshttps://github.com/python-telegram-bot/python-telegram-bot/projects
Wikihttps://github.com/python-telegram-bot/python-telegram-bot/wiki
Security and qualityhttps://github.com/python-telegram-bot/python-telegram-bot/security
Insightshttps://github.com/python-telegram-bot/python-telegram-bot/insights
https://github.com/python-telegram-bot/python-telegram-bot
New issuehttps://github.com/login?return_to=https://github.com/python-telegram-bot/python-telegram-bot/issues/2556
New issuehttps://github.com/login?return_to=https://github.com/python-telegram-bot/python-telegram-bot/issues/2556
[DISCUSSION] Handling of initshttps://github.com/python-telegram-bot/python-telegram-bot/issues/2556#top
🛠 breakingchange type: breakinghttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22%F0%9F%9B%A0%20breaking%22
🛠 refactorchange type: refactorhttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22%F0%9F%9B%A0%20refactor%22
v20.0a0https://github.com/python-telegram-bot/python-telegram-bot/milestone/22
https://github.com/Bibo-Joshi
Bibo-Joshihttps://github.com/Bibo-Joshi
on Jun 9, 2021https://github.com/python-telegram-bot/python-telegram-bot/issues/2556#issue-916625552
#2524https://github.com/python-telegram-bot/python-telegram-bot/issues/2524
#2524https://github.com/python-telegram-bot/python-telegram-bot/issues/2524
https://t.me/c/1494805131/16075https://t.me/c/1494805131/16075
Bibo-Joshihttps://github.com/Bibo-Joshi
🛠 refactorchange type: refactorhttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22%F0%9F%9B%A0%20refactor%22
🛠 breakingchange type: breakinghttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22%F0%9F%9B%A0%20breaking%22
on Jun 9, 2021https://github.com/python-telegram-bot/python-telegram-bot/issues/2556#event-4867389170
Bibo-Joshihttps://github.com/Bibo-Joshi
v14https://github.com/python-telegram-bot/python-telegram-bot/milestone/22
on Jun 9, 2021https://github.com/python-telegram-bot/python-telegram-bot/issues/2556#event-4867389180
https://github.com/Bibo-Joshi
Bibo-Joshihttps://github.com/Bibo-Joshi
on Jul 5, 2021https://github.com/python-telegram-bot/python-telegram-bot/issues/2556#issuecomment-874249287
herehttps://t.me/c/1494805131/16109
Bibo-Joshihttps://github.com/Bibo-Joshi
completedhttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Oct 9, 2021https://github.com/python-telegram-bot/python-telegram-bot/issues/2556#event-5438033878
github-actionshttps://github.com/apps/github-actions
on Oct 10, 2021https://github.com/python-telegram-bot/python-telegram-bot/issues/2556#event-5439659743
Sign up for freehttps://github.com/signup?return_to=https://github.com/python-telegram-bot/python-telegram-bot/issues/2556
Sign in to commenthttps://github.com/login?return_to=https://github.com/python-telegram-bot/python-telegram-bot/issues/2556
🛠 breakingchange type: breakinghttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22%F0%9F%9B%A0%20breaking%22
🛠 refactorchange type: refactorhttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22%F0%9F%9B%A0%20refactor%22
v20.0a0https://github.com/python-telegram-bot/python-telegram-bot/milestone/22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.