Add docs and fix style

Move comment onto multiple lines to shorten to line length
Add docstring to modloader.rreload
Use ``isinstance`` instead of ``type`` in modloader.rreload

Add extra newlines to modloader.modast  to conform with PEP8
Fix typo in docstring in modloader.modast

Remove redundant imports in modloader.modclass

Add docstring to modloader.modconfig.remove_mod

Add docstring to modloader.modinfo.reset_mods

Change methods in core to staticmethods
Remove redundant imports in core
Remove redundant variables in core
Add extra newlines to core to conform with PEP8
Add docstrings to core

Add extra newlines to testing.test to conform with PEP8

Author: muddyfish

modloader/__init__.py

@@ -19,9 +19,15 @@ def get_mod_path():
     return os.path.join(renpy.config.gamedir, "mods")
 
 
-# Credit to Matthew for this code: https://stackoverflow.com/a/17194836/3398583, modified by muddyfish
+# Credit to Matthew for this code: https://stackoverflow.com/a/17194836/3398583
+# Modified by muddyfish
 def rreload(module, modules=None):
-    """Recursively reload modules."""
+    """Recursively reloads a module.
+
+    Ignores modules in ``modules`` and all modules not in the mods folder
+
+
+    """
     print "RELOADING", module.__file__
     sys.stdout.flush()
     reload(module)
@@ -31,7 +37,7 @@ def rreload(module, modules=None):
         modules.append(module)
     for attribute_name in dir(module):
         attribute = getattr(module, attribute_name)
-        if type(attribute) is ModuleType:
+        if isinstance(attribute, ModuleType):
             if attribute not in modules:
                 if get_mod_path() in attribute.__file__:
                     rreload(attribute, modules)

modloader/modast.py

@@ -46,6 +46,7 @@ def find_label(label):
     """
     return renpy.game.script.lookup(label)
 
+
 def search_for_node_type(node, type_, max_depth=200):
     """Search for a specific type of node
 
@@ -210,6 +211,7 @@ def find_python_statement(statement):
     "NOPQRSTUVWXYZnopqrstuvwxyzABCDEFGHIJKLMabcdefghijklm",
     "ABCDEFGHIJKLMabcdefghijklmNOPQRSTUVWXYZnopqrstuvwxyz")
 
+
 class ASTHook(ast.Node):
     """A custom :class:`renpy.ast.Node` that acts as a hook between
         other node objects.
@@ -413,6 +415,7 @@ def call_hook(node, dest_node, func=None):
     hook = hook_opcode(node, None)
 
     def call_function(hook):
+        # pylint: disable=missing-docstring
         if func:
             func(hook)
 
@@ -425,7 +428,7 @@ def call_function(hook):
 
 
 def unhook_label(label):
-    """Unhook a hook from a lbel
+    """Unhook a hook from a label
 
     Args:
         label (str): The label's name

modloader/modclass.py

@@ -1,5 +1,4 @@
 """This file is free software under the GPLv3 license"""
-import sys
 from modloader import modinfo
 
 

modloader/modconfig.py

@@ -7,6 +7,11 @@
 
 
 def remove_mod(mod_name):
+    """Remove a mod from the game and reload.
+
+    Args:
+        mod_name (str): The internal name of the mod to be removed
+    """
     mod_class = get_mods()[mod_name]
     mod_folder = mod_class.__module__
     shutil.rmtree(os.path.join(renpy.config.gamedir, "mods", mod_folder))

modloader/modinfo.py

@@ -15,4 +15,5 @@ def get_mods():
 
 
 def reset_mods():
+    """Remove all mods from the registry"""
     modlist.clear()

mods/core/__init__.py

@@ -1,23 +1,32 @@
 """This file is free software under the GPLv3 license"""
-import renpy
 import renpy.parser as parser
 import renpy.ast as ast
 
 from modloader import modinfo, modast
-from modloader.modgame import sprnt
 from modloader.modgame import base as ml
 from modloader.modclass import Mod, loadable_mod
 
+
 @loadable_mod
 class AWSWMod(Mod):
-    """The core mod
+    """The core mod.
 
     This mod is responsible for being a proxy between renpy code and modlib
     """
-    def mod_info(self):
+
+    @staticmethod
+    def mod_info():
+        """Get the mod info
+        Returns: a three element tuple containing the mod name, version and description
+        """
         return ("Core", "v0.1", "")
 
