dataclass implementation by hexatester · Pull Request #2056 · python-telegram-bot/python-telegram-bot

hexatester · 2020-08-19T19:54:53Z

This only change class init & sub-classing class constants.
Might wanna install dacite to create an instance of data from dict without making a sweat.

I cant test this locally because the tests always timeout after a few tests on my pc.

https://docs.python.org/3/library/dataclasses.html#post-init-processing
https://stackoverflow.com/questions/52390576/how-can-i-make-a-python-dataclass-hashable

# Conflicts: # telegram/message.py

# Conflicts: # telegram/__main__.py # telegram/bot.py # telegram/callbackquery.py # telegram/chatmember.py # telegram/choseninlineresult.py # telegram/error.py # telegram/ext/callbackqueryhandler.py # telegram/ext/commandhandler.py # telegram/ext/conversationhandler.py # telegram/ext/dictpersistence.py # telegram/ext/filters.py # telegram/ext/inlinequeryhandler.py # telegram/ext/jobqueue.py # telegram/ext/messagequeue.py # telegram/ext/picklepersistence.py # telegram/ext/regexhandler.py # telegram/ext/stringcommandhandler.py # telegram/ext/stringregexhandler.py # telegram/ext/typehandler.py # telegram/files/animation.py # telegram/files/document.py # telegram/files/sticker.py # telegram/files/venue.py # telegram/files/video.py # telegram/files/videonote.py # telegram/files/voice.py # telegram/games/game.py # telegram/games/gamehighscore.py # telegram/inline/inlinekeyboardmarkup.py # telegram/inline/inlinequery.py # telegram/message.py # telegram/messageentity.py # telegram/passport/credentials.py # telegram/passport/encryptedpassportelement.py # telegram/passport/passportdata.py # telegram/passport/passportfile.py # telegram/payment/orderinfo.py # telegram/payment/precheckoutquery.py # telegram/payment/shippingoption.py # telegram/payment/shippingquery.py # telegram/payment/successfulpayment.py # telegram/poll.py # telegram/replykeyboardmarkup.py # telegram/update.py # telegram/user.py # telegram/userprofilephotos.py # telegram/utils/helpers.py # telegram/utils/webhookhandler.py

# Conflicts: # .github/workflows/test.yml # telegram/bot.py # telegram/dice.py # telegram/ext/jobqueue.py # telegram/files/animation.py # telegram/files/audio.py # telegram/files/document.py # telegram/files/photosize.py # telegram/files/sticker.py # telegram/files/video.py # telegram/files/videonote.py # telegram/files/voice.py # telegram/inline/inlinequeryresultgif.py # telegram/inline/inlinequeryresultmpeg4gif.py # telegram/message.py # telegram/passport/passportfile.py # telegram/utils/request.py

* Unify kwargs handling in Bot methods * Remove Request.get, make api_kwargs an explicit argument, move note to head of Bot class * Fix test_official * Update get_file methods

* First go on refactoring JobQueue * Temporarily enable tests for the v13 branch * Work on tests * Temporarily enable tests for the v13 branch * Increase coverage * Remove JobQueue.tick() # Was intended for interal use anyways # Fixes tests * Address review * Temporarily enable tests for the v13 branch * Address review * Dispatch errors * Fix handling of job_kwargs * Remove possibility to pass a Bot to JobQueue

* Refactor persistence of bots * User BP.set_bot in Dispatcher * Temporarily enable tests for the v13 branch * Add documentation

* Make most objects comparable * ID attrs for PollAnswer * fix test_game * fix test_userprofilephotos * update for API 4.7 * Warn on meaningless comparisons * Update for API 4.8 * Address review * Get started on docs, update Message._id_attrs * Change PollOption & InputLocation * Some more changes * Even more changes

# Conflicts: # .github/workflows/test.yml # telegram/bot.py # telegram/botcommand.py # telegram/chatpermissions.py # telegram/dice.py # telegram/ext/basepersistence.py # telegram/ext/filters.py # telegram/ext/jobqueue.py # telegram/files/animation.py # telegram/files/audio.py # telegram/files/document.py # telegram/files/photosize.py # telegram/files/sticker.py # telegram/files/video.py # telegram/files/videonote.py # telegram/files/voice.py # telegram/games/game.py # telegram/inline/inlinekeyboardbutton.py # telegram/inline/inlinequeryresultgif.py # telegram/inline/inlinequeryresultmpeg4gif.py # telegram/message.py # telegram/passport/passportfile.py # telegram/payment/invoice.py # telegram/poll.py # telegram/replykeyboardmarkup.py # telegram/utils/request.py # telegram/webhookinfo.py # tests/test_filters.py # tests/test_message.py

