Merge pull request #1850 from Dominik-Vogel/enable_logging_by_default

Call `start_all_logging` on qcodes import

Author: jenshnielsen

docs/examples/15_minutes_to_QCoDeS.ipynb

@@ -93,7 +93,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "In every measurement session, it is highly recommended to have QCoDeS logging turned on. This will allow you to have all the logs in case troubleshooting is required. To enable logging, we add the following single line of code at the beginnig of our scripts after the imports:"
+    "In every measurement session, it is highly recommended to have QCoDeS logging turned on. This will allow you to have all the logs in case troubleshooting is required. To enable logging, we can either add the following single line of code at the beginnig of our scripts after the imports:"
    ]
   },
   {
@@ -121,6 +121,24 @@
     "start_all_logging()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "or we can configure qcodes to automatically start logging on every import of qcodes, by running the following code once. (This will persist the current configuration in `~\\qcodesrc.json`)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from qcodes import config\n",
+    "config.logger.start_logging_on_import = 'always'\n",
+    "config.save_to_home()"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

docs/examples/logging/logging_example.ipynb

@@ -16,7 +16,7 @@
    "source": [
     "## TL;DR\n",
     " * There is a QCoDeS logging module: `qcodes.utils.logger`\n",
-    " * Call `logger.start_all_logging` at the start of every script/session to make sure all log messages get stored to the `.qcodes/logs` folder in your home directory.\n",
+    " * Call `logger.start_all_logging` at the start of every script/session to make sure all log messages get stored to the `.qcodes/logs` folder in your home directory, or set `logger.start_logging_on_import` to `True` in your `qcodesrc.json` configuration.\n",
     " * For debugging purposes you can log messages of an individual instrument (and see the VISA dialog).\n",
     " * You can obtain all logging messages in a `pandas.DataFrame` for further analysis."
    ]
@@ -106,6 +106,24 @@
     "2. Enable logging of the IPython commands into a separate log file."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Alternatively we can configure qcodes to automatically start logging on every import of qcodes, by running the following code once. (This will persist the current configuration in `~\\qcodesrc.json`)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from qcodes import config\n",
+    "config.logger.start_logging_on_import = 'always'\n",
+    "config.save_to_home()"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -1857,7 +1875,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.4"
+   "version": "3.7.5"
   },
   "toc": {
    "base_numbering": 1,

qcodes/__init__.py

@@ -5,13 +5,19 @@
 # config
 
 from qcodes.config import Config
+from qcodes.logger import start_all_logging
+from qcodes.logger.logger import conditionally_start_all_logging
 from qcodes.utils.helpers import add_to_spyder_UMR_excludelist
 from .version import __version__
 
+config: Config = Config()
+
+conditionally_start_all_logging()
+
 # we dont want spyder to reload qcodes as this will overwrite the default station
 # instrument list and running monitor
 add_to_spyder_UMR_excludelist('qcodes')
-config: Config = Config()
+
 
 from qcodes.version import __version__
 

qcodes/config/qcodesrc.json

@@ -7,7 +7,8 @@
         "loglevel": "WARNING",
         "file_loglevel": "INFO"
     },
-    "logger":{
+    "logger": {
+        "start_logging_on_import": "if_telemetry_set_up",
         "console_level": "WARNING",
         "file_level": "INFO",
         "logger_levels":{

qcodes/config/qcodesrc_schema.json

@@ -61,6 +61,12 @@
             "description": "controls all settings related to the logging module `qcodes.utils.logger`.",
             "type" : "object",
             "properties" : {
+                "start_logging_on_import": {
+                    "type": "string",
+                    "enum": ["always", "never", "if_telemetry_set_up"],
+                    "description": "whether to call `start_all_logging` on qcodes import time. Valid values are 'always', 'never', 'if_telemetry_set_up'.",
+                    "default": "if_telemetry_set_up"
+                },
                 "console_level" :{
                     "type" : "string",
                     "description": "control logging level of console output",

qcodes/logger/logger.py

@@ -293,6 +293,56 @@ def start_all_logging() -> None:
     start_logger()
 
 
+def conditionally_start_all_logging() -> None:
+    """Start logging if qcodesrc.json setup for it and in tool environment.
+
+    This function will start logging if the session is not being executed by
+    a tool such as pytest and under the following conditions depending on the
+    qcodes configuration of ``config.logger.start_logging_on_import``:
+
+    For ``never``:
+
+        don't start logging automatically
+
+    For ``always``:
+
+        Always start logging when not in test environment
+
+    For ``if_telemetry_set_up``:
+
+        Start logging if the GUID components and the instrumentation key for
+        telemetry are set up, and not in a test environment.
+    """
+    def start_logging_on_import() -> bool:
+        config = qc.config
+        if config.logger.start_logging_on_import == 'always':
+            return True
+        elif config.logger.start_logging_on_import == 'never':
+            return False
+        elif config.logger.start_logging_on_import == 'if_telemetry_set_up':
+            return (
+                config.GUID_components.location != 0 and
+                config.GUID_components.work_station != 0 and
+                config.telemetry.instrumentation_key != \
+                    "00000000-0000-0000-0000-000000000000"
+            )
+        else:
+            raise RuntimeError('Error in qcodesrc validation.')
+
+    def running_in_test_or_tool() -> bool:
+        import sys
+        tools = (
+            'pytest.py',
+            'pytest',
+            '_jb_pytest_runner.py',  # Jetbrains Pycharm
+            'testlauncher.py'        # VSCode
+        )
+        return any(sys.argv[0].endswith(tool) for tool in tools)
+
+    if start_logging_on_import() and not running_in_test_or_tool():
+        start_all_logging()
+
+
 @contextmanager
 def handler_level(level: LevelType,
                   handler: Union[logging.Handler,