Fixed loading errors for new plugin system. Still need to work on unloading.

Added missing comments and doc strings to plugin module.

Fixed translation files still using  instead of .

Author: satoon101

addons/source-python/packages/source-python/auth/commands.py

@@ -45,7 +45,7 @@ def call_command(self, args):
                 'Missing Command'].get_string() + '\n'
 
             # Print the auth help text
-            self._print_auth_help(message)
+            self.print_auth_help(message)
 
             # No need to go further
             return
@@ -61,7 +61,7 @@ def call_command(self, args):
                 'Invalid Sub-Command'].get_string(command=command) + '\n'
 
             # Print the auth help text
-            self._print_auth_help(message)
+            self.print_auth_help(message)
 
             # No need to go further
             return
@@ -78,22 +78,22 @@ def call_command(self, args):
         # Execute the command
         self[command]()
 
-    def _print_auth_help(self, message=''):
+    def print_auth_help(self, message=''):
         '''Prints all "sp auth" sub-commands.'''
 
         # Get header messages
         header = message + '[SP Auth] ' + _auth_strings[
             'Help'].get_string() + 'sp auth <command> [arguments]\n' + '=' * 78
 
         # Print all "sp auth" sub-commands
-        self._print_help(header, '=' * 78)
+        self.print_help(header, '=' * 78)
 
-    def _print_help(self, pretext='', posttext=''):
+    def print_help(self, pretext='', posttext=''):
         '''Prints all "sp auth" sub-commands'''
         AuthCommandsLogger.log_message(
-            pretext + '\n' + self._get_help_text() + '\n' + posttext)
+            pretext + '\n' + self.get_help_text() + '\n' + posttext)
 
-    def _get_help_text(self):
+    def get_help_text(self):
         '''Returns the help text for auth commands'''
 
         # Store the base message
@@ -206,4 +206,4 @@ def _print_auth_providers():
 
 # Add all printing commands to the dictionary
 _AuthCommandsInstance['list'] = _print_auth_providers
-_AuthCommandsInstance['help'] = _AuthCommandsInstance._print_auth_help
+_AuthCommandsInstance['help'] = _AuthCommandsInstance.print_auth_help

addons/source-python/packages/source-python/plugins/command.py

@@ -33,12 +33,12 @@
 # =============================================================================
 @public
 class SubCommandManager(OrderedDict, AutoUnload):
-    ''''''
+    '''Class used for executing sub-commands for the given console command'''
 
     def __init__(self, command, description='', prefix=''):
-        ''''''
+        '''Called on instance initialization'''
 
-        # 
+        # Re-call OrderedDict's __init__ to properly setup the object
         super(SubCommandManager, self).__init__()
 
         # Does the class have a proper manager object assigned?
@@ -79,225 +79,233 @@ def __init__(self, command, description='', prefix=''):
             self.command, self.call_command, description, 0)
 
     def _unload_instance(self):
-        ''''''
+        '''Unregisters commands when the instance is unloaded'''
         ServerCommandManager.unregister_commands(
             self.command, self.call_command)
 
     def call_command(self, CICommand):
-        ''''''
+        '''Gets the provided sub-command and executes accordingly'''
 
-        # 
+        # Get the argument string
         arg_string = CICommand.get_arg_string()
-        #
+
+        # Use try/except to split the argument string,
+        # if it contains more than one argument
         try:
 
-            # 
+            # Split the argument string to get the sub-command
             command, args = arg_string.split(maxsplit=1)
 
+        # Were there not enough arguments to split?
         except ValueError:
 
-            # 
+            # Set the command to the entire string
             command = arg_string.strip()
 
-            # 
+            # Set args to nothing
             args = ''
 
-        # 
+        # Split the remaining args
         args = args.split()
 
-        # 
+        # Make the sub-command lower-case
         command = command.lower()
 
-        # 
+        # Is the sub-command in the dictionary?
         if not command in self:
 
-            # 
+            # Was a sub-command given?
             if command:
 
-                # 
+                # Print a message about the invalid sub-command
                 message = self.prefix + _plugin_strings[
                     'Invalid Command'].get_string(
                         command=self.command, subcommand=command)
 
-            # 
+            # Was no sub-command given?
             else:
 
-                # 
+                # Print a message about the missing sub-command
                 message = self.prefix + _plugin_strings[
                     'No Command'].get_string(command=self.command)
 
+            # Print the help text for the console command
             self.print_help(message)
 
-            # 
+            # No need to go further
             return
 
-        # 
+        # Does the given sub-command's callable allow for arguments?
         if hasattr(self[command], 'args'):
 
-            # 
+            # Get the number of required arguments for the callable
             required = len([
                 x for x in self[command].args if x.startswith('<')])
 
-            # 
+            # Get the number of arguments provided
             given = len(args)
 
-            # 
+            # Were enough arguments provided?
             if given < required:
 
-                # 
+                # Print a message about the invalid number of arguments given
                 self.logger.log_message(
                     self.prefix + _plugin_strings['Invalid Arguments'
                     ].get_string(command=self.command, subcommand=command) +
                     ' '.join(self[command].args))
 
