Fix incompatibility with pathlib.Path

I was adding types to beetsplug/fetchart.py and found that this

  @cached_property
  def fallback(self) -> Path | None:
      return self.config["fallback"].get(
          confuse.Optional(confuse.templates.Path())
      )

fails with

  beetsplug/fetchart.py:1370: error: Incompatible return value type (got "PurePath | None", expected "Path | None")  [return-value]

Author: snejus

confuse/templates.py

@@ -24,7 +24,7 @@
 T = TypeVar("T")
 T_co = TypeVar("T_co", covariant=True)
 K = TypeVar("K", bound=Hashable, default=str)
-P = TypeVar("P", bound=pathlib.PurePath | str, default=str)
+P = TypeVar("P", bound=pathlib.Path | str, default=str)
 V = TypeVar("V", default=object)
 ConfigKey = int | str | bytes
 ConfigKeyT = TypeVar("ConfigKeyT", bound=ConfigKey, default=str)
@@ -738,7 +738,7 @@ def value(
         return os.path.abspath(path_str)
 
 
-class Path(Filename[pathlib.PurePath]):
+class Path(Filename[pathlib.Path]):
     """A template that validates strings as `pathlib.Path` objects.
 
     Filenames are parsed equivalent to the `Filename` template and then
@@ -863,7 +863,7 @@ def as_template(value: set[T]) -> Choice[T, T]: ...
 @overload
 def as_template(value: list[T]) -> OneOf[T]: ...
 @overload
-def as_template(value: pathlib.PurePath) -> Path: ...
+def as_template(value: pathlib.Path) -> Path: ...
 @overload
 def as_template(value: None) -> Template[None]: ...
 @overload
@@ -897,7 +897,7 @@ def as_template(value: Any) -> Template[Any]:
         return Number()
     elif isinstance(value, float):
         return Number(value)
-    elif isinstance(value, pathlib.PurePath):
+    elif isinstance(value, pathlib.Path):
         return Path(value)
     elif value is None:
         return Template(None)

docs/changelog.rst

@@ -6,6 +6,8 @@ Unreleased
 
 - Require `typing_extensions` on older Python versions (and use `typing` on
   newer versions). [#189](https://github.com/beetbox/confuse/issues/189)
+- Narrow `Path` template shorthand handling to concrete `pathlib.Path` values
+  for more accurate type checking.
 
 v2.2.0
 ------

test/test_valid.py

@@ -1,10 +1,12 @@
 import enum
 import os
+import pathlib
 import unittest
 from collections.abc import Mapping, Sequence
 from typing import Any
 
 import pytest
+from typing_extensions import assert_type
 
 import confuse
 
@@ -461,19 +463,20 @@ def test_filename_wrong_type(self):
 
 class PathTest(unittest.TestCase):
     def test_path_value(self):
-        import pathlib
-
         config = _root({"foo": "foo/bar"})
         valid = config["foo"].get(confuse.Path())
         assert valid == pathlib.Path(os.path.abspath("foo/bar"))
 
     def test_default_value(self):
-        import pathlib
-
         config = _root({})
         valid = config["foo"].get(confuse.Path("foo/bar"))
         assert valid == pathlib.Path("foo/bar")
 
+    def test_optional_value_type(self):
+        config = _root({"foo": "foo/bar"})
+        valid = config["foo"].get(confuse.Optional(confuse.Path()))
+        assert_type(valid, pathlib.Path | None)
+
     def test_default_none(self):
         config = _root({})
         valid = config["foo"].get(confuse.Path(None))