add pydantic tests (#127)

* add pydantic tests

* update changelog

* update readme

CHANGELOG.md

@@ -13,6 +13,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - improved azure test separation (#123).
 
+### Added
+- tests to confirm pydantic `BaseSettings` behavior (#127).
+
 ## [0.0.24] - 2023-06-19
 ### Added
 - started a changelog to keep track of significant changes (#118).

README.md

@@ -61,7 +61,7 @@ For more examples, see the [example notebook here](notebooks/examples.ipynb)
 Other fsspec-compatible filesystems may also work, but are not supported and tested.
 Contributions for new filesystems are welcome!
 
-### Class inheritance diagram
+### Class hierarchy
 
 The individual `UPath` subclasses relate in the following way with `pathlib` classes:
 
@@ -116,10 +116,15 @@ flowchart TB
   style s1 fill:none,stroke:#ca0020,stroke-width:3px,stroke-dasharray: 3 3,color:#ca0020
 ```
 
-`PosixUPath` and `WindowsUPath` subclasses are 100% compatible with the `PosixPath` and `WindowsPath` classes of their
+When instantiating `UPath` the returned instance type depends on the path that was provided to the constructor.
+For "URI"-style paths, `UPath` returns a subclass instance corresponding to the supported `fsppec` protocol, defined
+by the URI-scheme. If there is no specialized subclass implementation available, `UPath` with return a `UPath` instance
+and raise a warning that the protocol is currently not being tested in the test-suite, and correct behavior is not
+guaranteed.
+If a local path is provided, `UPath` will return a `PosixUPath` or `WindowsUPath` instance.
+These two subclasses are 100% compatible with the `PosixPath` and `WindowsPath` classes of their
 specific Python version, and are tested against all relevant tests of the CPython pathlib test-suite.
 
-
 ## Contributing
 
 Contributions are very welcome.

setup.cfg

@@ -46,6 +46,8 @@ dev =
     cheroot
     hadoop-test-cluster
     pyarrow
+    pydantic
+    pydantic-settings
 
 [options.package_data]
 upath =

upath/tests/third_party/test_pydantic.py

@@ -0,0 +1,17 @@
+import pytest
+
+try:
+    from pydantic import BaseConfig
+    from pydantic_settings import BaseSettings
+except ImportError:
+    BaseConfig = BaseSettings = None
+    pytestmark = pytest.mark.skip(reason="requires pydantic")
+
+from upath.core import UPath
+
+
+def test_pydantic_settings_local_upath():
+    class MySettings(BaseSettings):
+        example_path: UPath = UPath(__file__)
+
+    assert isinstance(MySettings().example_path, UPath)