Comment polishing.

[open-adventure.git] / make_graph.py

diff --git a/make_graph.py b/make_graph.py
index f4e1b11eb4c9ec81fb01c1244ecebb7c515681c5..f33e2b564ca709b31f8284d4220f1977e3c24a1e 100755 (executable)
--- a/make_graph.py
+++ b/make_graph.py
@@ -1,36 +1,37 @@
 #!/usr/bin/env python3
+# SPDX-FileCopyrightText: Eric S. Raymond <esr@thyrsus.com>
+# SPDX-License-Identifier: BSD-2-Clause
 """\
-usage: make-graph.py [-a] -d] [-m] [-s]
+usage: make_graph.py [-a] -d] [-m] [-s] [-v]
 
 Make a DOT graph of Colossal Cave.
 
 -a = emit graph of entire dungeon
--d = emit graoh of mazw all different
+-d = emit graph of maze all different
+-f = emit graph of forest locations
 -m = emit graph of maze all alike
--s = emit graph of surface locations
--v = include internal sy,no;s in room labels
+-s = emit graph of non-forest surface locations
+-v = include internal symbols in room labels
 """
-# Copyright (c) 2017 by Eric S. Raymond
-# SPDX-License-Identifier: BSD-2-clause
+
+# pylint: disable=consider-using-f-string,line-too-long,invalid-name,missing-function-docstring,multiple-imports,redefined-outer-name
 
 import sys, getopt, yaml
 
 def allalike(loc):
     "Select out loci related to the Maze All Alike"
-    return ("ALIKE" in loc) or (loc == "LOC_PITBRINK") or ("MAZEEND" in loc) or ("STALACTITE" in loc)
+    return location_lookup[loc]["conditions"].get("ALLALIKE")
 
 def alldifferent(loc):
     "Select out loci related to the Maze All Alike"
-    return ("DIFFERENT" in loc) or (loc == "LOC_DEADEND13")
+    return location_lookup[loc]["conditions"].get("ALLDIFFERENT")
 
 def surface(loc):
     "Select out surface locations"
-    attrs = location_lookup[loc]
-    if ("ABOVE" in attrs["conditions"]) and attrs["conditions"]["ABOVE"]:
-        return True
-    if ("FOREST" in attrs["conditions"]) and attrs["conditions"]["FOREST"]:
-        return True
-    return False
+    return location_lookup[loc]["conditions"].get("ABOVE")
+
+def forest(loc):
+    return location_lookup[loc]["conditions"].get("FOREST")
 
 def abbreviate(d):
     m = {"NORTH":"N", "EAST":"E", "SOUTH":"S", "WEST":"W", "UPWAR":"U", "DOWN":"D"}
@@ -69,7 +70,7 @@ def roomlabel(loc):
     return description
 
 # A forwarder is a location that you can't actually stop in - when you go there
-# it ships some message (which is the point) then shifts you to a nexr location.
+# it ships some message (which is the point) then shifts you to a next location.
 # A forwarder has a zero-length array of notion verbs in its travel section.
 #
 # Here is an example forwarder declaration:
@@ -96,23 +97,23 @@ def forward(loc):
     return loc
 
 def reveal(objname):
-    "Should this object be revealed when mappinmg?"
+    "Should this object be revealed when mapping?"
     if "OBJ_" in objname:
         return False
     if objname == "VEND":
         return True
     obj = object_lookup[objname]
     return not obj.get("immovable")
-    
+
 if __name__ == "__main__":
-    with open("adventure.yaml", "r") as f:
+    with open("adventure.yaml", "r", encoding='ascii', errors='surrogateescape') as f:
         db = yaml.safe_load(f)
 
     location_lookup = dict(db["locations"])
     object_lookup = dict(db["objects"])
 
     try:
-        (options, arguments) = getopt.getopt(sys.argv[1:], "admsv")
+        (options, arguments) = getopt.getopt(sys.argv[1:], "adfmsv")
     except getopt.GetoptError as e:
         print(e)
         sys.exit(1)
@@ -124,6 +125,8 @@ if __name__ == "__main__":
             subset = lambda loc: True
         elif switch == '-d':
             subset = alldifferent
+        elif switch == '-f':
+            subset = forest
         elif switch == '-m':
             subset = allalike
         elif switch == '-s':
@@ -145,8 +148,8 @@ if __name__ == "__main__":
                 startlocs[location] = [objname]
 
     # Compute reachability, using forwards.
-    # Dictionary ke6y is (from, to) iff its a valid link,
-    # value is correspoinding motion verbs.
+    # Dictionary key is (from, to) iff its a valid link,
+    # value is corresponding motion verbs.
     links = {}
     nodes = []
     for (loc, attrs) in db["locations"]: