Skip to content

Commit 074f867

Browse files
Merge branch 'stable' into unstable
Signed-off-by: LordOfPolls <dev@lordofpolls.com>
2 parents 8b6415b + 12d7053 commit 074f867

File tree

12 files changed

+153
-70
lines changed

12 files changed

+153
-70
lines changed

docs/src/API Reference/API Reference/models/Internal/active_voice_state.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@
1818
{ .annotate }
1919

2020
1. This connects the bot to the author's voice channel if we are not already connected
21-
2. Check out the [Voice Support Guide](/Guides/22 Voice.html) for more info on audio playback
21+
2. Check out the [Voice Support Guide](interactions.py/Guides/23 Voice/) for more info on audio playback
2222

2323
::: interactions.models.internal.active_voice_state

docs/src/Guides/01 Getting Started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,4 +110,4 @@ Congratulations! You now have a basic understanding of this library.
110110
If you have any questions check out our other guides, or join the
111111
--8<-- "discord_inv.md"
112112

113-
For more examples, check out the [examples page](/Guides/90 Example)
113+
For more examples, check out the [examples page](/interactions.py/Guides/90 Example)

docs/src/Guides/100 Migration From D.py.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@
1212
- These work mostly the same, with a few notable changes:
1313
- Your setup function doesn't need to do `bot.add_cog()`. Simply call `MyCog(bot)`, and it'll automatically register itself.
1414
- Extensions already define `self.bot`, you don't need to do that in your `__init__` function.
15-
- For a full example, see [here](/Guides/20 Extensions/)
15+
- For a full example, see [here](/interactions.py/Guides/20 Extensions/)
1616

1717
4. Event handlers
1818
- Register event handlers with `@interactions.listen`
1919
- Where possible, we use the official names for events, most notably `on_message_create` instead of dpy's `on_message`.
2020
- A full list can be found [here](/interactions.py/API Reference/API Reference/events/discord/).
2121
- Event details are stored on a model, passed as a single parameter. (eg: `on_member_update(before, after)` becomes `on_member_update(event)`, where event has a `.before` and `.after`.
2222
- `on_ready` is called whenever the gateway resumes. If you are looking to run stuff *once* upon startup, use the `on_startup` handler instead.
23-
- For more details, read [the Events guide](/Guides/10 Events).
23+
- For more details, read [the Events guide](/interactions.py/Guides/10 Events).
2424

2525
5. Migrating your commands
26-
- If you were already using dpy's command extension, migrating to slash commands is fairly simple. You just need to convert the decorators as per the [Slash Commands guide](/Guides/03 Creating Commands/)
27-
- If you wish to keep using prefixed commands (sometimes called message or text-based commands), you can use our prefixed command extension, which has an [extensive guide for them](/Guides/07 Creating Prefixed Commands). The syntax should be very similar to discord.py with a few exceptions.
26+
- If you were already using dpy's command extension, migrating to slash commands is fairly simple. You just need to convert the decorators as per the [Slash Commands guide](/interactions.py/Guides/03 Creating Commands/)
27+
- If you wish to keep using prefixed commands (sometimes called message or text-based commands), you can use our prefixed command extension, which has an [extensive guide for them](/interactions.py/Guides/07 Creating Prefixed Commands). The syntax should be very similar to discord.py with a few exceptions.
2828
- If you were manually handling commands with `on_message`, you'll probably need to figure it out yourself, as this guide doesn't know how you wrote your parser. Consider using the provided command handlers.
2929

3030
???+ Note

docs/src/Guides/40 Tasks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ To start a task that has been created, you need to run the `Task.start()` method
115115
```
116116
{ .annotate }
117117

118-
1. See [Events](/Guides/10 Events/) for more information
118+
1. See [Events](/interactions.py/Guides/10 Events/) for more information
119119

120120
=== ":two: Manual Registration"
121121

docs/src/Guides/99 2.x Migration_NAFF.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ from interactions.ext import prefixed_commands
1717
client = Client(..., intents=Intents.GUILD_MESSAGES | ...)
1818
prefixed_commands.setup(client)
1919
```
20-
From here it's more or less the same as before. You can find a guide on how to use prefixed commands [here](/Guides/26 Prefixed Commands/).
20+
From here it's more or less the same as before. You can find a guide on how to use prefixed commands [here](/interactions.py/Guides/26 Prefixed Commands/).
2121

2222
## Hybrid Commands
2323
For now, hybrid commands are not supported, but they will be in the future.

docs/src/changelog.md

+138-54
Original file line numberDiff line numberDiff line change
@@ -3,58 +3,142 @@
33
Here you can find the changelog for the library. This is a list of all the changes that have been made to the library, since V5.0.0.
44
In breaking changes, the breaking change is signified by a `💥`
55

6-
## 5.4.0 - May 17th, 2023
7-
- Feat: Add regex support for modal callback
8-
- Feat: Sort roles
9-
- Feat: Allow .purge to return messages
10-
- Feat: Support http proxies
11-
- Feat: Send not ready messages if requested
12-
- Feat: Support recovery from additional WebSocket close codes
13-
- Fix: Properly pass guild_id to http's get_guild
14-
- Fix: Pin our minimum version of attrs to >=22.1
15-
- Fix: Correctly handle message references
16-
17-
## 5.3.1 - May 6th, 2023
18-
- Fix: Use wrap partial on commands
19-
20-
## 5.3.0 - May 6th, 2023
21-
- Feat: Add BaseEvent.client alias property
22-
- Feat: Add `component` property to `ComponentContext`
23-
- Feat: Add support for mentioning onboarding
24-
- Feat: Implement new automod features
25-
- Feat: Add missing perms
26-
- Feat: Support audit log
27-
- Feat: Support clyde channel flag
28-
- Feat: Add support for voice messages
29-
- Feat: Pass event object based on listeners signature
30-
- Feat: `SlashCommandChoice` as parameter for `AutoCompleteContext.send`
31-
- Fix: Add missing MessageFlag
32-
- Fix: Account for discord's discrim change
33-
- Fix: Copy prefixed cmd set when unloading ext
34-
- Fix: Pass a Member as author of MessageReactionRemove
35-
- Fix: Pass default_member_permissions in SlashCommand.group()
36-
37-
## 5.2.0 - April 30th, 2023
38-
- Feat: Added `ratelimit` parameter to create thread methods
39-
- Feat: Format ratelimit messages with major params
40-
- Feat: Added user & member props to auto mod action
41-
- Feat: Added poll option to jurriged ext
42-
- Fix: Resolve failing linter checks
43-
- Fix: Migration oversights in debug ext
44-
- Fix: Handle a user not passing a cooldown system to the cooldown decorator
45-
46-
## 5.1.0 - April 21st, 2023
47-
- Feat: Add support for regex component callbacks
48-
- Feat: Add new audit log events to enums
49-
- Refactor: Change log level of missing enum value from error to warning
50-
- Feat: Add missing message types to enums
51-
- Feat: Add support for Avatar Decorations
52-
- Chore: Switch library license to MIT
53-
- Build: Add pypi alias `interactions.py`
54-
- Feat: Enhance cooldown system
55-
- Adds new cooldown strategies and allows fetching of the cooldown object using an ID instead of context object
56-
57-
## 5.0.1 - April 12th, 2023
58-
- Fix: copy checks when inheriting
6+
7+
## **Release 5.6.0 - June 2nd, 2023**
8+
### What's New
9+
- docs: Document `send_command_tracebacks` in the Error Tracking guide in https://github.com/interactions-py/interactions.py/pull/1422
10+
- feat: add missing args to Guild.create_forum_post in https://github.com/interactions-py/interactions.py/pull/1417
11+
- docs: fix errors in the bot example and add intent in https://github.com/interactions-py/interactions.py/pull/1416
12+
- feat: Provide Guild ID in GuildLeft event in https://github.com/interactions-py/interactions.py/pull/1435
13+
- feat: add support for sentry argument in https://github.com/interactions-py/interactions.py/pull/1433
14+
15+
### What's Fixed
16+
- fix: correctly work with Permissions.NONE when passed into Guild.create_role in https://github.com/interactions-py/interactions.py/pull/1421
17+
- fix: don't assume msg reference always has msg id in https://github.com/interactions-py/interactions.py/pull/1423
18+
- fix: prevent udp ka from throwing error on close in https://github.com/interactions-py/interactions.py/pull/1425
19+
- fix emoji.edit allowing roleslist in https://github.com/interactions-py/interactions.py/pull/1427
20+
- fix: Don't apply guild_id to messages fetched from DM history in https://github.com/interactions-py/interactions.py/pull/1424
21+
- fix: prevent udp ka from throwing error on close in https://github.com/interactions-py/interactions.py/pull/1425
22+
- fix: prevent already-responded error when using discord image proxy workaround in https://github.com/interactions-py/interactions.py/commit/859323ac11ed63c3e13a2a666421b0e71d0d25d1
23+
24+
**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.5.1...5.6.0
25+
26+
27+
## **Release 5.5.1 - May 23th, 2023**
28+
### What's Fixed
29+
- fix: Compatibility with discord_typings 0.6.0 in https://github.com/interactions-py/interactions.py/pull/1418
30+
31+
**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.5.0...5.5.1
32+
33+
34+
## **Release 5.5.0 - May 21th, 2023**
35+
### What's New
36+
- feat: Handle async checks in wait_for_component in https://github.com/interactions-py/interactions.py/pull/1406
37+
- feat: bypass discord's broken image proxy in https://github.com/interactions-py/interactions.py/pull/1414
38+
39+
**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.4.0...5.5.0
40+
41+
42+
## **Release 5.4.0 - May 17th, 2023**
43+
### What's New
44+
- feat: add regex support for modal callback in https://github.com/interactions-py/interactions.py/pull/1388
45+
- feat: sort roles in https://github.com/interactions-py/interactions.py/pull/1397
46+
- feat: allow .purge to return messages in https://github.com/interactions-py/interactions.py/pull/1396
47+
- feat: support http proxies in https://github.com/interactions-py/interactions.py/pull/1398
48+
- feat: send not ready messages if requested in https://github.com/interactions-py/interactions.py/pull/1389
49+
- feat: support recovery from additional WebSocket close codes in https://github.com/interactions-py/interactions.py/pull/1403
50+
51+
### What's Fixed
52+
- fix: properly pass guild_id to http's get_guild in https://github.com/interactions-py/interactions.py/pull/1394
53+
- fix: Pin our minimum version of attrs to >=22.1 in https://github.com/interactions-py/interactions.py/pull/1392
54+
- fix: correctly handle message references in https://github.com/interactions-py/interactions.py/pull/1395
55+
56+
**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.3.1...5.4.0
57+
58+
59+
## **Release 5.3.1 - May 6th, 2023**
60+
- fix: use wrap partial on commands in https://github.com/interactions-py/interactions.py/pull/1391
61+
62+
**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.3.0...5.3.1
63+
64+
65+
## **Release 5.3.0 - May 6th, 2023**
66+
### What's New
67+
- feat: add BaseEvent.client alias property in https://github.com/interactions-py/interactions.py/pull/1368
68+
- feat: add `component` property to `ComponentContex` in https://github.com/interactions-py/interactions.py/pull/1371
69+
- feat: add support for mentioning onboarding in https://github.com/interactions-py/interactions.py/pull/1373
70+
- feat: implement new automod features in https://github.com/interactions-py/interactions.py/pull/1372
71+
- feat: add missing perms in https://github.com/interactions-py/interactions.py/pull/1374
72+
- feat: support audit log 180 in https://github.com/interactions-py/interactions.py/pull/1379
73+
- feat: support clyde channel flag in https://github.com/interactions-py/interactions.py/pull/1375
74+
- feat: add support for voice messages in https://github.com/interactions-py/interactions.py/pull/1376
75+
- feat: pass event object based on listeners signature in https://github.com/interactions-py/interactions.py/pull/1367
76+
- feat: `SlashCommandChoice` as parameter for `AutoCompleteContext.send` in https://github.com/interactions-py/interactions.py/pull/1380
77+
78+
### What's Fixed
79+
- fix: account for discord's discrim change in https://github.com/interactions-py/interactions.py/pull/1384
80+
- fix: copy prefixed cmd set when unloading ext in https://github.com/interactions-py/interactions.py/pull/1385
81+
- fix: pass a Member as author of MessageReactionRemove in https://github.com/interactions-py/interactions.py/pull/1370
82+
- fix: pass default_member_permissions in SlashCommand.group() in https://github.com/interactions-py/interactions.py/pull/1369
83+
84+
**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.2.0...5.3.0
85+
86+
87+
## **Release 5.2.0 - April 30th, 2023**
88+
### What's New
89+
- feat: add `rate_limit_per_user` param for create thread methods in https://github.com/interactions-py/interactions.py/pull/1359
90+
- feat: format ratelimit messages with major params in https://github.com/interactions-py/interactions.py/pull/1360
91+
- feat: add `user` & `member` props to auto mod action in https://github.com/interactions-py/interactions.py/pull/1358
92+
- Added poll option to jurriged ext by @Proxy in https://github.com/interactions-py/interactions.py/pull/1364
93+
94+
### What's Fixed
95+
- fix: Resolve failing linter checks in https://github.com/interactions-py/interactions.py/pull/1361
96+
- fix migration oversights in debug ext
97+
- fix: handle a user not passing a cooldown system to the cooldown decorator
98+
99+
**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.1.0...5.2.0
100+
101+
102+
## **Release 5.1.0 - April 21st, 2023**
103+
### What's New
104+
- feat: support regex component callbacks in https://github.com/interactions-py/interactions.py/pull/1332
105+
- chore: switch to MIT license in https://github.com/interactions-py/interactions.py/pull/1334
106+
- feat: add audit new mod events to audit log enum in https://github.com/interactions-py/interactions.py/pull/1335
107+
- refactor: change log level of missing value to warning in https://github.com/interactions-py/interactions.py/pull/1339
108+
- feat: add missing message types in https://github.com/interactions-py/interactions.py/pull/1338
109+
- feat: support avatar decorations in https://github.com/interactions-py/interactions.py/pull/1329
110+
- feat: sync improvements in https://github.com/interactions-py/interactions.py/pull/1328
111+
- feat: rate limit improvements in https://github.com/interactions-py/interactions.py/pull/1321
112+
- refactor: Update readme shields and add recent extensions in https://github.com/interactions-py/interactions.py/pull/1348
113+
- feat: caching improvements in https://github.com/interactions-py/interactions.py/pull/1350
114+
- feat: add reset_with_key and get_cooldown_time_with_key in https://github.com/interactions-py/interactions.py/pull/1345
115+
- docs: adjust and fix many parts of the docs in https://github.com/interactions-py/interactions.py/pull/1353
116+
117+
### What's Fixed
118+
- fix: wrong check condition in the component callback in https://github.com/interactions-py/interactions.py/pull/1352
119+
- chore: Update filesize to new 25mb discord limit in https://github.com/interactions-py/interactions.py/pull/1346
120+
121+
**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.0.1...5.1.0
122+
123+
124+
## **Release 5.0.1 - HOTFIX - April 12th, 2023**
125+
- fix: copy checks when inheriting
59126
- When inheriting checks, slash commands would pass in their own checks to the subcommand. This makes sense logically, however, what wasn't being caught was that these were being passed by reference, and so any edit to the checks in one subcommand would affect potentially EVERY command.
60-
- Build: Ensure opus `dll`s are included in pypi releases
127+
- build: Ensure opus `dll`s are included in pypi releases
128+
129+
130+
## **Release 5.0.0 - April 10th, 2023**
131+
- Python3.10 is now the minimum supported python version
132+
- The cache takes centre stage - accessing client.http should not be required
133+
- The client is now substantially more error tolerant. Your commands can fail spectacularly, and the client wont drop an event
134+
- Full API coverage (excluding some pre-release bits)
135+
- Voice Playback and recording built-in
136+
vMany of the old exts are now merged in (check out [here](https://github.com/interactions-py/interactions.py/tree/5.0.0/interactions/ext))
137+
- Performance is improved
138+
- UX has subjectively improved - this is because this release was based heavily on feedback from users
139+
140+
Docs: https://interactions-py.github.io/interactions.py/<br/>
141+
For NAFF users: [NAFF Migration Guide](https://interactions-py.github.io/interactions.py/Guides/99%202.x%20Migration_NAFF/)<br/>
142+
For i.py v4: [I.PY V4 Migration Guide](https://interactions-py.github.io/interactions.py/Guides/98%20Migration%20from%204.X/)<br/>
143+
144+
Full Changelog https://github.com/interactions-py/interactions.py/compare/4.4.0...5.0.0

docs/src/index.md

-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ hide:
44
- toc
55
- feedback
66
---
7-
!!! danger "Remember"
8-
These docs are not completed. Please do not panic if something is missing or inaccurate.
97

108
We hope this documentation is helpful for you, but don't just ++ctrl+c++ and ++ctrl+v++.
119

interactions/ext/jurigged.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
)
2020
except ModuleNotFoundError:
2121
get_logger().error(
22-
"jurigged not installed, cannot enable jurigged integration. Install with `pip install interactions[jurigged]`"
22+
"jurigged not installed, cannot enable jurigged integration. Install with `pip install discord-py-interactions[jurigged]`"
2323
)
2424
raise
2525

interactions/ext/sentry.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import sentry_sdk
1717
except ModuleNotFoundError:
1818
get_logger().error(
19-
"sentry-sdk not installed, cannot enable sentry integration. Install with `pip install interactions[sentry]`"
19+
"sentry-sdk not installed, cannot enable sentry integration. Install with `pip install discord-py-interactions[sentry]`"
2020
)
2121
raise
2222

mkdocs.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -109,16 +109,16 @@ plugins:
109109
handlers:
110110
python:
111111
selection:
112-
inherited_members: true
112+
inherited_members: True
113113
filters:
114114
- "!^_"
115115
rendering:
116116
members_order: source
117117
show_bases: True
118118
show_root_toc_entry: False
119-
group_by_category: False
119+
group_by_category: True
120120
heading_level: 3
121-
show_if_no_docstring: False # temporary, this will be reverted to False once we're done with docs
121+
show_if_no_docstring: True
122122
- minify:
123123
minify_html: true
124124
# keep this at the bottom of the plugins list - if you are building without insiders, comment it out

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "interactions.py"
3-
version = "5.6.0"
3+
version = "5.7.0"
44
description = "Easy, simple, scalable and modular: a Python API wrapper for interactions."
55
authors = [
66
"LordOfPolls <dev@lordofpolls.com>",

setup.py

+1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
"mkdocs-minify-plugin",
2424
"mkdocs-git-committers-plugin-2",
2525
"mkdocs-git-revision-date-localized-plugin",
26+
"griffe==0.25",
2627
]
2728
extras_require["tests"] = [
2829
"pytest",

0 commit comments

Comments
 (0)