new: store logs in user log dir and display the location on startup

Author: thiswillbeyourgithub

DocToolsLLM/DocToolsLLM.py

@@ -3,7 +3,7 @@
 """
 
 # import this first because it sets the logging level
-from .utils.logger import whi, yel, red, md_printer, log, set_docstring, config_dir, cache_dir
+from .utils.logger import whi, yel, red, md_printer, log, set_docstring, log_dir, cache_dir
 
 import sys
 import faulthandler
@@ -247,6 +247,8 @@ def handle_exception(exc_type, exc_value, exc_traceback):
 
         if debug:
             llm_verbosity = True
+            whi(f"Cache location: {cache_dir.absolute()}")
+            whi(f"Config location: {log_dir.absolute()}")
 
         # storing as attributes
         self.modelbackend = modelname.split("/", 1)[0].lower()

DocToolsLLM/utils/logger.py

@@ -13,21 +13,24 @@
 from typing import Type, Callable, Optional, Union
 from rich.markdown import Markdown
 from rich.console import Console
-from platformdirs import user_cache_dir
+from platformdirs import user_cache_dir, user_log_dir
 
 from .typechecker import optional_typecheck
 
-assert Path(user_cache_dir()).exists(), f"User cache dir not found: '{user_cache_dir()}'"
-cache_dir = Path(user_cache_dir()) / "DocToolsLLM"
-cache_dir.mkdir(exist_ok=True)
-log_dir = cache_dir / "logs"
-log_dir.mkdir(exist_ok=True)
-(log_dir / "logs.txt").touch(exist_ok=True)
+cache_dir = Path(user_cache_dir(appname="DocToolsLLM"))
+assert cache_dir.parent.exists() or cache_dir.parent.parent.exists(), f"Invalid cache dir location: '{cache_dir}'"
+cache_dir.mkdir(parents=True, exist_ok=True)
+
+log_dir = Path(user_log_dir(appname="DocToolsLLM"))
+assert log_dir.parent.exists() or log_dir.parent.parent.exists() or log_dir.parent.parent.parent.exists(), f"Invalid log_dir location: '{log_dir}'"
+log_dir.mkdir(exist_ok=True, parents=True)
+log_file = (log_dir / "logs.txt")
+log_file.touch(exist_ok=True)
 
 # logger
 log_formatter = logging.Formatter('%(asctime)s %(levelname)s %(funcName)s(%(lineno)d) %(message)s')
 handler = logging.handlers.RotatingFileHandler(
-        filename=log_dir / "logs.txt",
+        filename=log_file,
         mode="a",
         encoding=None,
         delay=0,