* Unify kwargs handling in Bot methods * Remove Request.get, make api_kwargs an explicit argument, move note to head of Bot class * Fix test_official * Update get_file methods

* First go on refactoring JobQueue * Temporarily enable tests for the v13 branch * Work on tests * Temporarily enable tests for the v13 branch * Increase coverage * Remove JobQueue.tick() # Was intended for interal use anyways # Fixes tests * Address review * Temporarily enable tests for the v13 branch * Address review * Dispatch errors * Fix handling of job_kwargs * Remove possibility to pass a Bot to JobQueue

* Refactor persistence of bots * User BP.set_bot in Dispatcher * Temporarily enable tests for the v13 branch * Add documentation

* Make most objects comparable * ID attrs for PollAnswer * fix test_game * fix test_userprofilephotos * update for API 4.7 * Warn on meaningless comparisons * Update for API 4.8 * Address review * Get started on docs, update Message._id_attrs * Change PollOption & InputLocation * Some more changes * Even more changes

* Refactor handling of `default_quote` * Make it a breaking change * Pickle a bots defaults * Temporarily enable tests for the v13 branch * Temporarily enable tests for the v13 branch * Refactor handling of kwargs in Bot methods (#1924) * Unify kwargs handling in Bot methods * Remove Request.get, make api_kwargs an explicit argument, move note to head of Bot class * Fix test_official * Update get_file methods * Refactor JobQueue (#1981) * First go on refactoring JobQueue * Temporarily enable tests for the v13 branch * Work on tests * Temporarily enable tests for the v13 branch * Increase coverage * Remove JobQueue.tick() # Was intended for interal use anyways # Fixes tests * Address review * Temporarily enable tests for the v13 branch * Address review * Dispatch errors * Fix handling of job_kwargs * Remove possibility to pass a Bot to JobQueue * Refactor persistence of Bot instances (#1994) * Refactor persistence of bots * User BP.set_bot in Dispatcher * Temporarily enable tests for the v13 branch * Add documentation * Add warning to Updater for passing both defaults and bot * Address review * Fix test

* Refactor handling of message vs update filters * address review

# Conflicts: # .github/workflows/test.yml # telegram/bot.py # telegram/botcommand.py # telegram/chat.py # telegram/chatpermissions.py # telegram/dice.py # telegram/ext/basepersistence.py # telegram/ext/dispatcher.py # telegram/ext/filters.py # telegram/ext/jobqueue.py # telegram/ext/updater.py # telegram/files/animation.py # telegram/files/audio.py # telegram/files/document.py # telegram/files/photosize.py # telegram/files/sticker.py # telegram/files/venue.py # telegram/files/video.py # telegram/files/videonote.py # telegram/files/voice.py # telegram/games/game.py # telegram/inline/inlinekeyboardbutton.py # telegram/inline/inlinekeyboardmarkup.py # telegram/message.py # telegram/passport/passportfile.py # telegram/payment/invoice.py # telegram/poll.py # telegram/replykeyboardmarkup.py # telegram/update.py # telegram/user.py # telegram/userprofilephotos.py # telegram/utils/request.py # telegram/utils/webhookhandler.py # telegram/webhookinfo.py # tests/test_message.py # tests/test_updater.py

Bibo-Joshi · 2020-08-19T20:14:27Z

Hi! Thanks for the PR.
I ran the tests on my machine and most of them fail because tg.Base.de_json() doesn't work with your changes. I rebased your PR to master because that way the automated tests should run, when you add new commits. you can change it back by hitting "Edit" on the top right corner.
If you want to get this concept PR to minimally working, please go ahead. However, I feel obliged to warn you not fine tune every last bit just now, as we'd have to discuss the idea in the maintainers group before preceeding ;)

hexatester · 2020-08-19T20:36:19Z

I see, but hash still working from Base as intended right?

I might change the Base class and give it condition like isdataclass(cls) then handle it different way from the others.

But still i didn't find any way to add **kwargs inside init of dataclass.

I'll get this PR minimally working asap, can you just send me failed test logs?

Bibo-Joshi · 2020-08-20T06:29:20Z

uhm, currently the tests don't come further than test_animation. I think you should be able to see the log by clickling on "Details".

I also became aware that dataclasses are new in Py3.7 and as 3.6 reaches EOL only at the end of 2021 I don't think that we'll be willing to drop 3.6 before autumn 2021 …

hexatester · 2020-08-20T06:42:27Z

uhm, currently the tests don't come further than test_animation. I think you should be able to see the log by clickling on "Details".

I also became aware that dataclasses are new in Py3.7 and as 3.6 reaches EOL only at the end of 2021 I don't think that we'll be willing to drop 3.6 before autumn 2021 …

Okay.
Its fine about adding dataclasses to ptb next year, im just testing to see is it possible or not.

hexatester · 2020-08-21T01:41:56Z

I'll close this PR for now. At least we know it's definitely possible to refactor ptb using dataclass.

Thanks, also this really help my project.

Poolitzer and others added 30 commits May 12, 2020 08:37

adding mypy to the repo

79a76f6

first take on only testing changed files

22a45a0

allowing test branch

f61fecf

improving start condition of workflow

1e94485

Add mypy to pre-commit and make

6a51275

Try computing typing coverage in CI

a89828a

Save coverage report as artifact

656c2bd

Drop py3.5, use mypy options instead of diff-cover

e5f5867

use spaces over tabs in makefile

c856bbb

Remove deprecated getargspec

783e5d4

Refactor de_json

e13bb33

Annotate all the things! (Except tg.ext)

9160674

Merge branch 'master' into type_hinting_master

d84444b

# Conflicts: # telegram/message.py

Annotate InputMedia, Custom Aliases, improve file typing

7f4410d

Move de_list to TelegramObject

f87fa10

Persistence & Handlers

4b9c010

Filters

1a22799

JobQueue & Job

9a545be

Dispatcher

be15033

MessageQueue

db78e06

Some fixes

b74d0db

utils.typing -> utils.types + 2 newlines

84e49a6

Temporarily enable tests for the v13 branch

773430d

Refactor handling of kwargs in Bot methods (#1924)

6fd3d2f

* Unify kwargs handling in Bot methods * Remove Request.get, make api_kwargs an explicit argument, move note to head of Bot class * Fix test_official * Update get_file methods

Refactor persistence of Bot instances (#1994)

3418ba2

* Refactor persistence of bots * User BP.set_bot in Dispatcher * Temporarily enable tests for the v13 branch * Add documentation

Bibo-Joshi and others added 10 commits August 16, 2020 19:41

Temporarily enable tests for the v13 branch

dee672d

Refactor handling of kwargs in Bot methods (#1924)

02b058c

* Unify kwargs handling in Bot methods * Remove Request.get, make api_kwargs an explicit argument, move note to head of Bot class * Fix test_official * Update get_file methods

Refactor persistence of Bot instances (#1994)

c3a426a

* Refactor persistence of bots * User BP.set_bot in Dispatcher * Temporarily enable tests for the v13 branch * Add documentation

Refactor Handling of Message VS Update Filters (#2032)

87a426e

* Refactor handling of message vs update filters * address review

Make context-based callbacks the default setting (#2050)

ad30a8f

implement dataclass

e5563e1

Bibo-Joshi changed the base branch from type_hinting_master to master August 19, 2020 20:09

hexatester added 4 commits August 20, 2020 11:14

implement dataclass of inputmedia

fabcdeb

add get_dataclass_fields to utils.helpers

3735059

implement dataclass of files.Audio

3726874

add de_safe_dataclass to TelegramObject for safely casting dataclass

ade00bd

fix de_safe_dataclass by respecting field.default

8f4c15f

hexatester added 2 commits August 20, 2020 14:53

Some fixes __init__ and __post_init__ arg

b92255e

Improve post init using InitVar and default_factory

5b9f29b

hexatester closed this Aug 21, 2020

hexatester reopened this Aug 21, 2020

hexatester closed this Aug 21, 2020

github-actions bot locked and limited conversation to collaborators Aug 22, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dataclass implementation#2056

dataclass implementation#2056
hexatester wants to merge 47 commits intopython-telegram-bot:masterfrom
hexatester:dataclasses-concept

hexatester commented Aug 19, 2020

Uh oh!

Bibo-Joshi commented Aug 19, 2020

Uh oh!

hexatester commented Aug 19, 2020

Uh oh!

Bibo-Joshi commented Aug 20, 2020

Uh oh!

hexatester commented Aug 20, 2020

Uh oh!

hexatester commented Aug 21, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

hexatester commented Aug 19, 2020

Uh oh!

Bibo-Joshi commented Aug 19, 2020

Uh oh!

hexatester commented Aug 19, 2020

Uh oh!

Bibo-Joshi commented Aug 20, 2020

Uh oh!

hexatester commented Aug 20, 2020

Uh oh!

hexatester commented Aug 21, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants