feat(Webhook)!: New classes PartialWebhook & PartialSyncWebhook #878

Snipy7374 · 2022-11-26T15:47:12Z

Summary

Closes new classes: PartialWebhook and possible PartialSyncWebhook #622

Extras:

webhook/async_.py#L964-L971 moved __repr__ and url from Webhook and SyncWebhook to BaseWebhook to reduce code redundancy.
webhook/sync.py#L644-L645 document when SyncWebhook.from_url() could raise a TypeError.

Checklist

If code changes were made, then they have been tested
- I have updated the documentation to reflect the changes
- I have formatted the code properly by running task lint
- I have type-checked the code by running task pyright
This PR fixes an issue
This PR adds something new (e.g. new method or parameters)
This PR is a breaking change (e.g. methods or parameters removed/renamed)
This PR is not a code change (e.g. documentation, README, ...)

…o webhook-pr

onerandomusername · 2023-04-08T19:40:08Z

@Snipy7374 would you please resolve conflicts?

Snipy7374 · 2023-04-08T19:41:33Z

@Snipy7374 would you please resolve conflicts?

Oke

elenakrittik

A few documentation nitpicks (mostly).

Also, i think it would make a lot more sense if [Sync]Webhook inherited from Partial[Sync]Webhook than the other way around. If maintainers/users are fine with a little more breakage, i'd do it.

elenakrittik · 2024-05-15T18:54:58Z

changelog/622.docs.rst

@@ -0,0 +1 @@
+Documents ``TypeError`` raised on invalid session passed for :meth:`PartialSyncWebhook.from_url`.


Suggested change

Documents ``TypeError`` raised on invalid session passed for :meth:`PartialSyncWebhook.from_url`.

Document ``TypeError`` raised on invalid session passed for :meth:`PartialSyncWebhook.from_url`.

elenakrittik · 2024-05-15T18:55:57Z

changelog/622.breaking.rst

@@ -0,0 +1 @@
+Migrate ``fetch`` methods of :class:`Webhook` and :class:`SyncWebhook` to :class:`PartialWebhook` and :class:`PartialSyncWebhook`.


Suggested change

Migrate ``fetch`` methods of :class:`Webhook` and :class:`SyncWebhook` to :class:`PartialWebhook` and :class:`PartialSyncWebhook`.

Move ``fetch`` methods of :class:`Webhook` and :class:`SyncWebhook` to :class:`PartialWebhook` and :class:`PartialSyncWebhook`.

elenakrittik · 2024-05-15T18:57:09Z

changelog/622.feature.rst

+Adds :class:`PartialWebhook` and :class:`PartialSyncWebhook` to represent partial webhook objects, in addition the :meth:`from_url`
+and :meth:`partial` methods will now returns a partial webhook object that could be either a :class:`PartialWebhook` or :class:`PartialSyncWebhook`.


Suggested change

Adds :class:`PartialWebhook` and :class:`PartialSyncWebhook` to represent partial webhook objects, in addition the :meth:`from_url`

and :meth:`partial` methods will now returns a partial webhook object that could be either a :class:`PartialWebhook` or :class:`PartialSyncWebhook`.

Add :class:`PartialWebhook` and :class:`PartialSyncWebhook` to represent partial webhook objects, in addition the :meth:`from_url`

and :meth:`partial` methods will now return a partial webhook object that could be either a :class:`PartialWebhook` or :class:`PartialSyncWebhook`.

In addition, i think this should be split into two separate changelog entries.

elenakrittik · 2024-05-15T19:02:18Z

disnake/webhook/async_.py

-    @classmethod
    def partial(
-        cls, id: int, token: str, *, session: aiohttp.ClientSession, bot_token: Optional[str] = None
-    ) -> Webhook:
-        """Creates a partial :class:`Webhook`.
+        self,


self appears to be unused, so i believe this should be at least made a @staticmethod. More generally, i think this should also be moved to PartialWebhook (in that case it should remain a @classmethod)

elenakrittik · 2024-05-15T19:04:02Z

disnake/webhook/async_.py

-    @classmethod
    def from_url(
-        cls, url: str, *, session: aiohttp.ClientSession, bot_token: Optional[str] = None
-    ) -> Webhook:
-        """Creates a partial :class:`Webhook` from a webhook URL.
+        self, url: str, *, session: aiohttp.ClientSession, bot_token: Optional[str] = None
+    ) -> PartialWebhook:


Same as with Webhook.partial, this should at least be made a @staticmethod and ideally moved to PartialWebhook itself.

elenakrittik · 2024-05-15T20:09:53Z

disnake/webhook/async_.py

+        session: aiohttp.ClientSession,
+        bot_token: Optional[str] = None,
+    ) -> PartialWebhook:
+        """Creates a :class:`PartialWebhook`.


Suggested change

"""Creates a :class:`PartialWebhook`.

"""Create a :class:`PartialWebhook`.

elenakrittik · 2024-05-15T20:11:21Z

disnake/webhook/async_.py

@@ -1140,17 +1148,19 @@ def partial(
            "token": token,
        }



Should we do an isinstance(session, aiohttp.Session) check here to be consistent with SynchWebhook?

elenakrittik · 2024-05-15T20:13:13Z

disnake/webhook/async_.py

-        """Creates a partial :class:`Webhook` from a webhook URL.
+        self, url: str, *, session: aiohttp.ClientSession, bot_token: Optional[str] = None
+    ) -> PartialWebhook:
+        """Creates a :class:`PartialWebhook` from a webhook URL.


Suggested change

"""Creates a :class:`PartialWebhook` from a webhook URL.

"""Create a :class:`PartialWebhook` from a webhook URL.

``|

elenakrittik · 2024-05-15T20:14:25Z

disnake/webhook/async_.py

@@ -1188,7 +1198,7 @@ def from_url(



Same again: should we do an isinstance check on session somewhere here for consistency with SyncWebhook?

elenakrittik · 2024-05-15T20:20:02Z

disnake/webhook/sync.py

+        """Fetches the current PartialSyncWebhook to get a full webhook.
+
+        This could be used to get a full webhook from a partial webhook.


Suggested change

"""Fetches the current PartialSyncWebhook to get a full webhook.

This could be used to get a full webhook from a partial webhook.

"""Fetch the full :class:`SyncWebhook` from this partial webhook.

Snipy7374 and others added 10 commits November 10, 2022 23:50

feat PartialWebhook and PartialSyncWebhook

9d07026

adds changelog entry

5179b87

fix typo in changelog entry

0fb43f3

Merge branch 'DisnakeDev:master' into webhook-pr

aaa7539

Merge branch 'DisnakeDev:master' into webhook-pr

56e2445

add new classes in docs & fix typing

8ac3d07

Merge branch 'webhook-pr' of https://github.com/Snipy7374/disnake int…

83587fb

…o webhook-pr

Merge branch 'DisnakeDev:master' into webhook-pr

3ba0c57

add breaking changelog entry

e79f4df

Merge branch 'webhook-pr' of https://github.com/Snipy7374/disnake int…

43a92fe

…o webhook-pr

shiftinv added t: enhancement New feature breaking change Includes breaking changes to code/packaging s: needs review Issue/PR is awaiting reviews t: refactor/typing/lint Refactors, typing changes and/or linting changes labels Nov 27, 2022

shiftinv added this to the disnake v2.8 milestone Nov 27, 2022

Snipy7374 added 5 commits November 28, 2022 18:43

Merge branch 'DisnakeDev:master' into webhook-pr

0691efe

Merge branch 'master' into webhook-pr

9f86ed6

Merge branch 'DisnakeDev:master' into webhook-pr

83e42a7

Merge branch 'DisnakeDev:master' into webhook-pr

37a1e11

Merge branch 'DisnakeDev:master' into webhook-pr

fb4d476

shiftinv modified the milestones: disnake v2.8, disnake v2.9 Feb 5, 2023

Snipy7374 changed the title ~~feat(Webhook): New classes PartialWebhook & PartialSyncWebhook~~ feat(Webhook)!: New classes PartialWebhook & PartialSyncWebhook Apr 13, 2023

shiftinv removed this from the disnake v2.9 milestone Jun 16, 2023

elenakrittik suggested changes May 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(Webhook)!: New classes PartialWebhook & PartialSyncWebhook #878

feat(Webhook)!: New classes PartialWebhook & PartialSyncWebhook #878

Snipy7374 commented Nov 26, 2022 •

edited

Loading

onerandomusername commented Apr 8, 2023

Snipy7374 commented Apr 8, 2023

elenakrittik left a comment •

edited

Loading

elenakrittik May 15, 2024

elenakrittik May 15, 2024 •

edited

Loading

elenakrittik May 15, 2024

elenakrittik May 15, 2024

elenakrittik May 15, 2024

elenakrittik May 15, 2024

elenakrittik May 15, 2024

elenakrittik May 15, 2024

elenakrittik May 15, 2024

elenakrittik May 15, 2024

		@@ -0,0 +1 @@
		Documents ``TypeError`` raised on invalid session passed for :meth:`PartialSyncWebhook.from_url`.

	Documents ``TypeError`` raised on invalid session passed for :meth:`PartialSyncWebhook.from_url`.
	Document ``TypeError`` raised on invalid session passed for :meth:`PartialSyncWebhook.from_url`.

		@@ -0,0 +1 @@
		Migrate ``fetch`` methods of :class:`Webhook` and :class:`SyncWebhook` to :class:`PartialWebhook` and :class:`PartialSyncWebhook`.

	Migrate ``fetch`` methods of :class:`Webhook` and :class:`SyncWebhook` to :class:`PartialWebhook` and :class:`PartialSyncWebhook`.
	Move ``fetch`` methods of :class:`Webhook` and :class:`SyncWebhook` to :class:`PartialWebhook` and :class:`PartialSyncWebhook`.

		Adds :class:`PartialWebhook` and :class:`PartialSyncWebhook` to represent partial webhook objects, in addition the :meth:`from_url`
		and :meth:`partial` methods will now returns a partial webhook object that could be either a :class:`PartialWebhook` or :class:`PartialSyncWebhook`.

	"""Creates a :class:`PartialWebhook`.
	"""Create a :class:`PartialWebhook`.

	"""Creates a :class:`PartialWebhook` from a webhook URL.
	"""Create a :class:`PartialWebhook` from a webhook URL.
	``\|

		"""Fetches the current PartialSyncWebhook to get a full webhook.

		This could be used to get a full webhook from a partial webhook.

feat(Webhook)!: New classes PartialWebhook & PartialSyncWebhook #878

Are you sure you want to change the base?

feat(Webhook)!: New classes PartialWebhook & PartialSyncWebhook #878

Conversation

Snipy7374 commented Nov 26, 2022 • edited Loading

Summary

Checklist

onerandomusername commented Apr 8, 2023

Snipy7374 commented Apr 8, 2023

elenakrittik left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elenakrittik May 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Snipy7374 commented Nov 26, 2022 •

edited

Loading

elenakrittik left a comment •

edited

Loading

elenakrittik May 15, 2024 •

edited

Loading