mirror of
https://github.com/Rapptz/discord.py.git
synced 2026-09-21 03:27:42 +00:00
Fixed item state management in the UI View
* Fix ActionRow add_item type validation * Fix View item state tracking * Fix View add and remove item state * Add UI view item state tests
This commit is contained in:
@@ -260,15 +260,15 @@ class ActionRow(Item[V]):
|
|||||||
or (40) for the entire view.
|
or (40) for the entire view.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
if not isinstance(item, Item):
|
||||||
|
raise TypeError(f'expected Item not {item.__class__.__name__}')
|
||||||
|
|
||||||
if (self._weight + item.width) > 5:
|
if (self._weight + item.width) > 5:
|
||||||
raise ValueError('maximum number of children exceeded')
|
raise ValueError('maximum number of children exceeded')
|
||||||
|
|
||||||
if len(self._children) >= 5:
|
if len(self._children) >= 5:
|
||||||
raise ValueError('maximum number of children exceeded')
|
raise ValueError('maximum number of children exceeded')
|
||||||
|
|
||||||
if not isinstance(item, Item):
|
|
||||||
raise TypeError(f'expected Item not {item.__class__.__name__}')
|
|
||||||
|
|
||||||
if self._view:
|
if self._view:
|
||||||
self._view._add_count(1)
|
self._view._add_count(1)
|
||||||
|
|
||||||
|
|||||||
+6
-8
@@ -468,8 +468,8 @@ class BaseView:
|
|||||||
if not isinstance(item, Item):
|
if not isinstance(item, Item):
|
||||||
raise TypeError(f'expected Item not {item.__class__.__name__}')
|
raise TypeError(f'expected Item not {item.__class__.__name__}')
|
||||||
|
|
||||||
item._update_view(self)
|
|
||||||
self._add_count(item._total_count)
|
self._add_count(item._total_count)
|
||||||
|
item._update_view(self)
|
||||||
self._children.append(item)
|
self._children.append(item)
|
||||||
return self
|
return self
|
||||||
|
|
||||||
@@ -783,20 +783,17 @@ class View(BaseView):
|
|||||||
return components
|
return components
|
||||||
|
|
||||||
def add_item(self, item: Item[Any]) -> Self:
|
def add_item(self, item: Item[Any]) -> Self:
|
||||||
|
if not isinstance(item, Item):
|
||||||
|
raise TypeError(f'expected Item not {item.__class__.__name__}')
|
||||||
|
|
||||||
if len(self._children) >= 25:
|
if len(self._children) >= 25:
|
||||||
raise ValueError('maximum number of children exceeded')
|
raise ValueError('maximum number of children exceeded')
|
||||||
|
|
||||||
if item._is_v2():
|
if item._is_v2():
|
||||||
raise ValueError('v2 items cannot be added to this view')
|
raise ValueError('v2 items cannot be added to this view')
|
||||||
|
|
||||||
|
self.__weights.add_item(item)
|
||||||
super().add_item(item)
|
super().add_item(item)
|
||||||
try:
|
|
||||||
self.__weights.add_item(item)
|
|
||||||
except ValueError as e:
|
|
||||||
# if the item has no space left then remove it from _children
|
|
||||||
self._children.remove(item)
|
|
||||||
raise e
|
|
||||||
|
|
||||||
return self
|
return self
|
||||||
|
|
||||||
def remove_item(self, item: Item[Any]) -> Self:
|
def remove_item(self, item: Item[Any]) -> Self:
|
||||||
@@ -806,6 +803,7 @@ class View(BaseView):
|
|||||||
pass
|
pass
|
||||||
else:
|
else:
|
||||||
self.__weights.remove_item(item)
|
self.__weights.remove_item(item)
|
||||||
|
self._add_count(-item._total_count)
|
||||||
item._update_view(None)
|
item._update_view(None)
|
||||||
|
|
||||||
return self
|
return self
|
||||||
|
|||||||
@@ -0,0 +1,88 @@
|
|||||||
|
"""
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2015-present Rapptz
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a
|
||||||
|
copy of this software and associated documentation files (the "Software"),
|
||||||
|
to deal in the Software without restriction, including without limitation
|
||||||
|
the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
||||||
|
and/or sell copies of the Software, and to permit persons to whom the
|
||||||
|
Software is furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in
|
||||||
|
all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
||||||
|
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||||
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||||
|
DEALINGS IN THE SOFTWARE.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import discord
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
|
||||||
|
def test_add_item_with_full_row():
|
||||||
|
view = discord.ui.View()
|
||||||
|
|
||||||
|
for i in range(5):
|
||||||
|
view.add_item(discord.ui.Button(label=str(i), row=0))
|
||||||
|
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
view.add_item(discord.ui.Button(label="6", row=0))
|
||||||
|
|
||||||
|
assert len(view.children) == 5
|
||||||
|
assert view.total_children_count == 5
|
||||||
|
|
||||||
|
|
||||||
|
def test_add_item_invalid():
|
||||||
|
view = discord.ui.View()
|
||||||
|
|
||||||
|
with pytest.raises(TypeError):
|
||||||
|
view.add_item(object()) # type: ignore
|
||||||
|
|
||||||
|
|
||||||
|
def test_remove_item():
|
||||||
|
view = discord.ui.View()
|
||||||
|
item = discord.ui.Button(label="Test")
|
||||||
|
view.add_item(item)
|
||||||
|
|
||||||
|
view.remove_item(item)
|
||||||
|
|
||||||
|
assert view.children == []
|
||||||
|
assert view.total_children_count == 0
|
||||||
|
assert item.view is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_action_row_add_item_invalid():
|
||||||
|
row = discord.ui.ActionRow()
|
||||||
|
|
||||||
|
with pytest.raises(TypeError):
|
||||||
|
row.add_item(object()) # type: ignore
|
||||||
|
|
||||||
|
|
||||||
|
def test_layout_view_add_item_with_too_many_children():
|
||||||
|
view = discord.ui.LayoutView()
|
||||||
|
max_item_limit = 40
|
||||||
|
|
||||||
|
for i in range(max_item_limit - 1):
|
||||||
|
view.add_item(discord.ui.TextDisplay(str(i)))
|
||||||
|
|
||||||
|
row = discord.ui.ActionRow(
|
||||||
|
discord.ui.Button(label="A"),
|
||||||
|
discord.ui.Button(label="B"),
|
||||||
|
)
|
||||||
|
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
view.add_item(row)
|
||||||
|
|
||||||
|
assert len(view.children) == max_item_limit - 1
|
||||||
|
assert view.total_children_count == max_item_limit - 1
|
||||||
|
assert row.view is None
|
||||||
|
assert all(item.view is None for item in row.children)
|
||||||
Reference in New Issue
Block a user