extract common code for keystore arguments

Author: lenkan

src/keri/app/cli/commands/aid.py

@@ -9,21 +9,18 @@
 from hio.base import doing
 
 from keri import help
-from keri.app.cli.common import existing
+from keri.app.cli.common import existing 
+
+from keri.app.cli.common.parsing import Parsery
 from keri.kering import ConfigurationError
 
 logger = help.ogler.getLogger()
 
-parser = argparse.ArgumentParser(description='Print the AID for a given alias')
-parser.set_defaults(handler=lambda args: handler(args),
-                    transferable=True)
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
+parser = argparse.ArgumentParser(description='Print the AID for a given alias', parents=[Parsery.keystore()]) 
+parser.set_defaults(handler=lambda args: handler(args))
+
 parser.add_argument('--alias', '-a', help='human readable alias for the new identifier prefix', default=None,
                     required=True)
-parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)  # passcode => bran
 
 
 def handler(args):

src/keri/app/cli/commands/challenge/respond.py

@@ -8,19 +8,16 @@
 from hio.base import doing
 
 from keri.app import habbing, forwarding, connecting
-from keri.app.cli.common import existing
+from keri.app.cli.common import existing 
+from keri.app.cli.common.parsing import Parsery
 from keri.app.habbing import GroupHab
 from keri.peer import exchanging
 
 parser = argparse.ArgumentParser(description='Respond to a list of challenge words by signing and sending an EXN '
-                                             'response')
+                                             'response',
+                                 parents=[Parsery.keystore()])
 parser.set_defaults(handler=lambda args: respond(args))
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
 parser.add_argument('--alias', '-a', help='human readable alias for the identifier to use for responding', default=None)
-parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)  # passcode => bran
 parser.add_argument('--words', '-d', help='JSON formatted array of words to sign, \'@\' allowed to load from a file',
                     action="store", required=True)
 parser.add_argument('--recipient', '-r', help='Contact alias of the AID to send the signed words to',

src/keri/app/cli/commands/challenge/verify.py

@@ -14,21 +14,17 @@
 from keri.app import indirecting, challenging, connecting, signaling
 from keri.app.cli.commands.challenge.generate import generateWords
 from keri.app.cli.common import existing
+from keri.app.cli.common.parsing import Parsery
 from keri.help import helping
 from keri.peer import exchanging
 
 logger = help.ogler.getLogger()
 
 parser = argparse.ArgumentParser(description='Check mailbox for EXN challenge response messages and verify their '
-                                             'signatures and data against provided words and signer')
+                                             'signatures and data against provided words and signer',
+                                 parents=[Parsery.keystore()])
 parser.set_defaults(handler=lambda args: verify(args))
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
 parser.add_argument('--alias', '-a', help='Unused, kept for backwards compatibility', default=None)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
-parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)  # passcode => bran
-
 parser.add_argument('--words', '-d', help='JSON formatted array of words to verfiy, \'@\' allowed to load from a file',
                     action="store", required=False)
 parser.add_argument('--generate', '-g', help="Generate words, print to stdout and wait for verification",

src/keri/app/cli/commands/clean.py

@@ -9,6 +9,7 @@
 
 from keri import help
 from keri.app.cli.common import existing
+from keri.app.cli.common.parsing import Parsery
 
 logger = help.ogler.getLogger()
 
@@ -24,22 +25,11 @@ def handler(args):
     return [clean]
 
 
-parser = argparse.ArgumentParser(description='Cleans and migrates a database and keystore')
-parser.set_defaults(handler=handler,
-                    transferable=True)
-
-# Parameters for basic structure of database
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
+parser = argparse.ArgumentParser(description='Cleans and migrates a database and keystore', 
+                                 parents=[Parsery.keystore()])
+parser.set_defaults(handler=handler)
 parser.add_argument('--temp', '-t', help='create a temporary keystore, used for testing', default=False)
 
-# Parameters for Manager creation
-# passcode => bran
-parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)
-
-
 class CleanDoer(doing.Doer):
 
     def __init__(self, args):

src/keri/app/cli/commands/contacts/list.py

@@ -13,19 +13,14 @@
 from keri import help, kering
 from keri.app import connecting
 from keri.app.cli.common import existing
+from keri.app.cli.common.parsing import Parsery
 from keri.kering import ConfigurationError
 
 logger = help.ogler.getLogger()
 
-parser = argparse.ArgumentParser(description='List existing contacts')
-parser.set_defaults(handler=lambda args: handler(args),
-                    transferable=True)
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
-parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)  # passcode => bran
-
+parser = argparse.ArgumentParser(description='List existing contacts', 
+                                 parents=[Parsery.keystore()])
+parser.set_defaults(handler=lambda args: handler(args))
 
 def handler(args):
     kwa = dict(args=args)

