Raise a TypeError if wrong type given to fix_url

api/python/quilt3/packages.py

@@ -813,7 +813,7 @@ def set_dir(self, lkey, path=None, meta=None, update_policy="incoming"):
         Args:
             lkey(string): prefix to add to every logical key,
                 use '/' for the root of the package.
-            path(string): path to scan for files to add to package.
+            path(string, os.PathLike): path to scan for files to add to package.
                 If None, lkey will be substituted in as the path.
             meta(dict): user level metadata dict to attach to lkey directory entry.
             update_policy(str): can be either 'incoming' (default) or 'existing'.

api/python/quilt3/util.py

@@ -233,13 +233,18 @@ def __str__(self):
 
 def fix_url(url):
     """Convert non-URL paths to file:// URLs"""
-    # If it has a scheme, we assume it's a URL.
-    # On Windows, we ignore schemes that look like drive letters, e.g. C:/users/foo
+    # We could technically skip this check and use the TypeError check alone,
+    # but there are existing tests that expect a ValueError for NoneType objects
     if not url:
         raise ValueError("Empty URL")
+    if not isinstance(url, (str, os.PathLike)):
+        raise TypeError(f"Expected a string or pathlike object, but got an instance of {type(url)}.")
 
-    url = str(url)
+    if isinstance(url, os.PathLike):
+        url = url.__fspath__()
 
+    # If it has a scheme, we assume it's a URL.
+    # On Windows, we ignore schemes that look like drive letters, e.g. C:/users/foo
     parsed = urlparse(url)
     if parsed.scheme and not os.path.splitdrive(url)[0]:
         return url

api/python/tests/test_util.py

@@ -18,6 +18,13 @@
 
 
 # Code
+def test_fix_url():
+    with pytest.raises(TypeError):
+        util.fix_url(object())
+    with pytest.raises(ValueError):
+        util.fix_url(None)
+
+
 def test_write_yaml(tmpdir):
     fname = tmpdir / 'some_file.yml'
 

docs/api-reference/Package.md

@@ -142,7 +142,7 @@ __Arguments__
 
 * __lkey(string)__:  prefix to add to every logical key,
     use '/' for the root of the package.
-* __path(string)__:  path to scan for files to add to package.
+* __path(string, os.PathLike)__:  path to scan for files to add to package.
     If None, lkey will be substituted in as the path.
 * __meta(dict)__:  user level metadata dict to attach to lkey directory entry.
 * __update_policy(str)__:  can be either 'incoming' (default) or 'existing'.