PycordViews 1.0.1__py3-none-any.whl → 1.1.0__py3-none-any.whl

{PycordViews-1.0.1.dist-info → PycordViews-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PycordViews
-Version: 1.0.1
+Version: 1.1.0
 Summary: Views for py-cord library
 Home-page: https://github.com/BOXERRMD/Py-cord_Views
 Author: Chronos (alias BOXERRMD)
@@ -36,6 +36,7 @@ Dynamic: summary
 
 ```python
 from pycordViews.pagination import Pagination
+from pycordViews.menu import SelectMenu
 import discord
 
 intents = discord.Intents.all()
@@ -57,6 +58,23 @@ async def pagination_command(ctx):
 
     await pages.respond(ctx=ctx) # respond to the command
     await pages.send(send_to=ctx.author) # send the message to the command author
-
+    
+@bot.command(name="My command select")
+async def select_command(ctx):
+    """
+    Create a command select
+    """
+    async def your_response(select, interaction):
+        await interaction.response.send(f"You have selected {select.values[0]} !")
+    
+    my_selector = SelectMenu(timeout=None, disabled_on_timeout=False) # A basic selector menu
+    my_menu = my_selector.add_string_select_menu(placeholder="Choice anything !") # add string_select UI
+    
+    my_menu.add_option(label="My first choice !", emoji="😊", default=True, description="It's the first choice !", value='first choice')
+    my_menu.add_option(label="My second choice !", value='second choice')
+    my_menu.set_callable(your_response)
+    
+    await my_selector.respond(ctx)
+    
 bot.run("Your token")
 ```

PycordViews-1.1.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+pycordViews/__init__.py,sha256=SihgmXFTu75CxGmvRhVRHsRm4aDjMy8ZgiXfPuE3suE,223
+pycordViews/typeViews.py,sha256=5q_-FTUGMg2QjA7bsjbb2ep41Y4sm2sBPTCOV6b5X1w,122
+pycordViews/menu/__init__.py,sha256=SoAHnpJXxwTYDX5esYkgvSqpPqkuF1hDx22a-_U7ieU,83
+pycordViews/menu/errors.py,sha256=0Um-oH5qMdWSZB_bGlqILsf9WSDtC4n_HwkheekiMV4,480
+pycordViews/menu/menu.py,sha256=piouHpZLhHSo8MtJjx3eUp0zLzZoxj0n05pwdy0EJl4,1786
+pycordViews/menu/selectMenu.py,sha256=lxgMfTFt-pEu1BRm1zqcJJgMpBWHwwuDtY4hOY4deyA,9809
+pycordViews/pagination/__init__.py,sha256=Z9BcdoTWyC1KXGwQ1_C0tu9rkZpdrrjEHwMmjXsckeE,81
+pycordViews/pagination/errors.py,sha256=CYb5gBcXx0kYDUDkNpfUrqSxQAcJE_qfpomWtUFOsTk,316
+pycordViews/pagination/pagination_view.py,sha256=RRx4Ldr7RYp5n6-y7JttAu6fN_kD5QN9ROmuhkMCt_4,4307
+pycordViews/views/__init__.py,sha256=yligptZmw-np8tjKLr76SVmi0807Nk6jCyKkKYLhbCY,89
+pycordViews/views/easy_modified_view.py,sha256=umura9gYSt15z6nc5-YfRAF80ZtfmHJ88mYqdTgpxzM,8139
+pycordViews/views/errors.py,sha256=0NBjBDaSFZChJua1ho9qyfbNzwXy1U6Kcob5CCUxBK8,218
+PycordViews-1.1.0.dist-info/LICENSE,sha256=lNgcw1_xb7QENAQi3uHGymaFtbs0RV-ihiCd7AoLQjA,1082
+PycordViews-1.1.0.dist-info/METADATA,sha256=XpezVMLNGPJeKlApWAhmRhSssz-D3f0Q-0m18zhgEnE,2897
+PycordViews-1.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+PycordViews-1.1.0.dist-info/top_level.txt,sha256=kxuqvBlttJ3GI36DSbicXMygUS1AEOoA0WzzeYriSjE,70
+PycordViews-1.1.0.dist-info/RECORD,,

{PycordViews-1.0.1.dist-info → PycordViews-1.1.0.dist-info}/top_level.txt

@@ -1,3 +1,4 @@
 pycordViews
+pycordViews/menu
 pycordViews/pagination
 pycordViews/views

pycordViews/__init__.py

@@ -1,3 +1,5 @@
 from .typeViews import *
 from .views.easy_modified_view import EasyModifiedViews
 from .pagination.pagination_view import Pagination
+from .multibot.start_multibot import Multibot
+from .menu.selectMenu import SelectMenu

pycordViews/menu/__init__.py

@@ -0,0 +1,3 @@
+from .selectMenu import SelectMenu
+from .menu import Menu
+from .errors import *

pycordViews/menu/errors.py

@@ -0,0 +1,17 @@
+from typing import Any
+class MenuError(Exception):
+    pass
+
+class NotCoroutineError(MenuError):
+    def __init__(self, callable: Any):
+        """
+        If callable is not a coroutine
+        """
+        super().__init__(f"{callable} is not a coroutine")
+
+class ComponentTypeError(MenuError):
+    def __init__(self):
+        """
+        If the component type is not a string_select
+        """
+        super().__init__(f"Only string select type is available")

pycordViews/menu/menu.py

@@ -0,0 +1,57 @@
+from discord.components import ComponentType
+from discord.ui import Select
+from discord import MISSING, Emoji, PartialEmoji
+from typing import Callable, Union
+
+from .errors import NotCoroutineError, ComponentTypeError
+
+
+class Menu:
+
+    def __init__(self, menu_type: ComponentType, selectmenu: "SelectMenu", **kwargs):
+        """
+        A basic menu from selectMenu class
+        """
+        self.__menu: Select = Select(select_type=menu_type, **kwargs)
+        self.__selectMenu = selectmenu
+
+    def set_callable(self, _callable: Callable) -> "Menu":
+        """
+        Add a coroutine to the menu
+        """
+        if not isinstance(_callable, Callable):
+            raise NotCoroutineError(_callable)
+
+        self.__selectMenu.set_callable(self.__menu.custom_id, _callable=_callable)
+        return self
+
+    def add_option(self, label: str, value: str = MISSING, description: Union[str, None] = None, emoji: Union[str, Emoji, PartialEmoji, None] = None, default: bool = False) -> "Menu":
+        """
+        Add an option to choice.
+        Only from string_select type !
+        """
+        if self.__menu.type != ComponentType.string_select:
+            raise ComponentTypeError()
+
+        self.__menu.add_option(label=label, value=value, description=description, emoji=emoji, default=default)
+        return self
+
+    @property
+    def component(self) -> Select:
+        """
+        Get the component
+        """
+        return self.__menu
+
+    @property
+    def callable(self) -> Callable:
+        """
+        Get the callable link to the menu
+        """
+        return self.__callable
+
+    @callable.setter
+    def callable(self, _callable: Callable):
+        """
+        Set the callable link to menu
+        """

pycordViews/menu/selectMenu.py

@@ -0,0 +1,124 @@
+from ..views.easy_modified_view import EasyModifiedViews
+from .menu import Menu
+
+from typing import Union, Callable
+from discord.components import ComponentType
+from discord import ChannelType, Member, TextChannel, ApplicationContext
+
+class SelectMenu:
+    """
+    Create a simply select menu
+    """
+
+    def __init__(self, timeout: Union[float, None] = None, disabled_on_timeout: bool = False):
+        """
+        Init the select menu
+        """
+        self.__select_menu: EasyModifiedViews = EasyModifiedViews(timeout=timeout, disabled_on_timeout=disabled_on_timeout)
+
+    def add_string_select_menu(self, custom_id: str = None, placeholder: str = None, min_values: int = 1, max_values: int = 1, disabled=False, row=None) -> Menu:
+        """
+        Add a string select menu in the ui
+        :param custom_id: The ID of the select menu that gets received during an interaction. If not given then one is generated for you.
+        :param placeholder: The placeholder text that is shown if nothing is selected, if any.
+        :param max_values: The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.
+        :param min_values: The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.
+        :param disabled: Whether the select is disabled or not.
+        :param row: The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).
+        """
+        return self.__global_add_component(ComponentType.string_select, custom_id=custom_id, placeholder=placeholder, max_values=max_values, min_values=min_values, disabled=disabled, row=row)
+
+    def add_user_select_menu(self, custom_id: str = None, placeholder: str = None, min_values: int = 1, max_values: int = 1, disabled=False, row=None) -> Menu:
+        """
+        Add an user select menu in the ui
+        :param custom_id: The ID of the select menu that gets received during an interaction. If not given then one is generated for you.
+        :param placeholder: The placeholder text that is shown if nothing is selected, if any.
+        :param max_values: The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.
+        :param min_values: The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.
+        :param disabled: Whether the select is disabled or not.
+        :param row: The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).
+        """
+        return self.__global_add_component(ComponentType.user_select, custom_id=custom_id, placeholder=placeholder, max_values=max_values, min_values=min_values, disabled=disabled, row=row)
+
+    def add_role_select_menu(self, custom_id: str = None, placeholder: str = None, min_values: int = 1, max_values: int = 1, disabled=False, row=None) -> Menu:
+        """
+        Add a role select menu in the ui
+        :param custom_id: The ID of the select menu that gets received during an interaction. If not given then one is generated for you.
+        :param placeholder: The placeholder text that is shown if nothing is selected, if any.
+        :param max_values: The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.
+        :param min_values: The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.
+        :param disabled: Whether the select is disabled or not.
+        :param row: The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).
+        """
+        return self.__global_add_component(ComponentType.role_select, custom_id=custom_id, placeholder=placeholder, max_values=max_values, min_values=min_values, disabled=disabled, row=row)
+
+    def add_mentionnable_select_menu(self, custom_id: str = None, placeholder: str = None, min_values: int = 1, max_values: int = 1, disabled=False, row=None) -> Menu:
+        """
+        Add a role select menu in the ui
+        :param custom_id: The ID of the select menu that gets received during an interaction. If not given then one is generated for you.
+        :param placeholder: The placeholder text that is shown if nothing is selected, if any.
+        :param max_values: The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.
+        :param min_values: The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.
+        :param disabled: Whether the select is disabled or not.
+        :param row: The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).
+        """
+        return self.__global_add_component(ComponentType.mentionable_select, custom_id=custom_id, placeholder=placeholder, max_values=max_values, min_values=min_values, disabled=disabled, row=row)
+
+    def add_channel_select_menu(self, custom_id: str = None, placeholder: str = None, min_values: int = 1, max_values: int = 1, disabled=False, row=None, channel_types: list[ChannelType] = None):
+        """
+        Add a role select menu in the ui
+        :param custom_id: The ID of the select menu that gets received during an interaction. If not given then one is generated for you.
+        :param placeholder: The placeholder text that is shown if nothing is selected, if any.
+        :param max_values: The maximum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.
+        :param min_values: The minimum number of items that must be chosen for this select menu. Defaults to 1 and must be between 1 and 25.
+        :param disabled: Whether the select is disabled or not.
+        :param row: The relative row this select menu belongs to. A Discord component can only have 5 rows. By default, items are arranged automatically into those 5 rows. If you’d like to control the relative positioning of the row then passing an index is advised. For example, row=1 will show up before row=2. Defaults to None, which is automatic ordering. The row number must be between 0 and 4 (i.e. zero indexed).
+        :param channel_types: A list of channel types that can be selected in this menu.
+        """
+        return self.__global_add_component(ComponentType.channel_select, custom_id=custom_id, placeholder=placeholder, max_values=max_values, min_values=min_values, disabled=disabled, row=row, channel_types=channel_types)
+
+    def __global_add_component(self, component_type: ComponentType,
+                               custom_id: Union[str, None] = None,
+                               placeholder: Union[str, None] = None,
+                               min_values: int = 1,
+                               max_values: int = 1,
+                               disabled: bool = False,
+                               row: Union[int, None] = None,
+                               channel_types: Union[ChannelType, None] = None) -> Menu:
+        """
+        global function to add a Select component
+        """
+        menu = Menu(component_type,
+                    self.__select_menu,
+                    **{'custom_id': custom_id, 'placeholder': placeholder, 'min_values': min_values,
+                       'max_values': max_values, 'disabled': disabled, 'row': row, 'channel_types': channel_types})
+
+        self.__select_menu.add_items(menu.component)
+
+        return menu
+
+    def set_callable(self, *custom_ids: str, _callable : Callable):
+        """
+        Set a callable for the menu associated with the custom_id
+        :param custom_ids: IDs to menus
+        """
+        self.__select_menu.set_callable(*custom_ids, _callable=_callable)
+
+    async def respond(self, ctx: ApplicationContext, *args, **kwargs) -> None:
+        """
+        Respond at the ApplicationContext
+        """
+        await self.__select_menu.respond(ctx=ctx, *args, view=self.__select_menu, **kwargs)
+
+    async def send(self, target: Union[Member, TextChannel], *args, **kwargs) -> None:
+        """
+        Send at the target
+        """
+        await self.__select_menu.send(target=target, *args, view=self.__select_menu, **kwargs)
+
+    @property
+    def get_view(self) -> EasyModifiedViews:
+        """
+        Get the current view
+        """
+        return self.__select_menu

pycordViews/pagination/pagination_view.py

@@ -13,7 +13,7 @@ class Pagination:
     Allows you to easily setup a view pagination
     """
 
-    def __init__(self, timeout: Union[float, None] = None, disabled_on_timeout:bool = False):
+    def __init__(self, timeout: Union[float, None] = None, disabled_on_timeout: bool = False):
         """
         Initialisation for pagination
         :param timeout: The time before disable items on the view
@@ -25,7 +25,7 @@ class Pagination:
         self.__view.add_items(Button(label='◀', row=0, custom_id='back', style=ButtonStyle.blurple))
         self.__view.add_items(Button(label='▶', row=0, custom_id='forward', style=ButtonStyle.blurple))
         self.__view.add_items(Button(label='⏭', row=0, custom_id='forward+', style=ButtonStyle.blurple))
-        self.__view.set_callable('back+', 'back', 'forward', 'forward+', coroutine=self.__turn_page)
+        self.__view.set_callable('back+', 'back', 'forward', 'forward+', _callable=self.__turn_page)
 
         self.__pages: list[tuple[tuple, dict]] = []
         self.__current_page: int = 0
@@ -44,7 +44,7 @@ class Pagination:
         Deletes pages in the order in which they were added
         **Start to 0 !**
 
-        delete_pages(1,2,3,...)
+        delete_pages(0,1,2,3,...)
         """
         nbr_pages = len(self.__pages)-1
         for page_number in page_numbers:
@@ -54,7 +54,7 @@ class Pagination:
 
             del self.__pages[page_number]
 
-    async def __turn_page(self, interaction: Interaction):
+    async def __turn_page(self, button, interaction: Interaction):
         """
         Turn the page when button is pressed
         """
@@ -91,19 +91,18 @@ class Pagination:
         # Acknowledge the interaction
         await interaction.response.defer(invisible=True)
 
-    async def send(self, send_to: Union[Member, TextChannel]) -> None:
+    async def send(self, target: Union[Member, TextChannel]) -> None:
         """
         Send pagination without introduction message.
-        :param send_to: The member or channel to send the pagination
+        :param target: The member or channel to send the pagination
         """
-
-        await send_to.send(*self.__pages[0][0], **self.__pages[0][1], view=self.get_view)
+        await self.__view.send(ctx=target, *self.__pages[0][0], **self.__pages[0][1], view=self.get_view)
 
     async def respond(self, ctx: ApplicationContext) -> None:
         """
         Respond to the command call
         """
-        await ctx.respond(*self.__pages[0][0], **self.__pages[0][1], view=self.get_view)
+        await self.__view.respond(ctx=ctx, *self.__pages[0][0], **self.__pages[0][1], view=self.get_view)
 
     @property
     def get_view(self) -> EasyModifiedViews:

pycordViews/views/easy_modified_view.py

@@ -1,6 +1,6 @@
-from discord import Interaction, ApplicationContext, Message
+from discord import Interaction, ApplicationContext, Message, Member, TextChannel
 from discord.ui import View, Item
-from typing import Union, Callable, Coroutine, Iterable
+from typing import Union, Callable, Iterable
 
 from ..typeViews import T_views
 from .errors import CustomIDNotFound
@@ -39,11 +39,16 @@ class EasyModifiedViews(View):
         """
         self.__ctx = await ctx.respond(*args, **kwargs)
 
+    async def send(self, target: Union[Member, TextChannel], *args, **kwargs) -> None:
+        """
+        Send at the target
+        """
+        self.__ctx = await target.send(*args, **kwargs)
+
     def add_items(self,
                    *items: T_views) -> "EasyModifiedViews":
         """
         Add all items in the View.
-        custom_id REQUIRED !
         """
 
         for ui in items:
@@ -75,7 +80,7 @@ class EasyModifiedViews(View):
 
     def set_callable_decorator(self, custom_id: str):
         """
-        Decorator to set up a coroutine for the item
+        Decorator to set up a callable for the item
 
         **Interaction parameter is required in coroutine function !**
 
@@ -84,7 +89,7 @@ class EasyModifiedViews(View):
 
         @view.set_callable_decorator(custom_id='test_ID')
 
-        async def rep(**interaction**):
+        async def rep(**UI**, **interaction**):
             await interaction.response.send_message('coucou !!!')
 
         await ctx.respond('coucou', view=view)
@@ -92,36 +97,36 @@ class EasyModifiedViews(View):
         :param custom_id: item ID of the view
         """
 
-        def decorator(coroutine: Coroutine):
+        def decorator(_callable: Callable):
             self.__check_custom_id(custom_id)
 
-            self.__callback[custom_id]['func'] = coroutine
-            return coroutine
+            self.__callback[custom_id]['func'] = _callable
+            return _callable
 
         return decorator
 
-    def set_callable(self, *custom_ids: str, coroutine: Coroutine):
+    def set_callable(self, *custom_ids: str, _callable: Callable):
         """
-        set up a coroutine for items
+        set up a callable for items
         :param custom_ids: items IDs of the view
-        :param coroutine: The coroutine linked
+        :param _callable: The callable linked
 
-        **Interaction parameter is required in coroutine function !**
+        **UI and Interaction parameter is required in callable function !**
 
         view = EasyModifiedViews(None)
 
         view.add_view(discord.ui.Button(label='coucou', custom_id='test_ID'))
 
-        async def rep(**interaction**):
+        async def rep(**UI**, **interaction**):
             await interaction.response.send_message('coucou !!!')
 
-        view.set_callable(custom_id='test_ID', coroutine=rep)
+        view.set_callable(custom_id='test_ID', callable=rep)
         await ctx.respond('coucou', view=view)
         """
         for custom_id in custom_ids:
             self.__check_custom_id(custom_id)
 
-            self.__callback[custom_id]['func'] = coroutine
+            self.__callback[custom_id]['func'] = _callable
 
     async def interaction_check(self, interaction: Interaction) -> bool:
         """
@@ -130,7 +135,7 @@ class EasyModifiedViews(View):
         func = self.__callback[interaction.custom_id]['func']
 
         if func is not None:
-            await func(interaction)
+            await func(self.__callback[interaction.custom_id]['ui'], interaction)
 
         else:
             await interaction.response.defer(invisible=True)
@@ -238,11 +243,16 @@ class EasyModifiedViews(View):
         """
         Update the View on the attached message.
         """
-        if self.message:
-            await self.message.edit(view=self)
+        try:
 
-        else:
-            await self.__ctx.edit(view=self)
+            if self.message:
+                await self.message.edit(view=self)
+
+            else:
+                await self.__ctx.edit(view=self)
+
+        except:
+            pass
 
     @property
     def get_uis(self) -> list[T_views]:
@@ -258,3 +268,6 @@ class EasyModifiedViews(View):
         """
         self.__check_custom_id(custom_id)
         return self.__callback[custom_id]['ui']
+
+    def __str__(self):
+        return str(self.__callback)

PycordViews-1.0.1.dist-info/RECORD

@@ -1,13 +0,0 @@
-pycordViews/__init__.py,sha256=mK6mXFXlXBnvJpPjH9UI_iS54ICVh_0H3LEReQNJutU,135
-pycordViews/typeViews.py,sha256=5q_-FTUGMg2QjA7bsjbb2ep41Y4sm2sBPTCOV6b5X1w,122
-pycordViews/pagination/__init__.py,sha256=Z9BcdoTWyC1KXGwQ1_C0tu9rkZpdrrjEHwMmjXsckeE,81
-pycordViews/pagination/errors.py,sha256=CYb5gBcXx0kYDUDkNpfUrqSxQAcJE_qfpomWtUFOsTk,316
-pycordViews/pagination/pagination_view.py,sha256=ppcQ6e3RFlw9YXoRF_mRdVi4Pf4EomHWUMDtGxwTDbI,4267
-pycordViews/views/__init__.py,sha256=yligptZmw-np8tjKLr76SVmi0807Nk6jCyKkKYLhbCY,89
-pycordViews/views/easy_modified_view.py,sha256=Gk2zvDkLktAX2-gkpm9jD4qFI4th71nawzuIS1knscs,7766
-pycordViews/views/errors.py,sha256=0NBjBDaSFZChJua1ho9qyfbNzwXy1U6Kcob5CCUxBK8,218
-PycordViews-1.0.1.dist-info/LICENSE,sha256=lNgcw1_xb7QENAQi3uHGymaFtbs0RV-ihiCd7AoLQjA,1082
-PycordViews-1.0.1.dist-info/METADATA,sha256=N6T5_MOIE0l9w7zOYup256avGxbWbhVFTFqBeoBm2Yc,2077
-PycordViews-1.0.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-PycordViews-1.0.1.dist-info/top_level.txt,sha256=oPtEDovMPk2PEh7P6fY3IAXvCbmwnG3sbcFIAyljb-Y,53
-PycordViews-1.0.1.dist-info/RECORD,,