synapse 2.173.1__py311-none-any.whl → 2.174.0__py311-none-any.whl

synapse/tests/test_lib_storm.py

@@ -2283,9 +2283,9 @@ class StormTest(s_t_utils.SynTest):
             msgs = await core.stormlist(f'pkg.load --ssl-noverify https://127.0.0.1:{port}/api/v1/pkgtest/notok')
             self.stormIsInWarn('pkg.load got JSON error: FooBar', msgs)
 
-            replay = s_common.envbool('SYNDEV_NEXUS_REPLAY')
-            nevents = 4 if replay else 2
-            waiter = core.waiter(nevents, 'core:pkg:onload:complete')
+            # onload will on fire once. all other pkg.load events will effectively bounce
+            # because the pkg hasn't changed so no loading occurs
+            waiter = core.waiter(1, 'core:pkg:onload:complete')
 
             with self.getAsyncLoggerStream('synapse.cortex') as stream:
                 msgs = await core.stormlist(f'pkg.load --ssl-noverify https://127.0.0.1:{port}/api/v1/pkgtest/yep')
@@ -2301,10 +2301,10 @@ class StormTest(s_t_utils.SynTest):
             self.isin("No var with name: newp", buf)
             self.len(1, await core.nodes(f'ps:contact={cont}'))
 
-            evnts = await waiter.wait(timeout=2)
-            exp = []
-            for _ in range(nevents):
-                exp.append(('core:pkg:onload:complete', {'pkg': 'testload'}))
+            evnts = await waiter.wait(timeout=4)
+            exp = [
+                ('core:pkg:onload:complete', {'pkg': 'testload'})
+            ]
             self.eq(exp, evnts)
 
     async def test_storm_tree(self):

synapse/tests/test_lib_stormsvc.py

@@ -2,7 +2,6 @@ import asyncio
 import contextlib
 import synapse.exc as s_exc
 import synapse.common as s_common
-import synapse.cortex as s_cortex
 
 import synapse.tests.utils as s_test
 
@@ -796,56 +795,134 @@ class StormSvcTest(s_test.SynTest):
 
         with self.getTestDir() as dirn:
             async with self.getTestCore(dirn=dirn) as core:
