X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=site_config.py;h=7f6410d39356c1d0d8f910cfcece67eaf4cff29e;hb=e8fbbb7306430478dec55d2c963eed116d8330cc;hp=d98c6bc36b8e5671ea581f14dd21f31356debc99;hpb=4d03debb5b84b5b3e096add468ecd87c55ed0f5f;p=python_utils.git

diff --git a/site_config.py b/site_config.py
index d98c6bc..7f6410d 100644
--- a/site_config.py
+++ b/site_config.py
@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 
+"""Location/site dependent data."""
+
 import logging
 import platform
 from dataclasses import dataclass
@@ -27,6 +29,8 @@ args.add_argument(
 
 @dataclass
 class SiteConfig(object):
+    """The set of information specific to where the program is running."""
+
     location_name: str
     location: Location
     network: str
@@ -71,6 +75,14 @@ def is_anyone_present_wrapper(location: Location):
 
 
 def other_location() -> str:
+    """
+    Returns the location where this program is _NOT_ running.
+
+    >>> x = other_location()
+    >>> x in set(['HOUSE', 'CABIN'])
+    True
+
+    """
     hostname = platform.node()
     if '.house' in hostname:
         location = 'CABIN'
@@ -82,6 +94,14 @@ def other_location() -> str:
 
 
 def this_location() -> str:
+    """
+    Returns the location where this program _IS_ running.
+
+    >>> x = this_location()
+    >>> x in set(['HOUSE', 'CABIN'])
+    True
+
+    """
     hostname = platform.node()
     if '.house' in hostname:
         location = 'HOUSE'
@@ -93,6 +113,17 @@ def this_location() -> str:
 
 
 def effective_location(location_override: Optional[str] = None) -> str:
+    """Detects and returns a location taking into account two override
+    mechanisms.
+
+    >>> x = effective_location()
+    >>> x in set(['HOUSE', 'CABIN'])
+    True
+
+    >>> effective_location('HOUSE')
+    'HOUSE'
+
+    """
     if location_override is None:
         try:
             location_override = config.config['site_config_override_location']
@@ -102,7 +133,7 @@ def effective_location(location_override: Optional[str] = None) -> str:
     if location_override is None or location_override == 'NONE':
         location = this_location()
     else:
-        logger.debug(f'site_config\'s location_override was set to: {location_override}')
+        logger.debug('site_config\'s location_override was set to: %s', location_override)
         location = location_override
     return location