synapse 2.135.0__py311-none-any.whl → 2.136.0__py311-none-any.whl

synapse/lib/stormlib/compression.py

@@ -0,0 +1,176 @@
+import bz2
+import gzip
+import zlib
+
+import synapse.exc as s_exc
+import synapse.common as s_common
+
+import synapse.lib.stormtypes as s_stormtypes
+
+@s_stormtypes.registry.registerLib
+class Bzip2Lib(s_stormtypes.Lib):
+    '''
+    A Storm library which implements helpers for bzip2 compression.
+    '''
+    _storm_locals = (
+        {'name': 'en', 'desc': '''
+            Compress bytes using bzip2 and return them.
+
+            Example:
+                Compress bytes with bzip2::
+
+                    $foo = $lib.compression.bzip2.en($mybytez)''',
+         'type': {'type': 'function', '_funcname': 'en',
+                  'args': (
+                      {'name': 'valu', 'type': 'bytes', 'desc': 'The bytes to be compressed.'},
+                  ),
+                  'returns': {'type': 'bytes', 'desc': 'The bzip2 compressed bytes.'}}},
+        {'name': 'un', 'desc': '''
+            Decompress bytes using bzip2 and return them.
+
+            Example:
+                Decompress bytes with bzip2::
+
+                $foo = $lib.compression.bzip2.un($mybytez)''',
+         'type': {'type': 'function', '_funcname': 'un',
+                  'args': (
+                      {'name': 'valu', 'type': 'bytes', 'desc': 'The bytes to be decompressed.'},
+                  ),
+                  'returns': {'type': 'bytes', 'desc': 'Decompressed bytes.'}}},
+    )
+
+    _storm_lib_path = ('compression', 'bzip2')
+
+    def getObjLocals(self):
+        return {
+            'en': self.en,
+            'un': self.un,
+        }
+
+    async def en(self, valu):
+        valu = await s_stormtypes.toprim(valu)
+        try:
+            return bz2.compress(valu)
+        except Exception as e:
+            mesg = f'Error during bzip2 compression - {str(e)}: {repr(valu)[:256]}'
+            raise s_exc.StormRuntimeError(mesg=mesg) from None
+
+    async def un(self, valu):
+        valu = await s_stormtypes.toprim(valu)
+        try:
+            return bz2.decompress(valu)
+        except Exception as e:
+            mesg = f'Error during bzip2 decompression - {str(e)}: {repr(valu)[:256]}'
+            raise s_exc.StormRuntimeError(mesg=mesg) from None
+
+@s_stormtypes.registry.registerLib
+class GzipLib(s_stormtypes.Lib):
+    '''
+    A Storm library which implements helpers for gzip compression.
+    '''
+    _storm_locals = (
+        {'name': 'en', 'desc': '''
+            Compress bytes using gzip and return them.
+
+            Example:
+                Compress bytes with gzip::
+
+                    $foo = $lib.compression.gzip.en($mybytez)''',
+         'type': {'type': 'function', '_funcname': 'en',
+                  'args': (
+                      {'name': 'valu', 'type': 'bytes', 'desc': 'The bytes to be compressed.'},
+                  ),
+                  'returns': {'type': 'bytes', 'desc': 'The gzip compressed bytes.'}}},
+        {'name': 'un', 'desc': '''
+            Decompress bytes using gzip and return them.
+
+            Example:
+                Decompress bytes with gzip::
+
+                $foo = $lib.compression.gzip.un($mybytez)''',
+         'type': {'type': 'function', '_funcname': 'un',
+                  'args': (
+                      {'name': 'valu', 'type': 'bytes', 'desc': 'The bytes to be decompressed.'},
+                  ),
+                  'returns': {'type': 'bytes', 'desc': 'Decompressed bytes.'}}},
+    )
+
+    _storm_lib_path = ('compression', 'gzip')
+
+    def getObjLocals(self):
+        return {
+            'en': self.en,
+            'un': self.un,
+        }
+
+    async def en(self, valu):
+        valu = await s_stormtypes.toprim(valu)
+        try:
+            return gzip.compress(valu)
+        except Exception as e:
+            mesg = f'Error during gzip compression - {str(e)}: {repr(valu)[:256]}'
+            raise s_exc.StormRuntimeError(mesg=mesg) from None
+
+    async def un(self, valu):
+        valu = await s_stormtypes.toprim(valu)
+        try:
+            return gzip.decompress(valu)
+        except Exception as e:
+            mesg = f'Error during gzip decompression - {str(e)}: {repr(valu)[:256]}'
+            raise s_exc.StormRuntimeError(mesg=mesg) from None
+
+@s_stormtypes.registry.registerLib
+class ZlibLib(s_stormtypes.Lib):
+    '''
+    A Storm library which implements helpers for zlib compression.
+    '''
+    _storm_locals = (
+        {'name': 'en', 'desc': '''
+            Compress bytes using zlib and return them.
+
+            Example:
+                Compress bytes with zlib::
+
+                    $foo = $lib.compression.zlib.en($mybytez)''',
+         'type': {'type': 'function', '_funcname': 'en',
+                  'args': (
+                      {'name': 'valu', 'type': 'bytes', 'desc': 'The bytes to be compressed.'},
+                  ),
+                  'returns': {'type': 'bytes', 'desc': 'The zlib compressed bytes.'}}},
+        {'name': 'un', 'desc': '''
+            Decompress bytes using zlib and return them.
+
+            Example:
+                Decompress bytes with zlib::
+
+                $foo = $lib.compression.zlib.un($mybytez)''',
+         'type': {'type': 'function', '_funcname': 'un',
+                  'args': (
+                      {'name': 'valu', 'type': 'bytes', 'desc': 'The bytes to be decompressed.'},
+                  ),
+                  'returns': {'type': 'bytes', 'desc': 'Decompressed bytes.'}}},
+    )
+
+    _storm_lib_path = ('compression', 'zlib')
+
+    def getObjLocals(self):
+        return {
+            'en': self.en,
+            'un': self.un,
+        }
+
+    async def en(self, valu):
+        valu = await s_stormtypes.toprim(valu)
+        try:
+            return zlib.compress(valu)
+        except Exception as e:
+            mesg = f'Error during zlib compression - {str(e)}: {repr(valu)[:256]}'
+            raise s_exc.StormRuntimeError(mesg=mesg) from None
+
+    async def un(self, valu):
+        valu = await s_stormtypes.toprim(valu)
+        try:
+            return zlib.decompress(valu)
+        except Exception as e:
+            mesg = f'Error during zlib decompression - {str(e)}: {repr(valu)[:256]}'
+            raise s_exc.StormRuntimeError(mesg=mesg) from None