-    def mod_load(self):
+    @staticmethod
+    def mod_load():
+        """Run various housekeeping tasks for ease of modding.
+        Disables the screen cache.
+        Adds the MODS button to the main menu.
+        """
         # This is called due to renpy's screen cache. Any modifications to screens with an
         # enabled cache will fail!
         modast.disable_slast_cache()
@@ -35,25 +44,23 @@ def mod_load(self):
         modast.call_hook(stmt, modast.find_label("_core_updateChapter"))
 
         # How to abuse the ren'py parser for your own personal gain!
-        target_display = None
-
         tocompile = """
         screen dummy:
             imagebutton auto "ui/mods_%s.png" action [Show("preferencesbg"), Show('modmenu'), Play("audio", "se/sounds/open.wav")] hovered Play("audio", "se/sounds/select.ogg") xalign 0.03 yalign 0.955
         """
+
         compiled = parser.parse("FNDummy", tocompile)
         target_display = None
         for node in compiled:
-            #sprnt(type(e).__name__)
             if isinstance(node, ast.Init):
                 for child in node.block[0].screen.children:
                     target_display = child
 
         modast.get_slscreen('main_menu').children.append(target_display)
 
-
-    def mod_complete(self):
-        # Insert an NSFW warning if any mods register as NSFW
+    @staticmethod
+    def mod_complete():
+        """Insert a NSFW warning if any mods register as NSFW"""
 
         for mod_name, mod in modinfo.get_mods().iteritems():
             mod_info = mod.mod_info()

testing/test.py

@@ -5,25 +5,30 @@
 
 from modloader import modast
 
+
 def test_get_screen():
     result = modast.get_screen("screen_test_get_screen")
     return result is not None and isinstance(result,
             renpy.display.screen.Screen)
 
+
 def test_get_slscreen():
     result = modast.get_slscreen("screen_test_get_screen")
     return result is not None and isinstance(result,
             renpy.sl2.slast.SLScreen)
 
+
 def test_find_label():
     result = modast.find_label("label_test_find_label")
     return result is not None and isinstance(result, renpy.ast.Label)
 
+
 def test_search_for_node_type():
     result = modast.search_for_node_type(
             modast.find_label("label_test_find_label"), renpy.ast.Menu)
     return result is not None and isinstance(result, renpy.ast.Menu)
 
+
 def test_search_for_node_with_criteria():
     def bryce_say(node):
         return isinstance(node, renpy.ast.Say) and node.who == "Br"
@@ -32,49 +37,56 @@ def bryce_say(node):
             modast.find_label("label_test_find_label"), bryce_say)
     return result is not None and isinstance(result, renpy.ast.Say)
 
+
 def test_remove_slif():
     sl = modast.get_slscreen("screen_test_get_screen")
     result = modast.remove_slif(sl, "persistent.test")
     return result and len(sl.children[0].entries[0][1].children) == 0
 
+
 def test_find_menu_single():
     result = modast.find_menu("Yes you are!")
     return result is not None and isinstance(result, list)
 
+
 def test_find_menu_multi():
     result = modast.find_menu(["Yes you are!", "Of course!"])
     return result is not None and isinstance(result, list)
 
+
 def test_find_say():
     result = modast.find_say("This should not be displayed")
     return result is not None and isinstance(result, renpy.ast.Say) \
             and result.who == "c"
 
+
 def test_add_menu_option():
     menu = modast.find_menu("Yes you are!")[0]
     modast.add_menu_option(menu, "No you aren't",
             modast.find_label("label_extra"))
     return len(menu.items) == 3
 
+
 def test_find_in_source_code():
     # TODO: Fix this, it fails
     result = modast.find_in_source_code(16, "test.rpy")
     return result is not None and isinstance(result, renpy.ast.Label)
 
+
 def test_find_python_statement():
     result = modast.find_python_statement("this_is_a_very_unique = \"variable\"")
     return result is not None
 
+
 def test_tests():
     list_of_tests = [test_get_screen, test_get_slscreen,
-            test_find_label, test_search_for_node_type,
-            test_search_for_node_with_criteria, test_remove_slif,
-            test_find_menu_single, test_find_menu_multi,
-            test_find_say, test_add_menu_option,
-            test_find_in_source_code, test_find_python_statement]
+                     test_find_label, test_search_for_node_type,
+                     test_search_for_node_with_criteria, test_remove_slif,
+                     test_find_menu_single, test_find_menu_multi,
+                     test_find_say, test_add_menu_option,
+                     test_find_in_source_code, test_find_python_statement]
 
     for test in list_of_tests:
-        success = False
         try:
             success = test()
         except Exception, e: