Refactor logging (#295)

* Refactor logging * Delete edisgo_run file * Add logger module to API doc * Delete edisgo_run from API doc * Changes to docstring * Change logger * Expand docstring * Add setup_logger to examples * Add check if dingo example grid directory is empty * Add logging to whatsnew * Move logger setup to function * Add class teardown to enable caplog * Minor change in docstring Co-authored-by: birgits <birgit.schachler@rl-institut.de>
openego · Sep 8, 2022 · 4735c19 · 4735c19
1 parent 10d0b3b
commit 4735c19
Show file tree

Hide file tree

Showing 10 changed files with 317 additions and 625 deletions.
diff --git a/doc/api/edisgo.tools.rst b/doc/api/edisgo.tools.rst
@@ -9,14 +9,6 @@ edisgo.tools.config module
     :undoc-members:
     :show-inheritance:
 
-edisgo.tools.edisgo\_run module
---------------------------------
-
-.. automodule:: edisgo.tools.edisgo_run
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 edisgo.tools.geo module
 ------------------------
 
@@ -33,6 +25,14 @@ edisgo.tools.geopandas\_helper module
     :undoc-members:
     :show-inheritance:
 
+edisgo.tools.logger module
+----------------------------------------
+
+.. automodule:: edisgo.tools.logger
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 edisgo.tools.networkx\_helper module
 ----------------------------------------
 

diff --git a/doc/whatsnew/v0-2-0.rst b/doc/whatsnew/v0-2-0.rst
@@ -9,6 +9,7 @@ Changes
 * added pre-commit hooks (flake8, black, isort, pyupgrade) `#229 <https://github.com/openego/eDisGo/pull/229>`_
 * added issue and pull request templates `#220 <https://github.com/openego/eDisGo/issues/220>`_
 * added Windows installation yml and documentation
+* added functionality to set up different loggers with individual logging levels and where to write output `#295 <https://github.com/openego/eDisGo/issues/295>`_
 * added integrity checks of eDisGo object `#231 <https://github.com/openego/eDisGo/issues/231>`_
 * added functionality to save to and load from zip archive `#216 <https://github.com/openego/eDisGo/pull/216>`_
 * added option to not raise error in case power flow did not converge `#207 <https://github.com/openego/eDisGo/issues/207>`_

diff --git a/edisgo/flex_opt/charging_strategies.py b/edisgo/flex_opt/charging_strategies.py
@@ -32,7 +32,7 @@
     ],
 }
 
-logger = logging.getLogger("edisgo")
+logger = logging.getLogger(__name__)
 
 
 # TODO: the dummy timeseries should be as long as the simulated days and not

diff --git a/edisgo/network/electromobility.py b/edisgo/network/electromobility.py
@@ -12,7 +12,7 @@
 if "READTHEDOCS" not in os.environ:
     import geopandas as gpd
 
-logger = logging.getLogger("edisgo")
+logger = logging.getLogger(__name__)
 
 COLUMNS = {
     "charging_processes_df": [