synapse/lib/stormlib/graph.py

@@ -88,6 +88,8 @@ class GraphLib(s_stormtypes.Lib):
             Add a graph projection to the Cortex.
 
             Example:
+                Add a graph projection named "Test Projection"::
+
                     $rules = ({
                         "name": "Test Projection",
                         "desc": "My test projection",

synapse/lib/stormtypes.py

@@ -953,7 +953,6 @@ class LibTags(Lib):
             Normalize and prefix a list of syn:tag:part values so they can be applied.
 
             Examples:
-
                 Add tag prefixes and then use them to tag nodes::
 
                     $tags = $lib.tags.prefix($result.tags, vtx.visi)
@@ -4059,6 +4058,7 @@ class Bytes(Prim):
 
             Example:
                 Compress bytes with gzip::
+
                     $foo = $mybytez.gzip()''',
          'type': {'type': 'function', '_funcname': '_methGzip',
                   'returns': {'type': 'bytes', 'desc': 'The gzip compressed bytes.', }}},
@@ -4070,6 +4070,7 @@ class Bytes(Prim):
 
             Example:
                 Load bytes to a object::
+
                     $foo = $mybytez.json()''',
          'type': {'type': 'function', '_funcname': '_methJsonLoad',
                   'args': (
@@ -4103,8 +4104,9 @@ class Bytes(Prim):
             Unpack structures from bytes using python struct.unpack syntax.
 
             Examples:
-                # unpack 3 unsigned 16 bit integers in little endian format
-                ($x, $y, $z) = $byts.unpack("<HHH")
+                Unpack 3 unsigned 16 bit integers in little endian format::
+
+                    ($x, $y, $z) = $byts.unpack("<HHH")
             ''',
          'type': {'type': 'function', '_funcname': 'unpack',
                   'args': (
@@ -6338,7 +6340,7 @@ class Layer(Prim):
         formname = await tostr(formname, noneok=True)
 
         if formname is not None and self.runt.snap.core.model.form(formname) is None:
-            raise s_exc.NoSuchForm(formname)
+            raise s_exc.NoSuchForm.init(formname)
 
         iden = self.valu.get('iden')
         layr = self.runt.snap.core.getLayer(iden)
@@ -7421,8 +7423,8 @@ class LibUsers(Lib):
          'type': {'type': 'function', '_funcname': '_methUsersAdd',
                   'args': (
                       {'name': 'name', 'type': 'str', 'desc': 'The name of the user.', },
-                      {'name': 'passwd', 'type': 'str', 'desc': 'The users password.', 'default': None, },
-                      {'name': 'email', 'type': 'str', 'desc': 'The users email address.', 'default': None, },
+                      {'name': 'passwd', 'type': 'str', 'desc': "The user's password.", 'default': None, },
+                      {'name': 'email', 'type': 'str', 'desc': "The user's email address.", 'default': None, },
                       {'name': 'iden', 'type': 'str', 'desc': 'The iden to use to create the user.', 'default': None, }
                   ),
                   'returns': {'type': 'storm:auth:user',
@@ -8183,20 +8185,20 @@ class User(Prim):
                   'returns': {'type': 'list',
                               'desc': 'A list of ``storm:auth:gates`` that the user has rules for.', }}},
         {'name': 'name', 'desc': '''
-        A users name. This can also be used to set a users name.
+        A user's name. This can also be used to set a user's name.
 
         Example:
-                Change a users name::
+                Change a user's name::
 
                     $user=$lib.auth.users.byname(bob) $user.name=robert
         ''',
          'type': {'type': 'stor', '_storfunc': '_storUserName',
                   'returns': {'type': 'str', }}},
         {'name': 'email', 'desc': '''
-        A users email. This can also be used to set the users email.
+        A user's email. This can also be used to set the user's email.
 
         Example:
-                Change a users email address::
+                Change a user's email address::
 
                     $user=$lib.auth.users.byname(bob) $user.email="robert@bobcorp.net"
         ''',
@@ -8491,10 +8493,10 @@ class Role(Prim):
                   ),
                   'returns': {'type': 'null', }}},
         {'name': 'name', 'desc': '''
-            A roles name. This can also be used to set the role name.
+            A role's name. This can also be used to set the role name.
 
             Example:
-                    Change a roles name::
+                    Change a role's name::
 
                         $role=$lib.auth.roles.byname(analyst) $role.name=superheroes
             ''',

synapse/lib/types.py

@@ -385,7 +385,7 @@ class Bool(Type):
         return int(bool(valu)), {}
 
     def repr(self, valu):
-        return repr(bool(valu))
+        return repr(bool(valu)).lower()
 
 class Array(Type):
 
@@ -1732,6 +1732,9 @@ class Taxonomy(Str):
     def _normPyStr(self, text):
         return self._normPyList(text.strip().strip('.').split('.'))
 
+    def repr(self, norm):
+        return norm.rstrip('.')
+
 class Tag(Str):
 
     def postTypeInit(self):

synapse/lib/version.py

@@ -223,6 +223,6 @@ def reqVersion(valu, reqver,
 ##############################################################################
 # The following are touched during the release process by bumpversion.
 # Do not modify these directly.
-version = (2, 135, 0)
+version = (2, 136, 0)
 verstring = '.'.join([str(x) for x in version])
-commit = 'b57446b7668e6dcaced257b82fd2bb1a11ece8ce'
+commit = 'dba42be36057d465def6a8f17294aac3677a161e'

synapse/tests/test_cortex.py

@@ -1196,6 +1196,10 @@ class CortexTest(s_t_utils.SynTest):
                 self.len(1, await core.nodes('test:int +#foo.bar:score<=30'))
                 self.len(1, await core.nodes('test:int +#foo.bar:score>=10'))
                 self.len(1, await core.nodes('test:int +#foo.bar:score*range=(10, 30)'))
+                self.len(1, await core.nodes('test:int +#*:score'))
+                self.len(1, await core.nodes('test:int +#foo.*:score'))
+                self.len(1, await core.nodes('$tag=* test:int +#*:score'))
+                self.len(1, await core.nodes('$tag=foo.* test:int +#foo.*:score'))
 
                 self.len(0, await core.nodes('test:int -#foo.bar'))
                 self.len(0, await core.nodes('test:int -#foo.bar:score'))
@@ -1317,6 +1321,24 @@ class CortexTest(s_t_utils.SynTest):
                 with self.raises(s_exc.NoSuchType):
                     await core.addTagProp('derp', ('derp', {}), {})
 
+                with self.raises(s_exc.BadTypeValu):
+                    await core.nodes("$tag=(foo, bar) test:int#$tag:prop")
+
+                with self.raises(s_exc.BadTypeValu):
+                    await core.nodes("$tag=(foo, bar) test:int +#$tag:prop")
+
+                with self.raises(s_exc.BadTypeValu):
+                    await core.nodes("$tag=(foo, bar) test:int +#$tag:prop=5")
+
+                with self.raises(s_exc.BadTypeValu):
+                    await core.nodes("test:int $tag=(foo, bar) $lib.print(#$tag:prop)")
+
+                with self.raises(s_exc.BadTypeValu):
+                    await core.nodes("test:int $tag=(foo, bar) [ +#$tag:prop=foo ]")
+
+                with self.raises(s_exc.BadTypeValu):
+                    await core.nodes("test:int $tag=(foo, bar) [ -#$tag:prop ]")
+
             # Ensure that the tagprops persist
             async with self.getTestCore(dirn=dirn) as core:
                 # Ensure we can still work with a tagprop, after restart, that was
@@ -1496,7 +1518,7 @@ class CortexTest(s_t_utils.SynTest):
             self.eq(set(nodes[0].tags.keys()), {'foo', 'foo.v'})
 
             # Cannot norm a list of tag parts directly when making tags on a node
-            with self.raises(AttributeError):
+            with self.raises(s_exc.BadTypeValu):
                 await wcore.nodes("$foo=(('foo', 'bar.baz'),) [test:int=2 +#$foo]")
 
             # Can set a list of tags directly
@@ -1508,8 +1530,20 @@ class CortexTest(s_t_utils.SynTest):
             self.len(1, nodes)
             self.eq(set(nodes[0].tags.keys()), {'foo', 'bar', 'bar.baz'})
 
-            with self.raises(TypeError):
-                await wcore.nodes('$foo=$lib.set("foo", "bar") [test:int=5 +#$foo]')
+            nodes = await wcore.nodes('$foo=$lib.set("foo", "bar") [test:int=5 +#$foo]')
+            self.len(1, nodes)
+            self.eq(set(nodes[0].tags.keys()), {'foo', 'bar'})
+
+            await self.asyncraises(s_exc.BadTypeValu, wcore.nodes("$tag='' #$tag"))
+            await self.asyncraises(s_exc.BadTypeValu, wcore.nodes("$tag='' #$tag=2020"))
+            await self.asyncraises(s_exc.BadTypeValu, wcore.nodes("$tag=$lib.null #foo.$tag"))
+            await self.asyncraises(s_exc.BadTypeValu, wcore.nodes("$tag=(foo, bar) #$tag"))
+            await self.asyncraises(s_exc.BadTypeValu, wcore.nodes("$tag=(foo, bar) ##$tag"))
+            await self.asyncraises(s_exc.BadTypeValu, wcore.nodes("$tag=(foo, bar) inet:fqdn#$tag"))
+            await self.asyncraises(s_exc.BadTypeValu, wcore.nodes("test:int $tag=$lib.null +#foo.$tag"))
+            await self.asyncraises(s_exc.BadTypeValu, wcore.nodes("test:int $tag=(foo, bar) $lib.print(#$tag)"))
+            await self.asyncraises(s_exc.BadTypeValu, wcore.nodes("test:int $tag=(foo, bar) +#$tag"))
+            await self.asyncraises(s_exc.BadTypeValu, wcore.nodes("test:int $tag=(foo, bar) +#$tag=2020"))
 
     async def test_base_types1(self):
 
@@ -4907,7 +4941,7 @@ class CortexBasicTest(s_t_utils.SynTest):
             pode = podes[0]
             self.true(s_node.tagged(pode, '#foo'))
 
-            mesgs = await core.stormlist('$var="" test:str=foo [+?#$var=2019] $lib.print(#$var)')
+            mesgs = await core.stormlist('$var="" test:str=foo [+?#$var=2019]')
             podes = [m[1] for m in mesgs if m[0] == 'node']
             self.len(1, podes)
             pode = podes[0]