Merge branch 'main' into fix/747-collection-clone-removes-assets

Author: duckontheweb

CHANGELOG.md

@@ -26,6 +26,7 @@
 - Add a `variables` argument, to accompany `dimensions`, for the `apply` method of stac objects extended with datacube ([#782](https://github.com/stac-utils/pystac/pull/782))
 - Deepcopy collection properties on clone. Implement `clone` method for `Summaries` ([#794](https://github.com/stac-utils/pystac/pull/794))
 - Collection assets are now preserved when using `Collection.clone` ([#834](https://github.com/stac-utils/pystac/pull/834))
+- Docstrings for `StacIO.read_text` and `StacIO.write_text` now match the type annotations for the `source` argument. ([#835](https://github.com/stac-utils/pystac/pull/835))
 
 ## [v1.4.0]
 

pystac/stac_io.py

@@ -42,11 +42,11 @@ class StacIO(ABC):
     def read_text(self, source: HREF, *args: Any, **kwargs: Any) -> str:
         """Read text from the given URI.
 
-        The source to read from can be specified as a string or a
-        :class:`~pystac.Link`. If it is a string, it must be a URI or local path from
-        which to read. Using a :class:`~pystac.Link` enables implementations to use
-        additional link information, such as paging information contained in the
-        extended links described in the `STAC API spec
+        The source to read from can be specified as a string or :class:`os.PathLike`
+        object (:class:`~pystac.Link` is a path-like object). If it is a string, it
+        must be a URI or local path from which to read. Using a :class:`~pystac.Link`
+        enables implementations to use additional link information, such as paging
+        information contained in the extended links described in the `STAC API spec
         <https://github.com/radiantearth/stac-api-spec/tree/master/item-search#paging>`__.
 
         Args:
@@ -71,10 +71,11 @@ def write_text(
     ) -> None:
         """Write the given text to a file at the given URI.
 
-        The destination to write to from can be specified as a string or a
-        :class:`~pystac.Link`. If it is a string, it must be a URI or local path from
-        which to read. Using a :class:`~pystac.Link` enables implementations to use
-        additional link information.
+        The destination to write to can be specified as a string or
+        :class:`os.PathLike` object (:class:`~pystac.Link` is a path-like object). If
+        it is a string, it must be a URI or local path from which to read. Using a
+        :class:`~pystac.Link` enables implementations to use additional link
+        information.
 
         Args:
             dest : The destination to write to.

requirements-test.txt

@@ -8,7 +8,7 @@ jsonschema==4.6.0
 coverage==6.4.1
 doc8==0.11.2
 
-types-python-dateutil==2.8.17
+types-python-dateutil==2.8.18
 types-orjson==3.6.2
 
 pre-commit==2.19.0