#!/usr/bin/env python3
+"""Location/site dependent data."""
+
import logging
import platform
from dataclasses import dataclass
@dataclass
class SiteConfig(object):
+ """The set of information specific to where the program is running."""
+
location_name: str
location: Location
network: str
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'
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'
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.
+def effective_location(location_override: Optional[str] = None) -> str:
+ """Detects and returns a location taking into account two override
+ mechanisms.
- >>> cfg = get_config()
- >>> cfg.location_name == 'HOUSE' or cfg.location_name == 'CABIN'
+ >>> x = effective_location()
+ >>> x in set(['HOUSE', 'CABIN'])
True
+ >>> effective_location('HOUSE')
+ 'HOUSE'
+
"""
if location_override is None:
try:
if location_override is None or location_override == 'NONE':
location = this_location()
else:
+ logger.debug('site_config\'s location_override was set to: %s', 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.
+
+ >>> cfg = get_config()
+ >>> cfg.location_name == 'HOUSE' or cfg.location_name == 'CABIN'
+ True
+
+ """
+ location = effective_location(location_override)
if location == 'HOUSE':
return SiteConfig(
location_name='HOUSE',