Excluding a folder containing braces in its name fails

[LKajan]

If folder containing braces in its name is configured to the extend-exclude ruff fails to run. ruff . produces an error:

ruff failed
  Cause: error parsing glob 'C:\Users\<>\cookiecutter-plugin\{{cookiecutter.plugin_package}}': nested alternate groups are not allowed

Ruff version: 0.0.292

My project structure and configuration:

./
├ {{cookiecutter.project_directory}}
├ hooks/
| ├ post_gen_project.py
├ pyproject.toml

# pyproject.toml
[tool.ruff]
extend-exclude = ["{{cookiecutter.plugin_package}}"]

[charliermarsh]

These are globs, so you need to do some escaping:

[tool.ruff]
extend-exclude = [
  '\{\{cookiecutter.plugin_package\}\}'
]

TOML requires single quotes there, I think, but I tested this myself. Let me know if it works for you!

[LKajan]

Unfortunately escaping didn't work.
With extend-exclude = ['\{\{cookiecutter.plugin_package\}\}'] I'll get an error

ruff failed
  Cause: error parsing glob 'C:\{\{cookiecutter.plugin_package\}\}': nested alternate groups are not allowed

Please note also the path is now directly under C:\ and not in the workind directory.

[LKajan]

I found an issue from VS Code with the same error message: microsoft/vscode#194701
So this might be an issue of a upstream library.

[charliermarsh]

I wonder why the escaping worked fine for me but not for you. I just want to confirm that you used single quotes in the TOML file?

[LKajan]

I wonder why the escaping worked fine for me but not for you. I just want to confirm that you used single quotes in the TOML file?

That's what I was wondering too. Could this be an OS dependent? And how come single quotes make the path absolute and not relative?

[charliermarsh]

I assume so -- I only tested on macOS. I believe the single- vs. double-quotes is part of the TOML spec. Single quotes cause the string to be interpreted as a literal with no escaping at all.

[T-256]

For meta-characters escaping in glob you must wrap it in brackets: [ and ]
I used this and got expected result:

extend-exclude = ["[{][{]cookiecutter.plugin_package[}][}]"]

[charliermarsh]

Oh interesting -- @LKajan, can you give that a try?

[LKajan]

Thanks @T-256 that actually worked!

Should the value be escaped by user or by Ruff? If left to the user's responsibility, then at least this should be documented somehow. Either a clear instructions or at least a reference to a some rigrep/regexp documentation.

[T-256]

https://docs.astral.sh/ruff/settings/#extend-exclude :

For more information on the glob syntax, refer to the globset documentation.

In settings page, all of associated options already documented.

[LKajan]

Thanks for pointing that! I missed that part.