voxcity 0.6.15__py3-none-any.whl → 0.7.0__py3-none-any.whl

voxcity/downloader/utils.py

@@ -1,74 +1,74 @@
-# Utility functions for downloading files from various sources
-import requests
-import gdown
-
-def download_file(url, filename):
-    """Download a file from a URL and save it locally.
-    
-    This function uses the requests library to download a file from any publicly 
-    accessible URL and save it to the local filesystem. It handles the download 
-    process and provides feedback on the operation's success or failure.
-    
-    Args:
-        url (str): URL of the file to download. Must be a valid, accessible URL.
-        filename (str): Local path where the downloaded file will be saved.
-                       Include the full path and filename with extension.
-        
-    Returns:
-        None
-        
-    Prints:
-        - Success message with filename if download is successful (status code 200)
-        - Error message with status code if download fails
-        
-    Example:
-        >>> download_file('https://example.com/file.pdf', 'local_file.pdf')
-        File downloaded successfully and saved as local_file.pdf
-    """
-    # Attempt to download the file from the provided URL
-    response = requests.get(url)
-    
-    # Check if the download was successful (HTTP status code 200)
-    if response.status_code == 200:
-        # Open the local file in binary write mode and save the content
-        with open(filename, 'wb') as file:
-            file.write(response.content)
-        print(f"File downloaded successfully and saved as {filename}")
-    else:
-        print(f"Failed to download file. Status code: {response.status_code}")
-
-def download_file_google_drive(file_id, output_path):
-    """Download a file from Google Drive using its file ID.
-    
-    This function specifically handles downloads from Google Drive using the gdown
-    library, which is designed to bypass Google Drive's download restrictions.
-    It's useful for downloading large files or files that require authentication.
-    
-    Args:
-        file_id (str): Google Drive file ID. This is the unique identifier in the 
-                       sharing URL after '/d/' or 'id='.
-        output_path (str): Local path where the downloaded file will be saved.
-                          Include the full path and filename with extension.
-        
-    Returns:
-        bool: True if download was successful, False if any error occurred
-        
-    Prints:
-        Error message with exception details if download fails
-        
-    Example:
-        >>> success = download_file_google_drive('1234abcd...', 'downloaded_file.zip')
-        >>> if success:
-        >>>     print("Download completed successfully")
-    """
-    # Construct the direct download URL using the file ID
-    url = f"https://drive.google.com/uc?id={file_id}"
-    
-    try:
-        # Use gdown to handle the Google Drive download
-        # quiet=False enables download progress display
-        gdown.download(url, output_path, quiet=False)
-        return True
-    except Exception as e:
-        print(f"Error downloading file {file_id}: {str(e)}")
+# Utility functions for downloading files from various sources
+import requests
+import gdown
+
+def download_file(url, filename):
+    """Download a file from a URL and save it locally.
+    
+    This function uses the requests library to download a file from any publicly 
+    accessible URL and save it to the local filesystem. It handles the download 
+    process and provides feedback on the operation's success or failure.
+    
+    Args:
+        url (str): URL of the file to download. Must be a valid, accessible URL.
+        filename (str): Local path where the downloaded file will be saved.
+                       Include the full path and filename with extension.
+        
+    Returns:
+        None
+        
+    Prints:
+        - Success message with filename if download is successful (status code 200)
+        - Error message with status code if download fails
+        
+    Example:
+        >>> download_file('https://example.com/file.pdf', 'local_file.pdf')
+        File downloaded successfully and saved as local_file.pdf
+    """
+    # Attempt to download the file from the provided URL
+    response = requests.get(url)
+    
+    # Check if the download was successful (HTTP status code 200)
+    if response.status_code == 200:
+        # Open the local file in binary write mode and save the content
+        with open(filename, 'wb') as file:
+            file.write(response.content)
+        print(f"File downloaded successfully and saved as {filename}")
+    else:
+        print(f"Failed to download file. Status code: {response.status_code}")
+
+def download_file_google_drive(file_id, output_path):
+    """Download a file from Google Drive using its file ID.
+    
+    This function specifically handles downloads from Google Drive using the gdown
+    library, which is designed to bypass Google Drive's download restrictions.
+    It's useful for downloading large files or files that require authentication.
+    
+    Args:
+        file_id (str): Google Drive file ID. This is the unique identifier in the 
+                       sharing URL after '/d/' or 'id='.
+        output_path (str): Local path where the downloaded file will be saved.
+                          Include the full path and filename with extension.
+        
+    Returns:
+        bool: True if download was successful, False if any error occurred
+        
+    Prints:
+        Error message with exception details if download fails
+        
+    Example:
+        >>> success = download_file_google_drive('1234abcd...', 'downloaded_file.zip')
+        >>> if success:
+        >>>     print("Download completed successfully")
+    """
+    # Construct the direct download URL using the file ID
+    url = f"https://drive.google.com/uc?id={file_id}"
+    
+    try:
+        # Use gdown to handle the Google Drive download
+        # quiet=False enables download progress display
+        gdown.download(url, output_path, quiet=False)
+        return True
+    except Exception as e:
+        print(f"Error downloading file {file_id}: {str(e)}")
         return False

voxcity/errors.py

@@ -0,0 +1,30 @@
+"""
+Package-specific error hierarchy for voxcity.
+
+This enables precise exception handling without leaking low-level
+implementation details across boundaries.
+"""
+
+from __future__ import annotations
+
+
+class VoxCityError(Exception):
+    """Base exception for all voxcity errors."""
+
+
+class ConfigurationError(VoxCityError):
+    """Raised when configuration values are missing or invalid."""
+
+
+class DownloaderError(VoxCityError):
+    """Raised by downloader modules when remote data retrieval fails."""
+
+
+class ProcessingError(VoxCityError):
+    """Raised for failures during grid/voxel processing or geoprocessing."""
+
+
+class VisualizationError(VoxCityError):
+    """Raised for visualization/rendering failures."""
+
+

voxcity/exporter/__init__.py

@@ -1,4 +1,13 @@
-from .envimet import *
-from .magicavoxel import *
-from .obj import *
-from .cityles import *
+from typing import Protocol, runtime_checkable
+
+from .envimet import *
+from .magicavoxel import *
+from .obj import *
+from .cityles import *
+from .netcdf import *
+
+
+@runtime_checkable
+class Exporter(Protocol):
+    def export(self, obj, output_directory: str, base_filename: str):  # pragma: no cover - protocol
+        ...