Server/py: Improve docstring.

[plomrogue] / plomrogue-server.py

diff --git a/plomrogue-server.py b/plomrogue-server.py
index 2b5dcb6691a851adfeded8191f4253539922b48a..bcd985d22b6929c7605c5148ab1edf64ea14b537 100755 (executable)
--- a/plomrogue-server.py
+++ b/plomrogue-server.py
@@ -1,4 +1,13 @@
-import errno, os, time
+import errno
+import os
+import time
+
+
+class HandledException(Exception):
+    """Feature-less Exception child. Use for expected operational errors."""
+
+    pass
+
 
 def setup_server_io(io_db):
     """Fill IO files DB with proper file( path)s. Write process IO test string.
@@ -17,23 +26,34 @@ def setup_server_io(io_db):
     os.makedirs(io_dir, exist_ok=True)
     io_db["file_out"] = open(io_db["path_out"], "w")
     io_db["file_out"].write(io_db["teststring"] + "\n")
-    io_db["file_out"].flush()                         # TODO: Explain necessity.
     if os.access(io_db["path_in"], os.F_OK):
         os.remove(io_db["path_in"])
     io_db["file_in"] = open(io_db["path_in"], "w")
     io_db["file_in"].close()
     io_db["file_in"] = open(io_db["path_in"], "r")
 
+
 def cleanup_server_io(io_db):
     """Close and remove all files in IO files DB."""
     io_db["file_out"].close()
     os.remove(io_db["path_out"])
     io_db["file_in"].close()
     os.remove(io_db["path_in"])
-    if "file_worldstate" in io_db:                   # This file is only set up 
-        io_db["file_worldstate"].close()             # properly when the game 
-    if os.access(io_db["path_worldstate"], os.F_OK): # world is active, which is
-        os.remove(io_db["path_worldstate"])          # not guaranteed.
+    if "file_worldstate" in io_db:                    # This file's only set up
+        io_db["file_worldstate"].close()              # properly when the game
+    if os.access(io_db["path_worldstate"], os.F_OK):  # world is active, which
+        os.remove(io_db["path_worldstate"])           # is not guaranteed.
+
+
+def detect_atomic_leftover(path):
+    """Raise explained HandledException if file is found at path + "_tmp"."""
+    path_tmp = path + "_tmp"
+    msg = "Found file '" + path_tmp + "' that may be a leftover from an " \
+          "aborted previous attempt to write '" + path + "'. Aborting until " \
+          "the matter is resolved by removing it from its current path."
+    if os.access(path_tmp, os.F_OK):
+        raise HandledException(msg)
+
 
 io_db = {}
 try:
@@ -41,8 +61,20 @@ try:
     print("DUMMY: Open files.")
     setup_server_io(io_db)
     print("DUMMY: Run game.")
+    path_recordfile = "recordfile"
+    path_savefile = "savefile"
+    detect_atomic_leftover(path_savefile)
+    detect_atomic_leftover(path_recordfile)
+    if os.access(path_savefile, os.F_OK):
+        print(open(path_savefile, "r").read())
+    else:
+        msg = "MAKE_WORLD " + str(int(time.time()))
+        print(msg)
+except HandledException as exception:
+    print("Error:")
+    print(exception.args[0])
 except:
-    print("SOMETHING WENT WRONG\n")
+    print("SOMETHING WENT WRONG IN UNEXPECTED WAYS")
     raise
 finally:
     cleanup_server_io(io_db)