New 'forced_home' and 'home' setter

Author: pcisar

firebird/base/config.py

@@ -97,14 +97,19 @@ class DirectoryScheme:
     Note:
         All paths are set when the instance is created and can be changed later.
     """
-    def __init__(self, name: str, version: str=None):
+    def __init__(self, name: str, version: str=None, force_home: bool=False):
         """
         Arguments:
             name: Appplication name.
             version: Application version.
+            force_home: When True, general directories (i.e. all except user-specific and
+                TMP) would be always based on HOME directory.
         """
         self.name: str = name
         self.version: str = version
+        self.force_home: bool = force_home
+        _h = os.getenv(f'{self.name.upper()}_HOME')
+        self.__home: Path = Path(_h) if _h is not None else Path(os.getcwd())
         home = self.home
         self.dir_map: Dict[str, Path] = {'config': home / 'config',
                                          'run_data': home / 'run_data',
@@ -124,11 +129,28 @@ def has_home_env(self) -> bool:
         return os.getenv(f'{self.name.upper()}_HOME') is not None
     @property
     def home(self) -> Path:
-        """HOME directory. Either path set by "<app_name>_HOME" environment variable, or
-        current working directory.
-        """
-        home = os.getenv(f'{self.name.upper()}_HOME')
-        return Path(home) if home is not None else Path(os.getcwd())
+        """HOME directory. Initial value is path set by "<app_name>_HOME" environment
+        variable, or to current working directory when variable is not defined.
+
+        Important:
+            When new value is assigned, the general directories (i.e. all except user-specific
+            and TMP) are redefined as subdirectories of new home path ONLY when HOME was
+            initially defined using "<app_name>_HOME" environment variable, or instance
+            was created with `force_home`=True.
+
+            However, all paths could be still changed individually to any value.
+        """
+        return self.__home
+    @home.setter
+    def home(self, value: Union[Path, str]) -> None:
+        self.__home = value if isinstance(value, Path) else Path(value)
+        if self.has_home_env() or self.force_home:
+            self.dir_map.update({'config': self.__home / 'config',
+                                 'run_data': self.__home / 'run_data',
+                                 'logs': self.__home / 'logs',
+                                 'data': self.__home / 'data',
+                                 'cache': self.__home / 'cache',
+                                 'srv': self.__home / 'srv'})
     @property
     def config(self) -> Path:
         """Directory for host-specific system-wide configuration files.
@@ -229,25 +251,27 @@ def user_cache(self, path: Path) -> None:
 class WindowsDirectoryScheme(DirectoryScheme):
     """Directory scheme that conforms to Windows standards.
 
-    If HOME is defined using "<app_name>_HOME" environment variable, only user-specific
-    directories and TMP are set according to platform standars, while general directories
-    remain as defined by base `DirectoryScheme`.
+    If HOME is defined using "<app_name>_HOME" environment variable, or `force_home` parameter
+    is True, only user-specific directories and TMP are set according to platform standars,
+    while general directories remain as defined by base `DirectoryScheme`.
     """
-    def __init__(self, name: str, version: str=None):
+    def __init__(self, name: str, version: str=None, force_home: bool=False):
         """
         Arguments:
             name: Appplication name.
             version: Application version.
+            force_home: When True, general directories (i.e. all except user-specific and
+                TMP) would be always based on HOME directory.
         """
-        super().__init__(name, version)
+        super().__init__(name, version, force_home)
         app_dir = Path(self.name)
         if self.version is not None:
             app_dir /= self.version
         pd = Path(os.path.expandvars('%PROGRAMDATA%'))
         lad = Path(os.path.expandvars('%LOCALAPPDATA%'))
         ad = Path(os.path.expandvars('%APPDATA%'))
         # Set general directories only when HOME is not forced by environment variable.
