portolan-python 0.1.4__tar.gz → 0.1.6__tar.gz

{portolan_python-0.1.4 → portolan_python-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: portolan-python
-Version: 0.1.4
+Version: 0.1.6
 Summary: A lightweight Python implementation of the Portolan specification.
 Author: Portolan contributors
 License: Apache-2.0

{portolan_python-0.1.4 → portolan_python-0.1.6}/docs/distribution.md

@@ -8,8 +8,8 @@ preferred package index for published versions.
 Push a tag that matches the version in `pyproject.toml`:
 
 ```bash
-git tag v0.1.0
-git push origin v0.1.0
+git tag v0.1.6
+git push origin v0.1.6
 ```
 
 The release workflow runs the tests, builds both distributions, checks their
@@ -25,7 +25,7 @@ Install the wheel attached to a release:
 
 ```bash
 python -m pip install \
-  https://github.com/jemacchi/portolan-python/releases/download/v0.1.0/portolan_python-0.1.0-py3-none-any.whl
+  https://github.com/jemacchi/portolan-python/releases/download/v0.1.6/portolan_python-0.1.6-py3-none-any.whl
 ```
 
 This path needs no package index account.
@@ -35,7 +35,7 @@ This path needs no package index account.
 Install a published version from PyPI with:
 
 ```bash
-python -m pip install portolan-python==0.1.0
+python -m pip install portolan-python==0.1.6
 ```
 
 Omit the version constraint to install the latest published version.

{portolan_python-0.1.4 → portolan_python-0.1.6}/docs/examples.md

@@ -10,14 +10,14 @@ GitHub:
 
 ```bash
 python -m pip install \
-  https://github.com/jemacchi/portolan-python/releases/download/v0.1.0/portolan_python-0.1.0-py3-none-any.whl
+  https://github.com/jemacchi/portolan-python/releases/download/v0.1.6/portolan_python-0.1.6-py3-none-any.whl
 ```
 
 You can also install the source at a specific tag:
 
 ```bash
 python -m pip install \
-  "portolan-python @ git+https://github.com/jemacchi/portolan-python.git@v0.1.0"
+  "portolan-python @ git+https://github.com/jemacchi/portolan-python.git@v0.1.6"
 ```
 
 ## List collections and assets

{portolan_python-0.1.4 → portolan_python-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "portolan-python"
-version = "0.1.4"
+version = "0.1.6"
 description = "A lightweight Python implementation of the Portolan specification."
 readme = "README.md"
 requires-python = ">=3.10"

{portolan_python-0.1.4 → portolan_python-0.1.6}/src/portolan/registry.py

@@ -215,32 +215,65 @@ def _write_catalog_tree(
     target.parent.mkdir(parents=True, exist_ok=True)
     if document.get("type") == "Collection":
         document = _with_absolute_asset_hrefs(document_url, document)
+
+    links = document.get("links")
+    if isinstance(links, list):
+        rewritten_links: list[Any] = []
+        for link in links:
+            rewritten_link = link
+            if isinstance(link, dict) and isinstance(link.get("href"), str):
+                href = link["href"]
+                linked_url = urljoin(document_url, href)
+                rewritten_link = {**link, "href": linked_url}
+                if link.get("rel") in {"root", "parent"}:
+                    linked_target = next(
+                        (path for path, owner_url in targets.items() if owner_url == linked_url),
+                        None,
+                    )
+                    if linked_target is not None:
+                        rewritten_link = {
+                            **link,
+                            "href": _relative_local_href(target, linked_target),
+                        }
+                if link.get("rel") == "child":
+                    child_url = linked_url
+                    child_target = _target_document_path(root_url, child_url, output_root)
+                    owner = targets.get(child_target)
+                    if owner is not None and owner != child_url:
+                        raise ValueError(
+                            f"Registry documents map to the same local path: {owner}, {child_url}"
+                        )
+                    if child_url in visited:
+                        if owner == child_url:
+                            rewritten_link = {
+                                **link,
+                                "href": _relative_local_href(target, child_target),
+                            }
+                    else:
+                        child = fetch_json(child_url)
+                        if child.get("type") in {"Catalog", "Collection"}:
+                            _write_catalog_tree(
+                                child_url,
+                                child,
+                                root_url,
+                                output_root,
+                                fetch_json,
+                                visited,
+                                targets,
+                            )
+                            rewritten_link = {
+                                **link,
+                                "href": _relative_local_href(target, child_target),
+                            }
+            rewritten_links.append(rewritten_link)
+        document = {**document, "links": rewritten_links}
+
     target.write_text(json.dumps(document, indent=2) + "\n", encoding="utf-8")
 
-    for link in document.get("links", []):
-        if not isinstance(link, dict) or link.get("rel") != "child":
-            continue
-        href = link.get("href")
-        if not isinstance(href, str):
-            continue
-        child_url = urljoin(document_url, href)
-        if child_url in visited:
-            continue
-        child_target = _target_document_path(root_url, child_url, output_root)
-        owner = targets.get(child_target)
-        if owner is not None and owner != child_url:
-            raise ValueError(f"Registry documents map to the same local path: {owner}, {child_url}")
-        child = fetch_json(child_url)
-        if child.get("type") in {"Catalog", "Collection"}:
-            _write_catalog_tree(
-                child_url,
-                child,
-                root_url,
-                output_root,
-                fetch_json,
-                visited,
-                targets,
-            )
+
+def _relative_local_href(parent_target: Path, child_target: Path) -> str:
+    relative_path = os.path.relpath(child_target, start=parent_target.parent)
+    return Path(relative_path).as_posix()
 
 
 def _with_absolute_asset_hrefs(document_url: str, collection: JsonObject) -> JsonObject:

{portolan_python-0.1.4 → portolan_python-0.1.6}/tests/test_registry_api.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import json
+from email.message import Message
 from pathlib import Path
 from typing import Any
 from urllib.error import HTTPError
@@ -188,10 +189,123 @@ def test_download_registry_catalog_writes_snapshot_with_absolute_asset_hrefs(
     collection = json.loads(
         (catalog_root / "roads" / "collection.json").read_text(encoding="utf-8")
     )
-    assert catalog["links"][0]["href"] == "./roads/collection.json"
+    assert catalog["links"][0]["href"] == "roads/collection.json"
     assert collection["assets"]["data"]["href"] == "https://example.test/demo/roads/roads.parquet"
 
 
+def test_download_registry_catalog_rewrites_downloaded_children_to_local_hrefs(
+    tmp_path: Path,
+) -> None:
+    root_url = "https://example.test/demo/catalog.json"
+    child_url = "https://example.test/demo/roads/collection.json"
+    item_url = "https://example.test/demo/roads/item.json"
+    responses = {
+        root_url: {
+            "type": "Catalog",
+            "id": "demo",
+            "links": [
+                {"rel": "self", "href": root_url},
+                {"rel": "child", "href": child_url},
+                {"rel": "child", "href": item_url},
+            ],
+        },
+        child_url: {
+            **_collection("roads", {}),
+            "links": [{"rel": "child", "href": root_url}],
+        },
+        item_url: {"type": "Feature", "id": "road-1"},
+    }
+
+    catalog_root = download_registry_catalog(
+        root_url,
+        tmp_path,
+        fetch_json=lambda url: responses[url],
+    )
+
+    catalog = json.loads((catalog_root / "catalog.json").read_text(encoding="utf-8"))
+    collection = json.loads(
+        (catalog_root / "roads" / "collection.json").read_text(encoding="utf-8")
+    )
+    assert catalog["links"] == [
+        {"rel": "self", "href": root_url},
+        {"rel": "child", "href": "roads/collection.json"},
+        {"rel": "child", "href": item_url},
+    ]
+    assert collection["links"] == [{"rel": "child", "href": "../catalog.json"}]
+
+
+def test_download_registry_catalog_makes_non_downloaded_relative_links_absolute(
+    tmp_path: Path,
+) -> None:
+    root_url = "https://example.test/demo/catalog.json"
+    collection_url = "https://example.test/demo/roads/collection.json"
+    feature_url = "https://example.test/demo/roads/features/road-1.json"
+    responses = {
+        root_url: {
+            "type": "Catalog",
+            "id": "demo",
+            "links": [{"rel": "child", "href": "./roads/collection.json"}],
+        },
+        collection_url: {
+            **_collection("roads", {}),
+            "links": [
+                {"rel": "item", "href": "./items/road-1.json"},
+                {"rel": "child", "href": "./features/road-1.json"},
+            ],
+        },
+        feature_url: {"type": "Feature", "id": "road-1"},
+    }
+
+    catalog_root = download_registry_catalog(
+        root_url,
+        tmp_path,
+        fetch_json=lambda url: responses[url],
+    )
+
+    collection = json.loads(
+        (catalog_root / "roads" / "collection.json").read_text(encoding="utf-8")
+    )
+    assert collection["links"] == [
+        {"rel": "item", "href": "https://example.test/demo/roads/items/road-1.json"},
+        {"rel": "child", "href": feature_url},
+    ]
+
+
+def test_download_registry_catalog_keeps_downloaded_root_and_parent_links_local(
+    tmp_path: Path,
+) -> None:
+    root_url = "https://example.test/demo/catalog.json"
+    collection_url = "https://example.test/demo/roads/collection.json"
+    responses = {
+        root_url: {
+            "type": "Catalog",
+            "id": "demo",
+            "links": [{"rel": "child", "href": "./roads/collection.json"}],
+        },
+        collection_url: {
+            **_collection("roads", {}),
+            "links": [
+                {"rel": "root", "href": root_url},
+                {"rel": "parent", "href": root_url},
+            ],
+        },
+    }
+
+    catalog_root = download_registry_catalog(
+        root_url,
+        tmp_path,
+        fetch_json=lambda url: responses[url],
+    )
+
+    collection = json.loads(
+        (catalog_root / "roads" / "collection.json").read_text(encoding="utf-8")
+    )
+    assert collection["links"] == [
+        {"rel": "root", "href": "../catalog.json"},
+        {"rel": "parent", "href": "../catalog.json"},
+    ]
+
+
 def test_download_registry_catalog_skips_child_cycles(tmp_path: Path) -> None:
     root_url = "https://example.test/demo/catalog.json"
     child_url = "https://example.test/demo/roads/collection.json"
@@ -324,7 +438,7 @@ def test_download_registry_catalog_preserves_snapshot_when_child_fetch_fails(
                 "id": "demo",
                 "links": [{"rel": "child", "href": "./missing.json"}],
             }
-        raise HTTPError(url, 503, "Unavailable", hdrs=None, fp=None)
+        raise HTTPError(url, 503, "Unavailable", hdrs=Message(), fp=None)
 
     with pytest.raises(HTTPError):
         download_registry_catalog(root_url, tmp_path, fetch_json=fetch_json)

{portolan_python-0.1.4 → portolan_python-0.1.6}/uv.lock

@@ -468,7 +468,7 @@ wheels = [
 
 [[package]]
 name = "portolan-python"
-version = "0.1.4"
+version = "0.1.6"
 source = { editable = "." }
 
 [package.optional-dependencies]