figpack 0.2.34__py3-none-any.whl → 0.2.36__py3-none-any.whl

figpack/__init__.py

@@ -2,7 +2,7 @@
 figpack - A Python package for creating shareable, interactive visualizations in the browser
 """
 
-__version__ = "0.2.34"
+__version__ = "0.2.36"
 
 from .cli import view_figure
 from .core import FigpackView, FigpackExtension, ExtensionView

figpack/cli.py

@@ -249,6 +249,64 @@ def handle_extensions_command(args):
         print("Use 'figpack extensions <command> --help' for more information.")
 
 
+def download_and_view_archive(url: str, port: int = None) -> None:
+    """
+    Download a tar.gz/tgz archive from a URL and view it
+
+    Args:
+        url: URL to the tar.gz or tgz file
+        port: Optional port number to serve on
+    """
+    if not (url.endswith(".tar.gz") or url.endswith(".tgz")):
+        print(f"Error: URL must point to a .tar.gz or .tgz file: {url}")
+        sys.exit(1)
+
+    print(f"Downloading archive from: {url}")
+
+    try:
+        response = requests.get(url, timeout=60, stream=True)
+        response.raise_for_status()
+
+        # Create a temporary file to store the downloaded archive
+        with tempfile.NamedTemporaryFile(suffix=".tar.gz", delete=False) as temp_file:
+            temp_path = temp_file.name
+
+            # Download with progress indication
+            total_size = int(response.headers.get("content-length", 0))
+            downloaded_size = 0
+
+            for chunk in response.iter_content(chunk_size=8192):
+                if chunk:
+                    temp_file.write(chunk)
+                    downloaded_size += len(chunk)
+                    if total_size > 0:
+                        progress = (downloaded_size / total_size) * 100
+                        print(
+                            f"Downloaded: {downloaded_size / (1024*1024):.2f} MB ({progress:.1f}%)",
+                            end="\r",
+                        )
+
+            if total_size > 0:
+                print()  # New line after progress
+            print(f"Download complete: {downloaded_size / (1024*1024):.2f} MB")
+
+        # Now view the downloaded file
+        try:
+            view_figure(temp_path, port=port)
+        finally:
+            # Clean up the temporary file after viewing
+            import os
+
+            try:
+                os.unlink(temp_path)
+            except Exception:
+                pass
+
+    except requests.exceptions.RequestException as e:
+        print(f"Error: Failed to download archive from {url}: {e}")
+        sys.exit(1)
+
+
 def main():
     """Main CLI entry point"""
     parser = argparse.ArgumentParser(
@@ -270,7 +328,7 @@ def main():
     view_parser = subparsers.add_parser(
         "view", help="Extract and serve a figure archive locally"
     )
-    view_parser.add_argument("archive", help="Path to the tar.gz archive file")
+    view_parser.add_argument("archive", help="Path or URL to the tar.gz archive file")
     view_parser.add_argument(
         "--port", type=int, help="Port number to serve on (default: auto-select)"
     )
@@ -317,7 +375,11 @@ def main():
     if args.command == "download":
         download_figure(args.figure_url, args.dest)
     elif args.command == "view":
-        view_figure(args.archive, port=args.port)
+        # Check if archive argument is a URL
+        if args.archive.startswith("http://") or args.archive.startswith("https://"):
+            download_and_view_archive(args.archive, port=args.port)
+        else:
+            view_figure(args.archive, port=args.port)
     elif args.command == "extensions":
         handle_extensions_command(args)
     else:

figpack/core/_bundle_utils.py

@@ -1,7 +1,7 @@
 import os
 import pathlib
 import json
-from typing import Set
+from typing import Optional, List
 
 import zarr
 
@@ -14,7 +14,7 @@ thisdir = pathlib.Path(__file__).parent.resolve()
 
 
 def prepare_figure_bundle(
-    view: FigpackView, tmpdir: str, *, title: str, description: str = None
+    view: FigpackView, tmpdir: str, *, title: str, description: Optional[str] = None
 ) -> None:
     """
     Prepare a figure bundle in the specified temporary directory.
