pathspec=1.0.0 causes deprecation warnings

[ssbarnea]

Use of pathspec needs to be updated to avoid runtime deprecation warnings coming from pathspec 1.0.0 that was released few hours ago.

DeprecationWarning: GitWildMatchPattern ('gitwildmatch') is deprecated. Use 'gitignore' for GitIgnoreBasicPattern or GitIgnoreSpecPattern instead.

Note: we run CI with warnings as errors so for the time being we will be ceiling down pathspec.

[cpburnz]

Hi, I'm the author of pathspec, and recently released v1 (latest is v1.0.1 because I broke different project from yamllint this time). The biggest change is GitWildMatchPattern (a.k.a. "gitwildmatch") was split into two different implementations. (1) GitIgnoreBasicPattern (a.k.a. "gitignore") is new and properly implements the patterns in gitignore's documentation. (2) GitIgnoreSpecPattern is the previous GitWildMatchPattern implementation and is used by GitIgnoreSpec to implement Git's edge-cases.

pathspec.patterns.gitwildmatch.GitWildMatchPattern remains as a deprecated alias for GitIgnoreSpecPattern.

PathSpec

The form PathSpec.from_lines('gitwildmatch', ...) is now deprecated because it does not fully match the behavior of the gitignore docs or Git itself. There's 3 possible replacements depending on the exact behavior you want:

1. To keep the exact behavior as before, use PathSpec.from_lines(GitIgnoreSpecPattern, ...). This is the non-deprecated equivalent to using "gitwildmatch". I discourage this use because it's a hybrid between Git's behavior and the gitignore docs.

   from pathspec.patterns.gitignore.spec import GitIgnoreSpecPattern

2. To follow the gitignore docs, use PathSpec.from_lines('gitignore', ...). The change for using this form is "foo/*" will no longer match files in subdirectories, and the exact pattern "/" is equivalent to "**" (match everything) rather than being a no-op.

3. To follow Git's implementation, use GitIgnoreSpec.from_lines(...). The change for using this is Git allows including files from excluded directories which directly contradicts the gitignore docs.

yamllint/yamllint/config.py

Lines 35 to 36 in 73b9c0b

	self.yaml_files = pathspec.PathSpec.from_lines(
	'gitwildmatch', ['*.yaml', '*.yml', '.yamllint'])

yamllint/yamllint/config.py

Lines 115 to 118 in 73b9c0b

	self.ignore = pathspec.PathSpec.from_lines(
	'gitwildmatch',
	decoder.lines_in_files(conf['ignore-from-file'])
	)

yamllint/yamllint/config.py

Lines 121 to 122 in 73b9c0b

	self.ignore = pathspec.PathSpec.from_lines(
	'gitwildmatch', conf['ignore'].splitlines())

yamllint/yamllint/config.py

Lines 125 to 126 in 73b9c0b

	self.ignore = pathspec.PathSpec.from_lines(
	'gitwildmatch', conf['ignore'])

yamllint/yamllint/config.py

Lines 137 to 138 in 73b9c0b

	self.yaml_files = pathspec.PathSpec.from_lines('gitwildmatch',
	conf['yaml-files'])

yamllint/yamllint/config.py

Lines 171 to 174 in 73b9c0b

	conf['ignore'] = pathspec.PathSpec.from_lines(
	'gitwildmatch',
	decoder.lines_in_files(conf['ignore-from-file'])
	)

yamllint/yamllint/config.py

Lines 178 to 179 in 73b9c0b

	conf['ignore'] = pathspec.PathSpec.from_lines(
	'gitwildmatch', conf['ignore'].splitlines())

yamllint/yamllint/config.py

Lines 182 to 183 in 73b9c0b

	conf['ignore'] = pathspec.PathSpec.from_lines(
	'gitwildmatch', conf['ignore'])

[hswong3i]

@cpburnz may I have your comment if https://github.com/adrienverge/yamllint/pull/802/files#diff-443dfa037d6d01528b63511e2301a7bbb7d2ef8d3dc85b1df3e7fabd8b0d52f5R35-R36 looks valid?

        self.yaml_files = pathspec.GitIgnoreSpec.from_lines(
            'gitignore', ['*.yaml', '*.yml', '.yamllint'])

At least after these change, ansible-lint doesn't fire deprecation warnings anymore ;-)

[cpburnz]

@hswong3i That's valid. Though the 'gitignore' is redundant for GitIgnoreSpec so that can be shortened to:

        self.yaml_files = pathspec.GitIgnoreSpec.from_lines(
            ['*.yaml', '*.yml', '.yamllint'])

[adrienverge]

Hello Sorin, Caleb, Wong,

Thanks for your inputs on this.

@cpburnz the change you just released seems a good move, and I guess option 3 (follow Git's implementation) is the best way to go to avoid user frustration. What do you guys think?

[hswong3i]

@hswong3i That's valid. Though the 'gitignore' is redundant for GitIgnoreSpec so that can be shortened to:

    self.yaml_files = pathspec.GitIgnoreSpec.from_lines(
        ['*.yaml', '*.yml', '.yamllint'])

PR updated accordingly 🫡