new: add arg --silent

Author: thiswillbeyourgithub

WDoc/WDoc.py

@@ -131,6 +131,7 @@ def __init__(
         DIY_rolling_window_embedding: Union[bool, int] = False,
         import_mode: Union[bool, int] = False,
         disable_md_printing: bool = False,
+        silent: bool = False,
         version: bool = False,
 
         **cli_kwargs,

WDoc/docs/USAGE.md

@@ -222,11 +222,16 @@
     the default langchain SentenceTransformerEmbedding implementation
 
 * `--import_mode`: bool, default `False`
-    * if True, will return the answer from query instead of printing it
+    * if True, will return the answer from query instead of printing it.
+    The idea is to use if when you import WDoc instead of running
+    it from the cli. See `--silent`
 
 * `--disable_md_printing`: bool, default `True`
     * if True, instead of using rich to display some information, default to simpler colored prints.
 
+* `--silent`: bool, default False
+    * disable almost all prints. Can be handy if `--import_mode` is used.
+
 * `--version`: bool, default False
     * display the version and exit
 

WDoc/utils/flags.py

@@ -17,5 +17,6 @@ def check_kwargs(arg):
 is_debug = check_kwargs("debug")
 is_verbose = is_debug or check_kwargs("verbose")
 
+is_silent = check_kwargs("silent")
 
 disable_md_printing = check_kwargs("disable_md_printing")

WDoc/utils/logger.py

@@ -14,7 +14,7 @@
 import warnings
 
 from .typechecker import optional_typecheck
-from .flags import disable_md_printing
+from .flags import disable_md_printing, is_silent
 
 # ignore warnings from beautiful soup
 warnings.filterwarnings("ignore", category=UserWarning, module='bs4')
@@ -85,7 +85,8 @@ def printer(string: Union[str, Dict, List], **args) -> str:
         for k, v in colors.items():
             string = string.replace(v, "")
         logger.info(string)
-        tqdm.write(col + string + colors["reset"], **args)
+        if not is_silent:
+            tqdm.write(col + string + colors["reset"], **args)
         return inp
     return printer