meerschaum 2.9.5__py3-none-any.whl → 3.0.0__py3-none-any.whl

meerschaum/connectors/api/_actions.py

@@ -14,7 +14,7 @@ from functools import partial
 
 import meerschaum as mrsm
 from meerschaum.utils.typing import SuccessTuple, List, Callable, Optional
-from meerschaum.config.static import STATIC_CONFIG
+from meerschaum._internal.static import STATIC_CONFIG
 
 ACTIONS_ENDPOINT: str = STATIC_CONFIG['api']['endpoints']['actions']
 TEMP_PREFIX: str = STATIC_CONFIG['api']['jobs']['temp_prefix']
@@ -88,7 +88,7 @@ def do_action_legacy(
     """
     import sys, json
     from meerschaum.utils.debug import dprint
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     from meerschaum.utils.misc import json_serialize_datetime
     if action is None:
         action = []

meerschaum/connectors/api/_jobs.py

@@ -14,7 +14,7 @@ from datetime import datetime
 import meerschaum as mrsm
 from meerschaum.utils.typing import Dict, Any, SuccessTuple, List, Union, Callable, Optional
 from meerschaum.jobs import Job
-from meerschaum.config.static import STATIC_CONFIG
+from meerschaum._internal.static import STATIC_CONFIG
 from meerschaum.utils.warnings import warn, dprint
 
 JOBS_ENDPOINT: str = STATIC_CONFIG['api']['endpoints']['jobs']
@@ -380,3 +380,14 @@ def get_job_is_blocking_on_stdin(self, name: str, debug: bool = False) -> bool:
         return False
 
     return response.json()
+
+
+def get_job_prompt_kwargs(self, name: str, debug: bool = False) -> Dict[str, Any]:
+    """
+    Return the kwargs to the blocking `prompt()`, if available.
+    """
+    response = self.get(JOBS_ENDPOINT + f'/{name}/prompt_kwargs', debug=debug)
+    if not response:
+        return {}
+
+    return response.json()

meerschaum/connectors/api/_login.py

@@ -11,7 +11,7 @@ from __future__ import annotations
 import json
 import datetime
 from meerschaum.utils.typing import SuccessTuple, Any, Union
-from meerschaum.config.static import STATIC_CONFIG
+from meerschaum._internal.static import STATIC_CONFIG
 from meerschaum.utils.warnings import warn as _warn
 
 
@@ -22,14 +22,40 @@ def login(
     **kw: Any
 ) -> SuccessTuple:
     """Log in and set the session token."""
+    if self.login_scheme == 'api_key':
+        validate_response = self.post(
+            STATIC_CONFIG['api']['endpoints']['tokens'] + '/validate',
+            headers={'Authorization': f'Bearer {self.api_key}'},
+            use_token=False,
+            debug=debug,
+        )
+        if not validate_response:
+            return False, "API key is not valid."
+        return True, "API key is valid."
+
     try:
-        login_data = {
-            'username': self.username,
-            'password': self.password,
-        }
+        if self.login_scheme == 'password':
+            login_data = {
+                'username': self.username,
+                'password': self.password,
+            }
+        elif self.login_scheme == 'client_credentials':
+            login_data = {
+                'client_id': self.client_id,
+                'client_secret': self.client_secret,
+            }
     except AttributeError:
+        login_data = {}
+
+    if not login_data:
         return False, f"Please login with the command `login {self}`."
 
+    login_scheme_msg = (
+        f" as user '{login_data['username']}'"
+        if self.login_scheme == 'username'
+        else ''
+    )
+
     response = self.post(
         STATIC_CONFIG['api']['endpoints']['login'],
         data=login_data,
@@ -37,7 +63,7 @@ def login(
         debug=debug,
     )
     if response:
-        msg = f"Successfully logged into '{self}' as user '{login_data['username']}'."
+        msg = f"Successfully logged into '{self}'{login_scheme_msg}'."
         self._token = json.loads(response.text)['access_token']
         self._expires = datetime.datetime.strptime(
             json.loads(response.text)['expires'], 
@@ -45,7 +71,7 @@ def login(
         )
     else:
         msg = (
-            f"Failed to log into '{self}' as user '{login_data['username']}'.\n" +
+            f"Failed to log into '{self}'{login_scheme_msg}.\n" +
             f"    Please verify login details for connector '{self}'."
         )
         if warn and not self.__dict__.get('_emitted_warning', False):

meerschaum/connectors/api/_misc.py

@@ -13,7 +13,7 @@ def get_mrsm_version(self, **kw) -> Optional[str]:
     """
     Return the Meerschaum version of the API instance.
     """
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     try:
         j = self.get(
             STATIC_CONFIG['api']['endpoints']['version'] + '/mrsm',
@@ -31,7 +31,7 @@ def get_chaining_status(self, **kw) -> Optional[bool]:
     """
     Fetch the chaining status of the API instance.
     """
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     try:
         response = self.get(
             STATIC_CONFIG['api']['endpoints']['chaining'],

meerschaum/connectors/api/_pipes.py

@@ -21,7 +21,7 @@ def pipe_r_url(
     pipe: mrsm.Pipe
 ) -> str:
     """Return a relative URL path from a Pipe's keys."""
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     location_key = pipe.location_key
     if location_key is None:
         location_key = '[None]'
@@ -87,7 +87,7 @@ def edit_pipe(
     response = self.patch(
         r_url + '/edit',
         params={'patch': patch, 'instance_keys': self.get_pipe_instance_keys(pipe)},
-        json=pipe.parameters,
+        json=pipe.get_parameters(apply_symlinks=False),
         debug=debug,
     )
     if debug:
@@ -112,7 +112,13 @@ def fetch_pipes_keys(
     tags: Optional[List[str]] = None,
     params: Optional[Dict[str, Any]] = None,
     debug: bool = False
-) -> Union[List[Tuple[str, str, Union[str, None]]]]:
+) -> List[
+        Union[
+            Tuple[str, str, Union[str, None]],
+            Tuple[str, str, Union[str, None], List[str]],
+            Tuple[str, str, Union[str, None], Dict[str, Any]]
+        ]
+    ]:
     """
     Fetch registered Pipes' keys from the API.
     
@@ -142,7 +148,7 @@ def fetch_pipes_keys(
     -------
     A list of tuples containing pipes' keys.
     """
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     if connector_keys is None:
         connector_keys = []
     if metric_keys is None:
@@ -167,6 +173,8 @@ def fetch_pipes_keys(
             debug=debug
         ).json()
     except Exception as e:
+        import traceback
+        traceback.print_exc()
         error(str(e))
 
     if 'detail' in j:
@@ -185,10 +193,11 @@ def sync_pipe(
     """Sync a DataFrame into a Pipe."""
     from decimal import Decimal
     from meerschaum.utils.debug import dprint
-    from meerschaum.utils.misc import json_serialize_datetime, items_str, interval_str
+    from meerschaum.utils.dtypes import json_serialize_value
+    from meerschaum.utils.misc import items_str, interval_str
     from meerschaum.config import get_config
     from meerschaum.utils.packages import attempt_import
-    from meerschaum.utils.dataframe import get_numeric_cols, to_json
+    from meerschaum.utils.dataframe import get_special_cols, to_json
     begin = time.perf_counter()
     more_itertools = attempt_import('more_itertools')
     if df is None:
@@ -197,8 +206,10 @@ def sync_pipe(
 
     def get_json_str(c):
         ### allow syncing dict or JSON without needing to import pandas (for IOT devices)
-        if isinstance(c, (dict, list)):
-            return json.dumps(c, default=json_serialize_datetime)
+        if isinstance(c, str):
+            return c
+        if isinstance(c, (dict, list, tuple)):
+            return json.dumps(c, default=json_serialize_value)
         return to_json(c, orient='columns')
 
     df = json.loads(df) if isinstance(df, str) else df
@@ -218,26 +229,6 @@ def sync_pipe(
             else [partition.compute() for partition in df.partitions]
         )
 
-        numeric_cols = get_numeric_cols(df)
-        if numeric_cols:
-            for col in numeric_cols:
-                df[col] = df[col].apply(lambda x: f'{x:f}' if isinstance(x, Decimal) else x)
-            pipe_dtypes = pipe.dtypes
-            new_numeric_cols = [
-                col
-                for col in numeric_cols
-                if pipe_dtypes.get(col, None) != 'numeric'
-            ]
-            pipe.dtypes.update({
-                col: 'numeric'
-                for col in new_numeric_cols
-            })
-            edit_success, edit_msg = pipe.edit(debug=debug)
-            if not edit_success:
-                warn(
-                    "Failed to update new numeric columns "
-                    + f"{items_str(new_numeric_cols)}:\n{edit_msg}"
-                )
     elif isinstance(df, dict):
         ### `_chunks` is a dict of lists of dicts.
         ### e.g. {'a' : [ {'a':[1, 2]}, {'a':[3, 4]} ] }
@@ -313,7 +304,7 @@ def sync_pipe(
 
     success_tuple = True, (
         f"It took {interval_str(timedelta(seconds=(time.perf_counter() - begin)))} "
-        + "to sync {rowcount:,} row"
+        + f"to sync {rowcount:,} row"
         + ('s' if rowcount != 1 else '')
         + f" across {num_success_chunks:,} chunk" + ('s' if num_success_chunks != 1 else '') +
         f" to {pipe}."
@@ -324,7 +315,7 @@ def sync_pipe(
 def delete_pipe(
     self,
     pipe: Optional[mrsm.Pipe] = None,
-    debug: bool = None,        
+    debug: bool = False,
 ) -> SuccessTuple:
     """Delete a Pipe and drop its table."""
     if pipe is None:
@@ -576,7 +567,7 @@ def create_metadata(
     A bool indicating success.
     """
     from meerschaum.utils.debug import dprint
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     r_url = STATIC_CONFIG['api']['endpoints']['metadata']
     response = self.post(r_url, debug=debug)
     if debug:
@@ -663,7 +654,7 @@ def drop_pipe(
     from meerschaum.utils.warnings import error
     from meerschaum.utils.debug import dprint
     if pipe is None:
-        error(f"Pipe cannot be None.")
+        error("Pipe cannot be None.")
     r_url = pipe_r_url(pipe)
     response = self.delete(
         r_url + '/drop',

meerschaum/connectors/api/_plugins.py

@@ -16,7 +16,7 @@ def plugin_r_url(
     plugin: Union[mrsm.core.Plugin, str],
 ) -> str:
     """Generate a relative URL path from a Plugin."""
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     return f"{STATIC_CONFIG['api']['endpoints']['plugins']}/{plugin}"
 
 
@@ -111,7 +111,7 @@ def get_plugins(
     """
     import json
     from meerschaum.utils.warnings import error
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     response = self.get(
         STATIC_CONFIG['api']['endpoints']['plugins'],
         params = {'user_id': user_id, 'search_term': search_term},

meerschaum/connectors/api/_request.py

@@ -11,7 +11,7 @@ import urllib.parse
 import pathlib
 from meerschaum.utils.typing import Any, Optional, Dict, Union
 from meerschaum.utils.debug import dprint
-from meerschaum.config.static import STATIC_CONFIG
+from meerschaum._internal.static import STATIC_CONFIG
 
 METHODS = {
     'GET',

meerschaum/connectors/api/_tokens.py

@@ -0,0 +1,146 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Implement the `APIConnector` token methods.
+"""
+
+import json
+import uuid
+from datetime import datetime
+from typing import Union, List, Optional
+
+import meerschaum as mrsm
+from meerschaum.core import Token
+from meerschaum._internal.static import STATIC_CONFIG
+tokens_endpoint = STATIC_CONFIG['api']['endpoints']['tokens']
+
+
+def register_token(self, token: Token, debug: bool = False) -> mrsm.SuccessTuple:
+    """
+    Register the provided token to the API.
+    """
+    from meerschaum.utils.dtypes import json_serialize_value
+    r_url = tokens_endpoint + '/register'
+    response = self.post(
+        r_url,
+        data=json.dumps({
+            'label': token.label,
+            'scopes': token.scopes,
+            'expiration': token.expiration,
+        }, default=json_serialize_value),
+        debug=debug,
+    )
+    if not response:
+        return False, f"Failed to register token:\n{response.text}"
+
+    data = response.json()
+    token.label = data['label']
+    token.secret = data['secret']
+    token.id = uuid.UUID(data['id'])
+    if data.get('expiration', None):
+        token.expiration = datetime.fromisoformat(data['expiration'])
+
+    return True, f"Registered token '{token.label}'."
+
+
+def get_token_model(self, token_id: uuid.UUID, debug: bool = False) -> 'Union[TokenModel, None]':
+    """
+    Return a token's model from the API instance.
+    """
+    from meerschaum.models import TokenModel
+    r_url = tokens_endpoint + f'/{token_id}'
+    response = self.get(r_url, debug=debug)
+    if not response:
+        return None
+    data = response.json()
+    return TokenModel(**data)
+
+
+def get_tokens(self, labels: Optional[List[str]] = None, debug: bool = False) -> List[Token]:
+    """
+    Return the tokens registered to the current user.
+    """
+    from meerschaum.utils.warnings import warn
+    r_url = tokens_endpoint
+    params = {}
+    if labels:
+        params['labels'] = ','.join(labels)
+    response = self.get(r_url, params={'labels': labels}, debug=debug)
+    if not response:
+        warn(f"Could not get tokens from '{self}':\n{response.text}")
+        return []
+
+    tokens = [
+        Token(instance=self, **payload)
+        for payload in response.json()
+    ]
+    return tokens
+
+
+def edit_token(self, token: Token, debug: bool = False) -> mrsm.SuccessTuple:
+    """
+    Persist the token's in-memory state to the API.
+    """
+    r_url = tokens_endpoint + f"/{token.id}/edit"
+    response = self.post(
+        r_url,
+        json={
+            'creation': token.creation.isoformat() if token.creation else None,
+            'expiration': token.expiration.isoformat() if token.expiration else None,
+            'label': token.label,
+            'is_valid': token.is_valid,
+            'scopes': token.scopes,
+        },
+    )
+    if not response:
+        return False, f"Failed to edit token:\n{response.text}"
+
+    success, msg = response.json()
+    return success, msg
+
+
+def invalidate_token(self, token: Token, debug: bool = False) -> mrsm.SuccessTuple:
+    """
+    Invalidate the token, disabling it for future requests.
+    """
+    r_url = tokens_endpoint + f"/{token.id}/invalidate"
+    response = self.post(r_url)
+    if not response:
+        return False, f"Failed to invalidate token:\n{response.text}"
+
+    success, msg = response.json()
+    return success, msg
+
+
+def get_token_scopes(self, token_id: Union[uuid.UUID, Token], debug: bool = False) -> List[str]:
+    """
+    Return the scopes for a token.
+    """
+    _token_id = (token_id.id if isinstance(token_id, Token) else token_id)
+    model = self.get_token_model(_token_id, debug=debug).scopes
+    return getattr(model, 'scopes', [])
+
+
+def token_exists(self, token_id: Union[uuid.UUID, Token], debug: bool = False) -> bool:
+    """
+    Return `True` if a token exists.
+    """
+    _token_id = (token_id.id if isinstance(token_id, Token) else token_id)
+    model = self.get_token_model(_token_id, debug=debug)
+    if model is None:
+        return False
+    return model.creation is not None
+
+
+def delete_token(self, token: Token, debug: bool = False) -> mrsm.SuccessTuple:
+    """
+    Delete the token from the API.
+    """
+    r_url = tokens_endpoint + f"/{token.id}"
+    response = self.delete(r_url, debug=debug)
+    if not response:
+        return False, f"Failed to delete token:\n{response.text}"
+    
+    success, msg = response.json()
+    return success, msg

meerschaum/connectors/api/_users.py

@@ -7,18 +7,23 @@ Manage users via the API Connector.
 """
 
 from __future__ import annotations
-from meerschaum.utils.typing import Optional, Any, List, SuccessTuple
+
+import json
+from uuid import UUID
+
+import meerschaum as mrsm
+from meerschaum.utils.typing import Optional, Any, List, SuccessTuple, Union
+
 
 def get_users(
-        self,
-        debug: bool = False,
-        **kw : Any
-    ) -> List[str]:
+    self,
+    debug: bool = False,
+    **kw: Any
+) -> List[str]:
     """
     Return a list of registered usernames.
     """
-    from meerschaum.config.static import STATIC_CONFIG
-    import json
+    from meerschaum._internal.static import STATIC_CONFIG
     response = self.get(
         f"{STATIC_CONFIG['api']['endpoints']['users']}",
         debug = debug,
@@ -31,15 +36,15 @@ def get_users(
     except Exception as e:
         return []
 
+
 def edit_user(
-        self,
-        user: 'meerschaum.core.User',
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    self,
+    user: mrsm.core.User,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """Edit an existing user."""
-    import json
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     r_url = f"{STATIC_CONFIG['api']['endpoints']['users']}/edit"
     data = {
         'username': user.username,
@@ -54,7 +59,7 @@ def edit_user(
         if isinstance(_json, dict) and 'detail' in _json:
             return False, _json['detail']
         success_tuple = tuple(_json)
-    except Exception as e:
+    except Exception:
         msg = response.text if response else f"Failed to edit user '{user}'."
         return False, msg
 
@@ -62,14 +67,13 @@ def edit_user(
 
 
 def register_user(
-        self,
-        user: 'meerschaum.core.User',
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    self,
+    user: mrsm.core.User,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """Register a new user."""
-    import json
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     r_url = f"{STATIC_CONFIG['api']['endpoints']['users']}/register"
     data = {
         'username': user.username,
@@ -94,31 +98,37 @@ def register_user(
 
     
 def get_user_id(
-        self,
-        user: 'meerschaum.core.User',
-        debug: bool = False,
-        **kw: Any
-    ) -> Optional[int]:
+    self,
+    user: mrsm.core.User,
+    debug: bool = False,
+    **kw: Any
+) -> Union[int, str, UUID, None]:
     """Get a user's ID."""
-    from meerschaum.config.static import STATIC_CONFIG
-    import json
+    from meerschaum._internal.static import STATIC_CONFIG
+    from meerschaum.utils.misc import is_int, is_uuid
     r_url = f"{STATIC_CONFIG['api']['endpoints']['users']}/{user.username}/id"
     response = self.get(r_url, debug=debug, **kw)
     try:
-        user_id = int(json.loads(response.text))
+        id_text = str(json.loads(response.text))
+        if is_int(id_text):
+            user_id = int(id_text)
+        elif is_uuid(id_text):
+            user_id = UUID(id_text)
+        else:
+            user_id = id_text
     except Exception as e:
         user_id = None
     return user_id
 
+
 def delete_user(
-        self,
-        user: 'meerschaum.core.User',
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    self,
+    user: mrsm.core.User,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """Delete a user."""
-    from meerschaum.config.static import STATIC_CONFIG
-    import json
+    from meerschaum._internal.static import STATIC_CONFIG
     r_url = f"{STATIC_CONFIG['api']['endpoints']['users']}/{user.username}"
     response = self.delete(r_url, debug=debug)
     try:
@@ -126,53 +136,55 @@ def delete_user(
         if isinstance(_json, dict) and 'detail' in _json:
             return False, _json['detail']
         success_tuple = tuple(_json)
-    except Exception as e:
+    except Exception:
         success_tuple = False, f"Failed to delete user '{user.username}'."
     return success_tuple
 
+
 def get_user_attributes(
-        self,
-        user: 'meerschaum.core.User',
-        debug: bool = False,
-        **kw
-    ) -> int:
+    self,
+    user: mrsm.core.User,
+    debug: bool = False,
+    **kw
+) -> int:
     """Get a user's attributes."""
-    from meerschaum.config.static import STATIC_CONFIG
-    import json
+    from meerschaum._internal.static import STATIC_CONFIG
     r_url = f"{STATIC_CONFIG['api']['endpoints']['users']}/{user.username}/attributes"
     response = self.get(r_url, debug=debug, **kw)
     try:
         attributes = json.loads(response.text)
-    except Exception as e:
+    except Exception:
         attributes = None
     return attributes
 
+
 #############################
 # Chaining functions below. #
 #############################
 
 def get_user_password_hash(
-        self,
-        user: 'meerschaum.core.User',
-        debug: bool = False,
-        **kw: Any
-    ) -> Optional[str]:
+    self,
+    user: mrsm.core.User,
+    debug: bool = False,
+    **kw: Any
+) -> Optional[str]:
     """If configured, get a user's password hash."""
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     r_url = STATIC_CONFIG['api']['endpoints']['users'] + '/' + user.username + '/password_hash'
     response = self.get(r_url, debug=debug, **kw)
     if not response:
         return None
     return response.json()
 
+
 def get_user_type(
-        self,
-        user: 'meerschaum.core.User',
-        debug: bool = False,
-        **kw: Any
-    ) -> Optional[str]:
+    self,
+    user: mrsm.core.User,
+    debug: bool = False,
+    **kw: Any
+) -> Optional[str]:
     """If configured, get a user's type."""
-    from meerschaum.config.static import STATIC_CONFIG
+    from meerschaum._internal.static import STATIC_CONFIG
     r_url = STATIC_CONFIG['api']['endpoints']['users'] + '/' + user.username + '/type'
     response = self.get(r_url, debug=debug, **kw)
     if not response: