megadetector 5.0.7__py3-none-any.whl → 5.0.9__py3-none-any.whl

md_utils/directory_listing.py

@@ -1,22 +1,14 @@
-########
-#
-# directory_listing.py
-#
-# Script for creating HTML directory listings for a local directory and
-# all its subdirectories.  Primarily intended for use on mounted blob
-# containers, so it includes the ability to set the content-type property
-# on the generated html using the blob SDK, so it can be browser-viewable.
-#
-# Also includes a preview of a jpg file (the first in an alphabetical list),
-# if present.
-#
-# Sample invocation:
-#
-# python directory_listing.py /naipout/v002 --basepath /naipout/v002 \
-#   --enable_overwrite \
-#   --sas_url "https://naipblobs.blob.core.windows.net/naip/v002?sv=..."
-#
-########
+"""
+
+directory_listing.py
+
+Script for creating Apache-style HTML directory listings for a local directory 
+and all its subdirectories.
+
+Also includes a preview of a jpg file (the first in an alphabetical list),
+if present.
+
+"""
 
 #%% Imports
 
@@ -28,39 +20,26 @@ import re
 import azure.common
 from azure.storage.blob import BlobServiceClient, ContentSettings
 
+from md_utils.path_utils import is_image_file
 
-#%% Directory enumeration functions
-
-def is_image_file(path):
-    """
-    Checks whether the provided file path points to an image by checking the
-    file extension. The following file extensions are considered images: jpg,
-    jpeg.  The check is case-insensitive.
-
-    Args:
-        path: string, path to image file or just the file name
-
-    Returns:
-        boolean, True if the file is an image
-    """
-
-    return os.path.splitext(path)[1].lower()[1:] in ['jpg', 'jpeg'] #, 'gif', 'tiff', 'tif', 'png']
 
+#%% Directory enumeration functions
 
 def create_plain_index(root, dirs, files, dirname=None):
     """
-    Creates the fairly plain HTML folder index
-    including a preview of a single image file, if any is present.
-    Returns the HTML source as string.
+    Creates the fairly plain HTML folder index including a preview of a single image file, 
+    if any is present.
 
     Args:
-        root: string, path to the root directory, all paths in *dirs* and
-            *files* are relative to this one
-        dirs: list of strings, the directories in *root*
-        files: list of string, the files in *root*
-        dirname: name to print in the html, which may be different than *root*
-
-    Returns: HTML source of the directory listing
+        root (str): path to the root directory, all paths in [dirs] and
+            [files] are relative to this root folder
+        dirs (list): list of strings, the directories in [root]
+        files (list): list of strings, the files in [root]
+        dirname (str, optional): name to print in the html, 
+            which may be different than [root]
+
+    Returns: 
+        str: HTML source of the directory listing
     """
 
     if dirname is None:
@@ -128,25 +107,31 @@ def create_plain_index(root, dirs, files, dirname=None):
     html += "</body></html>\n"
     return html
 
+# ...def create_plain_index(...)
+
 
 def traverse_and_create_index(dir, sas_url=None, overwrite_files=False,
                               template_fun=create_plain_index, basepath=None):
     """
-    Recursively traverses the local directory *dir* and generates a index
-    file for each folder using *template_fun* to generate the HTML output.
+    Recursively traverses the local directory [dir] and generates a index
+    file for each folder using [template_fun] to generate the HTML output.
     Excludes hidden files.
 
     Args:
-        dir: string, path to directory
-        template_fun: function taking three arguments (string, list of string, list of string)
-            representing the current root, the list of folders, and the list of files.
-            Should return the HTML source of the index file
-
-    Return:
-        None
+        dir (str): directory to process
+        sas_url (str, optional): write-capable SAS URL that points to the same place as 
+            [dir], used for the very esoteric scenario where [dir] is really a mounted
+            blob container, and we want to set the content-type on each file so the resulting
+            index can be viewed in a browser
+        overwrite_files (bool, optional): whether to over-write existing index file
+        template_fun (func, optional): function taking three arguments (string, 
+            list of string, list of string) representing the current root, the list of folders, 
+            and the list of files.  Should return the HTML source of the index file.
+        basepath (str, optional): if not None, the name used for each subfolder in [dir]
+            in the output files will be relative to [basepath]
     """
 
-    print("Traversing {}".format(dir))
+    print('Traversing {}'.format(dir))
 
     # Make sure we remove the trailing /
     dir = os.path.normpath(dir)
@@ -222,19 +207,26 @@ def traverse_and_create_index(dir, sas_url=None, overwrite_files=False,
                 print('ERROR: It seems the SAS URL is incorrect or does not allow setting properties.')
                 return
 
+# ...def traverse_and_create_index(...)
 
-#%% Command-line driver
 
-if __name__ == '__main__':
+#%% Command-line driver
 
+def main():
+    
     parser = argparse.ArgumentParser()
-    parser.add_argument("directory", type=str, help='Path to directory which should be traversed.')
-    parser.add_argument("--basepath", type=str, help='Folder names will be printed relative to basepath, if specified', default=None)
-    parser.add_argument("--sas_url", type=str, help='Blobfuse does not set the content-type property ' + \
-        'properly and hence index.html won\'t be accessible in the browser. If you want to set the ' + \
-        'content-type in the corresponding blob storage, provide the SAS URL that corresponds to the ' + \
-        "directory, e.g. if *directory* is /mountpoint/path/to/folder, then *--sas_url* looks like " + \
-        "'https://accname.blob.core.windows.net/bname/path/to/folder?st=...&se=...&sp=...&...'")
+    
+    parser.add_argument("directory", type=str, 
+                        help='Path to directory which should be traversed.')
+    parser.add_argument("--basepath", type=str, 
+                        help='Folder names will be printed relative to basepath, if specified', 
+                        default=None)
+    parser.add_argument("--sas_url", type=str, 
+                        help='Blobfuse does not set the content-type property ' + \
+                             'properly and hence index.html won\'t be accessible in the browser. If you want to set the ' + \
+                              'content-type in the corresponding blob storage, provide the SAS URL that corresponds to the ' + \
+                              'directory, e.g. if *directory* is /mountpoint/path/to/folder, then *--sas_url* looks like ' + \
+                              '"https://accname.blob.core.windows.net/bname/path/to/folder?st=...&se=...&sp=...&..."')
     parser.add_argument("--enable_overwrite", action='store_true', default=False,
                         help='If set, the script will overwrite existing index.html files.')
 
@@ -249,3 +241,6 @@ if __name__ == '__main__':
         "match the format https://accname.blob.core.windows.net/bname/path/to/folder?..."
 
     traverse_and_create_index(args.directory, overwrite_files=args.enable_overwrite, sas_url=args.sas_url, basepath=args.basepath)
+
+if __name__ == '__main__':
+    main()