Merge #4224

4224: Public API of logging module r=astafan8 a=jenshnielsen This defines a public api for the logging module at qcodes.logger and updates examples to use this. Depends on #4223 Co-authored-by: Jens H. Nielsen <[email protected]>
microsoft · Jun 7, 2022 · 229a7ec · 229a7ec
2 parents 54522b7 + 3667ce2
commit 229a7ec
Show file tree

Hide file tree

Showing 9 changed files with 479 additions and 989 deletions.
diff --git a/docs/api/logger/index.rst b/docs/api/logger/index.rst
@@ -3,21 +3,5 @@
 qcodes.logger
 =============
 
-
-.. autosummary::
-
-    qcodes.logger
-    qcodes.logger.instrument_logger
-    qcodes.logger.log_analysis
-    qcodes.logger.logger
-
 .. automodule:: qcodes.logger
-
-
-.. toctree::
-   :maxdepth: 4
-   :hidden:
-
-   instrument_logger
-   log_analysis
-   logger
+    :autosummary:
diff --git a/docs/api/logger/instrument_logger.rst b/docs/api/logger/instrument_logger.rst
diff --git a/docs/api/logger/log_analysis.rst b/docs/api/logger/log_analysis.rst
diff --git a/docs/api/logger/logger.rst b/docs/api/logger/logger.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -57,6 +57,7 @@
     "sphinx.ext.todo",
     "qcodes.sphinx_extensions.parse_parameter_attr",
     "sphinxcontrib.towncrier",
+    "autodocsumm",
 ]
 
 # include special __xxx__ that DO have a docstring

diff --git a/docs/examples/logging/logfile_parsing.ipynb b/docs/examples/logging/logfile_parsing.ipynb
diff --git a/docs/examples/logging/logging_example.ipynb b/docs/examples/logging/logging_example.ipynb
diff --git a/docs_requirements.txt b/docs_requirements.txt
@@ -2,6 +2,7 @@ alabaster==0.7.12
 argon2-cffi==21.3.0
 async-generator==1.10
 attrs==21.4.0
+autodocsumm==0.2.8
 Babel==2.10.1
 backcall==0.2.0
 bleach==5.0.0

diff --git a/qcodes/logger/__init__.py b/qcodes/logger/__init__.py
@@ -9,10 +9,44 @@
 
 """
 
-
-from .logger import (flush_telemetry_traces,
-                     get_console_handler, get_file_handler, get_level_name,
-                     get_level_code, get_log_file_name, start_logger,
-                     start_command_history_logger, start_all_logging,
-                     handler_level, console_level, LogCapture)
 from .instrument_logger import filter_instrument
+from .log_analysis import (
+    capture_dataframe,
+    log_to_dataframe,
+    logfile_to_dataframe,
+    time_difference,
+)
+from .logger import (
+    LogCapture,
+    console_level,
+    flush_telemetry_traces,
+    get_console_handler,
+    get_file_handler,
+    get_level_code,
+    get_level_name,
+    get_log_file_name,
+    handler_level,
+    start_all_logging,
+    start_command_history_logger,
+    start_logger,
+)
+
+__all__ = [
+    "LogCapture",
+    "capture_dataframe",
+    "console_level",
+    "filter_instrument",
+    "flush_telemetry_traces",
+    "get_console_handler",
+    "get_file_handler",
+    "get_level_code",
+    "get_level_name",
+    "get_log_file_name",
+    "handler_level",
+    "log_to_dataframe",
+    "logfile_to_dataframe",
+    "start_all_logging",
+    "start_command_history_logger",
+    "start_logger",
+    "time_difference",
+]