synapse 2.219.0__py311-none-any.whl → 2.221.0__py311-none-any.whl

synapse/lib/stormlib/auth.py

@@ -83,7 +83,7 @@ stormcmds = (
             ('--email', {'type': 'str', 'help': 'The email address to set for the user.'}),
             ('--passwd', {'type': 'str', 'help': 'The new password for the user. This is best passed into the runtime as a variable.'}),
             ('--admin', {'type': 'bool', 'help': 'True to make the user and admin, false to remove their remove their admin status.'}),
-            ('--gate', {'type': 'str', 'help': 'The auth gate iden to grant or revoke admin status on. Use in conjunction with `--admin <bool>`.'}),
+            ('--gate', {'type': 'str', 'help': 'The auth gate iden to grant or revoke admin status on. Use in conjunction with `--admin <boolean>`.'}),
             ('--locked', {'type': 'bool', 'help': 'True to lock the user, false to unlock them.'}),
         ),
         'storm': '''
@@ -681,34 +681,34 @@ class UserJson(s_stormtypes.Prim):
         {'name': 'get', 'desc': 'Return a stored JSON object or object property for the user.',
          'type': {'type': 'function', '_funcname': 'get',
                    'args': (
-                        {'name': 'path', 'type': 'str|list', 'desc': 'A path string or list of path parts.'},
-                        {'name': 'prop', 'type': 'str|list', 'desc': 'A property name or list of name parts.', 'default': None},
+                        {'name': 'path', 'type': ['str', 'list'], 'desc': 'A path string or list of path parts.'},
+                        {'name': 'prop', 'type': ['str', 'list'], 'desc': 'A property name or list of name parts.', 'default': None},
                     ),
                     'returns': {'type': 'prim', 'desc': 'The previously stored value or ``(null)``.'}}},
 
         {'name': 'set', 'desc': 'Set a JSON object or object property for the user.',
          'type': {'type': 'function', '_funcname': 'set',
                   'args': (
-                       {'name': 'path', 'type': 'str|list', 'desc': 'A path string or list of path elements.'},
+                       {'name': 'path', 'type': ['str', 'list'], 'desc': 'A path string or list of path elements.'},
                        {'name': 'valu', 'type': 'prim', 'desc': 'The value to set as the JSON object or object property.'},
-                       {'name': 'prop', 'type': 'str|list', 'desc': 'A property name or list of name parts.', 'default': None},
+                       {'name': 'prop', 'type': ['str', 'list'], 'desc': 'A property name or list of name parts.', 'default': None},
                    ),
                    'returns': {'type': 'boolean', 'desc': 'True if the set operation was successful.'}}},
 
         {'name': 'del', 'desc': 'Delete a stored JSON object or object property for the user.',
          'type': {'type': 'function', '_funcname': '_del',
                   'args': (
-                       {'name': 'path', 'type': 'str|list', 'desc': 'A path string or list of path parts.'},
-                       {'name': 'prop', 'type': 'str|list', 'desc': 'A property name or list of name parts.', 'default': None},
+                       {'name': 'path', 'type': ['str', 'list'], 'desc': 'A path string or list of path parts.'},
+                       {'name': 'prop', 'type': ['str', 'list'], 'desc': 'A property name or list of name parts.', 'default': None},
                    ),
                    'returns': {'type': 'boolean', 'desc': 'True if the del operation was successful.'}}},
 
         {'name': 'iter', 'desc': 'Yield (<path>, <valu>) tuples for the users JSON objects.',
          'type': {'type': 'function', '_funcname': 'iter',
                   'args': (
-                       {'name': 'path', 'type': 'str|list', 'desc': 'A path string or list of path parts.', 'default': None},
+                       {'name': 'path', 'type': ['str', 'list'], 'desc': 'A path string or list of path parts.', 'default': None},
                    ),
-                   'returns': {'name': 'Yields', 'type': 'list', 'desc': '(<path>, <item>) tuples.'}}},
+                   'returns': {'name': 'yields', 'type': 'list', 'desc': '(<path>, <item>) tuples.'}}},
     )
 
     def __init__(self, runt, valu):
@@ -1046,7 +1046,7 @@ class User(s_stormtypes.Prim):
                   'args': (
                       {'name': 'name', 'type': 'str',
                        'desc': 'The name of the API key.'},
-                      {'name': 'duration', 'type': 'integer', 'default': None,
+                      {'name': 'duration', 'type': 'int', 'default': None,
                        'desc': 'Duration of time for the API key to be valid, in milliseconds.'},
                   ),
                   'returns': {'type': 'list',
@@ -1569,7 +1569,7 @@ class LibAuth(s_stormtypes.Lib):
                   'args': (
                       {'name': 'text', 'type': 'str', 'desc': 'The string to process.', },
                   ),
-                  'returns': {'type': 'list', 'desc': 'A tuple containing a bool and a list of permission parts.', }}},
+                  'returns': {'type': 'list', 'desc': 'A tuple containing a boolean and a list of permission parts.', }}},
         {'name': 'textFromRule', 'desc': 'Return a text string from a rule tuple.',
          'type': {'type': 'function', '_funcname': 'textFromRule',
                   'args': (

synapse/lib/stormlib/cell.py

@@ -160,7 +160,7 @@ class CellLib(s_stormtypes.Lib):
          ''',
          'type': {'type': 'function', '_funcname': '_trimNexsLog',
                   'args': (
-                      {'name': 'consumers', 'type': 'array', 'default': None,
+                      {'name': 'consumers', 'type': 'list', 'default': None,
                        'desc': 'List of Telepath URLs for consumers of the Nexus log.'},
                       {'name': 'timeout', 'type': 'int', 'default': 30,
                        'desc': 'Time (in seconds) to wait for consumers to catch-up before culling.'}

synapse/lib/stormlib/cortex.py

@@ -1083,13 +1083,13 @@ class CortexHttpApi(s_stormtypes.Lib):
         ''',
          'type': {'type': 'function', '_funcname': 'addHttpApi',
                   'args': (
-                      {'name': 'path', 'type': 'string',
+                      {'name': 'path', 'type': 'str',
                        'desc': 'The extended HTTP API path.'},
-                      {'name': 'name', 'type': 'string',
+                      {'name': 'name', 'type': 'str',
                        'desc': 'Friendly name for the Extended HTTP API.', 'default': ''},
-                      {'name': 'desc', 'type': 'string',
+                      {'name': 'desc', 'type': 'str',
                        'desc': 'Description for the Extended HTTP API.', 'default': ''},
-                      {'name': 'runas', 'type': 'string',
+                      {'name': 'runas', 'type': 'str',
                        'desc': 'Run the storm query as the API "owner" or as the authenticated "user".',
                        'default': 'owner'},
                       {'name': 'authenticated', 'type': 'boolean',
@@ -1103,14 +1103,14 @@ class CortexHttpApi(s_stormtypes.Lib):
         {'name': 'del', 'desc': 'Delete an Extended HTTP API endpoint.',
          'type': {'type': 'function', '_funcname': 'delHttpApi',
                   'args': (
-                      {'name': 'iden', 'type': 'string',
+                      {'name': 'iden', 'type': 'str',
                        'desc': 'The iden of the API to delete.'},
                   ),
                   'returns': {'type': 'null'}}},
         {'name': 'get', 'desc': 'Get an Extended ``http:api`` object.',
          'type': {'type': 'function', '_funcname': 'getHttpApi',
                   'args': (
-                      {'name': 'iden', 'type': 'string',
+                      {'name': 'iden', 'type': 'str',
                        'desc': 'The iden of the API to retrieve.'},
                   ),
                   'returns': {'type': 'http:api', 'desc': 'The ``http:api`` object.'}}},
@@ -1123,17 +1123,17 @@ class CortexHttpApi(s_stormtypes.Lib):
         ''',
          'type': {'type': 'function', '_funcname': 'getHttpApiByPath',
                   'args': (
-                      {'name': 'path', 'type': 'string',
+                      {'name': 'path', 'type': 'str',
                        'desc': 'Path to use to retrieve an object.'},
                   ),
                   'returns': {'type': ['http:api', 'null'], 'desc': 'The ``http:api`` object or ``(null)`` if there is no match.'}}},
         {'name': 'list', 'desc': 'Get all the Extended HTTP APIs on the Cortex',
          'type': {'type': 'function', '_funcname': 'listHttpApis', 'args': (),
-                 'returns': {'type': 'list', 'desc': 'A list of ``http:api`` objects'}}},
+                  'returns': {'type': 'list', 'desc': 'A list of ``http:api`` objects'}}},
         {'name': 'index', 'desc': 'Set the index for a given Extended HTTP API.',
          'type': {'type': 'function', '_funcname': 'setHttpApiIndx',
                   'args': (
-                      {'name': 'iden', 'type': 'string',
+                      {'name': 'iden', 'type': 'str',
                        'desc': 'The iden of the API to modify.'},
                       {'name': 'index', 'type': 'int', 'default': 0,
                        'desc': 'The new index of the API. Uses zero based indexing.'},

synapse/lib/stormlib/env.py

@@ -1,7 +1,6 @@
 import os
 
 import synapse.exc as s_exc
-import synapse.common as s_common
 import synapse.lib.stormtypes as s_stormtypes
 
 @s_stormtypes.registry.registerLib
@@ -21,10 +20,10 @@ class LibEnv(s_stormtypes.Lib):
             'type': 'function', '_funcname': '_libEnvGet',
             'args': (
                 {'name': 'name', 'type': 'str', 'desc': 'The name of the environment variable.', },
-                {'name': 'default', 'type': 'obj', 'default': None,
-                    'desc': 'The value to return if the environment variable is not set.', },
+                {'name': 'default', 'type': 'prim', 'default': None,
+                    'desc': 'The value to return if the environment variable is not set. Non-string values will be converted into their string forms.', },
             ),
-         'returns': {'type': 'str', 'desc': 'The environment variable string.'},
+            'returns': {'type': ['str', 'null'], 'desc': 'The environment variable string.'},
          },
         },
     )
@@ -47,4 +46,4 @@ class LibEnv(s_stormtypes.Lib):
             mesg = f'Environment variable must start with SYN_STORM_ENV_ : {name}'
             raise s_exc.BadArg(mesg=mesg)
 
-        return os.getenv(name, default=default)
+        return os.getenv(name, default=await s_stormtypes.tostr(default, noneok=True))

synapse/lib/stormlib/ethereum.py

@@ -13,7 +13,7 @@ class EthereumLib(s_stormtypes.Lib):
                       {'name': 'addr', 'type': 'str', 'desc': 'The Ethereum address to be converted.'},
                   ),
                   'returns': {'type': 'list',
-                              'desc': 'A list of (<bool>, <addr>) for status and checksummed address.', },
+                              'desc': 'A list of (<boolean>, <addr>) for status and checksummed address.', },
         }},
     )
 

