Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add properties for burst reactions #1947

Merged
merged 13 commits into from
Oct 30, 2023

Conversation

NeloBlivion
Copy link
Member

@NeloBlivion NeloBlivion commented Feb 26, 2023

Summary

Currently in beta., not yet documented and as such subject to change but the changes already exist on the API.
Adds properties and documentation for burst reactions (known as Super Reactions on the UI).

Information

  • 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, typehinting,
    examples, ...).

Checklist

  • I have searched the open pull requests for duplicates.
  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes.
  • If type: ignore comments were used, a comment is also left explaining why.
  • I have updated the changelog to include these changes.

@NeloBlivion NeloBlivion added upcoming discord feature Involves a feature not yet fully released by Discord python labels Feb 26, 2023
@codecov
Copy link

codecov bot commented Feb 26, 2023

Codecov Report

Merging #1947 (ad9239b) into master (ea3e3db) will decrease coverage by 0.01%.
The diff coverage is 33.33%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1947      +/-   ##
==========================================
- Coverage   33.24%   33.24%   -0.01%     
==========================================
  Files          97       97              
  Lines       19033    19038       +5     
==========================================
+ Hits         6328     6329       +1     
- Misses      12705    12709       +4     
Flag Coverage Δ
macos-latest-3.10 33.22% <33.33%> (-0.01%) ⬇️
macos-latest-3.11 33.22% <33.33%> (-0.01%) ⬇️
macos-latest-3.8 33.24% <33.33%> (-0.01%) ⬇️
macos-latest-3.9 33.24% <33.33%> (-0.01%) ⬇️
ubuntu-latest-3.10 33.22% <33.33%> (-0.01%) ⬇️
ubuntu-latest-3.11 33.22% <33.33%> (-0.01%) ⬇️
ubuntu-latest-3.8 33.24% <33.33%> (-0.01%) ⬇️
ubuntu-latest-3.9 33.24% <33.33%> (-0.01%) ⬇️
windows-latest-3.10 33.22% <33.33%> (-0.01%) ⬇️
windows-latest-3.11 33.22% <33.33%> (-0.01%) ⬇️
windows-latest-3.8 33.24% <33.33%> (-0.01%) ⬇️
windows-latest-3.9 33.24% <33.33%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
discord/reaction.py 39.53% <0.00%> (-0.95%) ⬇️
discord/raw_models.py 27.45% <25.00%> (-0.41%) ⬇️
discord/types/message.py 98.87% <100.00%> (+0.01%) ⬆️

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ea3e3db...ad9239b. Read the comment docs.

discord/raw_models.py Outdated Show resolved Hide resolved
discord/raw_models.py Outdated Show resolved Hide resolved
@Lulalaby Lulalaby added discord limitation Limitation imposed by discord priority: low Low Priority feature Implements a feature undocumented discord feature This isn't documented, might not receive support for it! changelog needed labels Feb 26, 2023
@NeloBlivion
Copy link
Member Author

NeloBlivion commented Apr 10, 2023

Now waiting on discord/discord-api-docs#6056, not updating quite yet since it's stated there will be further changes.

@plun1331 plun1331 removed the undocumented discord feature This isn't documented, might not receive support for it! label Apr 19, 2023
@NeloBlivion NeloBlivion marked this pull request as ready for review September 1, 2023 19:08
@NeloBlivion NeloBlivion requested a review from a team as a code owner September 1, 2023 19:08
@NeloBlivion
Copy link
Member Author

NeloBlivion commented Sep 1, 2023

Should largely be complete. Some notes:

  • For consistency with the rest of the library, both burst_colours and burst_colors are implemented.
  • Added ReactionType enum (0 = normal, 1 = burst). This is present in all relevant payloads as type, however it's undocumented. It is still necessary for Reaction.users().
  • raw_reaction_clear_emoji event payloads come with burst and type, however this is unreliable if the removed emoji has both normal and super reactions; in this instance, they default back to False/0.

I have now run out of super reactions for the week so pls test if events work fine too ok thanks

@Lulalaby
Copy link
Member

Lulalaby commented Sep 1, 2023

"consistency"
we should get rid of the weird colour honestly

@NeloBlivion
Copy link
Member Author

maybe for v3 but i don't see a reason to drop it from v2

@Lulalaby Lulalaby enabled auto-merge (squash) October 30, 2023 17:38
@Lulalaby Lulalaby merged commit 9e4b3ff into Pycord-Development:master Oct 30, 2023
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog needed discord limitation Limitation imposed by discord feature Implements a feature on hold priority: low Low Priority upcoming discord feature Involves a feature not yet fully released by Discord
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants