bugfix that pagination sets upper limit when should not! (#70)

* bugfix that pagination sets upper limit when should not!
* tags can be null

Signed-off-by: vsoch <vsoch@users.noreply.github.com>

Author: vsoch

CHANGELOG.md

@@ -14,6 +14,7 @@ and **Merged pull requests**. Critical items to know are:
 The versions coincide with releases on pip. Only major versions will be released as tags on Github.
 
 ## [0.0.x](https://github.com/oras-project/oras-py/tree/main) (0.0.x)
+ - bugfix that pagination sets upper limit of 10K (0.1.15)
  - pagination for tags (and general function for pagination) (0.1.14)
  - expose upload_blob function to be consistent (0.1.13)
  - ensure we always strip path separators before pull/push (0.1.12)

oras/client.py

@@ -94,13 +94,13 @@ def version(self, return_items: bool = False) -> Union[dict, str]:
         # Otherwise return a string that can be printed
         return "\n".join(["%s: %s" % (k, v) for k, v in versions.items()])
 
-    def get_tags(self, name: str, N: int = -1) -> List[str]:
+    def get_tags(self, name: str, N=None) -> List[str]:
         """
         Retrieve tags for a package.
 
         :param name: container URI to parse
         :type name: str
-        :param N: number of tags (-1 to get all tags)
+        :param N: number of tags (None to get all tags)
         :type N: int
         """
         return self.remote.get_tags(name, N=N)

oras/container.py

@@ -54,7 +54,9 @@ def get_blob_url(self, digest: str) -> str:
     def upload_blob_url(self) -> str:
         return f"{self.registry}/v2/{self.api_prefix}/blobs/uploads/"
 
-    def tags_url(self, N=10_000) -> str:
+    def tags_url(self, N=None) -> str:
+        if N is None:
+            return f"{self.registry}/v2/{self.api_prefix}/tags/list"
         return f"{self.registry}/v2/{self.api_prefix}/tags/list?n={N}"
 
     def put_manifest_url(self) -> str:

oras/provider.py

@@ -227,36 +227,33 @@ def upload_blob(
 
     @ensure_container
     def get_tags(
-        self, container: Union[str, oras.container.Container], N: int = -1
+        self, container: Union[str, oras.container.Container], N=None
     ) -> List[str]:
         """
         Retrieve tags for a package.
 
         :param container:  parsed container URI
         :type container: oras.container.Container or str
-        :param N: limit number of tags, -1 for all (default)
+        :param N: limit number of tags, None for all (default)
         :type N: Optional[int]
         """
-        # -1 is a flag for retrieving all, if set we use arbitrarily high number
-        retrieve_all = N == -1
-        N = N if (N and N > 0) else 10_0000
-
+        retrieve_all = N is None
         tags_url = f"{self.prefix}://{container.tags_url(N=N)}"  # type: ignore
         tags: List[str] = []
 
-        def extract_tags(response: requests.Response) -> bool:
+        def extract_tags(response: requests.Response):
             """
             Determine if we should continue based on new tags and under limit.
             """
             json = response.json()
-            new_tags = json.get("tags", [])
+            new_tags = json.get("tags") or []
             tags.extend(new_tags)
-            return bool(len(new_tags) and (retrieve_all or len(tags) < N))
+            return len(new_tags) and (retrieve_all or len(tags) < N)
 
         self._do_paginated_request(tags_url, callable=extract_tags)
 
         # If we got a longer set than was asked for
-        if len(tags) > N:
+        if N is not None and len(tags) > N:
             tags = tags[:N]
         return tags
 
@@ -270,7 +267,6 @@ def _do_paginated_request(
         the callable returns True, we continue to the next page, otherwise
         we stop.
         """
-
         # Save the base url to add parameters to, assuming only the params change
         parts = urllib.parse.urlparse(url)
         base_url = f"{parts.scheme}://{parts.netloc}"

oras/tests/test_oras.py

@@ -104,17 +104,11 @@ def test_get_many_tags():
     )
     assert len(tags) == 1005
 
-    # This should retrieve all tags (defaults to -1)
+    # This should retrieve all tags (defaults to None)
     tags = client.get_tags("channel-mirrors/conda-forge/linux-aarch64/arrow-cpp")
     assert len(tags) > 1500
 
-    # Same result (assuming doesn't change in small seconds between)
-    same_tags = client.get_tags(
-        "channel-mirrors/conda-forge/linux-aarch64/arrow-cpp", N=-1
-    )
-    assert not set(tags).difference(set(same_tags))
-
-    # None defaults to -1 too
+    # Same result if explicitly set
     same_tags = client.get_tags(
         "channel-mirrors/conda-forge/linux-aarch64/arrow-cpp", N=None
     )

oras/version.py

@@ -2,7 +2,7 @@
 __copyright__ = "Copyright The ORAS Authors."
 __license__ = "Apache-2.0"
 
-__version__ = "0.1.14"
+__version__ = "0.1.15"
 AUTHOR = "Vanessa Sochat"
 EMAIL = "vsoch@users.noreply.github.com"
 NAME = "oras"