meerschaum 2.3.6__py3-none-any.whl → 2.4.0__py3-none-any.whl

meerschaum/config/static/__init__.py

@@ -53,6 +53,9 @@ STATIC_CONFIG: Dict[str, Any] = {
         'internal_schema': '_mrsm_internal',
         'instance_schema': 'mrsm',
     },
+    'valkey': {
+        'colon': '-_',
+    },
     'environment': {
         'config': 'MRSM_CONFIG',
         'config_dir': 'MRSM_CONFIG_DIR',
@@ -69,6 +72,7 @@ STATIC_CONFIG: Dict[str, Any] = {
         'uid': 'MRSM_UID',
         'gid': 'MRSM_GID',
         'noask': 'MRSM_NOASK',
+        'noninteractive': 'MRSM_NONINTERACTIVE',
         'id': 'MRSM_SERVER_ID',
         'daemon_id': 'MRSM_DAEMON_ID',
         'systemd_log_path': 'MRSM_SYSTEMD_LOG_PATH',

meerschaum/connectors/{Connector.py → _Connector.py}

@@ -53,17 +53,23 @@ class Connector(metaclass=abc.ABCMeta):
         """
         self._original_dict = copy.deepcopy(self.__dict__)
         self._set_attributes(type=type, label=label, **kw)
-        self.verify_attributes(getattr(self, 'REQUIRED_ATTRIBUTES', None))
+
+        ### NOTE: Override `REQUIRED_ATTRIBUTES` if `uri` is set.
+        self.verify_attributes(
+            ['uri']
+            if 'uri' in self.__dict__
+            else getattr(self, 'REQUIRED_ATTRIBUTES', None)
+        )
 
     def _reset_attributes(self):
         self.__dict__ = self._original_dict
 
     def _set_attributes(
-            self,
-            *args,
-            inherit_default: bool = True,
-            **kw: Any
-        ):
+        self,
+        *args,
+        inherit_default: bool = True,
+        **kw: Any
+    ):
         from meerschaum.config.static import STATIC_CONFIG
         from meerschaum.utils.warnings import error
 
@@ -114,12 +120,11 @@ class Connector(metaclass=abc.ABCMeta):
         ### finally, update __dict__ with _attributes.
         self.__dict__.update(self._attributes)
 
-
     def verify_attributes(
-            self,
-            required_attributes: Optional[List[str]] = None,
-            debug: bool = False
-        ) -> None:
+        self,
+        required_attributes: Optional[List[str]] = None,
+        debug: bool = False,
+    ) -> None:
         """
         Ensure that the required attributes have been met.
         
@@ -147,6 +152,7 @@ class Connector(metaclass=abc.ABCMeta):
         from meerschaum.utils.misc import items_str
         if required_attributes is None:
             required_attributes = ['label']
+
         missing_attributes = set()
         for a in required_attributes:
             if a not in self.__dict__:
@@ -158,8 +164,8 @@ class Connector(metaclass=abc.ABCMeta):
                     + f"for connector '{self.type}:{self.label}'."
                 ),
                 InvalidAttributesError,
-                silent = True,
-                stack = False
+                silent=True,
+                stack=False
             )
 
 

meerschaum/connectors/__init__.py

@@ -14,13 +14,13 @@ For ease of use, you can also import from the root `meerschaum` module:
 from __future__ import annotations
 
 import meerschaum as mrsm
-from meerschaum.utils.typing import Any, SuccessTuple, Union, Optional, List, Dict
-from meerschaum.utils.threading import Lock, RLock
-from meerschaum.utils.warnings import error, warn
+from meerschaum.utils.typing import Any, Union, List, Dict
+from meerschaum.utils.threading import RLock
+from meerschaum.utils.warnings import warn
 
