singlestoredb 1.10.0__cp38-abi3-win_amd64.whl → 1.11.0__cp38-abi3-win_amd64.whl

singlestoredb/__init__.py

@@ -13,7 +13,7 @@ Examples
 
 """
 
-__version__ = '1.10.0'
+__version__ = '1.11.0'
 
 from typing import Any
 

singlestoredb/fusion/handlers/models.py

@@ -0,0 +1,250 @@
+#!/usr/bin/env python3
+import os
+from typing import Any
+from typing import Dict
+from typing import Optional
+
+from ..handler import SQLHandler
+from ..result import FusionSQLResult
+from .files import ShowFilesHandler
+from .utils import get_file_space
+
+
+class ShowModelsHandler(ShowFilesHandler):
+    """
+    SHOW MODELS
+        [ at_path ] [ <like> ]
+        [ <order-by> ]
+        [ <limit> ] [ recursive ] [ extended ];
+
+    # File path to list
+    at_path = AT '<path>'
+
+    # Should the listing be recursive?
+    recursive = RECURSIVE
+
+    # Should extended attributes be shown?
+    extended = EXTENDED
+
+    Description
+    -----------
+    Displays the list of models in models space.
+
+    Arguments
+    ---------
+    * ``<path>``: A path in the models space.
+    * ``<pattern>``: A pattern similar to SQL LIKE clause.
+      Uses ``%`` as the wildcard character.
+
+    Remarks
+    -------
+    * Use the ``LIKE`` clause to specify a pattern and return only the
+      files that match the specified pattern.
+    * The ``LIMIT`` clause limits the number of results to the
+      specified number.
+    * Use the ``ORDER BY`` clause to sort the results by the specified
+      key. By default, the results are sorted in the ascending order.
+    * The ``AT PATH`` clause specifies the path in the models
+      space to list the files from.
+    * To return more information about the files, use the ``EXTENDED``
+      clause.
+
+    Examples
+    --------
+    The following command lists the models::
+
+        SHOW MODELS;
+
+    The following command lists the models with additional information::
+
+        SHOW MODELS EXTENDED;
+
+    See Also
+    --------
+    * ``UPLOAD MODEL model_name FROM path``
+    * ``DOWNLOAD MODEL model_name``
+
+
+    """  # noqa: E501
+
+    def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
+        params['file_location'] = 'MODELS'
+
+        return super().run(params)
+
+
+ShowModelsHandler.register(overwrite=True)
+
+
+class UploadModelHandler(SQLHandler):
+    """
+    UPLOAD MODEL model_name
+        FROM local_path [ overwrite ];
+
+    # Model Name
+    model_name = '<model-name>'
+
+    # Path to local file or directory
+    local_path = '<local-path>'
+
+    # Should an existing file be overwritten?
+    overwrite = OVERWRITE
+
+    Description
+    -----------
+    Uploads a file or folder to models space.
+
+    Arguments
+    ---------
+    * ``<model-name>``: Model name.
+    * ``<local-path>``: The path to the file or folder to upload in the local
+      directory.
+
+    Remarks
+    -------
+    * If the ``OVERWRITE`` clause is specified, any existing file at the
+      specified path in the models space is overwritten.
+
+    Examples
+    --------
+    The following command uploads a file to models space and overwrite any
+    existing files at the specified path::
+
+        UPLOAD MODEL model_name
+            FROM 'llama3/' OVERWRITE;
+
+    See Also
+    --------
+    * ``DOWNLOAD MODEL model_name``
+
+    """  # noqa: E501
+
+    def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
+        params['file_location'] = 'MODELS'
+
+        model_name = params['model_name']
+        local_path = params['local_path']
+
+        file_space = get_file_space(params)
+
+        if os.path.isdir(local_path):
+            file_space.upload_folder(
+                local_path=local_path,
+                path=os.path.join(model_name, ''),
+                overwrite=params['overwrite'],
+            )
+        else:
+            file_space.upload_file(
+                local_path=local_path,
+                path=os.path.join(model_name, local_path),
+                overwrite=params['overwrite'],
+            )
+
+        return None
+
+
+UploadModelHandler.register(overwrite=True)
+
+
+class DownloadModelHandler(SQLHandler):
+    """
+    DOWNLOAD MODEL model_name
+        [ local_path ]
+        [ overwrite ];
+
+    # Model Name
+    model_name = '<model-name>'
+
+    # Path to local directory
+    local_path = TO '<local-path>'
+
+    # Should an existing directory be overwritten?
+    overwrite = OVERWRITE
+
+    Description
+    -----------
+    Download a model from models space.
+
+    Arguments
+    ---------
+    * ``<model-name>``: Model name to download in models space.
+    * ``<local-path>``: Specifies the path in the local directory
+      where the model is downloaded.
+
+    Remarks
+    -------
+    * If the ``OVERWRITE`` clause is specified, any existing file or folder at
+      the download location is overwritten.
+    * If ``<local-path>`` is not specified, the model is downloaded to the current location.
+
+    Examples
+    --------
+    The following command displays the contents of the file on the
+    standard output::
+
+        DOWNLOAD MODEL llama3;
+
+    The following command downloads a model to a specific location and
+    overwrites any existing models folder with the name ``local_llama3`` on the local storage::
+
+        DOWNLOAD MODEL llama3
+            TO 'local_llama3' OVERWRITE;
+
+    See Also
+    --------
+    * ``UPLOAD MODEL model_name FROM local_path``
+
+    """  # noqa: E501
+
+    def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
+        params['file_location'] = 'MODELS'
+
+        file_space = get_file_space(params)
+
+        model_name = params['model_name']
+        file_space.download_folder(
+            path=os.path.join(model_name, ''),
+            local_path=params['local_path'] or model_name,
+            overwrite=params['overwrite'],
+        )
+
+        return None
+
+
+DownloadModelHandler.register(overwrite=True)
+
+
+class DropModelsHandler(SQLHandler):
+    """
+    DROP MODEL model_name;
+
+    # Model Name
+    model_name = '<model-name>'
+
+    Description
+    -----------
+    Deletes a model from models space.
+
+    Arguments
+    ---------
+    * ``<model-name>``: Model name to delete in models space.
+
+    Example
+    --------
+    The following commands deletes a model from a model space::
+
+        DROP MODEL llama3;
+
+    """  # noqa: E501
+
+    def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
+        params['file_location'] = 'MODELS'
+        path = os.path.join(params['model_name'], '')
+
+        file_space = get_file_space(params)
+        file_space.removedirs(path=path)
+
+        return None
+
+
+DropModelsHandler.register(overwrite=True)

singlestoredb/fusion/handlers/utils.py

@@ -11,6 +11,7 @@ from ...management import manage_workspaces
 from ...management.files import FilesManager
 from ...management.files import FileSpace
 from ...management.files import manage_files
+from ...management.files import MODELS_SPACE
 from ...management.files import PERSONAL_SPACE
 from ...management.files import SHARED_SPACE
 from ...management.workspace import StarterWorkspace
@@ -296,15 +297,14 @@ def get_file_space(params: Dict[str, Any]) -> FileSpace:
     file_location = params.get('file_location')
     if file_location:
         file_location_lower_case = file_location.lower()
-        if (
-            file_location_lower_case != PERSONAL_SPACE and
-            file_location_lower_case != SHARED_SPACE
-        ):
-            raise ValueError(f'invalid file location: {file_location}')
 
         if file_location_lower_case == PERSONAL_SPACE:
             return manager.personal_space
         elif file_location_lower_case == SHARED_SPACE:
             return manager.shared_space
+        elif file_location_lower_case == MODELS_SPACE:
+            return manager.models_space
+        else:
+            raise ValueError(f'invalid file location: {file_location}')
 
     raise KeyError('no file space was specified')

singlestoredb/management/files.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import datetime
+import glob
 import io
 import os
 import re
@@ -23,9 +24,9 @@ from .utils import PathLike
 from .utils import to_datetime
 from .utils import vars_to_str
 
-
 PERSONAL_SPACE = 'personal'
 SHARED_SPACE = 'shared'
+MODELS_SPACE = 'models'
 
 
 class FilesObject(object):
@@ -35,8 +36,8 @@ class FilesObject(object):
     It can belong to either a workspace stage or personal/shared space.
 
     This object is not instantiated directly. It is used in the results
-    of various operations in ``WorkspaceGroup.stage``, ``FilesManager.personal_space``
-    and ``FilesManager.shared_space`` methods.
+    of various operations in ``WorkspaceGroup.stage``, ``FilesManager.personal_space``,
+    ``FilesManager.shared_space`` and ``FilesManager.models_space`` methods.
 
     """
 
@@ -513,6 +514,11 @@ class FilesManager(Manager):
         """Return the shared file space."""
         return FileSpace(SHARED_SPACE, self)
 
+    @property
+    def models_space(self) -> FileSpace:
+        """Return the models file space."""
+        return FileSpace(MODELS_SPACE, self)
+
 
 def manage_files(
     access_token: Optional[str] = None,
@@ -551,7 +557,8 @@ class FileSpace(FileLocation):
     FileSpace manager.
 
     This object is not instantiated directly.
-    It is returned by ``FilesManager.personal_space`` or ``FilesManager.shared_space``.
+    It is returned by ``FilesManager.personal_space``, ``FilesManager.shared_space``
+    or ``FileManger.models_space``.
 
     """
 
@@ -687,10 +694,36 @@ class FileSpace(FileLocation):
             ignore all '*.pyc' files in the directory tree
 
         """
-        raise ManagementError(
-            msg='Operation not supported: directories are currently not allowed '
-                'in Files API',
-        )
+        if not os.path.isdir(local_path):
+            raise NotADirectoryError(f'local path is not a directory: {local_path}')
+
+        if not path:
+            path = local_path
+
+        ignore_files = set()
+        if ignore:
+            if isinstance(ignore, list):
+                for item in ignore:
+                    ignore_files.update(glob.glob(str(item), recursive=recursive))
+            else:
+                ignore_files.update(glob.glob(str(ignore), recursive=recursive))
+
+        for dir_path, _, files in os.walk(str(local_path)):
+            for fname in files:
+                if ignore_files and fname in ignore_files:
+                    continue
+
+                local_file_path = os.path.join(dir_path, fname)
+                remote_path = os.path.join(
+                    path,
+                    local_file_path.lstrip(str(local_path)),
+                )
+                self.upload_file(
+                    local_path=local_file_path,
+                    path=remote_path,
+                    overwrite=overwrite,
+                )
+        return self.info(path)
 
     def _upload(
         self,
@@ -875,15 +908,30 @@ class FileSpace(FileLocation):
                 return False
             raise
 
-    def _list_root_dir(self) -> List[str]:
+    def _listdir(self, path: PathLike, *, recursive: bool = False) -> List[str]:
         """
-        Return the names of files in the root directory.
+        Return the names of files in a directory.
+
         Parameters
         ----------
+        path : Path or str
+            Path to the folder
+        recursive : bool, optional
+            Should folders be listed recursively?
+
         """
         res = self._manager._get(
-            f'files/fs/{self._location}',
+            f'files/fs/{self._location}/{path}',
         ).json()
+
+        if recursive:
+            out = []
+            for item in res['content'] or []:
+                out.append(item['path'])
+                if item['type'] == 'directory':
+                    out.extend(self._listdir(item['path'], recursive=recursive))
+            return out
+
         return [x['path'] for x in res['content'] or []]
 
     def listdir(
@@ -905,13 +953,17 @@ class FileSpace(FileLocation):
         List[str]
 
         """
-        if path == '' or path == '/':
-            return self._list_root_dir()
+        path = re.sub(r'^(\./|/)+', r'', str(path))
+        path = re.sub(r'/+$', r'', path) + '/'
 
-        raise ManagementError(
-            msg='Operation not supported: directories are currently not allowed '
-                'in Files API',
-        )
+        if not self.is_dir(path):
+            raise NotADirectoryError(f'path is not a directory: {path}')
+
+        out = self._listdir(path, recursive=recursive)
+        if path != '/':
+            path_n = len(path.split('/')) - 1
+            out = ['/'.join(x.split('/')[path_n:]) for x in out]
+        return out
 
     def download_file(
         self,
@@ -973,17 +1025,28 @@ class FileSpace(FileLocation):
         Parameters
         ----------
         path : Path or str
-            Path to the file
+            Directory path
         local_path : Path or str
             Path to local directory target location
         overwrite : bool, optional
             Should an existing directory / files be overwritten if they exist?
 
         """
-        raise ManagementError(
-            msg='Operation not supported: directories are currently not allowed '
-                'in Files API',
-        )
+
+        if local_path is not None and not overwrite and os.path.exists(local_path):
+            raise OSError('target path already exists; use overwrite=True to replace')
+
+        if not self.is_dir(path):
+            raise NotADirectoryError(f'path is not a directory: {path}')
+
+        files = self.listdir(path, recursive=True)
+        for f in files:
+            remote_path = os.path.join(path, f)
+            if self.is_dir(remote_path):
+                continue
+            target = os.path.normpath(os.path.join(local_path, f))
+            os.makedirs(os.path.dirname(target), exist_ok=True)
+            self.download_file(remote_path, target, overwrite=overwrite)
 
     def remove(self, path: PathLike) -> None:
         """
@@ -1010,10 +1073,10 @@ class FileSpace(FileLocation):
             Path to the file location
 
         """
-        raise ManagementError(
-            msg='Operation not supported: directories are currently not allowed '
-                'in Files API',
-        )
+        if not self.is_dir(path):
+            raise NotADirectoryError('path is not a directory')
+
+        self._manager._delete(f'files/fs/{self._location}/{path}')
 
     def rmdir(self, path: PathLike) -> None:
         """

singlestoredb/mysql/connection.py

@@ -729,6 +729,7 @@ class Connection(BaseConnection):
             return
         if self._closed:
             raise err.Error('Already closed')
+        events.unsubscribe(self._handle_event)
         self._closed = True
         if self._sock is None:
             return

singlestoredb/utils/events.py

@@ -27,6 +27,22 @@ def subscribe(func: Callable[[Dict[str, Any]], None]) -> None:
     _subscribers.add(func)
 
 
+def unsubscribe(func: Callable[[Dict[str, Any]], None]) -> None:
+    """
+    Unsubscribe from SingleStore portal events.
+
+    Parameters
+    ----------
+    func : Callable
+        The function to call when an event is received
+
+    """
+    try:
+        _subscribers.remove(func)
+    except KeyError:
+        pass
+
+
 def _event_handler(stream: Any, ident: Any, msg: Dict[str, Any]) -> None:
     """Handle request on the control stream."""
     if not _subscribers or not isinstance(msg, dict):

{singlestoredb-1.10.0.dist-info → singlestoredb-1.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: singlestoredb
-Version: 1.10.0
+Version: 1.11.0
 Summary: Interface to the SingleStoreDB database and workspace management APIs
 Home-page: https://github.com/singlestore-labs/singlestoredb-python
 Author: SingleStore

{singlestoredb-1.10.0.dist-info → singlestoredb-1.11.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-_singlestoredb_accel.pyd,sha256=cTNWxsBsHk77ryPm-wj9wFEi3q0MJgQ5JFOGo8KsfdM,59392
-singlestoredb/__init__.py,sha256=tic3Nv74hrvLzFMKed_-mr9zHudZrMogLBcwzs988lk,1712
+_singlestoredb_accel.pyd,sha256=YuyyOkJKfNWvP8UqILRk6CXXaqsNBUh9F8Q3b5OKZlc,59392
+singlestoredb/__init__.py,sha256=Hn7bg_Mioi5UgJH2ZaXgIbOsFdb9Xa1wqDeJvmNEYCU,1712
 singlestoredb/auth.py,sha256=RmYiH0Wlc2RXc4pTlRMysxtBI445ggCIwojWKC_eDLE,7844
 singlestoredb/config.py,sha256=n6ludREIoiZDEzSGmv0xouv_zHFnznKNKxSvjzgQ3Lk,12876
 singlestoredb/connection.py,sha256=I3A0VkA_E6pfUNCzIvj0KTb5zn6-htBAPsu6OVXO9-I,47150
@@ -39,8 +39,9 @@ singlestoredb/fusion/handlers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5N
 singlestoredb/fusion/handlers/export.py,sha256=Vf0idiFTluEhDpt7ozWSdYwQcOeXz2-J6-91ax8F834,7189
 singlestoredb/fusion/handlers/files.py,sha256=sXO5OFS5QsmwNOnMY3G5xpMPqh4_WkssW3dOB6uI4VQ,19669
 singlestoredb/fusion/handlers/job.py,sha256=3enfxHwERH7T4u0FEwOPN0IL0GtepaCYgEsisiy3Df4,21753
+singlestoredb/fusion/handlers/models.py,sha256=XWaPJQc3GQIOAcjNcxBSGUBJ3xu2qkzQ4ILa40TFQmY,6486
 singlestoredb/fusion/handlers/stage.py,sha256=PP-SSP204lwpmnycSXXSmFPzoN535JVuwglDCbaQ8Lw,14789
-singlestoredb/fusion/handlers/utils.py,sha256=OffWWj8FkZgqr5ijY3WQ6cwaAB7a7Z5cYxLeOAfU_JE,10356
+singlestoredb/fusion/handlers/utils.py,sha256=qwKGKi7hVlxoROZnAdOgqN3Fw4EHxMynfCdUWKvjFvo,10374
 singlestoredb/fusion/handlers/workspace.py,sha256=NxoEY5xd5lCQmXiim4nhAYCL0agHo1H_rGPpqa31hiw,28397
 singlestoredb/http/__init__.py,sha256=4cEDvLloGc3LSpU-PnIwacyu0n5oIIIE6xk2SPyWD_w,939
 singlestoredb/http/connection.py,sha256=LFUeWx7maS7xhQLqEX3pgvIGoosqyJTovtWwJ1DyDSA,40721
@@ -51,7 +52,7 @@ singlestoredb/management/__init__.py,sha256=A66ZnFyX--PsAZ2tvtYUfIUBvVGDBFQsnVc6
 singlestoredb/management/billing_usage.py,sha256=0UHFSPCrN0nyeGFFM-HXS3NP8pYmYo2BCCahDEPXvzg,3883
 singlestoredb/management/cluster.py,sha256=auBzNYIXvnI6rq3DNpPgJhwWoT6JsyZRikjpON23Pxg,14867
 singlestoredb/management/export.py,sha256=Ksrb8_sxeqva4NElaGxdPQUWQga2yOEkf0wnw5M-iGc,4302
-singlestoredb/management/files.py,sha256=9uVWe6yc48B9J1GHcMxQ4GEHOnIVlFzEXuKhWFuuZH0,29256
+singlestoredb/management/files.py,sha256=ly9Hwe0kVWqws8dvjuoIH0fURi8TadTTZPIFKTxnuWI,31677
 singlestoredb/management/job.py,sha256=Npfe1JLYJlggGBrXLniPKwKUKF1i3alvSY1SFtvauSs,25498
 singlestoredb/management/manager.py,sha256=8zU0d7NG83PYMhoAs2JriTqbqh-R2tLX7VZoeZtcogY,9148
 singlestoredb/management/organization.py,sha256=JBsNC4R3boUKdYvyCZyfGoVMC1mD6SPuMI1UssBVoOM,5611
@@ -61,7 +62,7 @@ singlestoredb/management/workspace.py,sha256=erII_7SA4vdJkTPBKB6aa88mYujmXTYdNeQ
 singlestoredb/mysql/__init__.py,sha256=CbpwzNUJPAmKPpIobC0-ugBta_RgHCMq7X7N75QLReY,4669
 singlestoredb/mysql/_auth.py,sha256=YaqqyvAHmeraBv3BM207rNveUVPM-mPnW20ts_ynVWg,8341
 singlestoredb/mysql/charset.py,sha256=mnCdMpvdub1S2mm2PSk2j5JddgsWRjsVLtGx-y9TskE,10724
-singlestoredb/mysql/connection.py,sha256=mmTF9X7cPbmTS7yPHHbkjwQGpOPSbpDgZ3MNd2MyXkA,74716
+singlestoredb/mysql/connection.py,sha256=lzwf31pFioWCUaMBB_TahB9VsemKMS0l3DrUqO3ZCJE,74764
 singlestoredb/mysql/converters.py,sha256=vebFFm6IrC0WgY-5Eh-esaPizY5cq3vDOUlEKGaYM-U,7771
 singlestoredb/mysql/cursors.py,sha256=pkrP-1t8IhBJRnYpdM7Rdm-332nOq1RYTDJ_yg_q5HI,27682
 singlestoredb/mysql/err.py,sha256=aDbmfq08gWVmfgIea735wSeiFdvYbB5wusgd3qTVq1s,2480
@@ -131,15 +132,15 @@ singlestoredb/utils/config.py,sha256=WVQ567ZzqzlTGueQH5fEpm5tPZuz8y7qvpEQUB-vPjk
 singlestoredb/utils/convert_rows.py,sha256=gkZeZazeJvimCYEQ1FdAC-AmMDwmFGCuP6mi653bpns,1885
 singlestoredb/utils/debug.py,sha256=y7dnJeJGt3U_BWXz9pLt1qNQREpPtumYX_sk1DiqG6Y,362
 singlestoredb/utils/dtypes.py,sha256=_P2fTX2Fgv9Bcl-2L6KivhWgLzyu91sDamxVnmG92Mw,6103
-singlestoredb/utils/events.py,sha256=rC9cHAetua_E1f-EiFkFM-gJzQSQIH5Uk-4sspC3KjI,1188
+singlestoredb/utils/events.py,sha256=Wpp4Z5kw6f7axGAerMirEhgjcAArboQtMc4aqXzfKIc,1519
 singlestoredb/utils/mogrify.py,sha256=gCcn99-vgsGVjTUV7RHJ6hH4vCNrsGB_Xo4z8kiSPDQ,4201
 singlestoredb/utils/results.py,sha256=wR70LhCqlobniZf52r67zYLBOKjWHQm68NAskdRQND8,15862
 singlestoredb/utils/xdict.py,sha256=-wi1lSPTnY99fhVMBhPKJ8cCsQhNG4GMUfkEBDKYgCw,13321
 sqlx/__init__.py,sha256=4Sdn8HN-Hf8v0_wCt60DCckCg8BvgM3-9r4YVfZycRE,89
 sqlx/magic.py,sha256=6VBlotgjautjev599tHaTYOfcfOA9m6gV_-P1_Qc4lI,3622
-singlestoredb-1.10.0.dist-info/LICENSE,sha256=Bojenzui8aPNjlF3w4ojguDP7sTf8vFV_9Gc2UAG1sg,11542
-singlestoredb-1.10.0.dist-info/METADATA,sha256=WMO1XteYPWWD3omXLyDKKoz10HINKtWZ5Hqdo75Z8rQ,5711
-singlestoredb-1.10.0.dist-info/WHEEL,sha256=UyMHzmWA0xVqVPKfTiLs2eN3OWWZUl-kQemNbpIqlKo,100
-singlestoredb-1.10.0.dist-info/entry_points.txt,sha256=bSLaTWB5zGjpVYPAaI46MkkDup0su-eb3uAhCNYuRV0,48
-singlestoredb-1.10.0.dist-info/top_level.txt,sha256=lA65Vf4qAMfg_s1oG3LEO90h4t1Z-SPDbRqkevI3bSY,40
-singlestoredb-1.10.0.dist-info/RECORD,,
+singlestoredb-1.11.0.dist-info/LICENSE,sha256=Bojenzui8aPNjlF3w4ojguDP7sTf8vFV_9Gc2UAG1sg,11542
+singlestoredb-1.11.0.dist-info/METADATA,sha256=8tDiZ6TwCEXStAL2L0YaT2LGv5f3B2XrT-KU6K5XS4A,5711
+singlestoredb-1.11.0.dist-info/WHEEL,sha256=UyMHzmWA0xVqVPKfTiLs2eN3OWWZUl-kQemNbpIqlKo,100
+singlestoredb-1.11.0.dist-info/entry_points.txt,sha256=bSLaTWB5zGjpVYPAaI46MkkDup0su-eb3uAhCNYuRV0,48
+singlestoredb-1.11.0.dist-info/top_level.txt,sha256=lA65Vf4qAMfg_s1oG3LEO90h4t1Z-SPDbRqkevI3bSY,40
+singlestoredb-1.11.0.dist-info/RECORD,,