meerschaum 2.3.5.dev0__py3-none-any.whl → 2.4.0__py3-none-any.whl

meerschaum/connectors/sql/_plugins.py

@@ -7,15 +7,19 @@ Functions for managing plugins registration via the SQL connector
 """
 
 from __future__ import annotations
+
+import json
+
+import meerschaum as mrsm
 from meerschaum.utils.typing import Optional, Any, List, SuccessTuple, Dict
 
 def register_plugin(
-        self,
-        plugin: 'meerschaum.core.Plugin',
-        force: bool = False,
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    self,
+    plugin: 'mrsm.core.Plugin',
+    force: bool = False,
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """Register a new plugin to the plugins table."""
     from meerschaum.utils.warnings import warn, error
     from meerschaum.utils.packages import attempt_import
@@ -46,14 +50,13 @@ def register_plugin(
                 f"must be greater than existing version '{old_version}'."
             )
 
-    import json
     bind_variables = {
-        'plugin_name' : plugin.name,
-        'version' : plugin.version,
-        'attributes' : (
+        'plugin_name': plugin.name,
+        'version': plugin.version,
+        'attributes': (
             json.dumps(plugin.attributes) if self.flavor not in json_flavors else plugin.attributes
         ),
-        'user_id' : plugin.user_id,
+        'user_id': plugin.user_id,
     }
 
     if old_id is None:
@@ -71,10 +74,10 @@ def register_plugin(
     return True, f"Successfully registered plugin '{plugin}'."
 
 def get_plugin_id(
-        self,
-        plugin: 'meerschaum.core.Plugin',
-        debug: bool = False
-    ) -> Optional[int]:
+    self,
+    plugin: 'mrsm.core.Plugin',
+    debug: bool = False
+) -> Optional[int]:
     """
     Return a plugin's ID.
     """
@@ -96,10 +99,10 @@ def get_plugin_id(
         return None
 
 def get_plugin_version(
-        self,
-        plugin: 'meerschaum.core.Plugin',
-        debug: bool = False
-    ) -> Optional[str]:
+    self,
+    plugin: 'mrsm.core.Plugin',
+    debug: bool = False
+) -> Optional[str]:
     """
     Return a plugin's version.
     """
@@ -112,10 +115,10 @@ def get_plugin_version(
     return self.value(query, debug=debug)
 
 def get_plugin_user_id(
-        self,
-        plugin: 'meerschaum.core.Plugin',
-        debug: bool = False
-    ) -> Optional[int]:
+    self,
+    plugin: 'mrsm.core.Plugin',
+    debug: bool = False
+) -> Optional[int]:
     """
     Return a plugin's user ID.
     """
@@ -137,10 +140,10 @@ def get_plugin_user_id(
         return None
 
 def get_plugin_username(
-        self,
-        plugin: 'meerschaum.core.Plugin',
-        debug: bool = False
-    ) -> Optional[str]:
+    self,
+    plugin: 'mrsm.core.Plugin',
+    debug: bool = False
+) -> Optional[str]:
     """
     Return the username of a plugin's owner.
     """
@@ -163,16 +166,15 @@ def get_plugin_username(
 
 
 def get_plugin_attributes(
-        self,
-        plugin: 'meerschaum.core.Plugin',
-        debug: bool = False
-    ) -> Dict[str, Any]:
+    self,
+    plugin: 'mrsm.core.Plugin',
+    debug: bool = False
+) -> Dict[str, Any]:
     """
     Return the attributes of a plugin.
     """
     ### ensure plugins table exists
     from meerschaum.connectors.sql.tables import get_tables
-    import json
     plugins_tbl = get_tables(mrsm_instance=self, debug=debug)['plugins']
     from meerschaum.utils.packages import attempt_import
     sqlalchemy = attempt_import('sqlalchemy')
@@ -191,12 +193,12 @@ def get_plugin_attributes(
     return _attr
 
 def get_plugins(
-        self,
-        user_id: Optional[int] = None,
-        search_term: Optional[str] = None,
-        debug: bool = False,
-        **kw: Any
-    ) -> List[str]:
+    self,
+    user_id: Optional[int] = None,
+    search_term: Optional[str] = None,
+    debug: bool = False,
+    **kw: Any
+) -> List[str]:
     """
     Return a list of all registered plugins.
 