src/keri/app/cli/commands/contacts/replace.py

@@ -12,19 +12,15 @@
 from keri import help
 from keri.app import connecting
 from keri.app.cli.common import existing
+from keri.app.cli.common.parsing import Parsery
 from keri.kering import ConfigurationError
 
 logger = help.ogler.getLogger()
 
 # Could be expanded to provide arbitrary data if desired
-parser = argparse.ArgumentParser(description='Replace contact information for identifier prefix with alias information')
-parser.set_defaults(handler=lambda args: handler(args),
-                    transferable=True)
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
-parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)  # passcode => bran
+parser = argparse.ArgumentParser(description='Replace contact information for identifier prefix with alias information', 
+                                 parents=[Parsery.keystore()])
+parser.set_defaults(handler=lambda args: handler(args))
 parser.add_argument('--prefix', '-o', help='identifier prefix to replace contact information for', required=True)
 parser.add_argument('--alias', '-a', help='human readable alias for the contact', required=True)
 

src/keri/app/cli/commands/decrypt.py

@@ -9,16 +9,13 @@
 
 from keri import kering
 from keri.app.cli.common import existing
+from keri.app.cli.common.parsing import Parsery
 from keri.core import indexing, coring, MtrDex
 
-parser = argparse.ArgumentParser(description='Decrypt arbitrary data for AIDs with Ed25519 public keys only')
+parser = argparse.ArgumentParser(description='Decrypt arbitrary data for AIDs with Ed25519 public keys only', 
+                                 parents=[Parsery.keystore()])
 parser.set_defaults(handler=lambda args: handler(args))
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
 parser.add_argument('--alias', '-a', help='human readable alias for the new identifier prefix', required=True)
-parser.add_argument('--passcode', '-p', help='22 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)  # passcode => bran
 parser.add_argument('--data', '-d', help='Encrypted data or file (starts with "@")', required=True)
 
 

src/keri/app/cli/commands/delegate/confirm.py

@@ -12,6 +12,7 @@
 from keri import help
 from keri.app import habbing, indirecting, agenting, grouping, forwarding, delegating, notifying
 from keri.app.cli.common import existing
+from keri.app.cli.common.parsing import Parsery
 from keri.app.habbing import GroupHab
 from keri import core
 from keri.core import coring, serdering
@@ -22,14 +23,10 @@
 logger = help.ogler.getLogger()
 
 parser = argparse.ArgumentParser(description='Confirm success delegate event (icp or rot) and gather and '
-                                             'propagate witness receipts.')
+                                             'propagate witness receipts.',
+                                 parents=[Parsery.keystore()])
 parser.set_defaults(handler=lambda args: confirm(args))
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
 parser.add_argument('--alias', '-a', help='human readable alias for the new identifier prefix', required=True)
-parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)  # passcode => bran
 parser.add_argument("--interact", "-i", help="anchor the delegation approval in an interaction event.  "
                                              "Default is to use a rotation event.", action="store_true")
 parser.add_argument("--auto", "-Y", help="auto approve any delegation request non-interactively", action="store_true")

src/keri/app/cli/commands/delegate/request.py

@@ -12,21 +12,18 @@
 from keri import help
 from keri.app import habbing, indirecting, agenting, grouping, forwarding, delegating
 from keri.app.cli.common import existing
+from keri.app.cli.common.parsing import Parsery
 from keri.app.habbing import GroupHab
 from keri.core import coring, serdering
 from keri.db import dbing
 
 logger = help.ogler.getLogger()
 
 parser = argparse.ArgumentParser(description='Resend a delegation request message to a delegator that has not '
-                                             'approved a previous delegation.')
+                                             'approved a previous delegation.',
+                                 parents=[Parsery.keystore()])
 parser.set_defaults(handler=lambda args: request(args))
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
 parser.add_argument('--alias', '-a', help='human readable alias for the new identifier prefix', required=True)
-parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)  # passcode => bran
 
 def request(args):
     """

src/keri/app/cli/commands/did/generate.py

@@ -17,20 +17,10 @@
 logger = help.ogler.getLogger()
 
 parser = argparse.ArgumentParser(description='Generate and print an AID\'s DID.')
-parser.set_defaults(handler=lambda args: handler(args),
-                    transferable=True)
+parser.set_defaults(handler=lambda args: handler(args))
 
-# Parameters for basic structure of database
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
 parser.add_argument('--alias', '-a', help='human readable alias for which to generate a DID', default=None)
 parser.add_argument("--role", "-r", help="role of oobis to generate", required=False, default="witness")
-
-# Parameters for Manager access
-# passcode => bran
-parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)
 parser.add_argument('--url', '-u', help="generate a DID URL instead of a DID", action="store_true")
 
 

src/keri/app/cli/commands/ends/add.py

@@ -12,21 +12,17 @@
 from keri.app import habbing, grouping, indirecting, forwarding
 from keri.app.agenting import WitnessPublisher
 from keri.app.cli.common import existing
+from keri.app.cli.common.parsing import Parsery
 from keri.app.notifying import Notifier
 from keri.core import parsing
 from keri.peer import exchanging
 
 logger = help.ogler.getLogger()
 
-parser = argparse.ArgumentParser(description='Add new endpoint role authorization.')
-parser.set_defaults(handler=lambda args: add_end(args),
-                    transferable=True)
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
+parser = argparse.ArgumentParser(description='Add new endpoint role authorization.', 
+                                 parents=[Parsery.keystore()])
+parser.set_defaults(handler=lambda args: add_end(args))
 parser.add_argument('--alias', '-a', help='human readable alias for the new identifier prefix', required=True)
-parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)  # passcode => bran
 parser.add_argument("--role", "-r", help="KERI enpoint authorization role.",
                     required=True)
 parser.add_argument("--eid", "-e", help="qualified base64 of AID to authorize with new role for the AID identified "

src/keri/app/cli/commands/ends/export.py

@@ -10,19 +10,14 @@
 
 from keri import help, kering
 from keri.app.cli.common import existing
+from keri.app.cli.common.parsing import Parsery
 from keri.core import eventing
 
 logger = help.ogler.getLogger()
 
-parser = argparse.ArgumentParser(description='Export end points')
-parser.set_defaults(handler=lambda args: export_ends(args),
-                    transferable=True)
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
-parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)  # passcode => bran
-
+parser = argparse.ArgumentParser(description='Export end points', 
+                                 parents=[Parsery.keystore()])
+parser.set_defaults(handler=lambda args: export_ends(args))
 parser.add_argument("--aid", "-a", help="qualified base64 of AID to export rpy messages for all endpoints.",
                     required=True)
 

src/keri/app/cli/commands/ends/list.py

@@ -11,18 +11,14 @@
 
 from keri import help, kering
 from keri.app.cli.common import existing
+from keri.app.cli.common.parsing import Parsery
 
 logger = help.ogler.getLogger()
 
-parser = argparse.ArgumentParser(description='Add new endpoint role authorization.')
-parser.set_defaults(handler=lambda args: add_end(args),
-                    transferable=True)
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
+parser = argparse.ArgumentParser(description='Add new endpoint role authorization.', 
+                                 parents=[Parsery.keystore()])
+parser.set_defaults(handler=lambda args: add_end(args))
 parser.add_argument('--alias', '-a', help='human readable alias for the new identifier prefix', required=True)
-parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)  # passcode => bran
 parser.add_argument("--aid", help="qualified base64 of AID to export rpy messages for all endpoints.",
                     required=True)
 

src/keri/app/cli/commands/escrow/clear.py

@@ -9,17 +9,13 @@
 from hio.base import doing
 from keri import help
 from keri.app.cli.common import existing
+from keri.app.cli.common.parsing import Parsery
 
 logger = help.ogler.getLogger()
 
-parser = argparse.ArgumentParser(description='Clear escrows')
-parser.set_defaults(handler=lambda args: handler(args),
-                    transferable=True)
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
-parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)  # passcode => bran
+parser = argparse.ArgumentParser(description='Clear escrows', 
+                                 parents=[Parsery.keystore()])
+parser.set_defaults(handler=lambda args: handler(args))
 parser.add_argument('--force', action="store_true", required=False,
                     help='True means perform clear without prompting the user')
 

src/keri/app/cli/commands/escrow/list.py

@@ -10,6 +10,7 @@
 from hio.base import doing
 
 from keri import help
+from keri.app.cli.common.parsing import Parsery
 from keri.core import eventing
 from keri.app.cli.common import existing
 from keri.db import dbing
@@ -18,14 +19,9 @@
 
 logger = help.ogler.getLogger()
 
-parser = argparse.ArgumentParser(description='Views events in escrow state.')
-parser.set_defaults(handler=lambda args: handler(args),
-                    transferable=True)
-parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
-parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
-                    required=False, default="")
-parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
-                    dest="bran", default=None)  # passcode => bran
+parser = argparse.ArgumentParser(description='Views events in escrow state.', 
+                                 parents=[Parsery.keystore()])
+parser.set_defaults(handler=lambda args: handler(args)) 
 
 parser.add_argument("--escrow", "-e", help="show values for one specific escrow", default=None)