-                with self.getTestDir() as svcd:
-                    async with await ChangingService.anit(svcd) as chng:
-                        chng.dmon.share('chng', chng)
-
-                        root = await chng.auth.getUserByName('root')
-                        await root.setPasswd('root')
-
-                        info = await chng.dmon.listen('tcp://127.0.0.1:0/')
-                        host, port = info
-
-                        curl = f'tcp://root:root@127.0.0.1:{port}/chng'
-
-                        await core.nodes(f'service.add chng {curl}')
-                        await core.nodes('$lib.service.wait(chng)')
-
-                        self.nn(core.getStormCmd('oldcmd'))
-                        self.nn(core.getStormCmd('old.bar'))
-                        self.nn(core.getStormCmd('old.baz'))
-                        self.none(core.getStormCmd('new.baz'))
-                        self.none(core.getStormCmd('runtecho'))
-                        self.none(core.getStormCmd('newcmd'))
-                        self.isin('old', core.stormpkgs)
-                        self.isin('old.bar', core.stormmods)
-                        self.isin('old.baz', core.stormmods)
-                        pkg = await core.getStormPkg('old')
-                        self.eq(pkg.get('version'), '0.0.1')
-
-                        waiter = core.waiter(1, 'stormsvc:client:unready')
-
-                    self.true(await waiter.wait(10))
-                    async with await ChangingService.anit(svcd, {'updated': True}) as chng:
-                        chng.dmon.share('chng', chng)
-                        await chng.dmon.listen(f'tcp://127.0.0.1:{port}/')
-
-                        await core.nodes('$lib.service.wait(chng)')
-
-                        self.nn(core.getStormCmd('newcmd'))
-                        self.nn(core.getStormCmd('new.baz'))
-                        self.nn(core.getStormCmd('old.bar'))
-                        self.nn(core.getStormCmd('runtecho'))
-                        self.none(core.getStormCmd('oldcmd'))
-                        self.none(core.getStormCmd('old.baz'))
-                        self.isin('old', core.stormpkgs)
-                        self.isin('new', core.stormpkgs)
-                        self.isin('echo', core.stormmods)
-                        self.isin('old.bar', core.stormmods)
-                        self.isin('new.baz', core.stormmods)
-                        self.notin('old.baz', core.stormmods)
-                        pkg = await core.getStormPkg('old')
-                        self.eq(pkg.get('version'), '0.1.0')
+                async with core.beholder() as wind:
+                    with self.getTestDir() as svcd:
+                        async with await ChangingService.anit(svcd) as chng:
+                            chng.dmon.share('chng', chng)
+
+                            root = await chng.auth.getUserByName('root')
+                            await root.setPasswd('root')
+
+                            info = await chng.dmon.listen('tcp://127.0.0.1:0/')
+                            host, port = info
+
+                            curl = f'tcp://root:root@127.0.0.1:{port}/chng'
+
+                            await core.nodes(f'service.add chng {curl}')
+                            await core.nodes('$lib.service.wait(chng)')
+
+                            self.nn(core.getStormCmd('oldcmd'))
+                            self.nn(core.getStormCmd('old.bar'))
+                            self.nn(core.getStormCmd('old.baz'))
+                            self.none(core.getStormCmd('new.baz'))
+                            self.none(core.getStormCmd('runtecho'))
+                            self.none(core.getStormCmd('newcmd'))
+                            self.isin('old', core.stormpkgs)
+                            self.isin('old.bar', core.stormmods)
+                            self.isin('old.baz', core.stormmods)
+                            pkg = await core.getStormPkg('old')
+                            self.eq(pkg.get('version'), '0.0.1')
+
+                            waiter = core.waiter(1, 'stormsvc:client:unready')
+
+                        self.true(await waiter.wait(10))
+                        async with await ChangingService.anit(svcd, {'updated': True}) as chng:
+                            chng.dmon.share('chng', chng)
+                            await chng.dmon.listen(f'tcp://127.0.0.1:{port}/')
+
+                            await core.nodes('$lib.service.wait(chng)')
+
+                            self.nn(core.getStormCmd('newcmd'))
+                            self.nn(core.getStormCmd('new.baz'))
+                            self.nn(core.getStormCmd('old.bar'))
+                            self.nn(core.getStormCmd('runtecho'))
+                            self.none(core.getStormCmd('oldcmd'))
+                            self.none(core.getStormCmd('old.baz'))
+                            self.isin('old', core.stormpkgs)
+                            self.isin('new', core.stormpkgs)
+                            self.isin('echo', core.stormmods)
+                            self.isin('old.bar', core.stormmods)
+                            self.isin('new.baz', core.stormmods)
+                            self.notin('old.baz', core.stormmods)
+                            pkg = await core.getStormPkg('old')
+                            self.eq(pkg.get('version'), '0.1.0')
+
+                        async with await ChangingService.anit(svcd, {'updated': False}) as chng:
+                            chng.dmon.share('chng', chng)
+                            await chng.dmon.listen(f'tcp://127.0.0.1:{port}/')
+
+                            await core.nodes('$lib.service.wait(chng)')
+                            self.nn(core.getStormCmd('oldcmd'))
+                            self.nn(core.getStormCmd('old.bar'))
+                            self.nn(core.getStormCmd('old.baz'))
+                            self.none(core.getStormCmd('new.baz'))
+                            self.none(core.getStormCmd('runtecho'))
+                            self.none(core.getStormCmd('newcmd'))
+                            self.isin('old', core.stormpkgs)
+                            self.isin('old.bar', core.stormmods)
+                            self.isin('old.baz', core.stormmods)
+
+                            self.none(await core.getStormPkg('new'))
+
+                            pkg = await core.getStormPkg('old')
+                            self.eq(pkg.get('version'), '0.0.1')
+
+                            svcs = await core.callStorm('return($lib.service.list())')
+                            self.len(1, svcs)
+
+                        async with await ChangingService.anit(svcd, {'updated': True}) as chng:
+                            chng.dmon.share('chng', chng)
+                            await chng.dmon.listen(f'tcp://127.0.0.1:{port}/')
+
+                            await core.nodes('$lib.service.wait(chng)')
+
+                        async with await ChangingService.anit(svcd, {'updated': True}) as chng:
+                            chng.dmon.share('chng', chng)
+                            await chng.dmon.listen(f'tcp://127.0.0.1:{port}/')
+
+                            await core.nodes('$lib.service.wait(chng)')
+
+                events = []
+                async for m in wind:
+                    events.append(m)
+
+                self.len(16, events)
+
+                # updated = false
+                self.eq('svc:set', events[-9]['event'])
+                self.eq('chng', events[-9]['info']['name'])
+                self.eq((0, 0, 1), events[-9]['info']['version'])
+
+                self.eq('pkg:del', events[-8]['event'])
+                self.eq('old', events[-8]['info']['name'])
+
+                self.eq('pkg:add', events[-7]['event'])
+                self.eq('old', events[-7]['info']['name'])
+                self.eq('0.0.1', events[-7]['info']['version'])
+
+                self.eq('pkg:del', events[-6]['event'])
+                self.eq('new', events[-6]['info']['name'])
+
+                # updated = true
+                self.eq('svc:set', events[-5]['event'])
+                self.eq('chng', events[-5]['info']['name'])
+                self.eq((0, 0, 1), events[-5]['info']['version'])
+
+                self.eq('pkg:del', events[-4]['event'])
+                self.eq('old', events[-4]['info']['name'])
+
+                self.eq('pkg:add', events[-3]['event'])
+                self.eq('old', events[-3]['info']['name'])
+                self.eq('0.1.0', events[-3]['info']['version'])
+
+                self.eq('pkg:add', events[-2]['event'])
+                self.eq('new', events[-2]['info']['name'])
+
+                # we get the set to let us know things are back, not no adds since the pkgs are the same
+                # so this is the last
+                self.eq('svc:set', events[-1]['event'])
+                self.eq('chng', events[-1]['info']['name'])
+                self.eq((0, 0, 1), events[-1]['info']['version'])
 
             # This test verifies that storm commands loaded from a previously connected service are still available,
             # even if the service is not available now

synapse/tests/test_lib_stormtypes.py

@@ -322,6 +322,42 @@ class StormTypesTest(s_test.SynTest):
             msgs = await core.stormlist('$lib.debug = (1) hehe.haha')
             self.stormIsInPrint('hehe.haha', msgs)
 
+    async def test_storm_doubleadd_pkg(self):
+        async with self.getTestCore() as core:
+            async with core.beholder() as wind:
+                pkg = {
+                    'name': 'hehe',
+                    'version': '1.1.1',
+                    'modules': [
+                        {'name': 'hehe', 'storm': 'function getDebug() { return($lib.debug) }'},
+                    ],
+                    'commands': [
+                        {'name': 'hehe.haha', 'storm': 'if $lib.debug { $lib.print(hehe.haha) }'},
+                    ],
+                }
+
+                # all but the first of these should bounce
+                for i in range(5):
+                    await core.addStormPkg(pkg)
+
+                pkg['version'] = '1.2.3'
+
+                # all but the first of these should bounce
+                for i in range(5):
+                    await core.addStormPkg(pkg)
+
+            events = []
+            async for m in wind:
+                events.append(m)
+            self.len(2, events)
+            self.eq('pkg:add', events[0]['event'])
+            self.eq('hehe', events[0]['info']['name'])
+            self.eq('1.1.1', events[0]['info']['version'])
+
+            self.eq('pkg:add', events[1]['event'])
+            self.eq('hehe', events[1]['info']['name'])
+            self.eq('1.2.3', events[1]['info']['version'])
+
     async def test_storm_private(self):
         async with self.getTestCore() as core:
             await core.addStormPkg({
@@ -4642,6 +4678,11 @@ class StormTypesTest(s_test.SynTest):
 
             opts = {'vars': {'iden': iden0}}
 
+            # for coverage...
+            self.false(await core.killCronTask('newp'))
+            self.false(await core._killCronTask('newp'))
+            self.false(await core.callStorm(f'return($lib.cron.get({iden0}).kill())'))
+
             cdef = await core.callStorm('return($lib.cron.get($iden).pack())', opts=opts)
             self.eq('mydoc', cdef.get('doc'))
             self.eq('myname', cdef.get('name'))
@@ -4793,12 +4834,10 @@ class StormTypesTest(s_test.SynTest):
                 self.stormIsInErr('does not match', mesgs)
 
                 # Make sure the old one didn't run and the new query ran
+                nextlayroffs = await layr.getEditOffs() + 1
                 unixtime += 60
-                await asyncio.sleep(0)
+                await layr.waitEditOffs(nextlayroffs, timeout=5)
                 self.eq(1, await prox.count('meta:note:type=m1'))
-                # UNG WTF
-                await asyncio.sleep(0)
-                await asyncio.sleep(0)
                 self.eq(1, await prox.count('meta:note:type=m2'))
 
                 # Delete the job

synapse/tests/test_lib_trigger.py

@@ -3,9 +3,6 @@ import json
 import synapse.exc as s_exc
 import synapse.common as s_common
 
-from synapse.common import aspin
-
-import synapse.cortex as s_cortex
 import synapse.telepath as s_telepath
 import synapse.tests.utils as s_t_utils
 import synapse.tools.backup as s_tools_backup
@@ -294,6 +291,18 @@ class TrigTest(s_t_utils.SynTest):
             with self.raises(s_exc.SchemaViolation):
                 await view.addTrigger({'cond': 'tag:add', 'storm': '[ +#count test:str=$tag ]', 'tag': 'foo&baz'})
 
+            # View iden mismatch
+            trigiden = s_common.guid()
+            viewiden = s_common.guid()
+            tdef = {'iden': trigiden, 'cond': 'node:add', 'storm': 'test:int=4', 'form': 'test:int', 'view': viewiden}
+            await view.addTrigger(tdef)
+            trigger = await view.getTrigger(trigiden)
+            self.eq(trigger.get('view'), view.iden)
+            with self.raises(s_exc.BadArg) as exc:
+                await view.setTriggerInfo(trigiden, 'view', viewiden)
+            self.eq(exc.exception.get('mesg'), 'Invalid key name provided: view')
+            await view.delTrigger(trigiden)
+
             # Trigger list
             triglist = await view.listTriggers()
             self.len(12, triglist)
@@ -551,6 +560,10 @@ class TrigTest(s_t_utils.SynTest):
 
             derp = await core.auth.addUser('derp')
 
+            # This is so we can later update the trigger in a view other than the one which it was created
+            viewiden = await core.callStorm('$view = $lib.view.get().fork() return($view.iden)')
+            inview = {'view': viewiden}
+
             tdef = {'cond': 'node:add', 'form': 'inet:ipv4', 'storm': '[ +#foo ]'}
             opts = {'vars': {'tdef': tdef}}
 
@@ -562,7 +575,7 @@ class TrigTest(s_t_utils.SynTest):
             self.nn(nodes[0].getTag('foo'))
 
             opts = {'vars': {'iden': trig.get('iden'), 'derp': derp.iden}}
-            await core.callStorm('$lib.trigger.get($iden).set(user, $derp)', opts=opts)
+            await core.callStorm('$lib.trigger.get($iden).set(user, $derp)', opts=opts | inview)
 
             nodes = await core.nodes('[ inet:ipv4=8.8.8.8 ]')
             self.len(1, nodes)
@@ -885,3 +898,9 @@ class TrigTest(s_t_utils.SynTest):
 
             await core.nodes('for $trig in $lib.trigger.list() { $lib.trigger.del($trig.iden) }')
             self.len(0, await core.nodes('syn:trigger'))
+
+    async def test_trigger_viewiden_migration(self):
+        async with self.getRegrCore('trigger-viewiden-migration') as core:
+            for view in core.views.values():
+                for _, trigger in view.triggers.list():
+                    self.eq(trigger.tdef.get('view'), view.iden)

synapse/tests/test_model_crypto.py

@@ -49,7 +49,9 @@ class CryptoModelTest(s_t_utils.SynTest):
                         :algorithm=aes256
                         :mode=CBC
                         :iv=41414141
+                        :iv:text=AAAA
                         :private=00000000
+                        :private:text=hehe
                         :private:md5=$md5
                         :private:sha1=$sha1
                         :private:sha256=$sha256
@@ -57,6 +59,7 @@ class CryptoModelTest(s_t_utils.SynTest):
                         :public:md5=$md5
                         :public:sha1=$sha1
                         :public:sha256=$sha256
+                        :public:text=haha
                         :seed:passwd=s3cret
                         :seed:algorithm=pbkdf2 ]
                 }]
@@ -72,6 +75,9 @@ class CryptoModelTest(s_t_utils.SynTest):
                         +:mode=cbc
                         +:iv=41414141
             '''))
+            self.len(1, await core.nodes('it:dev:str=AAAA -> crypto:key'))
+            self.len(1, await core.nodes('it:dev:str=hehe -> crypto:key'))
+            self.len(1, await core.nodes('it:dev:str=haha -> crypto:key'))
             self.len(1, await core.nodes('inet:passwd=s3cret -> crypto:key -> crypto:currency:address'))
 
             self.len(2, await core.nodes('crypto:key -> hash:md5'))

synapse/tests/test_model_economic.py

@@ -129,8 +129,21 @@ class EconTest(s_utils.SynTest):
 
                     :time=20180202
                     :purchase={perc.ndef[1]}
+
+                    :place=*
+                    :place:loc=us.ny.brooklyn
+                    :place:name=myhouse
+                    :place:address="123 main street, brooklyn, ny, 11223"
+                    :place:latlong=(90,80)
             ]'''
-            await core.nodes(text)
+            nodes = await core.nodes(text)
+
+            self.eq('myhouse', nodes[0].get('place:name'))
+            self.eq((90, 80), nodes[0].get('place:latlong'))
+            self.eq('us.ny.brooklyn', nodes[0].get('place:loc'))
+            self.eq('123 main street, brooklyn, ny, 11223', nodes[0].get('place:address'))
+
+            self.len(1, await core.nodes('econ:acct:payment -> geo:place'))
 
             self.len(1, await core.nodes('econ:acct:payment +:time@=(2017,2019) +{-> econ:pay:card +:name="bob smith"}'))
 

