X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=site_config.py;h=fcf22a8d2cf20d4e6a6dd83690a51de08ce2f44d;hb=d2357ff35e7752ae3eb6caa2813c35c17fea778b;hp=caaf3d8c1c49d9e3d26e5ab8efde06c8461808a7;hpb=5f75cf834725ac26b289cc5f157af0cb71cd5f0e;p=python_utils.git

diff --git a/site_config.py b/site_config.py
index caaf3d8..fcf22a8 100644
--- a/site_config.py
+++ b/site_config.py
@@ -1,9 +1,9 @@
 #!/usr/bin/env python3
 
-from dataclasses import dataclass
 import logging
 import platform
-from typing import Callable
+from dataclasses import dataclass
+from typing import Callable, Optional
 
 # Note: this module is fairly early loaded.  Be aware of dependencies.
 import config
@@ -12,15 +12,15 @@ from type.locations import Location
 logger = logging.getLogger(__name__)
 
 args = config.add_commandline_args(
-    f'({__file__})',
-    'Args related to __file__'
+    f'Global Site Config ({__file__})',
+    'Args related to global site-specific configuration',
 )
 args.add_argument(
     '--site_config_override_location',
     default='NONE',
     const='NONE',
     nargs='?',
-    choices=('HOUSE', 'CABIN', 'NONE'),
+    choices=['HOUSE', 'CABIN', 'NONE'],
     help='Where are we, HOUSE, CABIN?  Overrides standard detection code.',
 )
 
@@ -35,6 +35,7 @@ class SiteConfig(object):
     presence_location: Location
     is_anyone_present: Callable
     arper_minimum_device_count: int
+    arper_cache_file: str
 
 
 def get_location_name():
@@ -64,11 +65,76 @@ def get_location():
 
 def is_anyone_present_wrapper(location: Location):
     import base_presence
+
     p = base_presence.PresenceDetection()
     return p.is_anyone_in_location_now(location)
 
 
-def get_config():
+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'
+    elif '.cabin' in hostname:
+        location = 'HOUSE'
+    else:
+        raise Exception(f"{hostname} doesn't help me know where I'm running?!")
+    return location
+
+
+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'
+    elif '.cabin' in hostname:
+        location = 'CABIN'
+    else:
+        raise Exception(f"{hostname} doesn't help me know where I'm running?!")
+    return location
+
+
+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']
+        except KeyError:
+            location_override = None
+
+    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}')
+        location = location_override
+    return location
+
+
+def get_config(location_override: Optional[str] = None):
     """
     Get a configuration dataclass with information that is
     site-specific including the current running location.
@@ -78,37 +144,30 @@ def get_config():
     True
 
     """
-    hostname = platform.node()
-    try:
-        location_override = config.config['site_config_override_location']
-    except KeyError:
-        location_override = 'NONE'
-    if location_override == 'NONE':
-        if '.house' in hostname:
-            location = 'HOUSE'
-        elif '.cabin' in hostname:
-            location = 'CABIN'
+    location = effective_location(location_override)
     if location == 'HOUSE':
         return SiteConfig(
-            location_name = 'HOUSE',
-            location = Location.HOUSE,
-            network = '10.0.0.0/24',
-            network_netmask = '255.255.255.0',
-            network_router_ip = '10.0.0.1',
-            presence_location = Location.HOUSE,
-            is_anyone_present = lambda x=Location.HOUSE: is_anyone_present_wrapper(x),
-            arper_minimum_device_count = 50,
+            location_name='HOUSE',
+            location=Location.HOUSE,
+            network='10.0.0.0/24',
+            network_netmask='255.255.255.0',
+            network_router_ip='10.0.0.1',
+            presence_location=Location.HOUSE,
+            is_anyone_present=lambda x=Location.HOUSE: is_anyone_present_wrapper(x),
+            arper_minimum_device_count=50,
+            arper_cache_file='/home/scott/cache/.arp_table_cache_house',
         )
     elif location == 'CABIN':
         return SiteConfig(
-            location_name = 'CABIN',
-            location = Location.CABIN,
-            network = '192.168.0.0/24',
-            network_netmask = '255.255.255.0',
-            network_router_ip = '192.168.0.1',
-            presence_location = Location.CABIN,
-            is_anyone_present = lambda x=Location.CABIN: is_anyone_present_wrapper(x),
-            arper_minimum_device_count = 15,
+            location_name='CABIN',
+            location=Location.CABIN,
+            network='192.168.0.0/24',
+            network_netmask='255.255.255.0',
+            network_router_ip='192.168.0.1',
+            presence_location=Location.CABIN,
+            is_anyone_present=lambda x=Location.CABIN: is_anyone_present_wrapper(x),
+            arper_minimum_device_count=15,
+            arper_cache_file='/home/scott/cache/.arp_table_cache_cabin',
         )
     else:
         raise Exception(f'Unknown site location: {location}')
@@ -116,4 +175,5 @@ def get_config():
 
 if __name__ == '__main__':
     import doctest
+
     doctest.testmod()