Add logging

nbs/00_core.ipynb → nbs/99_utils.ipynb

@@ -6,17 +6,21 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# | hide\n",
     "%load_ext autoreload\n",
-    "%autoreload 2"
+    "%autoreload 2\n",
+    "\n",
+    "from nbdev.showdoc import *\n",
+    "from fastcore.test import *"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# core\n",
+    "# Utilities\n",
     "\n",
-    "> Fill in a module description here\n"
+    "> Common utilities used across modules.\n"
    ]
   },
   {
@@ -25,17 +29,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# | default_exp core"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# | hide\n",
-    "from nbdev.showdoc import *"
+    "from pkg_name.utils import *"
    ]
   },
   {
@@ -44,21 +38,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# | export\n",
-    "def foo():\n",
-    "    pass"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# | hide\n",
-    "import nbdev\n",
-    "\n",
-    "nbdev.nbdev_export()"
+    "show_doc(init_logging)"
    ]
   }
  ],

pkg_name/_modidx.py

@@ -5,4 +5,4 @@
                 'doc_host': 'https://tongyx361.github.io',
                 'git_url': 'https://github.com/tongyx361/nbdev-template-tongyx361',
                 'lib_path': 'pkg_name'},
-  'syms': {'pkg_name.core': {'pkg_name.core.foo': ('core.html#foo', 'pkg_name/core.py')}}}
+  'syms': {'pkg_name.utils': {'pkg_name.utils.init_logging': ('utils.html#init_logging', 'pkg_name/utils.py')}}}

pkg_name/utils.py

@@ -0,0 +1,56 @@
+"""
+Common utilities used across modules.
+"""
+
+import logging
+from typing import Optional
+
+
+# %% ../nbs/99_utils.ipynb 0
+def init_logging(
+    fmt: str = "[%(levelname)s] [%(asctime)s.%(msecs)d] [pid %(process)d] [%(pathname)s:%(lineno)d:%(funcName)s]\n%(message)s",
+    datefmt: str = "%Y-%m-%d %H:%M:%S",
+    level: int = logging.INFO,
+    log_path: Optional[str] = None,
+    file_mode: str = "w",
+    force: bool = True,
+) -> None:
+    """
+    Initialize logging.
+
+    Parameters
+    ----------
+    format: str
+        Format of the log message.
+    datefmt: str
+        Date format of the log message.
+    level: int
+        Level of the log message.
+    log_path: Optional[str]
+        Path to the log file.
+    file_mode: str
+        Mode of the log file.
+    force: bool
+        Whether to force the logging to be initialized.
+    """
+    if force:
+        logging.shutdown()
+
+    logging.basicConfig(
+        format=fmt,
+        datefmt=datefmt,
+        level=level,
+        force=force,
+    )
+
+    if log_path is not None:
+        file_handler = logging.FileHandler(log_path, mode=file_mode)
+        file_handler.setLevel(level)
+        file_handler.setFormatter(logging.Formatter(fmt=fmt, datefmt=datefmt))
+
+        logging.getLogger().addHandler(file_handler)
+        logging.info(f"log_path = {log_path}")
+
+
+init_logging()
+logging.info("Test logging.")

pyproject.toml

@@ -27,7 +27,7 @@ line_length = 88  # Should match Black's line length
 
 [tool.mypy]
 python_version = "3.11"
-disallow_untyped_defs = true
+disallow_untyped_defs = false
 ignore_missing_imports = true
 show_error_codes = true
 strict_optional = true