Merge pull request #26 from APLA-Toolbox/remove-docs

Workon Issue #22 - Use logger instead of prints

Author: guilyx

.gitignore

@@ -132,3 +132,7 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Logs
+logs/*
+!logs/.gitkeep

logs/.gitkeep

@@ -1,5 +1,7 @@
 import src.automated_planner as parser
 import argparse
+import logging
+import os
 
 
 def main():
@@ -11,10 +13,22 @@ def main():
     args_parser.add_argument("problem", type=str, help="PDDL problem file")
     args_parser.add_argument("-v", "--verbose", help="Increases the output's verbosity")
     args = args_parser.parse_args()
+    logging.basicConfig(
+        filename="logs/main.log",
+        format="%(levelname)s:%(message)s",
+        filemode="w",
+        level=logging.INFO,
+    )  # Creates the log file
     apla_tbx = parser.AutomatedPlanner(args.domain, args.problem)
+    logging.info("Starting the tool")
     path, time = apla_tbx.depth_first_search(time_it=True)
-    print(apla_tbx.get_actions_from_path(path))
-    print("Computation time: %.2f" % time)
+    logging.info(apla_tbx.get_actions_from_path(path))
+    logging.info("Computation time: %.2f seconds" % time)
+    logging.info("Tool finished")
+    # Output the log (to show something in the output screen)
+    logfile = open("logs/main.log", "r")
+    print(logfile.read())
+    logfile.close()
 
 
 if __name__ == "__main__":

main.py

@@ -2,6 +2,7 @@
 from .bfs import BreadthFirstSearch
 from .dfs import DepthFirstSearch
 from .dijkstra import DijkstraBestFirstSearch
+import logging
 
 UI = False
 
@@ -49,7 +50,7 @@ def __retrace_path(self, node):
 
     def get_actions_from_path(self, path):
         if not path:
-            print("Path is empty, can't operate...")
+            logging.warning("Path is empty, can't operate...")
             return []
         actions = []
         for node in path:
@@ -63,7 +64,7 @@ def get_actions_from_path(self, path):
 
     def get_state_def_from_path(self, path):
         if not path:
-            print("Path is empty, can't operate...")
+            logging.warning("Path is empty, can't operate...")
             return []
         trimmed_path = []
         for node in path:

src/automated_planner.py

@@ -1,4 +1,5 @@
 from .node import Node
+import logging
 
 
 class BreadthFirstSearch:
@@ -32,5 +33,5 @@ def search(self):
                     if child in self.visited:
                         continue
                     self.queue.append(child)
-        print("!!! No path found !!!")
+        logging.warning("!!! No path found !!!")
         return None

src/bfs.py

@@ -1,4 +1,6 @@
 from .node import Node
+import logging
+
 
 class DepthFirstSearch:
     def __init__(self, automated_planner):
@@ -31,5 +33,5 @@ def search(self):
                     if child in self.visited:
                         continue
                     self.stack.append(child)
-        print("!!! No path found !!!")
+        logging.warning("!!! No path found !!!")
         return None

src/dfs.py

@@ -1,6 +1,7 @@
+from .heuristics import zero_heuristic
 from .node import Node
+import logging
 import math
-from .heuristics import zero_heuristic
 
 
 class DijkstraBestFirstSearch:
@@ -64,5 +65,5 @@ def search(self):
                 else:
                     self.nodes[child_hash] = child
                     self.open_nodes_n += 1
-        print("!!! No path found !!!")
+        logging.warning("!!! No path found !!!")
         return None