pygeobox 1.0.0__py3-none-any.whl

pygeobox/task.py

@@ -0,0 +1,354 @@
+from urllib.parse import urljoin, urlencode
+from typing import Optional, Dict, List, Optional, Union, TYPE_CHECKING
+import time
+
+from .base import Base
+from .enums import TaskStatus
+
+if TYPE_CHECKING:
+    from . import GeoboxClient
+    from .vectorlayer import VectorLayer
+    from .raster import Raster
+    from .model3d import Model
+
+class Task(Base):
+    """
+    A class to represent a task in Geobox.
+
+    This class provides functionality to interact with tasks in Geobox.
+    It supports various operations including getting tasks, as well as advanced operations like waiting for a task to finish.
+    It also provides properties to access the task data, and a method to abort the task.
+    """
+    BASE_ENDPOINT: str = 'tasks/'
+
+    def __init__(self, 
+                 api: 'GeoboxClient', 
+                 uuid: str, 
+                 data: Optional[Dict] = {}):
+        """
+        Constructs all the necessary attributes for the Task object.
+
+        Args:
+            api (GeoboxClient): The API instance.
+            uuid (str): The UUID of the task.
+            data (Dict, optional): The task data.
+        """
+        super().__init__(api, uuid=uuid, data=data)
+        self._data = data if isinstance(data, dict) else {}
+
+
+    def refresh_data(self) -> None:
+        """
+        Updates the task data.
+        """
+        self._data = self.get_task(self.api, self.uuid).data
+
+
+    @property
+    def publised_asset(self) -> Union['VectorLayer', 'Raster', 'Model', None]:
+        """
+        Published asset property
+
+        Returns:
+            VectorLayer | Raster | Model | None: if task type is publish, it returns the published layer
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.task import Task
+            >>> client = GeoboxClient()
+            >>> task = Task.get_task(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> task.publised_asset
+        """
+        if self.name == 'import:publish-file-to-raster-dataset':
+            return self.api.get_raster(uuid=self.data['result']['raster_uuid'])
+        elif self.name == 'import:publish-file-to-vector-layer':
+            return self.api.get_vector(uuid=self.data['result']['layer_uuid'])
+        elif self.name == 'import:publish-file-to-3d-model':
+            return self.api.get_model(uuid=self.data['result']['model_uuid'])
+        else:
+            return None
+
+
+    @property
+    def data(self) -> Dict:
+        """
+        Returns the task data.
+
+        Returns:
+            Dict: the task data as a dictionary
+            
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.task import Task
+            >>> client = GeoboxClient()
+            >>> task = Task.get_task(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> task.data
+        """
+        return self._data
+    
+
+    @data.setter
+    def data(self, value: Dict) -> None:
+        """
+        Sets the task data.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.task import Task
+            >>> client = GeoboxClient()
+            >>> task = Task.get_task(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> task.data = {'name': 'test'}
+        """
+        self._data = value if isinstance(value, dict) else {}
+    
+
+    @property
+    def status(self) -> 'TaskStatus':
+        """
+        Returns the status of the task. (auto refresh)
+
+        Returns:
+            TaskStatus: the status of the task(SUCCESS, FAILURE, ABORTED, PENDING, PROGRESS)
+        
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.task import Task
+            >>> client = GeoboxClient()
+            >>> task = Task.get_task(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> task.status
+        """
+        self.refresh_data()
+        return TaskStatus(self._data.get('state'))
+
+
+    @property
+    def errors(self) -> Union[Dict, None]:
+        """
+        Get the task errors.
+
+        Returns:
+            Dict | None: if there are any errors
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.task import Task
+            >>> client = GeoboxClient()
+            >>> task = Task.get_task(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> task.errors    
+        """
+        result = self.data.get('result', {})
+        if result.get('errors') or result.get('detail', {}).get('msg'):
+            return result
+        else: 
+            return None
+
+
+    @property
+    def progress(self) -> Union[int, None]:
+        """
+        Returns the progress of the task.
+
+        Returns:
+            int | None: the progress of the task in percentage or None if the task is not running
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.task import Task
+            >>> client = GeoboxClient()
+            >>> task = Task.get_task(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> task.progress
+        """
+        endpoint = urljoin(self.endpoint, 'status/')
+        response = self.api.get(endpoint)
+        
+        current = response.get('current')
+        total = response.get('total')
+        if not total or not current:
+            return None
+        
+        return int((current / total) * 100)
+
+
+    def wait(self, timeout: Union[int, None] = None, interval: int = 1, progress_bar: bool = True) -> 'TaskStatus':
+        """
+        Wait for the task to finish.
+        
+        Args:
+            timeout (int, optional): Maximum time to wait in seconds.
+            interval (int, optional): Time between status checks in seconds.
+            progress_bar (bool, optional): Whether to show a progress bar. default: True
+            
+        Returns:
+            TaskStatus: the status of the task(SUCCESS, FAILURE, ABORTED, PENDING, PROGRESS)
+            
+        Raises:
+            TimeoutError: If the task doesn't complete within timeout seconds.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.task import Task
+            >>> client = GeoboxClient()
+            >>> task = Task.get_task(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> task.wait() # return the status of the task
+        """
+        start_time = time.time()
+        last_progress = 0
+        pbar = self._create_progress_bar() if progress_bar else None
+        
+        try:
+            while True:
+                self._check_timeout(start_time, timeout)
+                status = self.status
+                
+                if self._is_final_state(status):
+                    self._update_progress_bar(pbar, last_progress, status)
+                    return TaskStatus(status)
+                
+                if pbar:
+                    last_progress = self._update_progress_bar(pbar, last_progress)
+                
+                time.sleep(interval)
+        finally:
+            if pbar:
+                pbar.close()
+
+
+    def _create_progress_bar(self) -> 'tqdm':
+        """Creates a progress bar for the task."""
+        try:
+            from tqdm.auto import tqdm
+        except ImportError:
+            from .api import logger
+            logger.warning("[tqdm] extra is required to show the progress bar. install with: pip insatll pygeobox[tqdm]")
+            return None
+
+        return tqdm(total=100, colour='green', desc=f"Task: {self.name}", unit="%", leave=True)
+
+
+    def _check_timeout(self, start_time: float, timeout: Union[int, None]) -> None:
+        """Checks if the task has exceeded the timeout period."""
+        if timeout and time.time() - start_time > timeout:
+            raise TimeoutError(f"Task {self.name} timed out after {timeout} seconds")
+
+
+    def _is_final_state(self, status: 'TaskStatus') -> bool:
+        """Checks if the task has reached a final state."""
+        return status in [TaskStatus.FAILURE, TaskStatus.SUCCESS, TaskStatus.ABORTED]
+
+
+    def _update_progress_bar(self, pbar: Union['tqdm', None], last_progress: int, status: 'TaskStatus' = None) -> int:
+        """
+        Updates the progress bar with current progress and returns the new last_progress.
+        
+        Args:
+            pbar (tqdm | None): The progress bar to update
+            last_progress (int): The last progress value
+            status (TaskStatus, optional): The task status. If provided and SUCCESS, updates to 100%
+            
+        Returns:
+            int: The new last_progress value
+        """
+        if not pbar:
+            return last_progress
+        
+        if status == TaskStatus.SUCCESS:
+            pbar.update(100 - last_progress)
+            return 100
+        
+        current_progress = self.progress
+        if current_progress is not None:
+            progress_diff = current_progress - last_progress
+            if progress_diff > 0:
+                pbar.update(progress_diff)
+                return current_progress
+        return last_progress
+
+
+    def abort(self) -> None:
+        """
+        Aborts the task.
+
+        Returns:
+            None
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.task import Task
+            >>> client = GeoboxClient()
+            >>> task = Task.get_task(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> task.abort()
+        """
+        endpoint = urljoin(self.endpoint, 'abort/')
+        self.api.post(endpoint)
+
+
+    @classmethod
+    def get_tasks(cls, api: 'GeoboxClient', **kwargs) -> Union[List['Task'], int]:
+        """
+        Get a list of tasks
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            
+        Keyword Args:
+            state (TaskStatus): Available values : TaskStatus.PENDING, TaskStatus.PROGRESS, TaskStatus.SUCCESS, TaskStatus.FAILURE, TaskStatus.ABORTED
+            q (str): query filter based on OGC CQL standard. e.g. "field1 LIKE '%GIS%' AND created_at > '2021-01-01'"
+            search (str): search term for keyword-based searching among search_fields or all textual fields if search_fields does not have value. NOTE: if q param is defined this param will be ignored.
+            search_fields (str): comma separated list of fields for searching.
+            order_by (str): comma separated list of fields for sorting results [field1 A|D, field2 A|D, …]. e.g. name A, type D. NOTE: "A" denotes ascending order and "D" denotes descending order.
+            return_count (bool): The count of the tasks. default is False.
+            skip (int): The skip of the task. default is 0.
+            limit (int): The limit of the task. default is 10.
+            user_id (int): Specific user. privileges required.
+            shared (bool): Whether to return shared tasks. default is False.
+
+        Returns:
+            List[Task] | int: The list of task objects or the count of the tasks if return_count is True.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.task import Task
+            >>> client = GeoboxClient()
+            >>> tasks = Task.get_tasks(client)
+            or
+            >>> tasks = client.get_tasks()
+        """
+        params = {
+            'f': 'json',
+            'state': kwargs.get('state').value if kwargs.get('state') else None,
+            'q': kwargs.get('q'),
+            'search': kwargs.get('search'),
+            'search_fields': kwargs.get('search_fields'),
+            'order_by': kwargs.get('order_by'),
+            'return_count': kwargs.get('return_count', False),
+            'skip': kwargs.get('skip'),
+            'limit': kwargs.get('limit'),
+            'user_id': kwargs.get('user_id'),
+            'shared': kwargs.get('shared', False)
+        }
+        return super()._get_list(api, cls.BASE_ENDPOINT, params, factory_func=lambda api, item: Task(api, item['uuid'], item))
+        
+
+
+    @classmethod
+    def get_task(cls, api: 'GeoboxClient', uuid: str) -> 'Task':
+        """
+        Gets a task.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            uuid (str): The UUID of the task.
+
+        Returns:
+            Task: The task object.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.task import Task
+            >>> client = GeoboxClient()
+            >>> task = Task.get_task(client, uuid="12345678-1234-5678-1234-567812345678")
+            or
+            >>> task = client.get_task(uuid="12345678-1234-5678-1234-567812345678")
+        """
+        return super()._get_detail(api, cls.BASE_ENDPOINT, uuid, factory_func=lambda api, item: Task(api, item['uuid'], item))
+

