pixeltable 0.2.24__py3-none-any.whl → 0.3.0__py3-none-any.whl

pixeltable/__init__.py

@@ -2,9 +2,9 @@ from .catalog import Column, InsertableTable, Table, UpdateStatus, View
 from .dataframe import DataFrame
 from .exceptions import Error
 from .exprs import RELATIVE_PATH_ROOT
-from .func import Aggregator, Function, expr_udf, uda, udf
+from .func import Aggregator, Function, expr_udf, query, uda, udf
 from .globals import (array, configure_logging, create_dir, create_snapshot, create_table, create_view, drop_dir,
-                      drop_table, get_table, init, list_dirs, list_functions, list_tables, move)
+                      drop_table, get_table, init, list_dirs, list_functions, list_tables, move, tool, tools)
 from .type_system import (Array, ArrayType, Audio, AudioType, Bool, BoolType, ColumnType, Document, DocumentType, Float,
                           FloatType, Image, ImageType, Int, IntType, Json, JsonType, Required, String, StringType,
                           Timestamp, TimestampType, Video, VideoType)

pixeltable/__version__.py

@@ -1,3 +1,3 @@
 # These version placeholders will be replaced during build.
-__version__ = "0.2.24"
-__version_tuple__ = (0, 2, 24)
+__version__ = "0.3.0"
+__version_tuple__ = (0, 3, 0)

pixeltable/catalog/__init__.py

@@ -1,7 +1,7 @@
 from .catalog import Catalog
 from .column import Column
 from .dir import Dir
-from .globals import UpdateStatus, is_valid_identifier, is_valid_path, MediaValidation
+from .globals import UpdateStatus, is_valid_identifier, is_valid_path, MediaValidation, IfExistsParam, IfNotExistsParam
 from .insertable_table import InsertableTable
 from .named_function import NamedFunction
 from .path import Path

pixeltable/catalog/dir.py

@@ -21,6 +21,12 @@ class Dir(SchemaObject):
     def _display_name(cls) -> str:
         return 'directory'
 
+    @property
+    def _has_dependents(self) -> bool:
+        """ Returns True if this directory has any children. """
+        from pixeltable.catalog import Catalog, Path
+        return len(Catalog.get().paths.get_children(Path(self._path), child_type=None, recursive=False)) > 0
+
     def _move(self, new_name: str, new_dir_id: UUID) -> None:
         super()._move(new_name, new_dir_id)
         with Env.get().engine.begin() as conn:

pixeltable/catalog/globals.py

@@ -51,6 +51,31 @@ class MediaValidation(enum.Enum):
             val_strs = ', '.join(f'{s.lower()!r}' for s in cls.__members__.keys())
             raise excs.Error(f'{error_prefix} must be one of: [{val_strs}]')
 
+class IfExistsParam(enum.Enum):
+    ERROR = 0
+    IGNORE = 1
+    REPLACE = 2
+    REPLACE_FORCE = 3
+
+    @classmethod
+    def validated(cls, param_val: str, param_name: str) -> IfExistsParam:
+        try:
+            return cls[param_val.upper()]
+        except KeyError:
+            val_strs = ', '.join(f'{s.lower()!r}' for s in cls.__members__.keys())
+            raise excs.Error(f'{param_name} must be one of: [{val_strs}]')
+
+class IfNotExistsParam(enum.Enum):
+    ERROR = 0
+    IGNORE = 1
+
+    @classmethod
+    def validated(cls, param_val: str, param_name: str) -> IfNotExistsParam:
+        try:
+            return cls[param_val.upper()]
+        except KeyError:
+            val_strs = ', '.join(f'{s.lower()!r}' for s in cls.__members__.keys())
+            raise excs.Error(f'{param_name} must be one of: [{val_strs}]')
 
 def is_valid_identifier(name: str) -> bool:
     return name.isidentifier() and not name.startswith('_')

pixeltable/catalog/named_function.py

@@ -25,6 +25,10 @@ class NamedFunction(SchemaObject):
     def _display_name(cls) -> str:
         return 'function'
 
+    @property
+    def _has_dependents(self) -> bool:
+        return False
+
     def _move(self, new_name: str, new_dir_id: UUID) -> None:
         super()._move(new_name, new_dir_id)
         with Env.get().engine.begin() as conn:

pixeltable/catalog/path_dict.py

@@ -51,11 +51,41 @@ class PathDict:
             record_dir(dir)
 
     def _resolve_path(self, path: Path) -> SchemaObject:
+        """Resolve the path to a SchemaObject.
+
+        Args:
+            path: path to resolve
+
+        Returns:
+            SchemaObject at the path.
+
+        Raises:
+            Error if path is invalid or does not exist.
+        """
+        schema_obj = self.get_object(path)
+        if schema_obj is None:
+            raise excs.Error(f"No such path: {str(path)}")
+        return schema_obj
+
+    def get_object(self, path: Path) -> Optional[SchemaObject]:
+        """Get the object at the given path, if any.
+
+        Args:
+            path: path to object
+
+        Returns:
+            SchemaObject at the path if it exists, None otherwise.
+
+        Raises:
+            Error if path is invalid.
+        """
         if path.is_root:
             return self.root_dir
         dir = self.root_dir
         for i, component in enumerate(path.components):
             if component not in self.dir_contents[dir._id]:
+                if i == len(path.components) - 1:
+                    return None
                 raise excs.Error(f'No such path: {".".join(path.components[:i + 1])}')
             schema_obj = self.dir_contents[dir._id][component]
             if i < len(path.components) - 1:
@@ -112,19 +142,15 @@ class PathDict:
             Error if path is invalid or object at path has wrong type
         """
         # check for existence
+        obj = self.get_object(path)
         if expected is not None:
-            schema_obj = self._resolve_path(path)
-            if not isinstance(schema_obj, expected):
-                raise excs.Error(
-                    f'{str(path)} needs to be a {expected._display_name()} but is a {type(schema_obj)._display_name()}')
-        if expected is None:
-            parent_obj = self._resolve_path(path.parent)
-            if not isinstance(parent_obj, Dir):
+            if obj is None:
+                raise excs.Error(f"No such path: {str(path)}")
+            if not isinstance(obj, expected):
                 raise excs.Error(
-                    f'{str(path.parent)} is a {type(parent_obj)._display_name()}, not a {Dir._display_name()}')
-            if path.name in self.dir_contents[parent_obj._id]:
-                obj = self.dir_contents[parent_obj._id][path.name]
-                raise excs.Error(f"{type(obj)._display_name()} '{str(path)}' already exists")
+                    f'{str(path)} needs to be a {expected._display_name()} but is a {type(obj)._display_name()}')
+        if expected is None and obj is not None:
+            raise excs.Error(f"{type(obj)._display_name()} '{str(path)}' already exists")
 
     def get_children(self, parent: Path, child_type: Optional[type[SchemaObject]], recursive: bool) -> list[Path]:
         dir = self._resolve_path(parent)

pixeltable/catalog/schema_object.py

@@ -66,7 +66,13 @@ class SchemaObject:
         """
         pass
 
+    @property
+    @abstractmethod
+    def _has_dependents(self) -> bool:
+        """Returns True if this object has dependents (e.g., children, views)"""
+
     def _move(self, new_name: str, new_dir_id: UUID) -> None:
         """Subclasses need to override this to make the change persistent"""
         self.__name = new_name
         self.__dir_id = new_dir_id
+