-                # 
+                # No need to go further
                 return
 
-            # 
+            # Are all of the arguments required?
             if required == len(self[command].args):
 
-                # 
+                # Were the correct number of arguments given?
                 if given != required:
 
-                    # 
+                    # Print a message about the invalid
+                    # number of arguments given
                     self.logger.log_message(
                         self.prefix + _plugin_strings['Invalid Arguments'
                         ].get_string(command=self.command, subcommand=command
                         ) + ' '.join(self[command].args))
 
-                    # 
+                    # No need to go further
                     return
 
-            # 
+            # Call the sub-command's callable with the given arguments
             self[command](*args)
 
-            # 
+            # No need to go further
             return
 
-        # 
+        # Does the current item have its own call_command method?
         if hasattr(self[command], 'call_command'):
 
-            # 
+            # Call the instance's call_command method with the arguments
             self[command].call_command(args)
 
-            # 
+            # No need to go further
             return
 
-        # 
+        # Call the callable without the arguments
         self[command]()
 
     def print_help(self, message=''):
-        ''''''
+        '''Prints all sub-commands for the console command'''
 
-        # 
+        # Add a header message
         message += '\n' + self.prefix + _plugin_strings[
             'Help'].get_string(command=self.command) + '\n' + '=' * 78
 
-        # 
+        # Loop through all registered sub-commands
         for item in self:
 
-            # 
+            # Set the text
             text = str(item)
 
-            # 
+            # Does the current sub-command have its own print_help method?
             if hasattr(self[item], 'print_help'):
 
-                # 
-                message += '\n' + self[item]._get_help_text()
+                # Get the instance's help text
+                message += '\n' + self[item].get_help_text()
 
-                # 
+                # Continue to the next item
                 continue
 
-            # 
+            # Does the current command have any arguments?
             if hasattr(self[item], 'args'):
 
-                # 
+                # Add the arguments to the text
                 text += ' ' + ' '.join(self[item].args)
 
-            # 
+            # Add a message for the current command
             message += '\n' + text + self[
                 item].__doc__.rjust(78 - len(text))
 
-        # 
+        # Send the message
         self.logger.log_message(message + '\n' + '=' * 78)
 
     def load_plugin(self, plugin_name):
-        ''''''
+        '''Loads a plugin by name'''
 
-        # 
+        # Is the plugin already loaded?
         if plugin_name in self.manager:
 
-            # 
+            # Send a message that the plugin is already loaded
             self.logger.log_message(self.prefix + _plugin_strings[
                 'Already Loaded'].get_string(plugin=plugin_name))
 
-            # 
+            # No need to go further
             return
 
-        # 
+        # Load the plugin and get its instance
         plugin = self.manager[plugin_name]
 
-        # 
+        # Was the plugin unable to be loaded?
         if plugin is None:
 
-            # 
+            # Send a message that the plugin was not loaded
             self.logger.log_message(self.prefix + _plugin_strings[
                 'Unable to Load'].get_string(plugin=plugin_name))
 
-            # 
+            # No need to go further
             return
 
-        # 
+        # Send a message that the plugin was loaded
         self.logger.log_message(self.prefix + _plugin_strings[
             'Successful Load'].get_string(plugin=plugin_name))
 
+    # Set the method's required arguments
     load_plugin.args = ['<plugin>']
 
     def unload_plugin(self, plugin_name):
-        ''''''
+        '''Unloads a plugin by name'''
 
-        # 
+        # Is the plugin loaded?
         if not plugin_name in self.manager:
 
-            # 
+            # Send a message that the plugin is not loaded
             self.logger.log_message(self.prefix + _plugin_strings[
                 'Not Loaded'].get_string(plugin=plugin_name))
 
-            # 
+            # No need to go further
             return
 
-        # 
+        # Unload the plugin
         del self.manager[plugin_name]
 
-        # 
+        # Send a message that the plugin was unloaded
         self.logger.log_message(self.prefix + _plugin_strings[
             'Successful Unload'].get_string(plugin=plugin_name))
 
+    # Set the method's required arguments
     unload_plugin.args = ['<plugin>']
 
     def reload_plugin(self, plugin_name):
-        ''''''
+        '''Reloads a plugin by name'''
 
-        # 
+        # Unload the plugin
         self.unload_plugin(plugin_name)
 
-        # 
+        # Load the plugin
         self.load_plugin(plugin_name)
 
+    # Set the method's required arguments
     reload_plugin.args = ['<plugin>']
 
     def print_plugins(self):
-        ''''''
+        '''Prints all currently loaded plugins'''
 
-        # 
+        # Get the header message
         message = self.prefix + _plugin_strings[
             'Plugins'].get_string() + '\n' + '=' * 61 + '\n\n\t'
 
-        # 
+        # Add all loaded plugins to the message
         message += '\n\t'.join(self.manager)
 
-        # 
+        # Add a breaker at the end of the message
         message += '\n' + '=' * 61
 
-        # 
+        # Send the message
         self.logger.log_message(message)