99 Commits

Author SHA1 Message Date
Varun J
c26473d0eb
Fix views not being persistent if modifying custom_id after __init__ 2022-07-31 04:53:25 -04:00
Rapptz
efdda635fb Fix View.from_message not respecting ActionRow row order 2022-07-23 15:24:26 -04:00
mniip
1be36c9c3e
Change View, Modal, and AudioPlayer to use logger instead of stderr 2022-06-22 02:10:02 -04:00
Lilly Rose Berner
7267d18d9e
Improve component typing 2022-05-16 15:30:03 -04:00
Server Bot
902aa245a4
Swap order of arguments in Modal.on_error 2022-05-06 20:16:42 -04:00
NextChai
e7ce8b6b77
Add container operations documentation to TextInput 2022-04-30 03:58:11 -04:00
Lilly Rose Berner
7ee15e1d68
Use typing.Literal for channel and component type annotation 2022-04-29 06:07:22 -04:00
Rapptz
a0dfdb9b1d Fix multiple view instances not dispatching in app commands responses
Due to a quirk in InteractionResponse.send_message not returning a
message, all messages sent with an associated View would end up having
no message_id set. When multiple instances of a View are responded to
in a slash command context, this meant that the newest one would
override the storage of the older one. Ultimately leading to the first
view instance causing interaction failures.

Since fetching the original message is an unacceptable solution to the
problem due to incurred requests, the next best thing is to store an
intermediate interaction_id as a stop gap to differentiate between
the multiple instances. This change however, came with its own set of
complications.

Due to the interaction_id being an intermediate stop gap, the
underlying storage of the view store had to be changed to accommodate
the different way of accessing the data. Mainly, the interaction_id
key had to be quick to swap and remove to another key. This solution
attempts to change the interaction_id interim key with
a full fledged message_id key when it receives one if it's possible.

Note that the only way to obtain the interaction_id back from the
component interaction is to retrieve it from the MessageInteraction
data structure. This is because using the interaction_id of the button
press would be a different interaction ID than the one set as an
interim key. As a consequence, this stop gap only works for application
command based interactions. I am not aware of this bug manifesting in
component based interactions.

This patch also fixes a bug with ViewStore.remove_view not working due
to a bug being suppressed by a type: ignore comment. It also removes
the older __verify_integrity helper method since clean-up is already
done through View.stop() or View timeout.

Hopefully in the near future, the `/callback` endpoint will return
actual message data and this stop gap fix will no longer be necessary.
2022-04-28 12:24:57 -04:00
Rapptz
e198a0e7e6 Avoid re-creating View children on edit
The older code attempted to be clever and sync component additions and
removals with what the message edit is doing. In some cases, this led
to the re-creation of those components causing lost attributes to be
dropped such as `_rendered_row` which would mess up handling of view
weights.

Instead of recreating the children list every time and keeping track
of additions and removals, this change just updates the old state with
the new state while ignoring any new or removed additions. This should
work fine in theory due to additions or removals already being present
before editing the View instance in the first place.