synapse/tests/test_model_geopol.py

@@ -14,6 +14,7 @@ class GeoPolModelTest(s_t_utils.SynTest):
                     :iso2=vi
                     :iso3=vis
                     :isonum=31337
+                    :currencies=(usd, vcoins, PESOS, USD)
                 ]
             ''')
             self.len(1, nodes)
@@ -24,7 +25,9 @@ class GeoPolModelTest(s_t_utils.SynTest):
             self.eq('vi', nodes[0].get('iso2'))
             self.eq('vis', nodes[0].get('iso3'))
             self.eq(31337, nodes[0].get('isonum'))
+            self.eq(('pesos', 'usd', 'vcoins'), nodes[0].get('currencies'))
             self.len(2, await core.nodes('pol:country -> geo:name'))
+            self.len(3, await core.nodes('pol:country -> econ:currency'))
 
             nodes = await core.nodes('''
                     [ pol:vitals=*

synapse/tools/changelog.py

@@ -0,0 +1,236 @@
+import os
+import sys
+import pprint
+import asyncio
+import argparse
+import datetime
+import textwrap
+import traceback
+import subprocess
+import collections
+
+import regex
+
+import synapse.common as s_common
+
+import synapse.lib.output as s_output
+import synapse.lib.schemas as s_schemas
+
+defstruct = (
+    ('type', None),
+    ('desc', ''),
+    ('prs', ()),
+)
+
+SKIP_FILES = (
+    '.gitkeep',
+)
+
+version_regex = r'^v[0-9]\.[0-9]+\.[0-9]+((a|b|rc)[0-9]*)?$'
+def gen(opts: argparse.Namespace,
+        outp: s_output.OutPut):
+    if opts.verbose:
+        outp.printf(f'{opts=}')
+
+    name = opts.name
+    if name is None:
+        name = f'{s_common.guid()}.yaml'
+    fp = s_common.genpath(opts.cdir, name)
+
+    data = dict(defstruct)
+    data['type'] = opts.type
+    data['desc'] = opts.desc
+
+    if opts.migration_desc:
+        data['migration_desc'] = opts.migration_desc
+    if opts.pr:
+        data['prs'] = [opts.pr]
+
+    if opts.verbose:
+        outp.printf('Validating data against schema')
+
+    s_schemas._reqChanglogSchema(data)
+
+    if opts.verbose:
+        outp.printf('Saving the following information:')
+        outp.printf(s_common.yamldump(data).decode())
+
+    s_common.yamlsave(data, fp)
+
+    outp.printf(f'Saved changelog entry to {fp=}')
+
+    if opts.add:
+        if opts.verbose:
+            outp.printf('Adding file to git staging')
+        argv = ['git', 'add', fp]
+        ret = subprocess.run(argv, capture_output=True)
+        if opts.verbose:
+            outp.printf(f'stddout={ret.stdout}')
+            outp.printf(f'stderr={ret.stderr}')
+        ret.check_returncode()
+
+    return 0
+
+def format(opts: argparse.Namespace,
+           outp: s_output.OutPut):
+    if opts.verbose:
+        outp.printf(f'{opts=}')
+
+    if not regex.match(version_regex, opts.version):
+        outp.printf(f'Failed to match {opts.version} vs {version_regex}')
+        return 1
+
+    entries = collections.defaultdict(list)
+
+    files_processed = []  # Eventually for removing files from git.
+
+    for fn in os.listdir(opts.cdir):
+        if fn in SKIP_FILES:
+            continue
+        fp = s_common.genpath(opts.cdir, fn)
+        if opts.verbose:
+            outp.printf(f'Reading: {fp=}')
+        try:
+            data = s_common.yamlload(fp)
+        except Exception as e:
+            outp.printf(f'Error parsing yaml from {fp=}: {e}')
+            continue
+
+        if opts.verbose:
+            outp.printf('Got the following data:')
+            outp.printf(pprint.pformat(data))
+
+        files_processed.append(fp)
+
+        s_schemas._reqChanglogSchema(data)
+
+        if opts.prs_from_git:
+            outp.printf('--prs-from-git not yet implemented.')
+            return 1
+
+        if opts.enforce_prs and not data.get('prs'):
+            outp.printf(f'Entry is missing PR numbers: {fp=}')
+            return 1
+        data.setdefault('prs', [])
+
+        if opts.verbose:
+            outp.printf(f'Got data from {fp=}')
+
+        data.get('prs').sort()  # sort the PRs inplace
+        entries[data.get('type')].append(data)
+
+    if not entries:
+        outp.printf(f'No files passed validation from {opts.dir}')
+        return 1
+
+    if 'model' in entries:
+        outp.printf('Model specific entries are not yet implemented.')
+        return 1
+
+    date = opts.date
+    if date is None:
+        date = datetime.datetime.utcnow().strftime('%Y-%m-%d')
+    header = f'{opts.version} - {date}'
+    text = f'{header}\n{"=" * len(header)}\n'
+
+    for key, header in s_schemas._changelogTypes.items():
+        dataz = entries.get(key)
+        if dataz:
+            text = text + f'\n{header}\n{"-" * len(header)}'
+            dataz.sort(key=lambda x: x.get('prs'))
+            for data in dataz:
+                desc = data.get('desc')
+                for line in textwrap.wrap(desc, initial_indent='- ', subsequent_indent='  ', width=opts.width):
+                    text = f'{text}\n{line}'
+                if not opts.hide_prs:
+                    for pr in data.get('prs'):
+                        text = f'{text}\n  (`#{pr} <https://github.com/vertexproject/synapse/pull/{pr}>`_)'
+            if key == 'migration':
+                text = text + '\n- See :ref:`datamigration` for more information about automatic migrations.'
+            text = text + '\n'
+
+    if opts.rm:
+        if opts.verbose:
+            outp.printf('Staging file removals in git')
+        for fp in files_processed:
+            argv = ['git', 'rm', fp]
+            ret = subprocess.run(argv, capture_output=True)
+            if opts.verbose:
+                outp.printf(f'stddout={ret.stdout}')
+                outp.printf(f'stderr={ret.stderr}')
+            ret.check_returncode()
+
+    outp.printf(text)
+
+    return 0
+
+async def main(argv, outp=None):
+    if outp is None:
+        outp = s_output.OutPut()
+
+    pars = makeargparser()
+
+    opts = pars.parse_args(argv)
+    if opts.git_dir_check:
+        if not os.path.exists(os.path.join(os.getcwd(), '.git')):
+            outp.print('Current working directury must be the root of the repository.')
+            return 1
+    try:
+        return opts.func(opts, outp)
+    except Exception as e:
+        outp.printf(f'Error running {opts.func}: {traceback.format_exc()}')
+    return 1
+
+def makeargparser():
+    desc = '''Command line tool to manage changelog entries.
+    This tool and any data formats associated with it may change at any time.
+    '''
+    pars = argparse.ArgumentParser('synapse.tools.changelog', description=desc)
+
+    subpars = pars.add_subparsers(required=True,
+                                  title='subcommands',
+                                  dest='cmd', )
+    gen_pars = subpars.add_parser('gen', help='Generate a new changelog entry.')
+    gen_pars.set_defaults(func=gen)
+    gen_pars.add_argument('-t', '--type', required=True, choices=list(s_schemas._changelogTypes.keys()),
+                          help='The changelog type.')
+    gen_pars.add_argument('desc', type=str,
+                          help='The description to populate the initial changelog entry with.', )
+    gen_pars.add_argument('-p', '--pr', type=int, default=False,
+                          help='PR number associated with the changelog entry.')
+    gen_pars.add_argument('-a', '--add', default=False, action='store_true',
+                          help='Add the newly created file to the current git staging area.')
+    # Hidden name override. Mainly for testing.
+    gen_pars.add_argument('-n', '--name', default=None, type=str,
+                          help=argparse.SUPPRESS)
+
+    format_pars = subpars.add_parser('format', help='Format existing files into a RST block.')
+    format_pars.set_defaults(func=format)
+    mux_prs = format_pars.add_mutually_exclusive_group()
+    mux_prs.add_argument('--hide-prs', default=False, action='store_true',
+                         help='Hide PR entries.')
+    mux_prs.add_argument('--enforce-prs', default=False, action='store_true',
+                         help='Enforce PRs list to be populated with at least one number.', )
+    format_pars.add_argument('--prs-from-git', default=False, action='store_true',
+                             help='Attempt to populate any PR numbers from a given files commit history.')
+    format_pars.add_argument('-w', '--width', help='Maximum column width to wrap descriptions at.',
+                             default=79, type=int)
+    format_pars.add_argument('--version', required=True, action='store', type=str,
+                             help='Version number')
+    format_pars.add_argument('-d', '--date', action='store', type=str,
+                             help='Date to use with the changelog entry')
+    format_pars.add_argument('-r', '--rm', default=False, action='store_true',
+                             help='Stage the changelog files as deleted files in git.')
+
+    for p in (gen_pars, format_pars):
+        p.add_argument('-v', '--verbose', default=False, action='store_true',
+                       help='Enable verbose output')
+        p.add_argument('--cdir', default='./changes', action='store',
+                       help='Directory of changelog files.')
+        p.add_argument('--disable-git-dir-check', dest='git_dir_check', default=True, action='store_false',
+                       help=argparse.SUPPRESS)
+
+    return pars
+
+if __name__ == '__main__':  # pragma: no cover
+    sys.exit(asyncio.run(main(sys.argv[1:], s_output.stdout)))

{synapse-2.173.1.dist-info → synapse-2.174.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: synapse
-Version: 2.173.1
+Version: 2.174.0
 Summary: Synapse Intelligence Analysis Framework
 Author-email: The Vertex Project LLC <root@vertex.link>
 License: Apache License 2.0