named tuples in tyshell for better readability

[saartuer.git] / tyshell

diff --git a/tyshell b/tyshell
index c35ec0ebbe9da65439d6411246ceeecff076ebce..13a551330f03bb2ee8ec85074afc4aec19fc796e 100755 (executable)
--- a/tyshell
+++ b/tyshell
@@ -7,6 +7,7 @@ import subprocess
 import socket
 import pwd
 import grp
+from collections import namedtuple
 
 tuerSock = "/run/tuer.sock"
 
@@ -21,7 +22,11 @@ atexit.register(readline.write_history_file, histfile)
 
 # available commands
 def helpcmd(c):
-       print("Available commands: %s" % ", ".join(sorted(commands.keys())))
+       if (len(c) > 1):
+               print(commands.get(c[1],(None,'Can\'t find help for command %s'%(c[1]))).helpstring)
+       else:
+               print("Available commands: %s" % ", ".join(sorted(commands.keys())))
+               print("Use 'help command' to get more information on the command 'command'")
 
 def extcmd(cmd):
        def run(c):
@@ -32,7 +37,7 @@ def extcmd(cmd):
 
 def sendcmd(addr, cmd):
        def run(c):
-               print("Running %s..." % (cmd))
+               print("206 Sending command %s..." % (cmd))
                s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
                s.connect(addr)
                s.settimeout(60.0)
@@ -56,12 +61,14 @@ def alias (cmds, aliases):
                cmds[newname] = cmds[oldname]
        return cmds
 
+CmdEntry = namedtuple('CmdEntry','function helpstring')
+
 commands = alias({
-       'exit': exitcmd,
-       'help': helpcmd,
-       'open': sendcmd(tuerSock, 'unlock'),
-       'buzz': sendcmd(tuerSock, 'buzz'),
-       'who': whocmd,
+       'exit': CmdEntry(exitcmd, 'Quits this shell'),
+       'help': CmdEntry(helpcmd, 'Helps you getting to know the available commands'),
+       'open': CmdEntry(sendcmd(tuerSock, 'unlock'), 'Will try to unlock the apartment door'),
+       'buzz': CmdEntry(sendcmd(tuerSock, 'buzz'), 'Will buzz the buzzer for the street door'),
+       'who': CmdEntry(whocmd, 'Shows the list of people, who are allowed to control this system'),
 },{
        # aliases
        'unlock': 'open',
@@ -93,7 +100,7 @@ while True:
                print("Command %s not found. Use help." % command[0])
        elif len(cmdoptions) == 1: # exactly one command fits (prefix)
                try:
-                       res = commands[cmdoptions[0]](command)
+                       res = commands[cmdoptions[0]].function(command)
                        if res: break
                except Exception as e:
                        print("Error while executing %s: %s" % (command[0], str(e)))