@@ -238,11 +240,11 @@ def get_plugins(
 
 
 def delete_plugin(
-        self,
-        plugin: 'meerschaum.core.Plugin',
-        debug: bool = False,
-        **kw: Any
-    ) -> SuccessTuple:
+    self,
+    plugin: 'mrsm.core.Plugin',
+    debug: bool = False,
+    **kw: Any
+) -> SuccessTuple:
     """Delete a plugin from the plugins table."""
     from meerschaum.utils.warnings import warn, error
     from meerschaum.utils.packages import attempt_import

meerschaum/connectors/sql/_users.py

@@ -7,14 +7,17 @@ Manage users via the SQL Connector
 """
 
 from __future__ import annotations
+
+import meerschaum as mrsm
 from meerschaum.utils.typing import SuccessTuple, Optional, Any, Dict, List, Union
 
+
 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."""
     from meerschaum.utils.warnings import warn, error, info
     from meerschaum.utils.packages import attempt_import
@@ -57,6 +60,7 @@ def register_user(
         return False, f"Failed to register user '{user}'."
     return True, f"Successfully registered user '{user}'."
 
+
 def valid_username(username: str) -> SuccessTuple:
     """Verify that a given username is valid."""
     from meerschaum.config.static import STATIC_CONFIG
@@ -75,7 +79,7 @@ def valid_username(username: str) -> SuccessTuple:
         if not c.isalnum() and c not in acceptable_chars:
             fail_reasons.append(
                 (
-                    f"Usernames may only contain alphanumeric characters " +
+                    "Usernames may only contain alphanumeric characters " +
                     "and the following special characters: "
                     + str(list(acceptable_chars))
                 )
@@ -92,11 +96,11 @@ def valid_username(username: str) -> SuccessTuple:
 
 
 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:
     """Update an existing user's metadata."""
     from meerschaum.utils.packages import attempt_import
     sqlalchemy = attempt_import('sqlalchemy')
@@ -145,11 +149,12 @@ def edit_user(
         return False, f"Failed to edit user '{user}'."
     return True, f"Successfully edited user '{user}'."
 
+
 def get_user_id(
-        self,
-        user: meerschaum.core.User,
-        debug : bool = False
-    ) -> Optional[int]:
+    self,
+    user: 'mrsm.core.User',
+    debug: bool = False
+) -> Optional[int]:
     """If a user is registered, return the `user_id`."""
     ### ensure users table exists
     from meerschaum.utils.packages import attempt_import
@@ -168,10 +173,10 @@ def get_user_id(
     return None
 
 def get_user_attributes(
-        self,
-        user: meerschaum.core.User,
-        debug: bool = False
-    ) -> Union[Dict[str, Any], None]:
+    self,
+    user: 'mrsm.core.User',
+    debug: bool = False
+) -> Union[Dict[str, Any], None]:
     """
     Return the user's attributes.
     """
@@ -208,10 +213,10 @@ def get_user_attributes(
     return result
 
 def delete_user(
-        self,
-        user: meerschaum.core.User,
-        debug: bool = False
-    ) -> SuccessTuple:
+    self,
+    user: 'mrsm.core.User',
+    debug: bool = False
+) -> SuccessTuple:
     """Delete a user's record from the users table."""
     ### ensure users table exists
     from meerschaum.connectors.sql.tables import get_tables
@@ -238,11 +243,12 @@ def delete_user(
 
     return True, f"Successfully deleted user '{user}'"
 
+
 def get_users(
-        self,
-        debug: bool = False,
-        **kw: Any
-    ) -> List[str]:
+    self,
+    debug: bool = False,
+    **kw: Any
+) -> List[str]:
     """
     Get the registered usernames.
     """
@@ -256,12 +262,13 @@ def get_users(
 
     return list(self.read(query, debug=debug)['username'])
 
+
 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]:
     """
     Return the password has for a user.
     **NOTE**: This may be dangerous and is only allowed if the security settings explicity allow it.
@@ -278,7 +285,7 @@ def get_user_password_hash(
             dprint(f"Already given user_id: {user_id}")
     else:
         if debug:
-            dprint(f"Fetching user_id...")
+            dprint("Fetching user_id...")
         user_id = self.get_user_id(user, debug=debug)
 
     if user_id is None:
@@ -288,12 +295,13 @@ def get_user_password_hash(
 
     return self.value(query, debug=debug)
 
+
 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]:
     """
     Return the user's type.
     """