Stubs for `filecmp` are missing `Pathlike` for `common` argument

[bersbersbers]

bug.py:

"""Demo mypy bug."""
import filecmp
from pathlib import Path

d = Path.home()
filecmp.cmpfiles(d, d, d.glob("*"))

mypy bug.py:

bug.py:6: error: Value of type variable "AnyStr" of "cmpfiles" cannot be "Path"
Found 1 error in 1 file (checked 1 source file)

I guess common should be Iterable[AnyStr | PathLike[AnyStr]]:

typeshed/stdlib/filecmp.pyi

Lines 16 to 18 in 7bc9c16

	def cmpfiles(
	a: AnyStr | PathLike[AnyStr], b: AnyStr | PathLike[AnyStr], common: Iterable[AnyStr], shallow: int | bool = ...
	) -> tuple[list[AnyStr], list[AnyStr], list[AnyStr]]: ...

Related: #3858, #3864

[srittau]

Sounds right. All arguments are just passed to to os.path.join(), which accepts PathLikes. PR welcome!

[itaisteinherz]

I'd like to work on this.

[bersbersbers]

Will I have to wait for a new release of mypy for this to be effective or is there another way to update the typeshed? E.g., uninstalling and installing mypy did not help.

[AlexWaygood]

Will I have to wait for a new release of mypy for this to be effective or is there another way to update the typeshed? E.g., uninstalling and installing mypy did not help.

If you clone typeshed, you can use mypy with the --custom-typeshed-dir option. But yeah, you'll have to wait until mypy 0.940 (at least) for mypy's vendored copy of these stubs to be updated.

[bersbersbers]

Works great, thanks everybody!

[AlexWaygood]

Works great, thanks everybody!

Awesome!

[bersbersbers]

Btw, after cloning, MYPYPATH=/data/bers/typeshed/stdlib mypy bug.py also works for this example.

[bersbersbers]

For the record, mypy 0.942 has not yet picked this up (in line with the history of the typeshed subdirectory at https://github.com/python/mypy/commits/v0.942/mypy/typeshed). python/mypy#12321 should have it at one point.