pygeobox/tile3d.py

@@ -0,0 +1,295 @@
+from typing import List, Dict, Optional, TYPE_CHECKING, Union
+from urllib.parse import urljoin
+
+from .base import Base
+
+if TYPE_CHECKING:
+    from . import GeoboxClient
+
+
+class Tile3d(Base):
+    
+    BASE_ENDPOINT = '3dtiles/'
+
+    def __init__(self, 
+                 api: 'GeoboxClient',
+                 uuid: str,
+                 data: Optional[Dict] = {}):
+        """
+        Initialize a 3D Tile instance.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            name (str): The name of the 3D Tile.
+            uuid (str): The unique identifier for the 3D Tile.
+            data (Dict): The data of the 3D Tile.
+        """
+        super().__init__(api, uuid=uuid, data=data)
+
+
+    @classmethod
+    def get_3dtiles(cls, api: 'GeoboxClient', **kwargs) -> Union[List['Tile3d'], int]:
+        """
+        Get list of 3D Tiles with optional filtering and pagination.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+
+        Keyword Args:
+            q (str): query filter based on OGC CQL standard. e.g. "field1 LIKE '%GIS%' AND created_at > '2021-01-01'"
+            search (str): search term for keyword-based searching among search_fields or all textual fields if search_fields does not have value. NOTE: if q param is defined this param will be ignored.
+            search_fields (str): comma separated list of fields for searching.
+            order_by (str): comma separated list of fields for sorting results [field1 A|D, field2 A|D, …]. e.g. name A, type D. NOTE: "A" denotes ascending order and "D" denotes descending order.
+            return_count (bool): Whether to return total count. default is False.
+            skip (int): Number of items to skip. default is 0.
+            limit (int): Number of items to return. default is 10.
+            user_id (int): Specific user. privileges required.
+            shared (bool): Whether to return shared maps. default is False.
+
+        Returns:
+            List[Tile3d] | int: A list of 3D Tile instances or the total number of 3D Tiles.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.tile3d import Tile3d
+            >>> client = GeoboxClient()
+            >>> tiles = Tile3d.get_3dtiles(client, q="name LIKE '%My tile%'")
+            or
+            >>> tiles = client.get_3dtiles(q="name LIKE '%My tile%'")
+        """ 
+        params = {
+           'f': 'json',
+           'q': kwargs.get('q'),
+           'search': kwargs.get('search'),
+           'search_fields': kwargs.get('search_fields'),
+           'order_by': kwargs.get('order_by'),
+           'return_count': kwargs.get('return_count', False),
+           'skip': kwargs.get('skip', 0),
+           'limit': kwargs.get('limit', 10),
+           'user_id': kwargs.get('user_id'),
+           'shared': kwargs.get('shared', False)
+        }
+        return super()._get_list(api, cls.BASE_ENDPOINT, params, factory_func=lambda api, item: Tile3d(api, item['uuid'], item))
+    
+
+    @classmethod
+    def get_3dtile(cls, api: 'GeoboxClient', uuid: str, user_id: int = None) -> 'Tile3d':
+        """
+        Get a 3D Tile by its UUID.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            uuid (str): The UUID of the map to 3D Tile.
+            user_id (int): Specific user. privileges required.
+
+        Returns:
+            Tile3d: The 3D Tile object.
+
+        Raises:
+            NotFoundError: If the 3D Tile with the specified UUID is not found.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.tile3d import Tile3d
+            >>> client = GeoboxClient()
+            >>> tile = Tile3d.get_3dtile(client, uuid="12345678-1234-5678-1234-567812345678")
+            or
+            >>> tile = client.get_3dtile(uuid="12345678-1234-5678-1234-567812345678")
+        """ 
+        params = {
+            'f': 'json',
+            'user_id': user_id,
+        }
+        return super()._get_detail(api, cls.BASE_ENDPOINT, uuid, params, factory_func=lambda api, item: Tile3d(api, item['uuid'], item))
+
+
+    @classmethod
+    def get_3dtile_by_name(cls, api: 'GeoboxClient', name: str, user_id: int = None) -> Union['Tile3d', None]:
+        """
+        Get a 3dtile by name
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            name (str): the name of the 3dtile to get
+            user_id (int, optional): specific user. privileges required.
+
+        Returns:
+            Tile3d | None: returns the 3dtile if a 3dtile matches the given name, else None
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.tile3d import Tile3d
+            >>> client = GeoboxClient()
+            >>> tile3d = Tile3d.get_3dtile_by_name(client, name='test')
+            or
+            >>> tile3d = client.get_3dtile_by_name(name='test')
+        """
+        tile3ds = cls.get_3dtiles(api, q=f"name = '{name}'", user_id=user_id)
+        if tile3ds and tile3ds[0].name == name:
+            return tile3ds[0]
+        else:
+            return None
+    
+
+    def update(self, **kwargs) -> Dict:
+        """
+        Update the 3D Tile.
+
+        Keyword Args:
+            name (str): The name of the 3D Tile.
+            display_name (str): The display name of the 3D Tile.
+            description (str): The description of the 3D Tile.
+            settings (Dict): The settings of the 3D Tile.
+            thumbnail (str): The thumbnail of the 3D Tile.
+
+        Returns:
+            Dict: The updated 3D Tile data.
+
+        Raises:
+            ApiRequestError: If the API request fails.
+            ValidationError: If the 3D Tile data is invalid.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.tile3d import Tile3d
+            >>> client = GeoboxClient()
+            >>> tile = Tile3d.get_3dtile(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> tile.update_3dtile(display_name="New Display Name")
+        """
+        data = {
+            "name": kwargs.get('name'),
+            "display_name": kwargs.get('display_name'),   
+            "description": kwargs.get('description'),
+            "settings": kwargs.get('settings'),
+            "thumbnail": kwargs.get('thumbnail'),
+        }
+        return super()._update(self.endpoint, data)
+    
+
+    def delete(self) -> None:
+        """
+        Delete the 3D Tile.
+
+        Returns:
+            None
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.tile3d import Tile3d
+            >>> client = GeoboxClient()
+            >>> tile = Map.get_3dtile(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> tile.delete()
+        """
+        super().delete(self.endpoint)
+
+
+    @property
+    def thumbnail(self) -> str:
+        """
+        Get the thumbnail URL of the 3D Tile.
+
+        Returns:
+            str: The thumbnail url of the 3D Tile.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.tile3d import Tile3d
+            >>> client = GeoboxClient()
+            >>> tile = Tile3d.get_3dtile(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> tile.thumbnail
+            'https://example.com/thumbnail.png'
+        """
+        endpoint = urljoin(self.api.base_url, f'{self.endpoint}thumbnail.png')
+        return endpoint
+
+
+    def get_item(self, path: str) -> Dict:
+        """
+        Get an Item from 3D Tiles
+
+        Args:
+            path (str): the path of the item.
+
+        Returns:
+            Dict: the data of the item.
+
+        Example:
+            >>> from geobox imoprt GeoboxClient
+            >>> from geobox.tile3d import Tile3d
+            >>> client = GeoboxClient()
+            >>> tile = Tile3d.get_3dtile(client, uuid="12345678-1234-5678-1234-567812345678")
+            or
+            >>> tile = client.get_3dtile(uuid="12345678-1234-5678-1234-567812345678")
+            >>> item = tile.get_item()
+        """
+        endpoint = f"{self.endpoint}{path}"
+        return self.api.get(endpoint)
+
+
+    def share(self, users: List['User']) -> None:
+        """
+        Shares the 3D Tile with specified users.
+
+        Args:
+            users (List[User]): The list of user objects to share the 3D Tile with.
+
+        Returns:
+            None
+
+        Example:
+            >>> from geobox import GeoboxClient             
+            >>> from geobox.tile3d import Tile3d
+            >>> client = GeoboxClient()
+            >>> tile = Tile3d.get_3dtile(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> users = client.search_users(search='John')
+            >>> tile.share(users=users)
+        """
+        super()._share(self.endpoint, users)
+    
+
+    def unshare(self, users: List['User']) -> None:
+        """
+        Unshares the 3D Tile with specified users.
+
+        Args:
+            users (List[User]): The list of user objects to unshare the 3D Tile with.
+
+        Returns:
+            None
+
+        Example:
+            >>> from geobox import GeoboxClient             
+            >>> from geobox.tile3d import Tile3d
+            >>> client = GeoboxClient()
+            >>> tile = Tile3d.get_3dtile(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> users = client.search_users(search='John')
+            >>> tile.unshare(users=users)
+        """
+        super()._unshare(self.endpoint, users)
+
+
+    def get_shared_users(self, search: str = None, skip: int = 0, limit: int = 10) -> List['User']:
+        """
+        Retrieves the list of users the 3D Tile is shared with.
+
+        Args:
+            search (str, optional): The search query.
+            skip (int, optional): The number of users to skip.
+            limit (int, optional): The maximum number of users to retrieve.
+
+        Returns:
+            List[User]: The list of shared users.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.tile3d import Tile3d
+            >>> client = GeoboxClient()
+            >>> tile = Tile3d.get_3dtile(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> tile.get_shared_users(search='John', skip=0, limit=10)
+        """
+        params = {
+            'search': search,
+            'skip': skip,
+            'limit': limit
+        }
+        return super()._get_shared_users(self.endpoint, params)