docs💥: revamp extension guide #1494

AstreaTSS · 2023-07-17T00:48:09Z

Pull Request Type

Description

This PR completely revamps the extension guide. While it was agreed it didn't need changing, it was one of the least favorite guides according to statistics, and was in need of a revamp anyhow (I might have gone overboard with it, but that's a good thing I hope 😅).

This PR also merges the normal and advanced extension guides, since both were short on their own. It technically makes it breaking for documentation, so...

Changes

Like the event PR, see the diff.

Revamp the extension guide (as well as merging the advanced guide). This updates many of the demonstrations of extensions to fit better with modern usage, and also showcases a number of things that were constantly asked about.

Related Issues

Test Scenarios

Python Compatibility

I've ensured my code works on Python 3.10.x
I've ensured my code works on Python 3.11.x

Checklist

I've run the pre-commit code linter over all edited files
I've tested my changes on supported Python versions
I've added tests for my code, if applicable
I've updated / added documentation, where applicable

docs/src/Guides/20 Extensions.md

Co-authored-by: Max <maxyolo01.ytb@gmail.com> Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com>

AstreaTSS · 2023-07-18T01:02:07Z

I'm going to be adding one more section to this explaining how to load all extensions in a folder, since it seems to be a common thing to do.

docs/src/Guides/20 Extensions.md

LordOfPolls · 2023-07-21T04:27:04Z

You may have noticed I have made some changes

AstreaTSS · 2023-07-21T04:42:40Z

You may have noticed that I made my own commit addressing your review and also changing other things too.

* feat: add args, kwargs to task (#1478) * modified: interactions/models/internal/tasks/task.py * reset to set_last_call_time Signed-off-by: kennhh <133614589+kennhh@users.noreply.github.com> --------- Signed-off-by: kennhh <133614589+kennhh@users.noreply.github.com> * feat: add id attr to app perms update event * revert: commit signoff err * ci: show pre-commit diff on failure (#1484) * feat: add alt methods for multi-arg params for prefixed cmds (#1471) * feat: add alt methods for multi-arg params for prefixed cmds * fix: use empty if the typehint is just tuple * ci: correct from checks. * fix: support ConsumeRest without typehint --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * feat: cache channel data from interactions (#1479) * fix: account for BaseChannel for channel mentions (#1480) * feat: add default to delete/edit init interaction msg (#1481) * docs: remove outdated cookiecutter template (#1483) * docs: remove outdated cookiecutter template * docs: add boilerplate mention * feat: add id attr to app perms update event (#1485) * feat: add sort order for forums (#1488) * feat: add forum sort order * feat: cache layout and sort order for forums * feat: add rate limit per user where needed (#1489) Signed-off-by: LordOfPolls <dev@lordofpolls.com> * fix: use message channel for PrefixedContext (#1491) * fix: bound app_permissions for HybridContext (#1492) * feat: add start_time(s) for AutoShardedClient (#1482) * feat: add start_time(s) for AutoShardedClient * feat: make start_times a dict * docs: make start_times docstring clearer Co-authored-by: Sophia <41456914+i0bs@users.noreply.github.com> Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com> --------- Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com> Co-authored-by: Sophia <41456914+i0bs@users.noreply.github.com> * fix: correct listen typehint (#1495) * chore: move mutable class ref/attrs to ClassVar typing (#1497) * ci: weekly check. (#1460) * ci: weekly check. updates: - https://github.com/charliermarsh/ruff-pre-commit → https://github.com/astral-sh/ruff-pre-commit - [github.com/astral-sh/ruff-pre-commit: v0.0.272 → v0.0.278](astral-sh/ruff-pre-commit@v0.0.272...v0.0.278) - [github.com/psf/black: 23.3.0 → 23.7.0](psf/black@23.3.0...23.7.0) * ci: correct from checks. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * feat: add ability to use different arg name than option name (#1493) * feat: add ability to use different arg name than option name * feat: raise better error if arg name doesnt exist * fix: use ValueError instead of TypeError TypeError seems to be suppressed * fix: make sure exported auto_defer is deco, not module (#1496) * fix/feat: adjust invite obj to respect event variants (#1500) * fix/feat: adjust invite obj to respect event variants * docs: update docs for event object * revert: keep MISSING for backwards compatibility * style: consistency Co-authored-by: Sophia <41456914+i0bs@users.noreply.github.com> Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com> --------- Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com> Co-authored-by: Sophia <41456914+i0bs@users.noreply.github.com> * fix: address issues with tag usage for guild forums (#1499) * fix: address issues with tags for guild forums * fix: is this breaking? better be safe than sorry * docs💥: revamp extension guide (#1494) * docs💥: revamp extension guide * docs: update extension example * docs: oops, forgot a word Co-authored-by: Max <maxyolo01.ytb@gmail.com> Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com> * docs: add section for loading all extensions in folder * docs: turns out ipy can load multi exts in one file * docs: lots of wording adjustments --------- Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com> Co-authored-by: Max <maxyolo01.ytb@gmail.com> Co-authored-by: LordOfPolls <dev@lordofpolls.com> * feat: add `guild` & `channel` properties to `ThreadMembersUpdate` (#1504) * ci: weekly check. (#1503) * ci: weekly check. updates: - [github.com/astral-sh/ruff-pre-commit: v0.0.278 → v0.0.280](astral-sh/ruff-pre-commit@v0.0.278...v0.0.280) * ci: correct from checks. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * fix(http): incorrect path for delete permission endpoint (#1506) * fix delete_permissions api endpoint fix API Endpoint in delete_channel_permission adding "permissions/" in Endpoint * ci: correct from checks. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * ci: weekly check. (#1511) updates: - [github.com/astral-sh/ruff-pre-commit: v0.0.280 → v0.0.281](astral-sh/ruff-pre-commit@v0.0.280...v0.0.281) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * feat: Implement missing stuff for scheduled events (#1507) * feat: Implement gateway support for scheduled events * fix: add optional to user add/remove * refactor: pre-commit'ed * refactor: change attrs to props and add `attrs.field` * refactor: set repr to True * feat(client): add `get_scheduled_event` helper method * refactor: use cache helpers in methods * chore: replace typing * docs: clarify intents in example (#1516) * feat: infer modal/component callback names from coroutine (#1519) * feat: infer callback decor from coroutine name * docs: add new logic notation * chore: add doc notation to component callback definition * docs: clarify intents for extensions * ci: weekly check. (#1521) updates: - [github.com/astral-sh/ruff-pre-commit: v0.0.281 → v0.0.282](astral-sh/ruff-pre-commit@v0.0.281...v0.0.282) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --------- Signed-off-by: kennhh <133614589+kennhh@users.noreply.github.com> Signed-off-by: LordOfPolls <dev@lordofpolls.com> Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com> Co-authored-by: kennhh <133614589+kennhh@users.noreply.github.com> Co-authored-by: i0bs <41456914+i0bs@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: LordOfPolls <dev@lordofpolls.com> Co-authored-by: Max <maxyolo01.ytb@gmail.com> Co-authored-by: Damego <damego.dev@gmail.com> Co-authored-by: Donbur4156 <janpfister@t-online.de>

* feat: add args, kwargs to task (#1478) * modified: interactions/models/internal/tasks/task.py * reset to set_last_call_time Signed-off-by: kennhh <133614589+kennhh@users.noreply.github.com> --------- Signed-off-by: kennhh <133614589+kennhh@users.noreply.github.com> * feat: add id attr to app perms update event * revert: commit signoff err * ci: show pre-commit diff on failure (#1484) * feat: add alt methods for multi-arg params for prefixed cmds (#1471) * feat: add alt methods for multi-arg params for prefixed cmds * fix: use empty if the typehint is just tuple * ci: correct from checks. * fix: support ConsumeRest without typehint --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * feat: cache channel data from interactions (#1479) * fix: account for BaseChannel for channel mentions (#1480) * feat: add default to delete/edit init interaction msg (#1481) * docs: remove outdated cookiecutter template (#1483) * docs: remove outdated cookiecutter template * docs: add boilerplate mention * feat: add id attr to app perms update event (#1485) * feat: add sort order for forums (#1488) * feat: add forum sort order * feat: cache layout and sort order for forums * feat: add rate limit per user where needed (#1489) Signed-off-by: LordOfPolls <dev@lordofpolls.com> * fix: use message channel for PrefixedContext (#1491) * fix: bound app_permissions for HybridContext (#1492) * feat: add start_time(s) for AutoShardedClient (#1482) * feat: add start_time(s) for AutoShardedClient * feat: make start_times a dict * docs: make start_times docstring clearer Co-authored-by: Sophia <41456914+i0bs@users.noreply.github.com> Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com> --------- Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com> Co-authored-by: Sophia <41456914+i0bs@users.noreply.github.com> * fix: correct listen typehint (#1495) * chore: move mutable class ref/attrs to ClassVar typing (#1497) * ci: weekly check. (#1460) * ci: weekly check. updates: - https://github.com/charliermarsh/ruff-pre-commit → https://github.com/astral-sh/ruff-pre-commit - [github.com/astral-sh/ruff-pre-commit: v0.0.272 → v0.0.278](astral-sh/ruff-pre-commit@v0.0.272...v0.0.278) - [github.com/psf/black: 23.3.0 → 23.7.0](psf/black@23.3.0...23.7.0) * ci: correct from checks. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * feat: add ability to use different arg name than option name (#1493) * feat: add ability to use different arg name than option name * feat: raise better error if arg name doesnt exist * fix: use ValueError instead of TypeError TypeError seems to be suppressed * fix: make sure exported auto_defer is deco, not module (#1496) * fix/feat: adjust invite obj to respect event variants (#1500) * fix/feat: adjust invite obj to respect event variants * docs: update docs for event object * revert: keep MISSING for backwards compatibility * style: consistency Co-authored-by: Sophia <41456914+i0bs@users.noreply.github.com> Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com> --------- Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com> Co-authored-by: Sophia <41456914+i0bs@users.noreply.github.com> * fix: address issues with tag usage for guild forums (#1499) * fix: address issues with tags for guild forums * fix: is this breaking? better be safe than sorry * docs💥: revamp extension guide (#1494) * docs💥: revamp extension guide * docs: update extension example * docs: oops, forgot a word Co-authored-by: Max <maxyolo01.ytb@gmail.com> Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com> * docs: add section for loading all extensions in folder * docs: turns out ipy can load multi exts in one file * docs: lots of wording adjustments --------- Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com> Co-authored-by: Max <maxyolo01.ytb@gmail.com> Co-authored-by: LordOfPolls <dev@lordofpolls.com> * feat: add `guild` & `channel` properties to `ThreadMembersUpdate` (#1504) * ci: weekly check. (#1503) * ci: weekly check. updates: - [github.com/astral-sh/ruff-pre-commit: v0.0.278 → v0.0.280](astral-sh/ruff-pre-commit@v0.0.278...v0.0.280) * ci: correct from checks. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * fix(http): incorrect path for delete permission endpoint (#1506) * fix delete_permissions api endpoint fix API Endpoint in delete_channel_permission adding "permissions/" in Endpoint * ci: correct from checks. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * ci: weekly check. (#1511) updates: - [github.com/astral-sh/ruff-pre-commit: v0.0.280 → v0.0.281](astral-sh/ruff-pre-commit@v0.0.280...v0.0.281) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * feat: Implement missing stuff for scheduled events (#1507) * feat: Implement gateway support for scheduled events * fix: add optional to user add/remove * refactor: pre-commit'ed * refactor: change attrs to props and add `attrs.field` * refactor: set repr to True * feat(client): add `get_scheduled_event` helper method * refactor: use cache helpers in methods * chore: replace typing * chore: pyproject version bump --------- Signed-off-by: kennhh <133614589+kennhh@users.noreply.github.com> Signed-off-by: LordOfPolls <dev@lordofpolls.com> Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com> Signed-off-by: Sophia <41456914+i0bs@users.noreply.github.com> Co-authored-by: kennhh <133614589+kennhh@users.noreply.github.com> Co-authored-by: i0bs <41456914+i0bs@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: LordOfPolls <dev@lordofpolls.com> Co-authored-by: Max <maxyolo01.ytb@gmail.com> Co-authored-by: Damego <damego.dev@gmail.com> Co-authored-by: Donbur4156 <janpfister@t-online.de>

AstreaTSS added 2 commits July 16, 2023 20:34

docs💥: revamp extension guide

eb0e6bd

docs: update extension example

7f93516

mAxYoLo01 reviewed Jul 17, 2023

View reviewed changes

docs/src/Guides/20 Extensions.md Outdated Show resolved Hide resolved

docs: oops, forgot a word

a525722

Co-authored-by: Max <maxyolo01.ytb@gmail.com> Signed-off-by: Astrea <25420078+AstreaTSS@users.noreply.github.com>

AstreaTSS added 2 commits July 17, 2023 21:28

docs: add section for loading all extensions in folder

993d00a

docs: turns out ipy can load multi exts in one file

2bdf792

i0bs requested a review from FayeDel July 19, 2023 23:00

i0bs approved these changes Jul 19, 2023

View reviewed changes

LordOfPolls requested changes Jul 21, 2023

View reviewed changes

docs: lots of wording adjustments

95ee693

LordOfPolls approved these changes Jul 23, 2023

View reviewed changes

LordOfPolls merged commit 159e020 into interactions-py:unstable Jul 23, 2023

AstreaTSS deleted the ext-guide-update branch August 16, 2023 19:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs💥: revamp extension guide #1494

docs💥: revamp extension guide #1494

AstreaTSS commented Jul 17, 2023 •

edited

Loading

AstreaTSS commented Jul 18, 2023

LordOfPolls commented Jul 21, 2023

AstreaTSS commented Jul 21, 2023

docs💥: revamp extension guide #1494

docs💥: revamp extension guide #1494

Conversation

AstreaTSS commented Jul 17, 2023 • edited Loading

Pull Request Type

Description

Changes

Related Issues

Test Scenarios

Python Compatibility

Checklist

AstreaTSS commented Jul 18, 2023

LordOfPolls commented Jul 21, 2023

AstreaTSS commented Jul 21, 2023

AstreaTSS commented Jul 17, 2023 •

edited

Loading