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

flag to control Windows pattern expansion #1918

Merged
merged 1 commit into from
May 19, 2021
Merged

Conversation

davidism
Copy link
Member

Windows terminals don't do pattern expansion, so #1096 requested simulating it in Click. However, Windows also doesn't have a way to escape patterns so that the literal value is used. This adds a flag cli(windows_expand_args=False) to disable expansion.

Checklist:

  • Add tests that demonstrate the correct behavior of the change. Tests should fail without the change.
  • Add or update relevant docs, in the docs folder and in code.
  • Add an entry in CHANGES.rst summarizing the change and linking to the issue.
  • Add .. versionchanged:: entries in any relevant code docs.
  • Run pre-commit hooks and fix any issues.
  • Run pytest and tox, no tests failed.

@davidism davidism added this to the 8.0.1 milestone May 19, 2021
@davidism davidism merged commit 6e91b13 into 8.0.x May 19, 2021
@davidism davidism deleted the disable-windows-expansion branch May 19, 2021 20:56
@ofek
Copy link
Contributor

ofek commented May 19, 2021

How is this used? I tried:

import click

@click.group(windows_expand_args=False)
@click.pass_context
def cli(ctx):
    ...

and

import click

@click.group(context_settings={'windows_expand_args': False})
@click.pass_context
def cli(ctx):
    ...

@davidism
Copy link
Member Author

davidism commented May 20, 2021

It's an argument to the main program.

cli(windows_expand_args=False)

@ofek
Copy link
Contributor

ofek commented May 20, 2021

@davidism
Copy link
Member Author

davidism commented May 20, 2021

Define another function (or use functools.partial) and point the entry point at that.

def main():
    cli(...)

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 4, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants