✨ Add ignore patterns

[lemonyte]

Allows the user to specify glob patterns to ignore when scanning for source files.

• Closes Feature request: ignore patterns for files or directories #57

Example usage:

# Ignore everything in the scripts directory.
bump-pydantic --ignore=scripts/** .
# Ignore only files in the tests directory, but don't ignore more deeply nested files.
bump-pydantic --ignore=tests/* .
# Ignore only files under directories named foo.
bump-pydantic --ignore=**/foo/* .
# Ignore all __init__.py files.
bump-pydantic --ignore=**/__init__.py .

Note: on POSIX systems it may be necessary to escape patterns in the command line.

bump-pydantic --ignore=scripts/\*\* .

Implementation details and design decisions

• This PR adds a function glob_to_re() which translates a glob pattern into a regular expression. The function is necessary because:

  • the glob module does not provide a way to match a path against a pattern without traversing the file system, and
  • the fnmatch.fnmatch() and pathlib.Path.match() functions do not handle recursive wildcards (**).

• This feature requires disabling automatic argument expansion on Windows in Click. If not disabled, option strings like .venv/** will be transformed into .venv\\ before bump-pydantic is able to apply its own interpretation of the string. The only way to pass this argument to Click is during the invocation of the app instance, therefore it was necessary to make the executable function a functools.partial.

• Extra: a list of default ignore patterns has been added, currently only containing .venv/**.

• Extra: if no files are left either because there are no source files in the given directory, or as a result of filtering with ignore patterns, the program now exits gracefully instead of having Mypy raise an error.

[Kludex]

Can we add some unit tests for glob_to_re?

[Kludex]

Why can't this be added to the app instead of using this partial?

[lemonyte]

Neither Typer nor Click seem to have an option to pass this argument during initialization. The only way to pass it is during invocation of the app through the __call__() or main() methods.

[Kludex]

Do you have a reference for this?

[lemonyte]

PR pallets/click#1918 added the parameter, only to the main method.
The only mention of this parameter in Click's documentation is under the main method here.
pallets/click#1918 (comment) explains how to use it in an entrypoint.

[Kludex]

Thanks @lemonyte :)