meerschaum 1.7.1__py3-none-any.whl → 1.7.3__py3-none-any.whl

meerschaum/connectors/api/_misc.py

@@ -11,22 +11,12 @@ from meerschaum.utils.typing import Optional
 
 def get_mrsm_version(self, **kw) -> Optional[str]:
     """
-
-    Parameters
-    ----------
-    **kw :
-        
-
-    Returns
-    -------
-    type
-        
-
+    Return the Meerschaum version of the API instance.
     """
-    from meerschaum.config.static import _static_config
+    from meerschaum.config.static import STATIC_CONFIG
     try:
         j = self.get(
-            _static_config()['api']['endpoints']['version'] + '/mrsm',
+            STATIC_CONFIG['api']['endpoints']['version'] + '/mrsm',
             use_token = True,
             **kw
         ).json()
@@ -38,22 +28,12 @@ def get_mrsm_version(self, **kw) -> Optional[str]:
 
 def get_chaining_status(self, **kw) -> Optional[bool]:
     """
-
-    Parameters
-    ----------
-    **kw :
-        
-
-    Returns
-    -------
-    type
-        
-
+    Fetch the chaining status of the API instance.
     """
-    from meerschaum.config.static import _static_config
+    from meerschaum.config.static import STATIC_CONFIG
     try:
         response = self.get(
-            _static_config()['api']['endpoints']['chaining'],
+            STATIC_CONFIG['api']['endpoints']['chaining'],
             use_token = True,
             **kw
         )

meerschaum/connectors/api/_plugins.py

@@ -13,8 +13,8 @@ def plugin_r_url(
         plugin: Union[meerschaum.core.Plugin, str]
     ) -> str:
     """Generate a relative URL path from a Plugin."""
