Fix default cache database location

fixes #1296

Author: Jorenar

AUTHORS.txt

@@ -58,3 +58,4 @@ Mattori Birnbaum - me [at] mattori [dot] com - https://mattori.com
 Pi R
 Alnoman Kamil - noman [at] kamil [dot] gr - https://kamil.gr
 Leonardo Taccari - iamleot [at] gmail [dot] com
+Jorenar - dev [at] jorenar [dot] com - https://jorenar.com

CHANGELOG.rst

@@ -12,6 +12,7 @@ may want to subscribe to `GitHub's tag feed
 unreleased
 
 * CHANGE the ``pkg_resources`` library is no longer required.
+* FIX the location of caching database to ``$XDG_CACHE_HOME``
 
 0.13.0
 ======

khal/settings/khal.spec

@@ -77,7 +77,7 @@ type = option('calendar', 'birthdays', 'discover', default='calendar')
 addresses = force_list(default='')
 
 [sqlite]
-# khal stores its internal caching database here, by default this will be in the *$XDG_DATA_HOME/khal/khal.db* (this will most likely be *~/.local/share/khal/khal.db*).
+# khal stores its internal caching database here, by default this will be in the *$XDG_CACHE_HOME/khal/khal.db* (this will most likely be *~/.cache/khal/khal.db*).
 path = expand_db_path(default=None)
 
 # It is mandatory to set (long)date-, time-, and datetimeformat options, all others options in the **[locale]** section are optional and have (sensible) defaults.

khal/settings/utils.py

@@ -113,9 +113,9 @@ def expand_path(path: str) -> str:
 
 
 def expand_db_path(path: str) -> str:
-    """expands `~` as well as variable names, defaults to $XDG_DATA_HOME"""
+    """expands `~` as well as variable names, defaults to $XDG_CACHE_HOME"""
     if path is None:
-        path = join(xdg.BaseDirectory.xdg_data_home, 'khal', 'khal.db')
+        path = join(xdg.BaseDirectory.xdg_cache_home, 'khal', 'khal.db')
     return expanduser(expandvars(path))
 
 

tests/cli_test.py

@@ -17,11 +17,13 @@
 
 class CustomCliRunner(CliRunner):
     def __init__(self, config_file, db=None, calendars=None,
-                 xdg_data_home=None, xdg_config_home=None, tmpdir=None, **kwargs) -> None:
+                 xdg_data_home=None, xdg_config_home=None,
+                 xdg_cache_home=None, tmpdir=None, **kwargs) -> None:
         self.config_file = config_file
         self.db = db
         self.calendars = calendars
         self.xdg_data_home = xdg_data_home
+        self.xdg_cache_home = xdg_cache_home
         self.xdg_config_home = xdg_config_home
         self.tmpdir = tmpdir
 
@@ -40,12 +42,14 @@ def runner(tmpdir, monkeypatch):
     calendar3 = tmpdir.mkdir('calendar3')
 
     xdg_data_home = tmpdir.join('vdirs')
+    xdg_cache_home = tmpdir.join('.cache')
     xdg_config_home = tmpdir.join('.config')
     config_file = xdg_config_home.join('khal').join('config')
 
     # TODO create a vdir config on disk and let vdirsyncer actually read it
     monkeypatch.setattr('vdirsyncer.cli.config.load_config', lambda: Config())
     monkeypatch.setattr('xdg.BaseDirectory.xdg_data_home', str(xdg_data_home))
+    monkeypatch.setattr('xdg.BaseDirectory.xdg_cache_home', str(xdg_cache_home))
     monkeypatch.setattr('xdg.BaseDirectory.xdg_config_home', str(xdg_config_home))
     monkeypatch.setattr('xdg.BaseDirectory.xdg_config_dirs', [str(xdg_config_home)])
 
@@ -65,7 +69,7 @@ def inner(print_new=False, default_calendar=True, days=2, **kwargs):
         runner = CustomCliRunner(
             config_file=config_file, db=db, calendars={"one": calendar},
             xdg_data_home=xdg_data_home, xdg_config_home=xdg_config_home,
-            tmpdir=tmpdir,
+            xdg_cache_home=xdg_cache_home, tmpdir=tmpdir,
         )
         return runner
     return inner

tests/settings_test.py

@@ -49,7 +49,7 @@ def test_simple_config(self):
                     'color': None, 'priority': 10, 'type': 'calendar', 'addresses': [''],
                 },
             },
-            'sqlite': {'path': os.path.expanduser('~/.local/share/khal/khal.db')},
+            'sqlite': {'path': os.path.expanduser('~/.cache/khal/khal.db')},
             'locale': LOCALE_BERLIN,
             'default': {
                 'default_calendar': None,
@@ -89,7 +89,7 @@ def test_small(self):
                 'work': {'path': os.path.expanduser('~/.calendars/work/'),
                          'readonly': True, 'color': None, 'priority': 10,
                          'type': 'calendar', 'addresses': ['[email protected]']}},
-            'sqlite': {'path': os.path.expanduser('~/.local/share/khal/khal.db')},
+            'sqlite': {'path': os.path.expanduser('~/.cache/khal/khal.db')},
             'locale': {
                 'local_timezone': get_localzone(),
                 'default_timezone': get_localzone(),