synapse/lib/stormlib/gen.py

@@ -140,7 +140,7 @@ class LibGen(s_stormtypes.Lib):
          'desc': 'Returns a file:bytes node by SHA256, adding the node if it does not exist.',
          'type': {'type': 'function', '_funcname': '_storm_query',
                   'args': (
-                      {'name': 'sha256', 'type': ['str', 'hash:sha256'], 'desc': 'The SHA256 fingerprint for the file:bytes node.'},
+                      {'name': 'sha256', 'type': 'str', 'desc': 'The SHA256 fingerprint for the file:bytes node.'},
                       {'name': 'try', 'type': 'boolean', 'default': False,
                        'desc': 'Type normalization will fail silently instead of raising an exception.'},
                   ),
@@ -149,7 +149,7 @@ class LibGen(s_stormtypes.Lib):
          'desc': 'Returns a crypto:x509:cert node by SHA256, adding the node if it does not exist.',
          'type': {'type': 'function', '_funcname': '_storm_query',
                   'args': (
-                      {'name': 'sha256', 'type': ['str', 'hash:sha256'], 'desc': 'The SHA256 fingerprint for the certificate.'},
+                      {'name': 'sha256', 'type': 'str', 'desc': 'The SHA256 fingerprint for the certificate.'},
                       {'name': 'try', 'type': 'boolean', 'default': False,
                        'desc': 'Type normalization will fail silently instead of raising an exception.'},
                   ),
@@ -159,7 +159,7 @@ class LibGen(s_stormtypes.Lib):
          'type': {'type': 'function', '_funcname': '_storm_query',
                   'args': (
                       {'name': 'server', 'type': ['str', 'inet:server'], 'desc': 'The server associated with the x509 certificate.'},
-                      {'name': 'sha256', 'type': ['str', 'hash:sha256'], 'desc': 'The SHA256 fingerprint for the certificate.'},
+                      {'name': 'sha256', 'type': 'str', 'desc': 'The SHA256 fingerprint for the certificate.'},
                       {'name': 'try', 'type': 'boolean', 'default': False,
                        'desc': 'Type normalization will fail silently instead of raising an exception.'},
                   ),

synapse/lib/stormlib/hex.py

@@ -29,7 +29,7 @@ class HexLib(s_stormtypes.Lib):
          'type': {'type': 'function', '_funcname': 'toint',
                   'args': (
                       {'name': 'valu', 'type': 'str', 'desc': 'The hex string to be converted.'},
-                      {'name': 'signed', 'type': 'bool', 'default': False,
+                      {'name': 'signed', 'type': 'boolean', 'default': False,
                        'desc': 'If true, convert to a signed integer.'},
                   ),
                   'returns': {'type': 'int', 'desc': 'The resulting integer.', }
@@ -39,7 +39,7 @@ class HexLib(s_stormtypes.Lib):
                   'args': (
                       {'name': 'valu', 'type': 'int', 'desc': 'The integer to be converted.'},
                       {'name': 'length', 'type': 'int', 'desc': 'The number of bytes to use to represent the integer.'},
-                      {'name': 'signed', 'type': 'bool', 'default': False,
+                      {'name': 'signed', 'type': 'boolean', 'default': False,
                        'desc': 'If true, convert as a signed value.'},
                   ),
                   'returns': {'type': 'str', 'desc': 'The resulting hex string.', }