Implement Polls #1922

PythonTryHard · 2024-05-19T12:48:14Z

Summary

Implementing built-in Discord polls.

Checklist

I have run nox and all the pipelines have passed.
I have made unittests according to the code I have added/modified/deleted.

Related issues

Resolves #1886

hikari/internal/routes.py

Having an `attrs` class with `weakref_slot=False` at the same time as a predefined `__slots__` will cause `attrs` to throw a fit: TypeError: 'property' object is not iterable

...oops Signed-off-by: PythonTryHard <[email protected]>

mplatypus

Here are my suggestions so far for the code, but it looks great otherwise.

hikari/polls.py

mplatypus · 2024-05-27T10:08:41Z

hikari/polls.py

+    def __init__(
+        self,
+        question: str,
+        duration: int,


It would be nice to be able to set the duration via a datetime.timedelta object at minimum, and maybe support a datetime.datetime object, that strips of datetime.datetime.now()? not sure about the second one, but definitely the first.

A datetime.timedelta does sound better than just an int, but the problem is Discord's API only allows for int up to 144hrs (7 days).

We could just do floor(datetime.timedelta.hours) but that feels like it's just int with extra steps.

hikari/polls.py

hikari/events/poll_events.py

mplatypus · 2024-05-27T11:27:09Z

Okay, I can't seem to push anything to GH, so I will just send it here.

hikari/impl/entity_factory.py - This actually allows for the payload to be serialised properly, by converting the question from a poll media object, to a payload (plus, same with questions)

    def _serialize_poll_partial_emoji(self, emoji: typing.Optional[emoji_models.Emoji]) -> data_binding.JSONObject:
        if isinstance(emoji, emoji_models.UnicodeEmoji):
            return {"name": emoji.name}
        elif isinstance(emoji, emoji_models.CustomEmoji):
            return {"name": emoji.name, "id": emoji.name}
        return {}

    def _serialize_poll_media(self, poll_media: poll_models.PollMedia) -> data_binding.JSONObject:
        # FIXME: Typing is **very** dodgy here. Revise this before shipping.

        serialised_poll_media: typing.MutableMapping[str, typing.Any] = {"text": poll_media.text}

        answer_emoji = self._serialize_poll_partial_emoji(poll_media.emoji)
        if answer_emoji:
            serialised_poll_media["emoji"] = answer_emoji

        return serialised_poll_media

    def serialize_poll(self, poll: poll_models.PollCreate) -> data_binding.JSONObject:
        answers: typing.MutableSequence[typing.Any] = []
        for answer_id, answer in poll.answers.items():
            answers.append({"answer_id": answer_id, "poll_media": self._serialize_poll_media(answer.poll_media)})

        return {
            "question": self._serialize_poll_media(poll.question),
            "answers": answers,
            "expiry": poll.duration,
            "allow_multiple_options": poll.allow_multiselect,
            "layout_type": poll.layout_type,
        }

added `_serialize_poll_media()` and fixed polls question serialisation.

The removal of the counter has been added, so that the user can choose there own options, however, they may need to add a check because in its current form, you can override other answers.

Co-authored-by: MPlatypus <[email protected]>

"Apparently".

davfsa

Overall really nice pr, thanks!

hikari/internal/routes.py

hikari/polls.py

davfsa · 2024-05-27T15:05:43Z

hikari/polls.py

+class PartialPoll:
+    """Base class for all poll objects."""
+
+    __slots__: typing.Sequence[str] = ("_question", "_answers", "_allow_multiselect", "_layout_type", "_counter")
+
+    def __init__(self, question: str, allow_multiselect: bool, layout_type: typing.Union[int, PollLayoutType]):
+        self._question = PollMedia(text=question)  # Only text is supported for question
+        self._allow_multiselect = allow_multiselect
+        self._layout_type = layout_type


This object is a bit too confusing. It should be more like embed (or it should be moved as a special endpoint class)

Considering it's a certified Discord moment™️ by having a separate poll object and poll creation object, I have absolutely no idea how to implement the two classes elegantly without copy-pasting code. Hence the hacky PartialPoll.

Is it against stuffs like PartialMessage, PartialGuild, etc.? Yes. Do I have any other ideas? No, sadly.

Also not happy with it at the current time

hikari/polls.py

hikari/impl/entity_factory.py

hikari/events/poll_events.py

- De-underscore `answer_payload`. - Remove unnecessary `dict.get` from `deserialize_poll`. - Streamline serialization of poll in `_build_message_payload`. - API endpoint naming consistency. - Correct typing targeting Python 3.8 Co-authored-by: davfsa <[email protected]> Signed-off-by: PythonTryHard <[email protected]>

Co-authored-by: MPlatypus <[email protected]>

Most, or all tests have been completed. - test_serialize_poll - test_deserialize_poll_vote_create_event - test_deserialize_poll_vote_delete_event

Co-authored by: MPlatypus <[email protected]>

Continuation of 51fe4e4

Running `nox -s pytest` would randomly throws an error for failing `assert isinstance(response, list)`. Failed on my machine, does not fail on Platy's machine. This fixes the issue by making sure `AsyncMock` returns a proper list instead of an `AsyncMock` object. Co-authored by: davfsa <[email protected]> Thanks dav!

on_message_poll_vote_add on_message_poll_vote_remove fixed get_poll_answer test.

PythonTryHard · 2024-08-19T06:16:33Z

CI is green. Let's end this.

PythonTryHard · 2024-08-19T06:17:03Z

@davfsa One final thing is left, waiting for your input

changes/1922.feature.md

hikari/events/poll_events.py

hikari/impl/entity_factory.py

beagold · 2024-09-04T06:53:09Z

hikari/impl/entity_factory.py

+
+        answers: typing.MutableSequence[poll_models.PollAnswer] = []
+        for answer_payload in payload["answers"]:
+            answer_id = answer_payload["answer_id"]


This could be missing in some cases according to the documentation:

https://discord.com/developers/docs/resources/poll#poll-answer-object-poll-answer-object-structure

Only sent as part of responses from Discord's API/Gateway.

beagold · 2024-09-04T06:56:04Z

hikari/intents.py

+    GUILD_MESSAGE_POLLS = 1 << 24
+    """Subscribes to the events listed below.
+
+    * `MESSAGE_POLL_VOTE_ADD`
+    * `MESSAGE_POLL_VOTE_REMOVE`
+    """
+
+    DIRECT_MESSAGE_POLLS = 1 << 25
+    """Subscribes to the events listed below.
+
+    * `MESSAGE_POLL_VOTE_ADD`
+    * `MESSAGE_POLL_VOTE_REMOVE`
+    """


Currently the docstring is the same, would be nice to differentiate between guild and DM in the docstring too

beagold · 2024-09-04T06:58:36Z

hikari/internal/routes.py

@@ -345,6 +345,10 @@ def compile_to_file(
 PATCH_STAGE_INSTANCE: typing.Final[Route] = Route(PATCH, "/stage-instances/{channel}")
 DELETE_STAGE_INSTANCE: typing.Final[Route] = Route(DELETE, "/stage-instances/{channel}")

+# Polls
+GET_POLL_ANSWER: typing.Final[Route] = Route(GET, "/channels/{channel}/polls/{message}/answer/{answer}")
+POST_END_POLL: typing.Final[Route] = Route(POST, "/channels/{channel}/polls/{message}/expire")


I hate discord for the naming, but maybe

Suggested change

POST_END_POLL: typing.Final[Route] = Route(POST, "/channels/{channel}/polls/{message}/expire")

POST_EXPIRE_POLL: typing.Final[Route] = Route(POST, "/channels/{channel}/polls/{message}/expire")

beagold · 2024-09-04T06:58:55Z

hikari/polls.py

+# 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.
+"""Polls and poll-related objects."""  # TODO: Improve this docstring


Todo indeed :)

beagold · 2024-09-04T06:59:40Z

hikari/polls.py

+class PartialPoll:
+    """Base class for all poll objects."""
+
+    __slots__: typing.Sequence[str] = ("_question", "_answers", "_allow_multiselect", "_layout_type", "_counter")
+
+    def __init__(self, question: str, allow_multiselect: bool, layout_type: typing.Union[int, PollLayoutType]):
+        self._question = PollMedia(text=question)  # Only text is supported for question
+        self._allow_multiselect = allow_multiselect
+        self._layout_type = layout_type


Also not happy with it at the current time

beagold · 2024-09-04T07:02:09Z

hikari/polls.py

+        return self
+
+
+class Poll(PartialPoll):


Overall not happy with the the layout of these objects, will add more meaningful comments when I play around with the design a bit.

I like the builder idea, but it feels a bit too over the place. Could be condensed way better

PythonTryHard added 3 commits May 19, 2024 20:36

Initial commit on implementing polls

1ed6fcf

Towncrier chore

2c53e90

New poll endpoints

89088f1

PythonTryHard force-pushed the polls branch from 709c981 to 89088f1 Compare May 19, 2024 13:36

mplatypus reviewed May 19, 2024

View reviewed changes

hikari/internal/routes.py Outdated Show resolved Hide resolved

PythonTryHard added 9 commits May 20, 2024 16:33

Ensure route naming consistency

2888d76

Basic implementation of poll-related classes

f31effb

I forgor to format my code

36e5963

Poll-specific events

b7979c4

Only import hikari.Emoji on type checking

a32ac57

Remove erroneous __slots__ from PollResult

153fab3

Having an `attrs` class with `weakref_slot=False` at the same time as a predefined `__slots__` will cause `attrs` to throw a fit: TypeError: 'property' object is not iterable

Integrate poll classes and events into hikari

3daae57

Implement poll in EntityFactory and REST

aaab4c4

Update typing stub

4be409f

PythonTryHard requested a review from mplatypus May 27, 2024 04:12

Apparently Emoji needs to be imported

8d3220b

...oops Signed-off-by: PythonTryHard <[email protected]>

mplatypus reviewed May 27, 2024

View reviewed changes

mplatypus and others added 7 commits May 27, 2024 22:22

added _serialize_poll_media()

a330fcd

added `_serialize_poll_media()` and fixed polls question serialisation.

Removal of counter

ff5413e

The removal of the counter has been added, so that the user can choose there own options, however, they may need to add a check because in its current form, you can override other answers.

Merge pull request #1 from MPlatypus/fix/polls

64d7b33

Credit's where credit's due

f7f58b7

Throw error on adding answer with existing ID

a5dbfe7

Co-authored-by: MPlatypus <[email protected]>

Apparently we don't need to set _answer to None

a6ba51e

"Apparently".

Docstring, dammit

ea9de9e

davfsa requested changes May 27, 2024

View reviewed changes

PythonTryHard and others added 4 commits May 27, 2024 22:30

Emoji is now emojis.Emoji

e7768d3

PollObject is now Poll

65c333f

Correct duration key in serialize_poll

6102e92

PythonTryHard and others added 24 commits July 10, 2024 22:31

Merge pull request #5 from mplatypus/polls

43fee96

Merge remote-tracking branch 'fork/master' into polls

bc65d79

Co-authored-by: MPlatypus <[email protected]>

Appease flake8

add6bf5

Appease mypy

fbe5d1a

Correct docstring after renaming

700521e

Edit message endpoint doesn't support polls

250cb47

Improve names and docstrings

bfd338e

finished most tests.

385e62d

Most, or all tests have been completed. - test_serialize_poll - test_deserialize_poll_vote_create_event - test_deserialize_poll_vote_delete_event

Merge pull request #6 from mplatypus/polls

db85774

Merge remote-tracking branch 'fork/master' into polls

1f6db34

Co-authored by: MPlatypus <[email protected]>

Correct edit_message tests

51fe4e4

Correct poll answer payload extraction

eb41493

Correct event name in test

25ce6f2

...missed some

afeeebf

Continuation of 51fe4e4

added missing tests.

9b33958

on_message_poll_vote_add on_message_poll_vote_remove fixed get_poll_answer test.

Added tests for polls

46d9cbc

Merge pull request #7 from mplatypus/polls

69c0e6c

Remove leftover inlined method

9f0e4c8

Update copyright holder

ff06143

Fix failing poll tests

466af5b

I guess this is fine

f2131f6

I did a dumb

a751cc4

Merge remote-tracking branch 'origin/master' into polls

2011519

PythonTryHard marked this pull request as ready for review August 19, 2024 06:16

PythonTryHard requested a review from mplatypus August 19, 2024 06:16

beagold added the enhancement New feature or request label Aug 28, 2024

beagold requested changes Sep 4, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Polls #1922

Implement Polls #1922

PythonTryHard commented May 19, 2024

mplatypus left a comment

mplatypus May 27, 2024

PythonTryHard May 27, 2024

mplatypus commented May 27, 2024

davfsa left a comment

davfsa May 27, 2024

PythonTryHard May 28, 2024

beagold Sep 4, 2024

PythonTryHard commented Aug 19, 2024

PythonTryHard commented Aug 19, 2024

beagold Sep 4, 2024

beagold Sep 4, 2024

beagold Sep 4, 2024

beagold Sep 4, 2024

beagold Sep 4, 2024

beagold Sep 4, 2024

	POST_END_POLL: typing.Final[Route] = Route(POST, "/channels/{channel}/polls/{message}/expire")
	POST_EXPIRE_POLL: typing.Final[Route] = Route(POST, "/channels/{channel}/polls/{message}/expire")

Implement Polls #1922

Are you sure you want to change the base?

Implement Polls #1922

Conversation

PythonTryHard commented May 19, 2024

Summary

Checklist

Related issues

mplatypus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mplatypus commented May 27, 2024

davfsa left a 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

PythonTryHard commented Aug 19, 2024

PythonTryHard commented Aug 19, 2024

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