NGPIris 5.1.1.dev3__py3-none-any.whl → 5.2.0.dev1__py3-none-any.whl

NGPIris/cli/__init__.py

@@ -19,14 +19,14 @@ def format_list(list_of_things : list) -> str:
     list_of_buckets = list(map(lambda s : s + "\n", list_of_things))
     return "".join(list_of_buckets).strip("\n")
 
-def _list_objects_generator(hcph : HCPHandler, name_only : bool) -> Generator[str, Any, None]:
+def _list_objects_generator(hcph : HCPHandler, path : str, name_only : bool, files_only : bool) -> Generator[str, Any, None]:
     """
     Handle object list as a paginator that `click` can handle. It works slightly 
     different from `list_objects` in `hcp.py` in order to make the output 
     printable in a terminal
     """
     paginator : Paginator = hcph.s3_client.get_paginator("list_objects_v2")
-    pages : PageIterator = paginator.paginate(Bucket = hcph.bucket_name)
+    pages : PageIterator = paginator.paginate(Bucket = hcph.bucket_name, Prefix = path)
     (nb_of_cols, _) = get_terminal_size()
     max_width = floor(nb_of_cols / 5)
     if (not name_only):
@@ -36,7 +36,11 @@ def _list_objects_generator(hcph : HCPHandler, name_only : bool) -> Generator[st
             tablefmt = "plain",
             stralign = "center"
         ) + "\n" + "-"*nb_of_cols + "\n"
-    for object in pages.search("Contents[?!ends_with(Key, '/')][]"): # filter objects that does not end with "/"
+    if files_only:
+        filter_string = "Contents[?!ends_with(Key, '/')][]" # filter objects that does not end with "/"
+    else:
+        filter_string = "Contents[*][]"
+    for object in pages.search(filter_string): 
         if name_only:
             yield str(object["Key"]) + "\n"
         else:
@@ -55,6 +59,11 @@ def _list_objects_generator(hcph : HCPHandler, name_only : bool) -> Generator[st
 def object_is_folder(object_path : str, hcph : HCPHandler) -> bool:
     return (object_path[-1] == "/") and (hcph.get_object(object_path)["ContentLength"] == 0)
 
+def add_trailing_slash(path : str) -> str:
+    if not path[-1] == "/":
+        path += "/"
+    return path
+
 @click.group()
 @click.argument("credentials")
 @click.version_option(package_name = "NGPIris")
@@ -85,6 +94,8 @@ def upload(context : Context, bucket : str, source : str, destination : str):
     """
     hcph : HCPHandler = get_HCPHandler(context)
     hcph.mount_bucket(bucket)
+    source = add_trailing_slash(source)
+    destination = add_trailing_slash(destination)
     if Path(source).is_dir():
         hcph.upload_folder(source, destination)
     else:
@@ -198,22 +209,52 @@ def list_buckets(context : Context):
 
 @cli.command()
 @click.argument("bucket")
+@click.argument("path", required = False)
 @click.option(
     "-no", 
     "--name-only", 
     help = "Output only the name of the objects instead of all the associated metadata", 
-    default = False
+    default = False,
+    is_flag = True
+)
+@click.option(
+    "-p",
+    "--pagination",
+    help = "Output as a paginator",
+    default = False,
+    is_flag = True
+)
+@click.option(
+    "-fo", 
+    "--files-only", 
+    help = "Output only file objects", 
+    default = False,
+    is_flag = True
 )
 @click.pass_context
-def list_objects(context : Context, bucket : str, name_only : bool):
+def list_objects(context : Context, bucket : str, path : str, name_only : bool, pagination : bool, files_only : bool):
     """
     List the objects in a certain bucket/namespace on the HCP.
 
     BUCKET is the name of the bucket in which to list its objects.
+
+    PATH is an optional argument for where to list the objects
     """
     hcph : HCPHandler = get_HCPHandler(context)
     hcph.mount_bucket(bucket)
-    click.echo_via_pager(_list_objects_generator(hcph, name_only))
+    if path:
+        path_with_slash = add_trailing_slash(path)
+
+        if not hcph.object_exists(path_with_slash):
+            raise RuntimeError("Path does not exist")
+    else:
+        path_with_slash = ""
+
+    if pagination:
+        click.echo_via_pager(_list_objects_generator(hcph, path_with_slash, name_only, files_only))
+    else:
+        for obj in hcph.list_objects(path_with_slash, name_only, files_only):
+            click.echo(obj)
 
 @cli.command()
 @click.argument("bucket")

NGPIris/hcp/hcp.py

@@ -178,6 +178,8 @@ class HCPHandler:
             pass
         else:
             raise RuntimeError("No bucket selected. Either use `mount_bucket` first or supply the optional `bucket_name` parameter for `test_connection`")
+        
+        response = {}
         try:
             response = dict(self.s3_client.head_bucket(Bucket = bucket_name))
         except EndpointConnectionError as e: # pragma: no cover
@@ -234,7 +236,7 @@ class HCPHandler:
         return list_of_buckets
     
     @check_mounted
-    def list_objects(self, path_key : str = "", name_only : bool = False) -> Generator:
+    def list_objects(self, path_key : str = "", name_only : bool = False, files_only : bool = False) -> Generator:
         """
         List all objects in the mounted bucket as a generator. If one wishes to 
         get the result as a list, use :py:function:`list` to type cast the generator
@@ -243,16 +245,35 @@ class HCPHandler:
         :type path_key: str, optional
         :param name_only: If True, yield only a the object names. If False, yield the full metadata about each object. Defaults to False.
         :type name_only: bool, optional
+        :param files_only: If true, only yield file objects. Defaults to False
+        :type files_only: bool, optional
         :yield: A generator of all objects in a bucket
         :rtype: Generator
         """
         paginator : Paginator = self.s3_client.get_paginator("list_objects_v2")
-        pages : PageIterator = paginator.paginate(Bucket = self.bucket_name)
-        for object in pages.search("Contents[?starts_with(Key, '" + path_key + "')][]"):
-            if name_only:
-                yield str(object["Key"])
-            else:
-                yield object
+        pages : PageIterator = paginator.paginate(Bucket = self.bucket_name, Prefix = path_key)
+
+        if files_only:
+            filter_string = "Contents[?!ends_with(Key, '/')][]"
+        else:
+            filter_string = "Contents[*][]"
+
+        split_path_key = len(path_key.split("/")) + 1
+
+        pages_filtered = pages.search(filter_string)
+        for object in pages_filtered:
+            # Split the object key by "/"
+            split_object = object["Key"].split("/")
+            # Check if the object is within the specified path_key depth
+            if len(split_object) <= split_path_key:
+                # Skip objects that are not at the desired depth
+                if (len(split_object) == split_path_key) and split_object[-1]:
+                    continue
+                
+                if name_only:
+                    yield str(object["Key"])
+                else:
+                    yield object
                     
     @check_mounted
     def get_object(self, key : str) -> dict:
@@ -510,7 +531,6 @@ class HCPHandler:
         """
         return self.fuzzy_search_in_bucket(search_string, name_only, case_sensitive, 100)
         
-
     @check_mounted
     def fuzzy_search_in_bucket(
         self, 
@@ -556,7 +576,7 @@ class HCPHandler:
                 if name_only:
                     yield item
                 else:
-                    yield full_list[index]
+                    yield full_list[index] # type: ignore
 
     @check_mounted
     def get_object_acl(self, key : str) -> dict:

{NGPIris-5.1.1.dev3.dist-info → NGPIris-5.2.0.dev1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: NGPIris
-Version: 5.1.1.dev3
+Version: 5.2.0.dev1
 Author-email: Erik Brink <erik.brink@gu.se>, Isak Sylvin <isak.sylvin@gu.se>
 Description-Content-Type: text/markdown
 License-File: LICENSE

{NGPIris-5.1.1.dev3.dist-info → NGPIris-5.2.0.dev1.dist-info}/RECORD

@@ -1,21 +1,21 @@
 NGPIris/__init__.py,sha256=eHaeRGl1JQ_hjsazEd4oQCXOkdpSxLIzg-ipYAAaa-s,69
-NGPIris/cli/__init__.py,sha256=PaivVdvfSNTeU9eAXLp5OAl6V2LmcAWZDGPvR8jgwH4,11843
+NGPIris/cli/__init__.py,sha256=w2_abrZPDFZb_iX31nqWJUGsbVmE_zFv1vjQeMsP7BE,13003
 NGPIris/hci/__init__.py,sha256=qZRzN2JZp8uIw46TQiqJHMIkleiVDErSoZ3-v0O_cZU,38
 NGPIris/hci/exceptions.py,sha256=wUbpUwY8u1QtuSvnzlBuql9LgGsxBl207IGsHkCt-JQ,47
 NGPIris/hci/hci.py,sha256=-7RBWPGqlINVNsl-GbjuXkcLdIF5cs4cu3OFt2FJi1E,4321
 NGPIris/hci/helpers.py,sha256=THZt9ItmEsEiuvB1v99orAx1oOMgBdGR62PQyOre5yo,2592
 NGPIris/hcp/__init__.py,sha256=yMDW3WpxsU89GNcBJ3ApeGHOmWvisfuuAsZxwlKWnpw,38
 NGPIris/hcp/exceptions.py,sha256=24irbs3JMWaVOM_gf4ByR1hfYPpEP1eXPgHvq77uuqU,361
-NGPIris/hcp/hcp.py,sha256=xYKZYESS6_k3qcU7KpSDss3M3U59jVqSnhOSdr-PV7Q,24738
+NGPIris/hcp/hcp.py,sha256=1GrqqxLT4Z9Vufg4jQoXykJO-UafOhoBYVSgG6mU8Js,25578
 NGPIris/hcp/helpers.py,sha256=SRHX-B6TSDogK7Mz2co7VkzHtZdtMaMeH-_NoDWEDh8,1406
 NGPIris/hcp/statistics.py,sha256=8VgRC-7hWQOCRWwoKk4NHCtGTdY_4C2iHcAHEXKJ0kM,817
 NGPIris/parse_credentials/__init__.py,sha256=O9uq_F9uOtuW7giW-t10KV4VmTgfkvgaBEwQU43Sf-w,57
 NGPIris/parse_credentials/parse_credentials.py,sha256=E1NzQCMvjOa2mGLBkEYshZomNSxfSCkoc_iUhUfpBEM,2106
 NGPIris/utils/__init__.py,sha256=yPCEc1-_7r01dZ-31EKiA7Jova7ztX7XXuU95IKmKX8,59
 NGPIris/utils/utils.py,sha256=m9qwLuOoiqVNRy7B4raYNFJkigL_wE--PiWhyhVhHII,248
-NGPIris-5.1.1.dev3.dist-info/LICENSE,sha256=ZA2Q9u5AEkH_YoNNDRsz-DBJ6ZuL_foE7RsKFjXd4-c,18093
-NGPIris-5.1.1.dev3.dist-info/METADATA,sha256=opGIL9MCWMxgEANG02bnvGPJUtz8Gyc-qs7omOoJPTk,7080
-NGPIris-5.1.1.dev3.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-NGPIris-5.1.1.dev3.dist-info/entry_points.txt,sha256=t8ADhe3ovPm9tW3XDZq1_vKmfHY98Ei_o6WioJobNzU,117
-NGPIris-5.1.1.dev3.dist-info/top_level.txt,sha256=954WCuIJkle_SMtr7MNPapiiLLAFhlKbcz6Bp89-2V0,8
-NGPIris-5.1.1.dev3.dist-info/RECORD,,
+NGPIris-5.2.0.dev1.dist-info/LICENSE,sha256=ZA2Q9u5AEkH_YoNNDRsz-DBJ6ZuL_foE7RsKFjXd4-c,18093
+NGPIris-5.2.0.dev1.dist-info/METADATA,sha256=Wd5zaHozIbbbCxyYrlx8ScOJ_wfvCxElv2_OOe2Xq-4,7080
+NGPIris-5.2.0.dev1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+NGPIris-5.2.0.dev1.dist-info/entry_points.txt,sha256=t8ADhe3ovPm9tW3XDZq1_vKmfHY98Ei_o6WioJobNzU,117
+NGPIris-5.2.0.dev1.dist-info/top_level.txt,sha256=954WCuIJkle_SMtr7MNPapiiLLAFhlKbcz6Bp89-2V0,8
+NGPIris-5.2.0.dev1.dist-info/RECORD,,