-from meerschaum.connectors.Connector import Connector, InvalidAttributesError
-from meerschaum.connectors.sql.SQLConnector import SQLConnector
-from meerschaum.connectors.api.APIConnector import APIConnector
+from meerschaum.connectors._Connector import Connector, InvalidAttributesError
+from meerschaum.connectors.sql._SQLConnector import SQLConnector
+from meerschaum.connectors.api._APIConnector import APIConnector
 from meerschaum.connectors.sql._create_engine import flavor_configs as sql_flavor_configs
 
 __all__ = (
@@ -31,6 +31,9 @@ __all__ = (
     "get_connector",
     "is_connected",
     "poll",
+    "api",
+    "sql",
+    "valkey",
 )
 
 ### store connectors partitioned by
@@ -39,6 +42,7 @@ connectors: Dict[str, Dict[str, Connector]] = {
     'api'    : {},
     'sql'    : {},
     'plugin' : {},
+    'valkey' : {},
 }
 instance_types: List[str] = ['sql', 'api']
 _locks: Dict[str, RLock] = {
@@ -53,7 +57,10 @@ attributes: Dict[str, Dict[str, Any]] = {
         'required': [
             'host',
             'username',
-            'password'
+            'password',
+        ],
+        'optional': [
+            'port',
         ],
         'default': {
             'protocol': 'http',
@@ -164,13 +171,15 @@ def get_connector(
 
     if 'sql' not in types:
         from meerschaum.connectors.plugin import PluginConnector
+        from meerschaum.connectors.valkey import ValkeyConnector
         with _locks['types']:
             types.update({
-                'api'   : APIConnector,
-                'sql'   : SQLConnector,
+                'api': APIConnector,
+                'sql': SQLConnector,
                 'plugin': PluginConnector,
+                'valkey': ValkeyConnector,
             })
-    
+
     ### determine if we need to call the constructor
     if not refresh:
         ### see if any user-supplied arguments differ from the existing instance
@@ -260,11 +269,11 @@ def is_connected(keys: str, **kw) -> bool:
 
     try:
         typ, label = keys.split(':')
-    except Exception as e:
+    except Exception:
         return False
     if typ not in instance_types:
         return False
-    if not (label in connectors.get(typ, {})):
+    if label not in connectors.get(typ, {}):
         return False
 
     from meerschaum.connectors.parse import parse_instance_keys
@@ -273,7 +282,7 @@ def is_connected(keys: str, **kw) -> bool:
         with warnings.catch_warnings():
             warnings.filterwarnings('ignore')
             return conn.test_connection(**kw)
-    except Exception as e:
+    except Exception:
         return False
 
 
@@ -340,7 +349,7 @@ def load_plugin_connectors():
             to_import.append(plugin.name)
     if not to_import:
         return
-    import_plugins(*to_import) 
+    import_plugins(*to_import)
 
 
 def get_connector_plugin(
@@ -378,3 +387,4 @@ def _load_builtin_custom_connectors():
     Import custom connectors decorated with `@make_connector` or `@make_executor`.
     """
     import meerschaum.jobs.systemd
+    import meerschaum.connectors.valkey

meerschaum/connectors/api/{APIConnector.py → _APIConnector.py}

@@ -7,7 +7,7 @@ Interact with Meerschaum APIs. May be chained together (see 'meerschaum:api_inst
 """
 
 from datetime import datetime, timedelta, timezone
-from meerschaum.utils.typing import Optional
+from meerschaum.utils.typing import Optional, List
 from meerschaum.connectors import Connector
 from meerschaum.utils.warnings import warn, error
 from meerschaum.utils.packages import attempt_import
@@ -24,6 +24,8 @@ class APIConnector(Connector):
     IS_INSTANCE: bool = True
     IS_THREAD_SAFE: bool = False
 
+    OPTIONAL_ATTRIBUTES: List[str] = ['port']
+
     from ._request import (
         make_request,
         get,

meerschaum/connectors/api/__init__.py

@@ -6,5 +6,6 @@
 Interact with the Meerschaum API (send commands, pull data, etc.)
 """
 
-from meerschaum.connectors.api.APIConnector import APIConnector
+from meerschaum.connectors.api._APIConnector import APIConnector
 
+__all__ = ('APIConnector',)

meerschaum/connectors/parse.py

@@ -7,7 +7,10 @@ Utility functions for parsing connector keys.
 """
 
 from __future__ import annotations
-from meerschaum.utils.typing import Mapping, Any, SuccessTuple, Union, Optional, Dict, Tuple
+
+import meerschaum as mrsm
+from meerschaum.utils.typing import Any, Union, Optional, Dict, Tuple
+
 
 def parse_connector_keys(
     keys: str,
@@ -15,20 +18,20 @@ def parse_connector_keys(
     as_tuple: bool = False,
     **kw:  Any
 ) -> (
-        Union[
-            meerschaum.connectors.Connector,
-            Dict[str, Any],
-            Tuple[
-                Union[
-                    meerschaum.connectors.Connector,
-                    Dict[str, Any],
-                    None
-                ],
-                str
+    Union[
+        mrsm.connectors.Connector,
+        Dict[str, Any],
+        Tuple[
+            Union[
+                mrsm.connectors.Connector,
+                Dict[str, Any],
+                None,
             ],
-            None
-        ]
-    ):
+            str
+        ],
+        None
+    ]
+):
     """
     Convenience function for parsing connector keys and returning Connector objects.
 
@@ -95,13 +98,12 @@ def parse_instance_keys(
     """
     Parse the Meerschaum instance value into a Connector object.
     """
-    from meerschaum.utils.warnings import warn
     from meerschaum.config import get_config
 
     if keys is None:
         keys = get_config('meerschaum', 'instance')
     keys = str(keys)
-    
+
     return parse_connector_keys(keys, construct=construct, as_tuple=as_tuple, **kw)
 
 

meerschaum/connectors/poll.py

@@ -9,16 +9,16 @@ Poll database and API connections.
 from meerschaum.utils.typing import InstanceConnector, Union, Optional, Dict, Any
 
 def retry_connect(
-        connector: Union[InstanceConnector, None] = None,
-        max_retries: int = 50,
-        retry_wait: int = 3,
-        workers: int = 1,
-        warn: bool = True,
-        print_on_connect: bool = False,
-        enforce_chaining: bool = True,
-        enforce_login: bool = True,
-        debug: bool = False,
-    ) -> bool:
+    connector: Union[InstanceConnector, None] = None,
+    max_retries: int = 50,
+    retry_wait: int = 3,
+    workers: int = 1,
+    warn: bool = True,
+    print_on_connect: bool = False,
+    enforce_chaining: bool = True,
+    enforce_login: bool = True,
+    debug: bool = False,
+) -> bool:
     """
     Keep trying to connect to the database.
 
@@ -85,16 +85,16 @@ def retry_connect(
 
 
 def _wrap_retry_connect(
-        connector_meta: Dict[str, Any],
-        max_retries: int = 50,
-        retry_wait: int = 3,
-        workers: int = 1,
-        print_on_connect: bool = False,
-        warn: bool = True,
-        enforce_chaining: bool = True,
-        enforce_login: bool = True,
-        debug: bool = False,
-    ) -> bool:
+    connector_meta: Dict[str, Any],
+    max_retries: int = 50,
+    retry_wait: int = 3,
+    workers: int = 1,
+    print_on_connect: bool = False,
+    warn: bool = True,
+    enforce_chaining: bool = True,
+    enforce_login: bool = True,
+    debug: bool = False,
+) -> bool:
     """
     Keep trying to connect to the database.
 
@@ -144,8 +144,6 @@ def _wrap_retry_connect(
     import time
 
     connector = get_connector(**connector_meta)
-    if connector.type not in instance_types:
-        return None
 
     if not hasattr(connector, 'test_connection'):
         return True
@@ -157,7 +155,15 @@ def _wrap_retry_connect(
             dprint(f"Trying to connect to '{connector}'...")
             dprint(f"Attempt ({retries + 1} / {max_retries})")
 
-        if connector.type == 'sql':
+        if connector.type not in ('sql', 'api'):
+            try:
+                connected = connector.test_connection()
+            except Exception as e:
+                if warn:
+                    print(e)
+                connected = False
+
+        elif connector.type == 'sql':
 
             def _connect(_connector):
                 ### Test queries like `SELECT 1`.
@@ -185,7 +191,7 @@ def _wrap_retry_connect(
                             _warn(
                                 f"Meerschaum instance '{connector}' does not allow chaining " +
                                 "and cannot be used as the parent for this instance.",
-                                stack = False
+                                stack=False,
                             )
                         return False
 

meerschaum/connectors/sql/__init__.py

@@ -6,4 +6,6 @@
 Subpackage for SQLConnector subclass
 """
 
-from meerschaum.connectors.sql.SQLConnector import SQLConnector
+from meerschaum.connectors.sql._SQLConnector import SQLConnector
+
+__all__ = ('SQLConnector',)