@@ -51,8 +51,8 @@ def prepare_figure_bundle(
     # because we only support version 2 on the frontend right now.
 
     if _check_zarr_version() == 3:
-        old_default_zarr_format = zarr.config.get("default_zarr_format")
-        zarr.config.set({"default_zarr_format": 2})
+        old_default_zarr_format = zarr.config.get("default_zarr_format")  # type: ignore
+        zarr.config.set({"default_zarr_format": 2})  # type: ignore
 
     try:
         # Write the view data to the Zarr group
@@ -80,7 +80,7 @@ def prepare_figure_bundle(
         _remove_metadata_files_except_consolidated(pathlib.Path(tmpdir) / "data.zarr")
     finally:
         if _check_zarr_version() == 3:
-            zarr.config.set({"default_zarr_format": old_default_zarr_format})
+            zarr.config.set({"default_zarr_format": old_default_zarr_format})  # type: ignore
 
 
 def _remove_metadata_files_except_consolidated(zarr_dir: pathlib.Path) -> None:
@@ -107,7 +107,7 @@ def _remove_metadata_files_except_consolidated(zarr_dir: pathlib.Path) -> None:
                     print(f"Warning: could not remove file {file_path}: {e}")
 
 
-def _discover_required_extensions(view: FigpackView) -> Set[str]:
+def _discover_required_extensions(view: FigpackView) -> List[str]:
     """
     Recursively discover all extensions required by a view and its children
 

figpack/core/_file_handler.py

@@ -187,6 +187,6 @@ class FileUploadCORSRequestHandler(CORSRequestHandler):
             self.send_error(500, f"Internal Server Error: {str(e)}")
             return False
 
-    def log_message(self, fmt, *args):
+    def log_message(self, format, *args):
         """Override to suppress default logging (same as parent class)."""
         pass

figpack/core/_save_figure.py

@@ -15,9 +15,9 @@ def _save_figure(
         view: FigpackView instance to save
         output_path: Output path (destination folder or .tar.gz file path)
     """
-    output_path = pathlib.Path(output_path)
-    if (output_path.suffix == ".gz" and output_path.suffixes[-2] == ".tar") or (
-        output_path.suffix == ".tgz"
+    output_path_2 = pathlib.Path(output_path)
+    if (output_path_2.suffix == ".gz" and output_path_2.suffixes[-2] == ".tar") or (
+        output_path_2.suffix == ".tgz"
     ):
         # It's a .tar.gz file
         with tempfile.TemporaryDirectory(prefix="figpack_save_") as tmpdir:
@@ -25,11 +25,11 @@ def _save_figure(
             # Create tar.gz file
             import tarfile
 
-            with tarfile.open(output_path, "w:gz") as tar:
+            with tarfile.open(output_path_2, "w:gz") as tar:
                 tar.add(tmpdir, arcname=".")
     else:
         # It's a folder
-        output_path.mkdir(parents=True, exist_ok=True)
+        output_path_2.mkdir(parents=True, exist_ok=True)
         prepare_figure_bundle(
-            view, str(output_path), title=title, description=description
+            view, str(output_path_2), title=title, description=description
         )

figpack/core/_server_manager.py

@@ -45,7 +45,7 @@ class CORSRequestHandler(SimpleHTTPRequestHandler):
         """Reject PUT requests when file upload is not enabled."""
         self.send_error(405, "Method Not Allowed")
 
-    def log_message(self, fmt, *args):
+    def log_message(self, format, *args):
         pass
 
 
@@ -189,6 +189,7 @@ class ProcessServerManager:
             and self._server_thread.is_alive()
             and (allow_origin is None or self._allow_origin == allow_origin)
         ):
+            assert self._port is not None
             return f"http://localhost:{self._port}", self._port
 
         # Stop existing server if settings are incompatible
@@ -209,7 +210,7 @@ class ProcessServerManager:
         if enable_file_upload:
             from ._file_handler import FileUploadCORSRequestHandler
 
-            def handler_factory(*args, **kwargs):
+            def handler_factory_enable_upload(*args, **kwargs):
                 return FileUploadCORSRequestHandler(
                     *args,
                     directory=str(temp_dir),
@@ -219,6 +220,11 @@ class ProcessServerManager:
                     **kwargs,
                 )
 
+            assert port is not None
+            self._server = ThreadingHTTPServer(
+                ("0.0.0.0", port), handler_factory_enable_upload
+            )
+
         else:
 
             def handler_factory(*args, **kwargs):
@@ -226,7 +232,8 @@ class ProcessServerManager:
                     *args, directory=str(temp_dir), allow_origin=allow_origin, **kwargs
                 )
 
-        self._server = ThreadingHTTPServer(("0.0.0.0", port), handler_factory)
+            assert port is not None
+            self._server = ThreadingHTTPServer(("0.0.0.0", port), handler_factory)
         self._port = port
         self._allow_origin = allow_origin
 

figpack/core/_show_view.py

@@ -19,7 +19,7 @@ def _is_in_notebook() -> bool:
     """
     try:
         # Check if IPython is available and we're in a notebook
-        from IPython import get_ipython
+        from IPython import get_ipython  # type: ignore
 
         ipython = get_ipython()
         if ipython is None:

figpack/core/_upload_bundle.py

@@ -1,3 +1,4 @@
+from typing import Optional, Union
 import hashlib
 import json
 import pathlib
@@ -114,6 +115,7 @@ def _upload_single_file_with_signed_url(
         else:
             break
 
+    assert last_exception is not None
     raise last_exception
 
 
@@ -154,10 +156,10 @@ def _compute_deterministic_figure_hash(tmpdir_path: pathlib.Path) -> str:
 
 def _create_or_get_figure(
     figure_hash: str,
-    api_key: str,
-    total_files: int = None,
-    total_size: int = None,
-    title: str = None,
+    api_key: Optional[str],
+    total_files: Optional[int] = None,
+    total_size: Optional[int] = None,
+    title: Optional[str] = None,
     ephemeral: bool = False,
 ) -> dict:
     """
@@ -178,7 +180,7 @@ def _create_or_get_figure(
     if not ephemeral and api_key is None:
         raise ValueError("API key is required for non-ephemeral figures")
 
-    payload = {
+    payload: dict[str, Union[str, int]] = {
         "figureHash": figure_hash,
         "figpackVersion": __version__,
         "bucket": FIGPACK_BUCKET,
@@ -252,8 +254,8 @@ def _finalize_figure(figure_url: str, api_key: str) -> dict:
 
 def _upload_bundle(
     tmpdir: str,
-    api_key: str,
-    title: str = None,
+    api_key: Optional[str],
+    title: Optional[str] = None,
     ephemeral: bool = False,
     use_consolidated_metadata_only: bool = False,
 ) -> str:
@@ -329,7 +331,9 @@ def _upload_bundle(
 
             # Get signed URLs for this batch
             try:
-                signed_urls_map = _get_batch_signed_urls(figure_url, batch, api_key)
+                signed_urls_map = _get_batch_signed_urls(
+                    figure_url, batch, api_key if api_key else ""
+                )
             except Exception as e:
                 print(f"Failed to get signed URLs for batch {batch_num}: {e}")
                 raise
@@ -400,7 +404,9 @@ def _upload_bundle(
     try:
         # Use batch API for manifest
         manifest_batch = [("manifest.json", temp_file_path)]
-        signed_urls_map = _get_batch_signed_urls(figure_url, manifest_batch, api_key)
+        signed_urls_map = _get_batch_signed_urls(
+            figure_url, manifest_batch, api_key if api_key else ""
+        )
 
         if "manifest.json" not in signed_urls_map:
             raise Exception("No signed URL returned for manifest.json")
@@ -418,7 +424,7 @@ def _upload_bundle(
 
     # Finalize the figure upload
     print("Finalizing figure...")
-    _finalize_figure(figure_url, api_key)
+    _finalize_figure(figure_url, api_key if api_key else "")
     print("Upload completed successfully")
 
     return figure_url

figpack/core/_view_figure.py

@@ -34,10 +34,10 @@ def serve_files(
         enable_file_upload: Whether to enable PUT requests for file uploads
         max_file_size: Maximum file size in bytes for uploads (default 10MB)
     """
-    tmpdir = pathlib.Path(tmpdir)
-    tmpdir = tmpdir.resolve()
-    if not tmpdir.exists() or not tmpdir.is_dir():
-        raise SystemExit(f"Directory not found: {tmpdir}")
+    tmpdir_2 = pathlib.Path(tmpdir)
+    tmpdir_2 = tmpdir_2.resolve()
+    if not tmpdir_2.exists() or not tmpdir_2.is_dir():
+        raise SystemExit(f"Directory not found: {tmpdir_2}")
 
     # Create a temporary server manager instance for this specific directory
     # Note: We can't use the singleton ProcessServerManager here because it serves
@@ -56,29 +56,34 @@ def serve_files(
     # Choose handler based on file upload requirement
     if enable_file_upload:
 
-        def handler_factory(*args, **kwargs):
+        def handler_factory_upload_enabled(*args, **kwargs):
             return FileUploadCORSRequestHandler(
                 *args,
-                directory=str(tmpdir),
+                directory=str(tmpdir_2),
                 allow_origin=allow_origin,
                 enable_file_upload=True,
                 max_file_size=max_file_size,
                 **kwargs,
             )
 
-        upload_status = " (file upload enabled)" if enable_file_upload else ""
+        upload_status = (
+            " (file upload enabled)" if handler_factory_upload_enabled else ""
+        )
+
+        httpd = ThreadingHTTPServer(("0.0.0.0", port), handler_factory_upload_enabled)  # type: ignore
     else:
 
         def handler_factory(*args, **kwargs):
             return CORSRequestHandler(
-                *args, directory=str(tmpdir), allow_origin=allow_origin, **kwargs
+                *args, directory=str(tmpdir_2), allow_origin=allow_origin, **kwargs
             )
 
         upload_status = ""
 
-    httpd = ThreadingHTTPServer(("0.0.0.0", port), handler_factory)
+        httpd = ThreadingHTTPServer(("0.0.0.0", port), handler_factory)  # type: ignore
+
     print(
-        f"Serving {tmpdir} at http://localhost:{port} (CORS → {allow_origin}){upload_status}"
+        f"Serving {tmpdir_2} at http://localhost:{port} (CORS → {allow_origin}){upload_status}"
     )
     thread = threading.Thread(target=httpd.serve_forever, daemon=True)
     thread.start()

figpack/core/extension_view.py

@@ -2,9 +2,13 @@
 Base class for views that use figpack extensions
 """
 
+from typing import TYPE_CHECKING
+
 from .figpack_view import FigpackView
-from .figpack_extension import FigpackExtension
-from ..core.zarr import Group
+
+if TYPE_CHECKING:
+    from .figpack_extension import FigpackExtension
+    from .zarr import Group
 
 
 class ExtensionView(FigpackView):
@@ -12,7 +16,7 @@ class ExtensionView(FigpackView):
     Base class for views that are rendered by figpack extensions
     """
 
-    def __init__(self, *, extension: FigpackExtension, view_type: str):
+    def __init__(self, *, extension: "FigpackExtension", view_type: str) -> None:
         """
         Initialize an extension-based view
 
@@ -23,7 +27,7 @@ class ExtensionView(FigpackView):
         self.extension = extension
         self.view_type = view_type
 
-    def write_to_zarr_group(self, group: Group) -> None:
+    def write_to_zarr_group(self, group: "Group") -> None:
         """
         Write the extension view metadata to a Zarr group.
         Subclasses should call super().write_to_zarr_group(group) first,

figpack/core/figpack_extension.py

@@ -17,7 +17,7 @@ class FigpackExtension:
         javascript_code: str,
         additional_files: Optional[Dict[str, str]] = None,
         version: str = "1.0.0",
-    ):
+    ) -> None:
         """
         Initialize a figpack extension
 

figpack/core/figpack_view.py

@@ -5,7 +5,7 @@ Base view class for figpack visualization components
 import os
 import random
 import string
-from typing import Union
+from typing import Optional
 
 from .zarr import Group
 
@@ -19,17 +19,17 @@ class FigpackView:
         self,
         *,
         title: str,
-        description: Union[str, None] = None,
-        port: Union[int, None] = None,
-        open_in_browser: Union[bool, None] = None,
-        upload: Union[bool, None] = None,
-        inline: Union[bool, None] = None,
+        description: Optional[str] = None,
+        port: Optional[int] = None,
+        open_in_browser: Optional[bool] = None,
+        upload: Optional[bool] = None,
+        inline: Optional[bool] = None,
         inline_height: int = 600,
-        ephemeral: Union[bool, None] = None,
-        allow_origin: Union[str, None] = None,
-        wait_for_input: Union[bool, None] = None,
-        _dev: Union[bool, None] = None,
-    ):
+        ephemeral: Optional[bool] = None,
+        allow_origin: Optional[str] = None,
+        wait_for_input: Optional[bool] = None,
+        _dev: Optional[bool] = None,
+    ) -> None:
         """
         Display a figpack view component with intelligent environment detection and flexible display options.
         See https://flatironinstitute.github.io/figpack/show_function.html for complete documentation.
@@ -86,6 +86,8 @@ class FigpackView:
                 inline = False
             elif _is_in_notebook() and not upload:
                 inline = True
+            else:
+                inline = False
 
         # determine open_in_browser
         if open_in_browser is None:
@@ -111,13 +113,19 @@ class FigpackView:
                     upload = True
                     ephemeral = True
 
+        if ephemeral is None:
+            ephemeral = False
+
+        if upload is None:
+            upload = False
+
         # determine _dev
         if _dev is None:
             _dev = os.environ.get("FIGPACK_DEV") == "1"
 
         if port is None and os.environ.get("FIGPACK_PORT"):
             try:
-                port = int(os.environ.get("FIGPACK_PORT"))
+                port = int(os.environ.get("FIGPACK_PORT", ""))
             except Exception:
                 pass
 
@@ -129,6 +137,8 @@ class FigpackView:
         if ephemeral and not upload:
             raise ValueError("ephemeral=True requires upload=True to be set")
 
+        _local_figure_name: Optional[str] = None
+
         if _dev:
             if open_in_browser:
                 print("** Note: In dev mode, open_in_browser is forced to False **")

figpack/core/zarr.py

@@ -33,13 +33,13 @@ class Group:
         if _check_zarr_version() == 2:
             self._zarr_group.create_dataset(name, **kwargs)
         elif _check_zarr_version() == 3:
-            self._zarr_group.create_array(name, **kwargs)
+            self._zarr_group.create_array(name, **kwargs)  # type: ignore
         else:
             raise RuntimeError("Unsupported Zarr version")
 
     @property
     def attrs(self) -> Dict[str, Any]:
-        return self._zarr_group.attrs
+        return self._zarr_group.attrs  # type: ignore
 
     def __getitem__(self, key: str) -> Any:
         return self._zarr_group[key]