Make utils._is_url private

Author: jsignell

CHANGELOG.md

@@ -17,6 +17,7 @@
 - Update migrate code to handle license changes in STAC spec 1.1.0 ([#1491](https://github.com/stac-utils/pystac/pull/1491))
 - Allow links to have `file://` prefix - but don't write them that way by default ([#1489](https://github.com/stac-utils/pystac/pull/1489))
 - Raise `STACError` with message when a link is expected to resolve to a STAC object but doesn't ([#1500](https://github.com/stac-utils/pystac/pull/1500))
+- Raise an error on APILayoutStrategy when root_href is non-url ([#1498](https://github.com/stac-utils/pystac/pull/1498))
 
 ### Fixed
 

pystac/catalog.py

@@ -31,8 +31,8 @@
 from pystac.utils import (
     HREF,
     StringEnum,
+    _is_url,
     is_absolute_href,
-    is_url,
     make_absolute_href,
     make_relative_href,
 )
@@ -771,7 +771,7 @@ def normalize_hrefs(
         if not is_absolute_href(root_href):
             root_href = make_absolute_href(root_href, os.getcwd(), start_is_dir=True)
 
-        if isinstance(_strategy, APILayoutStrategy) and not is_url(root_href):
+        if isinstance(_strategy, APILayoutStrategy) and not _is_url(root_href):
             raise STACError("When using APILayoutStrategy the root_href must be a URL")
 
         def process_item(

pystac/stac_io.py

@@ -16,7 +16,7 @@
     merge_common_properties,
     migrate_to_latest,
 )
-from pystac.utils import HREF, is_url, safe_urlparse
+from pystac.utils import HREF, _is_url, safe_urlparse
 
 # Use orjson if available
 try:
@@ -294,7 +294,7 @@ def read_text_from_href(self, href: str) -> str:
             href : The URI of the file to open.
         """
         href_contents: str
-        if is_url(href):
+        if _is_url(href):
             try:
                 logger.debug(f"GET {href} Headers: {self.headers}")
                 req = Request(href, headers=self.headers)
@@ -328,7 +328,7 @@ def write_text_to_href(self, href: str, txt: str) -> None:
             href : The path to which the file will be written.
             txt : The string content to write to the file.
         """
-        if is_url(href):
+        if _is_url(href):
             raise NotImplementedError("DefaultStacIO cannot write to urls")
         href = safe_urlparse(href).path
         dirname = os.path.dirname(href)
@@ -429,7 +429,7 @@ def read_text_from_href(self, href: str) -> str:
             Args:
                 href : The URI of the file to open.
             """
-            if is_url(href):
+            if _is_url(href):
                 # TODO provide a pooled StacIO to enable more efficient network
                 # access (probably named `PooledStacIO`).
                 http = PoolManager()

pystac/utils.py

@@ -608,6 +608,7 @@ def is_file_path(href: str) -> bool:
     return bool(os.path.splitext(parsed.path)[1])
 
 
-def is_url(href: str) -> bool:
+def _is_url(href: str) -> bool:
+    """Checks if an HREF is a url rather than a local path"""
     parsed = safe_urlparse(href)
     return parsed.scheme not in ["", "file"]