Closes #7231 #7511
2022-04-27 01:24:10 -04:00
Willy
5456c0cae9
Add TextInput to Item docstring 2022-04-17 05:28:29 -04:00
Snaptraks
0fa9bfc925
Correct order of arguments in View.on_error 2022-04-12 21:15:16 -04:00
Omkaar
1e914e8945
Document Modal parameter limits 2022-04-08 23:58:18 -04:00
Rapptz
c68ea67213 Properly handle inheritance overriding in View subclasses 2022-04-05 09:41:48 -04:00
Rapptz
1458251736 Change View.children to be a property
This allows users to call remove_item in a loop. Likewise, it prevents
the footgun of doing children.append(...) which does not uphold the
invariants with the weight system.
2022-04-03 20:13:42 -04:00
Kellen
0f18d93e47
Remove unused imports 2022-04-02 04:58:39 -04:00
Rapptz
b4fbb08818 Allow runtime modification of timeout expiry at runtime
This is done through setting View.timeout while it's running
2022-03-31 01:54:13 -04:00
Rapptz
e515378076 Remove annotation on row property in subclasses 2022-03-29 23:04:34 -04:00
Rapptz
3215cb65e2 Raise if custom_id is not a str 2022-03-29 23:04:34 -04:00
Rapptz
968a1f366f Change View callback order to (self, interaction, item)
This is more consistent with the rest of the library which always has
the interaction as the first parameter. This has been done before in
the command extension as well, the first parameter is always either
self or the context.
2022-03-24 23:00:50 -04:00
UltimateSppy765
6d494585f5
Correct documentation for TextInput.custom_id 2022-03-23 18:38:22 -04:00
chromacoat dreamkey
515d17405a
Fix typos in some View methods' docstrings 2022-03-20 12:59:23 -04:00
Pat
94f4da9248
Change View child mutators to be fluent-style methods 2022-03-19 04:48:50 -04:00
Rapptz
26457b6d50 Remove automatic defer behaviour from View and Modal
This doesn't make as much sense anymore now that
InteractionResponse.edit_message exists.
2022-03-15 10:30:19 -04:00
Narmy
3fd8f76c61
Add missing underscore in Modal refresh method 2022-03-14 21:00:39 -04:00
Rapptz
934ab4151a Mark state refresh methods as private with an underscore
People kept wondering what it is or what it does.
2022-03-14 07:50:25 -04:00
Stocker
5aa696ccfa
Fix typing issues and improve typing completeness across the library
Co-authored-by: Danny <Rapptz@users.noreply.github.com>
Co-authored-by: Josh <josh.ja.butt@gmail.com>
2022-03-13 23:52:10 -04:00
Rapptz
c0890bfbc1 Remove unused View._expires_at private function 2022-03-13 11:50:09 -04:00
Han Seung Min - 한승민
93af158b0c
Refactor loop code to allow usage of asyncio.run 2022-03-13 04:54:14 -04:00
Neon Jonn
adb69e7157
Fix some spelling mistakes 2022-03-10 20:45:16 -05:00
Stella
2b600241a4
Fix Modal.stop sometimes not removing from the store 2022-03-07 17:39:00 -05:00
Sebastian Law
87415ab5a7
Fix modal docs code block warning 2022-03-06 19:16:23 -05:00
Pawnyy
6788ec2533
Add docstring example for ui.Modal 2022-03-06 18:29:38 -05:00
Rapptz
4c8b1f9abd Remove unused imports 2022-03-05 21:40:42 -05:00
Rapptz
37d55c8ec4 Add TextInput.__str__ special method
Closes #7504
2022-03-05 21:05:46 -05:00
Josh
147948af9b
Use typing.Self throughout library 2022-03-01 07:53:24 -05:00
Nihaal Sangha
90cabd1673
Fix various typos 2022-02-27 21:19:19 -05:00
Rapptz
d01e73fca5 Document more uses of type ignore 2022-02-21 23:08:26 -05:00
Josh
d409ddd227
Alter return-type of button/select decorators 2022-02-21 21:54:44 -05:00
Josh
6dbd40a8ef
Remove use of typing.Self from TextInput 2022-02-21 09:13:18 -05:00
Rapptz
e56f64218a Rename default_value to default for TextInput 2022-02-20 11:04:50 -05:00
Rapptz
88b520b5ab Reformat code using black
Segments where readability was hampered were fixed by appropriate
format skipping directives. New code should hopefully be black
compatible. The moment they remove the -S option is probably the moment
I stop using black though.
2022-02-20 08:04:58 -05:00
Josh
19c6687b55
Add support for Modal Interactions 2022-02-20 04:57:44 -05:00
Rapptz
c22f058fa0 Fix views not being removed upon timeout 2022-02-17 07:35:12 -05:00
Rapptz
3382d2e9e8 Update documentation on select limits 2021-08-25 09:21:49 -04:00
Rapptz
0cc67e58ed Fallback to None message_id searches in View dispatch
Not all persistent views have an associated message_id attached to
them.

Fix #7319
2021-08-01 03:30:45 -04:00
Rapptz
b87d306a70 Remove unused variable in view 2021-08-01 02:40:11 -04:00
Rapptz
e795d341e7 Change View dispatch mechanism to be keyed by message_id as well
If different persistent view instances are used within different
message_ids their callbacks will get called without differentiating
between them, leading to potential issues such as 404 errors. This
change makes it so N views with custom IDs bound to N message_ids
will no longer conflict with one another.
2021-07-31 23:08:05 -04:00
Lucas Hardt
ca9b371982
Add support for discord.ui.Select.disabled 2021-07-28 19:58:39 -04:00
scrazzz
a0e5e062c9
Add versionadded to ui.View and ui.Item 2021-07-21 02:47:52 -04:00
Kaylynn Morgan
feed302269
Fix documentation note for interaction_check 2021-07-21 02:46:52 -04:00