From 99d5a8a7c7f86725d772f19e007c24e9f1397740 Mon Sep 17 00:00:00 2001
From: Santo Cariotti <sancn@live.com>
Date: Thu, 20 Jul 2017 19:03:57 +0200
Subject: added docstrings

---
 lib/commands.py | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

(limited to 'lib/commands.py')

diff --git a/lib/commands.py b/lib/commands.py
index 95f3563..1b5a5a8 100644
--- a/lib/commands.py
+++ b/lib/commands.py
@@ -5,25 +5,28 @@ from config import config as co
 class Commands(object):
 
     def command(self, what, cmd):
+        """
+        this function is used for execute a command
+        """
         if what == 'clear':
             clear()
         elif what == 'set':
             try:
-                if cmd[1] == 'user' and cmd[2] is not None:
+                if cmd[1] == 'user' and cmd[2] is not None: #set name for user
                     if len(cmd[2]) > 10:
                         raise PersonalError('lunghezza maggiore del consetito. Max 10')
 
-                    if userexist(cmd[2]) == True:
+                    if userexist(cmd[2]) == True: #check if the user exists
                         raise PersonalError('questo nome utente esiste già')
 
                     if len(cmd) > ListCommands.info['set'][1]:
                         raise PersonalError(Colors.grey + 'set user' + Colors.red + ' accetta 1 parametro')
 
-                    if self.user != '': r.zrem('usersname', self.user)
+                    if self.user != '': r.zrem('usersname', self.user) #if user already exists, del the name from set
 
                     self.user = cmd[2]
-                    r.hset('user:'+host, 'name', self.user)
-                    r.zadd('usersname', self.user, 0)
+                    r.hset('user:'+host, 'name', self.user) #change name of user:0.0.0.0
+                    r.zadd('usersname', self.user, 0) #insert new name into the set
 
                     print('Ok')
                 elif cmd[1] is not ListCommands.commands['set']:
@@ -39,19 +42,22 @@ class Commands(object):
                 if len(cmd) > ListCommands.info['get'][1]:
                     raise PersonalError(Colors.grey + 'get ' + Colors.red + 'accetta 2 parametri')
 
-                if cmd[1] == 'i':
+                if cmd[1] == 'i': #if first word after get is 'i', there is an info
                     if cmd[2] == 'user':
+                        #if self.user is empty, print 'nil'
                         if self.user != '':
                             print(r.hget('user:'+host, 'name').decode('utf-8'))
                         else:
                             print('nil')
-                    elif cmd[2] not in ListCommands.commands['get'][1]:
+                    elif cmd[2] not in ListCommands.commands['get'][1]: #check if the word after 'i' exists
                         ListCommands.err('keyword')
                     else:
                         print(co[cmd[2]])
                 elif cmd[1] == 'user?':
+                    #if there are more than 2 word after 'get', the func doens't work
                     if len(cmd) > 3:
                         raise PersonalError(Colors.grey + 'get user?' + Colors.red + ' accetta 1 parametro')
+                    #return 1 if the user exists
                     print((lambda x: '0' if x == False else '1')(userexist(cmd[2])))
                 else:
                     raise KeyError
-- 
cgit v1.2.3-18-g5258