PycordViews 1.0.0__tar.gz → 1.0.1__tar.gz

{pycordviews-1.0.0 → pycordviews-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PycordViews
-Version: 1.0.0
+Version: 1.0.1
 Summary: Views for py-cord library
 Home-page: https://github.com/BOXERRMD/Py-cord_Views
 Author: Chronos (alias BOXERRMD)

{pycordviews-1.0.0 → pycordviews-1.0.1}/PycordViews.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PycordViews
-Version: 1.0.0
+Version: 1.0.1
 Summary: Views for py-cord library
 Home-page: https://github.com/BOXERRMD/Py-cord_Views
 Author: Chronos (alias BOXERRMD)

pycordviews-1.0.1/PycordViews.egg-info/SOURCES.txt

@@ -0,0 +1,23 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+PycordViews.egg-info/PKG-INFO
+PycordViews.egg-info/SOURCES.txt
+PycordViews.egg-info/dependency_links.txt
+PycordViews.egg-info/requires.txt
+PycordViews.egg-info/top_level.txt
+pycordViews/__init__.py
+pycordViews/typeViews.py
+pycordViews/pagination/__init__.py
+pycordViews/pagination/errors.py
+pycordViews/pagination/pagination_view.py
+pycordViews/views/__init__.py
+pycordViews/views/easy_modified_view.py
+pycordViews/views/errors.py
+pycordViews/pagination/__init__.py
+pycordViews/pagination/errors.py
+pycordViews/pagination/pagination_view.py
+pycordViews/views/__init__.py
+pycordViews/views/easy_modified_view.py
+pycordViews/views/errors.py

pycordviews-1.0.1/PycordViews.egg-info/top_level.txt

@@ -0,0 +1,3 @@
+pycordViews
+pycordViews/pagination
+pycordViews/views

pycordviews-1.0.1/pycordViews/pagination/__init__.py

@@ -0,0 +1,2 @@
+from .pagination_view import Pagination
+from .errors import PageNumberNotFound

pycordviews-1.0.1/pycordViews/pagination/errors.py

@@ -0,0 +1,13 @@
+from typing import Union
+
+class Py_cordPagination(Exception):
+    """
+    Main class exception
+    """
+
+class PageNumberNotFound(Py_cordPagination):
+    """
+    If the page number is not found
+    """
+    def __init__(self, number: Union[int, str]):
+        super().__init__(f"Page {number} not found !")

pycordviews-1.0.1/pycordViews/pagination/pagination_view.py

@@ -0,0 +1,120 @@
+from ..views.easy_modified_view import EasyModifiedViews
+from discord import ButtonStyle, Interaction, TextChannel, Member, ApplicationContext
+from discord.ui import Button
+from .errors import PageNumberNotFound
+
+from typing import Union, Any
+
+
+class Pagination:
+    """
+    Class
+    -------------
+    Allows you to easily setup a view pagination
+    """
+
+    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
+        :param disabled_on_timeout: If timeout is done, disable all items
+        """
+        self.__view = EasyModifiedViews(timeout, disabled_on_timeout=disabled_on_timeout)
+
+        self.__view.add_items(Button(label='⏮', row=0, custom_id='back+', style=ButtonStyle.blurple))
+        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.__pages: list[tuple[tuple, dict]] = []
+        self.__current_page: int = 0
+
+    def add_page(self, *args, **kwargs) -> None:
+        """
+        Adds a page (in a list) as if this function directly sent the message
+        Pages are just modified and not reset ! Don't forget to disable embeds or content if the page don't need this.
+
+        add_page(content="my message", embeds=[embed1, embed2], ...)
+        """
+        self.__pages.append((args, kwargs))
+
+    def delete_pages(self, *page_numbers: Union[str, int]):
+        """
+        Deletes pages in the order in which they were added
+        **Start to 0 !**
+
+        delete_pages(1,2,3,...)
+        """
+        nbr_pages = len(self.__pages)-1
+        for page_number in page_numbers:
+
+            if page_number < 0 or page_number > nbr_pages:
+                raise PageNumberNotFound(page_number)
+
+            del self.__pages[page_number]
+
+    async def __turn_page(self, interaction: Interaction):
+        """
+        Turn the page when button is pressed
+        """
+        page_count = len(self.__pages)
+
+        if page_count <= 1:
+            await self.__view.shutdown()
+            await interaction.response.defer(invisible=True)
+            return
+
+            # Update the current page based on the button pressed
+
+        if interaction.custom_id == 'back+':  # Go to the first page
+            self.__current_page = 0
+
+        elif interaction.custom_id == 'back':  # Go to the previous page
+            self.__current_page = max(0, self.__current_page - 1)
+
+        elif interaction.custom_id == 'forward':  # Go to the next page
+            self.__current_page = min(page_count-1, self.__current_page + 1)
+
+        elif interaction.custom_id == 'forward+':  # Go to the last page
+            self.__current_page = page_count-1
+
+
+        await interaction.message.edit(
+
+            *self.__pages[self.__current_page][0],
+
+            **self.__pages[self.__current_page][1]
+
+        )
+
+        # Acknowledge the interaction
+        await interaction.response.defer(invisible=True)
+
+    async def send(self, send_to: Union[Member, TextChannel]) -> None:
+        """
+        Send pagination without introduction message.
+        :param send_to: The member or channel to send the pagination
+        """
+
+        await send_to.send(*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)
+
+    @property
+    def get_view(self) -> EasyModifiedViews:
+        """
+        Get the view of pagination
+        """
+        return self.__view
+
+    @property
+    def get_page(self) -> int:
+        """
+        Get the number of showed page
+        """
+        return self.__current_page

pycordviews-1.0.1/pycordViews/views/__init__.py

@@ -0,0 +1,2 @@
+from .easy_modified_view import EasyModifiedViews
+from .errors import CustomIDNotFound

pycordviews-1.0.1/pycordViews/views/easy_modified_view.py

@@ -0,0 +1,260 @@
+from discord import Interaction, ApplicationContext, Message
+from discord.ui import View, Item
+from typing import Union, Callable, Coroutine, Iterable
+
+from ..typeViews import T_views
+from .errors import CustomIDNotFound
+
+
+class EasyModifiedViews(View):
+    """
+    Class
+    -------------
+    Allows you to easily modify and replace an ui.
+    """
+
+    def __init__(self, timeout: Union[float, None] = None, disabled_on_timeout: bool = False, *items: Item):
+        """
+        Init a Class view for Discord UI
+        :param timeout: The time before ui disable
+        """
+        super().__init__(*items, timeout=timeout)
+        self.__timeout: Union[float, None] = timeout
+        self.__disabled_on_timeout: bool = disabled_on_timeout
+        self.__callback: dict[str, dict[str, Union[Callable[[Interaction], None], T_views]]] = {}
+        self.__ctx: Union[Message, Interaction] = None
+
+    def __check_custom_id(self, custom_id: str) -> None:
+        """
+        Check if the custom_id is alive
+        :param custom_id: ID to find
+        :raise: CustomIDNotFound
+        """
+        if custom_id not in self.__callback.keys():
+            raise CustomIDNotFound()
+
+    async def respond(self, ctx: ApplicationContext, *args, **kwargs) -> None:
+        """
+        Respond at the ApplicationContext
+        """
+        self.__ctx = await ctx.respond(*args, **kwargs)
+
+    def add_items(self,
+                   *items: T_views) -> "EasyModifiedViews":
+        """
+        Add all items in the View.
+        custom_id REQUIRED !
+        """
+
+        for ui in items:
+
+            self.__callback[ui.custom_id] = {'ui': ui, 'func': None}
+            self.add_item(ui)
+
+        return self
+
+    async def update_items(self, *items: T_views) -> "EasyModifiedViews":
+        """
+        Update all views.
+        Append items if custom_ids not in the view
+        Update items if custom_ids in the view
+        :param items: items to update
+        """
+
+        for item in items:
+
+            try:
+                self.__check_custom_id(item.custom_id)
+                self.__callback[item.custom_id]['ui'] = item
+
+            except CustomIDNotFound:
+                self.add_items(item)
+
+        await self._update()
+        return self
+
+    def set_callable_decorator(self, custom_id: str):
+        """
+        Decorator to set up a coroutine for the item
+
+        **Interaction parameter is required in coroutine function !**
+
+        view = EasyModifiedViews(None)
+        view.add_view(discord.ui.Button(label='coucou', custom_id='test_ID'))
+
+        @view.set_callable_decorator(custom_id='test_ID')
+
+        async def rep(**interaction**):
+            await interaction.response.send_message('coucou !!!')
+
+        await ctx.respond('coucou', view=view)
+
+        :param custom_id: item ID of the view
+        """
+
+        def decorator(coroutine: Coroutine):
+            self.__check_custom_id(custom_id)
+
+            self.__callback[custom_id]['func'] = coroutine
+            return coroutine
+
+        return decorator
+
+    def set_callable(self, *custom_ids: str, coroutine: Coroutine):
+        """
+        set up a coroutine for items
+        :param custom_ids: items IDs of the view
+        :param coroutine: The coroutine linked
+
+        **Interaction parameter is required in coroutine function !**
+
+        view = EasyModifiedViews(None)
+
+        view.add_view(discord.ui.Button(label='coucou', custom_id='test_ID'))
+
+        async def rep(**interaction**):
+            await interaction.response.send_message('coucou !!!')
+
+        view.set_callable(custom_id='test_ID', coroutine=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
+
+    async def interaction_check(self, interaction: Interaction) -> bool:
+        """
+        Func to apply items
+        """
+        func = self.__callback[interaction.custom_id]['func']
+
+        if func is not None:
+            await func(interaction)
+
+        else:
+            await interaction.response.defer(invisible=True)
+
+        return True
+
+    async def shutdown(self) -> None:
+        """
+        Disable all items (ui) in the view
+        """
+        self.disable_all_items()
+        await self._update()
+
+    async def disable_items(self, *custom_ids: str) -> None:
+        """
+        Disable partial items in the view
+        :param custom_ids: custom ids of all items to deactivate
+        """
+
+        self.disable_all_items(exclusions=[self.get_item(id_) for id_ in self.__callback.keys() if id_ not in custom_ids])
+        await self._update()
+
+    async def enable_items(self, *custom_ids: str) -> None:
+        """
+        Enabl partial items in the view
+        :param custom_ids: custom ids of all items to activate
+        """
+        self.enable_all_items(
+            exclusions=[self.get_item(id_) for id_ in self.__callback.keys() if id_ not in custom_ids])
+        await self._update()
+
+    async def full_enable_items(self) -> None:
+        """
+        Enable all items in the view
+        """
+        self.enable_all_items()
+        await self._update()
+
+
+    async def switch_status_items(self):
+        """
+        Switch status for all items
+        Enable -> Disable
+        Disable -> Enable
+        """
+
+        for key, in self.__callback.keys():
+            self.__callback[key]['ui'].disabled = not self.__callback[key]['ui'].disabled
+
+        await self._update()
+
+
+    def is_items_disabled(self, *custom_ids: str) -> bool:
+        """
+        Return True if all items are disabled
+        """
+
+        for custom_id in custom_ids:
+            self.__check_custom_id(custom_id)
+            if not self.__callback[custom_id]['ui'].disabled:
+                return False
+
+        return True
+
+
+    def is_items_enabled(self, *custom_ids: str) -> bool:
+        """
+        Return True il aff items are enabled
+        """
+
+        for custom_id in custom_ids:
+            self.__check_custom_id(custom_id)
+            if self.__callback[custom_id]['ui'].disabled:
+                return False
+
+        return True
+
+
+    async def delete_items(self, clear_all: bool = False, *custom_ids: str) -> None:
+        """
+        Delete an item on the view
+        :param custom_ids: IDs of items to delete
+        :param clear_all: Clear all items in the view
+        :raise: CustomIDNotFound
+        """
+        if clear_all:
+            self.clear_items()
+
+        else:
+
+            for custom_id in custom_ids:
+                self.__check_custom_id(custom_id)
+                self.remove_item(self.get_item(custom_id))
+
+        await self._update()
+
+    def on_timeout(self) -> None:
+        """
+        Called if timeout view is finished
+        """
+        if self.__disabled_on_timeout:
+            self.shutdown()
+
+    async def _update(self) -> None:
+        """
+        Update the View on the attached message.
+        """
+        if self.message:
+            await self.message.edit(view=self)
+
+        else:
+            await self.__ctx.edit(view=self)
+
+    @property
+    def get_uis(self) -> list[T_views]:
+        """
+        Get all uis in the view
+        """
+        return [i['ui'] for i in self.__callback.values()]
+
+    def get_ui(self, custom_id: str) -> T_views:
+        """
+        Get an ui in the view
+        :raise: CustomIDNotFound
+        """
+        self.__check_custom_id(custom_id)
+        return self.__callback[custom_id]['ui']

pycordviews-1.0.1/pycordViews/views/errors.py

@@ -0,0 +1,9 @@
+class Py_cordEasyModifiedViews(Exception):
+    """
+    Main class exception
+    """
+
+
+class CustomIDNotFound(Py_cordEasyModifiedViews):
+    def __init__(self):
+        super().__init__(f"custom_id not found !")

{pycordviews-1.0.0 → pycordviews-1.0.1}/setup.py

@@ -5,7 +5,7 @@ with open("README.md") as file:
 
 setup(
     name="PycordViews",
-    version="1.0.0",
+    version="1.0.1",
     url="https://github.com/BOXERRMD/Py-cord_Views",
     author="Chronos (alias BOXERRMD)",
     author_email="vagabonwalybi@gmail.com",
@@ -27,6 +27,6 @@ setup(
     install_requires=[
         "py-cord==2.6.1"
     ],
-    packages=['pycordViews'],
+    packages=['pycordViews', 'pycordViews/pagination', 'pycordViews/views'],
     python_requires='>=3.9'
 )

pycordviews-1.0.0/PycordViews.egg-info/SOURCES.txt

@@ -1,11 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-setup.py
-PycordViews.egg-info/PKG-INFO
-PycordViews.egg-info/SOURCES.txt
-PycordViews.egg-info/dependency_links.txt
-PycordViews.egg-info/requires.txt
-PycordViews.egg-info/top_level.txt
-pycordViews/__init__.py
-pycordViews/typeViews.py

pycordviews-1.0.0/PycordViews.egg-info/top_level.txt

@@ -1 +0,0 @@
-pycordViews