-        if not self.has_home_env():
+        if not self.has_home_env() and not force_home:
             self.dir_map.update({'config': pd / app_dir / 'config',
                                  'run_data': pd / app_dir / 'run',
                                  'logs': pd / app_dir / 'log',
@@ -266,22 +290,24 @@ def __init__(self, name: str, version: str=None):
 class LinuxDirectoryScheme(DirectoryScheme):
     """Directory scheme that conforms to Linux standards.
 
-    If HOME is defined using "<app_name>_HOME" environment variable, only user-specific
-    directories and TMP are set according to platform standars, while general directories
-    remain as defined by base `DirectoryScheme`.
+    If HOME is defined using "<app_name>_HOME" environment variable, or `force_home` parameter
+    is True, only user-specific directories and TMP are set according to platform standars,
+    while general directories remain as defined by base `DirectoryScheme`.
     """
-    def __init__(self, name: str, version: str=None):
+    def __init__(self, name: str, version: str=None, force_home: bool=False):
         """
         Arguments:
             name: Appplication name.
             version: Application version.
+            force_home: When True, general directories (i.e. all except user-specific and
+                TMP) would be always based on HOME directory.
         """
-        super().__init__(name, version)
+        super().__init__(name, version, force_home)
         app_dir = Path(self.name)
         if self.version is not None:
             app_dir /= self.version
         # Set general directories only when HOME is not forced by environment variable.
-        if not self.has_home_env():
+        if not self.has_home_env() and not force_home:
             self.dir_map.update({'config': Path('/etc') / app_dir,
                                  'run_data': Path('/run') / app_dir,
                                  'logs': Path('/var/log') / app_dir,
@@ -304,20 +330,20 @@ class MacOSDirectoryScheme(DirectoryScheme):
     directories and TMP are set according to platform standars, while general directories
     remain as defined by base `DirectoryScheme`.
     """
-    def __init__(self, name: str, version: str=None):
+    def __init__(self, name: str, version: str=None, force_home: bool=False):
         """
         Arguments:
             name: Appplication name.
             version: Application version.
         """
-        super().__init__(name, version)
+        super().__init__(name, version, force_home)
         app_dir = Path(self.name)
         if self.version is not None:
             app_dir /= self.version
         pd = Path('/Library/Application Support')
         lad = Path('~/Library/Application Support').expanduser()
         # Set general directories only when HOME is not forced by environment variable.
-        if not self.has_home_env():
+        if not self.has_home_env() and not force_home:
             self.dir_map.update({'config': pd / app_dir / 'config',
                                  'run_data': pd / app_dir / 'run',
                                  'logs': pd / app_dir / 'log',
@@ -333,12 +359,19 @@ def __init__(self, name: str, version: str=None):
                              'user_cache': Path('~/Library/Caches').expanduser() / app_dir / 'cache',
                              })
 
-def get_directory_scheme(app_name: str, version: str=None) -> DirectoryScheme:
+def get_directory_scheme(app_name: str, version: str=None, *, force_home: bool=False) -> DirectoryScheme:
     """Returns directory scheme for current platform.
+
+    Arguments:
+        app_name: Application name
+        version: Application version string
+        force_home: When True, the general directies are always set to subdirectories of
+                    `DirectoryScheme.home` directory. When False, these the home is used
+                    ONLY when it's set by "<app_name>_HOME" environment variable.
     """
     return {'Windows': WindowsDirectoryScheme,
             'Linux':LinuxDirectoryScheme,
-            'Darwin': MacOSDirectoryScheme}.get(platform.system(), DirectoryScheme)(app_name, version)
+            'Darwin': MacOSDirectoryScheme}.get(platform.system(), DirectoryScheme)(app_name, version, force_home)
 
 T = TypeVar('T')
 

test/test_config.py

@@ -3213,7 +3213,6 @@ def test_01_widnows(self):
         if platform.system() != 'Windows':
             self.skipTest("Only for Windows")
         scheme = config.get_directory_scheme(self.app_name)
-        # 'C:/Users/pavel/AppData/Local/test_app/tmp'
         self.assertEqual(scheme.config, Path('c:/ProgramData/test_app/config'))
         self.assertEqual(scheme.run_data, Path('c:/ProgramData/test_app/run'))
         self.assertEqual(scheme.logs, Path('c:/ProgramData/test_app/log'))
@@ -3225,7 +3224,55 @@ def test_01_widnows(self):
         self.assertEqual(scheme.user_data, Path('~/AppData/Local/test_app/data').expanduser())
         self.assertEqual(scheme.user_sync, Path('~/AppData/Roaming/test_app').expanduser())
         self.assertEqual(scheme.user_cache, Path('~/AppData/Local/test_app/cache').expanduser())
-    def test_02_linux(self):
+    @mock.patch.dict(os.environ, {f'{app_name.upper()}_HOME': 'c:/mydir/apphome/'})
+    def test_02_widnows_home_env(self):
+        if platform.system() != 'Windows':
+            self.skipTest("Only for Windows")
+        scheme = config.get_directory_scheme(self.app_name)
+        self.assertEqual(scheme.config, Path('c:/mydir/apphome/config'))
+        self.assertEqual(scheme.run_data, Path('c:/mydir/apphome/run_data'))
+        self.assertEqual(scheme.logs, Path('c:/mydir/apphome/logs'))
+        self.assertEqual(scheme.data, Path('c:/mydir/apphome/data'))
+        self.assertEqual(scheme.tmp, Path('~/AppData/Local/test_app/tmp').expanduser())
+        self.assertEqual(scheme.cache, Path('c:/mydir/apphome/cache'))
+        self.assertEqual(scheme.srv, Path('c:/mydir/apphome/srv'))
+        self.assertEqual(scheme.user_config, Path('~/AppData/Local/test_app/config').expanduser())
+        self.assertEqual(scheme.user_data, Path('~/AppData/Local/test_app/data').expanduser())
+        self.assertEqual(scheme.user_sync, Path('~/AppData/Roaming/test_app').expanduser())
+        self.assertEqual(scheme.user_cache, Path('~/AppData/Local/test_app/cache').expanduser())
+    @mock.patch('os.getcwd', return_value='c:/mydir/apphome/')
+    def test_03_widnows_home_forced(self, *args):
+        if platform.system() != 'Windows':
+            self.skipTest("Only for Windows")
+        scheme = config.get_directory_scheme(self.app_name)
+        self.assertEqual(scheme.config, Path('c:/mydir/apphome/config'))
+        self.assertEqual(scheme.run_data, Path('c:/mydir/apphome/run_data'))
+        self.assertEqual(scheme.logs, Path('c:/mydir/apphome/logs'))
+        self.assertEqual(scheme.data, Path('c:/mydir/apphome/data'))
+        self.assertEqual(scheme.tmp, Path('~/AppData/Local/test_app/tmp').expanduser())
+        self.assertEqual(scheme.cache, Path('c:/mydir/apphome/cache'))
+        self.assertEqual(scheme.srv, Path('c:/mydir/apphome/srv'))
+        self.assertEqual(scheme.user_config, Path('~/AppData/Local/test_app/config').expanduser())
+        self.assertEqual(scheme.user_data, Path('~/AppData/Local/test_app/data').expanduser())
+        self.assertEqual(scheme.user_sync, Path('~/AppData/Roaming/test_app').expanduser())
+        self.assertEqual(scheme.user_cache, Path('~/AppData/Local/test_app/cache').expanduser())
+    def test_04_widnows_home_change(self, *args):
+        if platform.system() != 'Windows':
+            self.skipTest("Only for Windows")
+        scheme = config.get_directory_scheme(self.app_name)
+        scheme.home = 'c:/mydir/apphome/'
+        self.assertEqual(scheme.config, Path('c:/mydir/apphome/config'))
+        self.assertEqual(scheme.run_data, Path('c:/mydir/apphome/run_data'))
+        self.assertEqual(scheme.logs, Path('c:/mydir/apphome/logs'))
+        self.assertEqual(scheme.data, Path('c:/mydir/apphome/data'))
+        self.assertEqual(scheme.tmp, Path('~/AppData/Local/test_app/tmp').expanduser())
+        self.assertEqual(scheme.cache, Path('c:/mydir/apphome/cache'))
+        self.assertEqual(scheme.srv, Path('c:/mydir/apphome/srv'))
+        self.assertEqual(scheme.user_config, Path('~/AppData/Local/test_app/config').expanduser())
+        self.assertEqual(scheme.user_data, Path('~/AppData/Local/test_app/data').expanduser())
+        self.assertEqual(scheme.user_sync, Path('~/AppData/Roaming/test_app').expanduser())
+        self.assertEqual(scheme.user_cache, Path('~/AppData/Local/test_app/cache').expanduser())
+    def test_05_linux_default(self):
         if platform.system() != 'Linux':
             self.skipTest("Only for Linux")
         scheme = config.get_directory_scheme(self.app_name)
@@ -3240,12 +3287,60 @@ def test_02_linux(self):
         self.assertEqual(scheme.user_data, Path('~/.local/share/test_app').expanduser())
         self.assertEqual(scheme.user_sync, Path('~/.local/sync/test_app').expanduser())
         self.assertEqual(scheme.user_cache, Path('~/.cache/test_app').expanduser())
+    @mock.patch.dict(os.environ, {f'{app_name.upper()}_HOME': '/mydir/apphome/'})
+    def test_06_linux_home_env(self):
+        if platform.system() != 'Linux':
+            self.skipTest("Only for Linux")
+        scheme = config.get_directory_scheme(self.app_name)
+        self.assertEqual(scheme.config, Path('/mydir/apphome/config'))
+        self.assertEqual(scheme.run_data, Path('/mydir/apphome/run_data'))
+        self.assertEqual(scheme.logs, Path('/mydir/apphome/logs'))
+        self.assertEqual(scheme.data, Path('/mydir/apphome/data'))
+        self.assertEqual(scheme.tmp, Path('/var/tmp/test_app'))
+        self.assertEqual(scheme.cache, Path('/mydir/apphome/cache'))
+        self.assertEqual(scheme.srv, Path('/mydir/apphome/srv'))
+        self.assertEqual(scheme.user_config, Path('~/.config/test_app').expanduser())
+        self.assertEqual(scheme.user_data, Path('~/.local/share/test_app').expanduser())
+        self.assertEqual(scheme.user_sync, Path('~/.local/sync/test_app').expanduser())
+        self.assertEqual(scheme.user_cache, Path('~/.cache/test_app').expanduser())
+    @mock.patch('os.getcwd', return_value='/mydir/apphome/')
+    def test_07_linux_home_forced(self, *args):
+        if platform.system() != 'Linux':
+            self.skipTest("Only for Linux")
+        scheme = config.get_directory_scheme(self.app_name, force_home=True)
+        self.assertEqual(scheme.config, Path('/mydir/apphome/config'))
+        self.assertEqual(scheme.run_data, Path('/mydir/apphome/run_data'))
+        self.assertEqual(scheme.logs, Path('/mydir/apphome/logs'))
+        self.assertEqual(scheme.data, Path('/mydir/apphome/data'))
+        self.assertEqual(scheme.tmp, Path('/var/tmp/test_app'))
+        self.assertEqual(scheme.cache, Path('/mydir/apphome/cache'))
+        self.assertEqual(scheme.srv, Path('/mydir/apphome/srv'))
+        self.assertEqual(scheme.user_config, Path('~/.config/test_app').expanduser())
+        self.assertEqual(scheme.user_data, Path('~/.local/share/test_app').expanduser())
+        self.assertEqual(scheme.user_sync, Path('~/.local/sync/test_app').expanduser())
+        self.assertEqual(scheme.user_cache, Path('~/.cache/test_app').expanduser())
+    def test_08_linux_home_change(self, *args):
+        if platform.system() != 'Linux':
+            self.skipTest("Only for Linux")
+        scheme = config.get_directory_scheme(self.app_name, force_home=True)
+        scheme.home = '/mydir/apphome/'
+        self.assertEqual(scheme.config, Path('/mydir/apphome/config'))
+        self.assertEqual(scheme.run_data, Path('/mydir/apphome/run_data'))
+        self.assertEqual(scheme.logs, Path('/mydir/apphome/logs'))
+        self.assertEqual(scheme.data, Path('/mydir/apphome/data'))
+        self.assertEqual(scheme.tmp, Path('/var/tmp/test_app'))
+        self.assertEqual(scheme.cache, Path('/mydir/apphome/cache'))
+        self.assertEqual(scheme.srv, Path('/mydir/apphome/srv'))
+        self.assertEqual(scheme.user_config, Path('~/.config/test_app').expanduser())
+        self.assertEqual(scheme.user_data, Path('~/.local/share/test_app').expanduser())
+        self.assertEqual(scheme.user_sync, Path('~/.local/sync/test_app').expanduser())
+        self.assertEqual(scheme.user_cache, Path('~/.cache/test_app').expanduser())
 
 if __name__ == '__main__':
     unittest_main()
 
-#class TestFloatOption(BaseConfigTest):
-    #"Unit tests for firebird.base.config.FloatOption"
+#class Test<TYPE>Option(BaseConfigTest):
+    #"Unit tests for firebird.base.config.<TYPE>Option"
     #def setUp(self):
         #super().setUp()
     #def test_simple(self):