feat: implement positional flags #2443

Vioshim · 2024-04-30T18:14:28Z

Summary

This allows FlagConverters to be used after the first text expression, for example

class HandleText(FlagConverter, prefix="--", delimiter=" "):
    text: str = commands.flag(positional=True)
    flip: bool = False
    
@bot.bridge_command()
async def welcome(ctx: bridge.BridgeContext, *, flags: HandleText):
    text = flags.text[::-1] if flags.flip else flags.text
    await ctx.respond(text)

# ?welcome Hello world
# ?welcome Hello world --flip True
# ?welcome --text Hello world
# ?welcome --text Hello world --flip True

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.

discord/ext/commands/flags.py

docs/ext/commands/commands.rst

CHANGELOG.md

discord/ext/commands/flags.py

docs/ext/commands/commands.rst

Co-authored-by: Dorukyum <[email protected]> Co-authored-by: JustaSqu1d <[email protected]> Signed-off-by: Lala Sabathil <[email protected]>

Lulalaby · 2024-07-01T13:14:27Z

@Vioshim please work on dorus comment and resolve conflcts

Signed-off-by: Lala Sabathil <[email protected]>

The typing import in flags.py has been updated to include the Optional module. This change ensures that the __commands_flag_positional__ attribute can accept a value of None.

Signed-off-by: Dorukyum <[email protected]>

Paillat-dev · 2025-03-31T10:20:58Z

Needs testing + doesn't work with python 3.11+

Lulalaby · 2025-08-02T03:23:04Z

Merge conflicts

Paillat-dev · 2025-08-02T15:47:11Z

@Lulalaby I think that OP is gone but I can fix these in a new pr. Lmk if ok

Lulalaby · 2025-08-02T15:49:34Z

Sure go for it if you still think it's a good addition

Vioshim · 2025-08-04T19:33:16Z

My apologies, felt lost on how to be able to contribute in the project once i saw the things about merging conflicts or the documentation changes, so ended up lost on how to correct it alongside irl stuff, so my apologies for the lack of response

Paillat-dev · 2025-08-04T21:09:21Z

@Vioshim no worries. Do you still want to work on this ? If lmk and I'll handle the merge conflicts and the rest

Vioshim · 2025-08-04T21:21:07Z

That'd be quite appreciated, thank you!!
@Paillat-dev

Paillat-dev · 2025-08-04T21:22:09Z

No worries and thank you for your contribution !

Signed-off-by: Paillat <[email protected]>

Paillat-dev · 2025-08-04T21:30:42Z

@Lumabots Can I get some testing from you ? Specifically on python 3.11 and higher ?

discord/ext/commands/flags.py

Signed-off-by: Paillat <[email protected]>

Lumabots · 2025-08-04T21:39:05Z

@Lumabots Can I get some testing from you ? Specifically on python 3.11 and higher ?

Yep doing that tomorrow evening

DA-344

lgtm code wise, if this is tested and works then should be ready to merge

Lumabots

lgtm, tested with py11, 12, 13

Lulalaby · 2025-10-21T09:00:51Z

Damn one year old already

A

@Paillat-dev

* Implements positional flags * style(pre-commit): auto fixes from pre-commit.com hooks * Documentation for positional argument in commands.Flag * style(pre-commit): auto fixes from pre-commit.com hooks * Apply suggestions from code review Co-authored-by: Dorukyum <[email protected]> Co-authored-by: JustaSqu1d <[email protected]> Signed-off-by: Lala Sabathil <[email protected]> * chore: Update typing import in flags.py The typing import in flags.py has been updated to include the Optional module. This change ensures that the __commands_flag_positional__ attribute can accept a value of None. * style(pre-commit): auto fixes from pre-commit.com hooks * style(pre-commit): auto fixes from pre-commit.com hooks * Apply suggestion from @Paillat-dev Signed-off-by: Paillat <[email protected]> --------- Signed-off-by: Lala Sabathil <[email protected]> Signed-off-by: Lala Sabathil <[email protected]> Signed-off-by: Dorukyum <[email protected]> Signed-off-by: Paillat <[email protected]> Signed-off-by: Paillat <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Lala Sabathil <[email protected]> Co-authored-by: Dorukyum <[email protected]> Co-authored-by: JustaSqu1d <[email protected]> Co-authored-by: Lala Sabathil <[email protected]> Co-authored-by: Paillat <[email protected]> Co-authored-by: Paillat <[email protected]> (cherry picked from commit 9f265b0)

Implements positional flags

c85c7f0

Vioshim requested a review from a team as a code owner April 30, 2024 18:14

pullapprove4 bot requested a review from FrostByte266 April 30, 2024 18:14

pullapprove4 bot added PA: All Contributors pending PA: Maintainers pending labels Apr 30, 2024

style(pre-commit): auto fixes from pre-commit.com hooks

96fe65e

