ni / ni/python-styleguide

ni-python-styleguide's `--extend-exclude` format is inconsistent with `black`

Open
#134 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
21
Forks
20
Avg merge
22h 9m
Merged PRs (30d)
3

Description

Some of our projects attempt to exclude the same files in both tools.black and tools.ni-python-styleguide. However, the extend_exclude key has a different format for each tool: black uses a regex and ni-python-styleguide uses a comma-separated list of fnmatch patterns.

In nidaqmx-python, we tried to keep these in sync, but copying the ni-python-styleguide format to the tools.black section results in a regex that doesn't match anything.
https://github.com/ni/nidaqmx-python/blob/master/pyproject.toml#L82

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the referenced nidaqmx-python/pyproject.toml entry and compare the tools.black and tools.ni-python-styleguide extend_exclude formats described in the issue. Determine the intended compatible representation; done means the same exclusions can be shared without the black regex failing to match.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.