-    from meerschaum.config.static import _static_config
-    return f"{_static_config()['api']['endpoints']['plugins']}/{plugin}"
+    from meerschaum.config.static import STATIC_CONFIG
+    return f"{STATIC_CONFIG['api']['endpoints']['plugins']}/{plugin}"
 
 def register_plugin(
         self,
@@ -105,9 +105,9 @@ def get_plugins(
     """
     import json
     from meerschaum.utils.warnings import warn, error
-    from meerschaum.config.static import _static_config
+    from meerschaum.config.static import STATIC_CONFIG
     response = self.get(
-        _static_config()['api']['endpoints']['plugins'],
+        STATIC_CONFIG['api']['endpoints']['plugins'],
         params = {'user_id' : user_id, 'search_term' : search_term},
         use_token = True,
         debug = debug
@@ -129,7 +129,6 @@ def get_plugin_attributes(
     """
     import json
     from meerschaum.utils.warnings import warn, error
-    from meerschaum.config.static import _static_config
     r_url = plugin_r_url(plugin) + '/attributes'
     response = self.get(r_url, use_token=True, debug=debug)
     attributes = response.json()

meerschaum/connectors/api/_users.py

@@ -17,10 +17,10 @@ def get_users(
     """
     Return a list of registered usernames.
     """
-    from meerschaum.config.static import _static_config
+    from meerschaum.config.static import STATIC_CONFIG
     import json
     response = self.get(
-        f"{_static_config()['api']['endpoints']['users']}",
+        f"{STATIC_CONFIG['api']['endpoints']['users']}",
         debug = debug,
         use_token = True,
     )
@@ -69,8 +69,8 @@ def register_user(
     ) -> SuccessTuple:
     """Register a new user."""
     import json
-    from meerschaum.config.static import _static_config
-    r_url = f"{_static_config()['api']['endpoints']['users']}/register"
+    from meerschaum.config.static import STATIC_CONFIG
+    r_url = f"{STATIC_CONFIG['api']['endpoints']['users']}/register"
     data = {
         'username': user.username,
         'password': user.password,
@@ -100,9 +100,9 @@ def get_user_id(
         **kw: Any
     ) -> Optional[int]:
     """Get a user's ID."""
-    from meerschaum.config.static import _static_config
+    from meerschaum.config.static import STATIC_CONFIG
     import json
-    r_url = f"{_static_config()['api']['endpoints']['users']}/{user.username}/id"
+    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))
@@ -117,9 +117,9 @@ def delete_user(
         **kw: Any
     ) -> SuccessTuple:
     """Delete a user."""
-    from meerschaum.config.static import _static_config
+    from meerschaum.config.static import STATIC_CONFIG
     import json
-    r_url = f"{_static_config()['api']['endpoints']['users']}/{user.username}"
+    r_url = f"{STATIC_CONFIG['api']['endpoints']['users']}/{user.username}"
     response = self.delete(r_url, debug=debug)
     try:
         _json = json.loads(response.text)
@@ -137,9 +137,9 @@ def get_user_attributes(
         **kw
     ) -> int:
     """Get a user's attributes."""
-    from meerschaum.config.static import _static_config
+    from meerschaum.config.static import STATIC_CONFIG
     import json
-    r_url = f"{_static_config()['api']['endpoints']['users']}/{user.username}/attributes"
+    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)
@@ -158,8 +158,8 @@ def get_user_password_hash(
         **kw: Any
     ) -> Optional[str]:
     """If configured, get a user's password hash."""
-    from meerschaum.config.static import _static_config
-    r_url = _static_config()['api']['endpoints']['users'] + '/' + user.username + '/password_hash'
+    from meerschaum.config.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
@@ -172,8 +172,8 @@ def get_user_type(
         **kw: Any
     ) -> Optional[str]:
     """If configured, get a user's type."""
-    from meerschaum.config.static import _static_config
-    r_url = _static_config()['api']['endpoints']['users'] + '/' + user.username + '/type'
+    from meerschaum.config.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:
         return None

meerschaum/connectors/parse.py

@@ -53,14 +53,14 @@ def parse_connector_keys(
     import copy
     from meerschaum.connectors import get_connector
     from meerschaum.config import get_config
-    from meerschaum.config.static import _static_config
+    from meerschaum.config.static import STATIC_CONFIG
     from meerschaum.utils.warnings import error
 
     ### `get_connector()` handles the logic for falling back to 'main',
     ### so don't make any decisions here.
     vals = str(keys).split(':')
     _type = vals[0]
-    _label = vals[1] if len(vals) > 1 else _static_config()['connectors']['default_label']
+    _label = vals[1] if len(vals) > 1 else STATIC_CONFIG['connectors']['default_label']
     _get_connector_kw = {'type': _type, 'label': _label}
     _get_connector_kw.update(kw)
 

meerschaum/connectors/sql/_users.py

@@ -70,7 +70,7 @@ def valid_username(username: str) -> SuccessTuple:
     if len(username) > max_length:
         fail_reasons.append(f"Usernames must contain {max_length} or fewer characters.")
 
-    acceptable_chars = {'_', '-'}
+    acceptable_chars = {'_', '-', '.', '@'}
     for c in username:
         if not c.isalnum() and c not in acceptable_chars:
             fail_reasons.append(

meerschaum/core/User/_User.py

@@ -13,9 +13,9 @@ pwd_context = None
 def get_pwd_context():
     global pwd_context
     if pwd_context is None:
-        from meerschaum.config.static import _static_config
+        from meerschaum.config.static import STATIC_CONFIG
         from meerschaum.utils.packages import attempt_import
-        hash_config = _static_config()['users']['password_hash']
+        hash_config = STATIC_CONFIG['users']['password_hash']
         passlib_context = attempt_import('passlib.context')
         pwd_context = passlib_context.CryptContext(
             schemes = hash_config['schemes'],
@@ -24,7 +24,11 @@ def get_pwd_context():
         )
     return pwd_context
 
-class User():
+class User:
+    """
+    The Meerschaum User object manages authentication to a given instance.
+    """
+
     def __init__(
         self,
         username: str,

meerschaum/utils/venv/_Venv.py

@@ -93,6 +93,8 @@ class Venv:
         Return the top-level path for this virtual environment.
         """
         from meerschaum.config._paths import VIRTENV_RESOURCES_PATH
+        if self._venv is None:
+            return self.target_path.parent
         return VIRTENV_RESOURCES_PATH / self._venv
 
 

meerschaum/utils/venv/__init__.py

@@ -579,16 +579,21 @@ def venv_target_path(
 
         if not inside_venv():
             site_path = pathlib.Path(site.getusersitepackages())
-            ### Allow for dist-level paths (running as root).
             if not site_path.exists():
-                if platform.system() == 'Windows' or os.geteuid() == 0:
-                    for possible_dist in reversed(site.getsitepackages()):
-                        dist_path = pathlib.Path(possible_dist)
-                        if not dist_path.exists():
-                            continue
-                        return dist_path
-                    
-                    raise EnvironmentError("Could not determine the dist-packages directory.")
+
+                ### Windows does not have `os.geteuid()`.
+                if platform.system() == 'Windows' or os.geteuid() != 0:
+                    site_path.mkdir(parents=True, exist_ok=True)
+                    return site_path
+
+                ### Allow for dist-level paths (running as root).
+                for possible_dist in reversed(site.getsitepackages()):
+                    dist_path = pathlib.Path(possible_dist)
+                    if not dist_path.exists():
+                        continue
+                    return dist_path
+                
+                raise EnvironmentError("Could not determine the dist-packages directory.")
 
             return site_path