JustaSqu1d added hold: documentation This pull request is missing documentation hold: changelog This pull request is missing a changelog entry labels Apr 30, 2024

Vioshim and others added 2 commits April 30, 2024 14:16

Documentation for positional argument in commands.Flag

539a9a0

style(pre-commit): auto fixes from pre-commit.com hooks

409ec1a

Dorukyum reviewed May 20, 2024

View reviewed changes

discord/ext/commands/flags.py Show resolved Hide resolved

JustaSqu1d previously requested changes May 20, 2024

View reviewed changes

docs/ext/commands/commands.rst Outdated Show resolved Hide resolved

pullapprove4 bot removed the PA: All Contributors pending label May 20, 2024

JustaSqu1d removed the hold: changelog This pull request is missing a changelog entry label May 22, 2024

Dorukyum changed the title ~~feat: Implements positional flags~~ feat: implement positional flags Jun 28, 2024

Dorukyum previously requested changes Jun 28, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

discord/ext/commands/flags.py Outdated Show resolved Hide resolved

docs/ext/commands/commands.rst Outdated Show resolved Hide resolved

pullapprove4 bot removed the PA: Maintainers pending label Jun 28, 2024

Apply suggestions from code review

29401b1

Co-authored-by: Dorukyum <[email protected]> Co-authored-by: JustaSqu1d <[email protected]> Signed-off-by: Lala Sabathil <[email protected]>

JustaSqu1d added priority: medium Medium Priority feature Implements a feature python Pull requests that update Python code and removed hold: documentation This pull request is missing documentation labels Aug 7, 2024

Lulalaby added this to the v2.7 milestone Aug 10, 2024

Lulalaby and others added 6 commits August 16, 2024 14:52

Merge branch 'master' into master

8fdc110

Signed-off-by: Lala Sabathil <[email protected]>

chore: Update typing import in flags.py

dfdc4f3

The typing import in flags.py has been updated to include the Optional module. This change ensures that the __commands_flag_positional__ attribute can accept a value of None.

style(pre-commit): auto fixes from pre-commit.com hooks

4f752e6

Merge branch 'master' into master

431f9e4

style(pre-commit): auto fixes from pre-commit.com hooks

ecf1698

Merge branch 'master' into master

5647c53

Signed-off-by: Dorukyum <[email protected]>

Paillat-dev mentioned this pull request Apr 1, 2025

fix: 🐛 Fix ValueError when using Flag #2759

Merged

9 tasks

Merge branch 'master' into master

b5666b5

Signed-off-by: Paillat <[email protected]>

Paillat-dev reviewed Aug 4, 2025

View reviewed changes

discord/ext/commands/flags.py Outdated Show resolved Hide resolved

Apply suggestion from @Paillat-dev

ea060dd

Signed-off-by: Paillat <[email protected]>

Lulalaby added the on hold label Aug 30, 2025

Lulalaby requested a review from a team as a code owner August 30, 2025 20:33

Lulalaby force-pushed the master branch 2 times, most recently from b55c125 to 82659b2 Compare August 30, 2025 21:10

Lulalaby removed the on hold label Aug 30, 2025

Lulalaby requested a review from a team as a code owner September 1, 2025 12:31

Lulalaby force-pushed the master branch from 6529ef4 to 9855a4e Compare September 1, 2025 22:02

DA-344 approved these changes Sep 1, 2025

View reviewed changes

Merge branch 'master' into master

162f9d8

Lumabots approved these changes Oct 21, 2025

View reviewed changes

Lulalaby approved these changes Oct 21, 2025

View reviewed changes

Lulalaby merged commit 9f265b0 into Pycord-Development:master Oct 21, 2025
27 of 28 checks passed

Uh oh!

feat: implement positional flags #2443

feat: implement positional flags #2443

Uh oh!

Conversation

Vioshim commented Apr 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Information

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Lulalaby commented Jul 1, 2024

Uh oh!

Paillat-dev commented Mar 31, 2025

Uh oh!

Lulalaby commented Aug 2, 2025

Uh oh!

Paillat-dev commented Aug 2, 2025

Uh oh!

Lulalaby commented Aug 2, 2025

Uh oh!

Vioshim commented Aug 4, 2025

Uh oh!

Paillat-dev commented Aug 4, 2025

Uh oh!

Vioshim commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Paillat-dev commented Aug 4, 2025

Uh oh!

Paillat-dev commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Lumabots commented Aug 4, 2025

Uh oh!

DA-344 left a comment

Choose a reason for hiding this comment

Uh oh!

Lumabots left a comment

Choose a reason for hiding this comment

Uh oh!

Lulalaby commented Oct 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Vioshim commented Apr 30, 2024 •

edited

Loading

Vioshim commented Aug 4, 2025 •

edited

Loading

Paillat-dev commented Aug 4, 2025 •

edited

Loading