MAINT: Use logger instead of logging directly

MartinThoma · Oct 27, 2019 · 74fe623 · 74fe623
1 parent 35b89be
commit 74fe623
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 17 deletions.
diff --git a/edapy/cli.py b/edapy/cli.py
@@ -10,6 +10,8 @@
 
 # Core Library
 import collections
+import logging
+import sys
 
 # Third party
 import click
@@ -20,6 +22,12 @@
 import edapy.images
 import edapy.pdf
 
+logging.basicConfig(
+    format="%(asctime)s %(levelname)s %(message)s",
+    level=logging.DEBUG,
+    stream=sys.stdout,
+)
+
 
 def setup_yaml():
     """
@@ -40,7 +48,7 @@ def _represent_dict_order(self, data):
 @click.group(help=__doc__)
 @click.version_option(version=edapy.__version__)
 def entry_point():
-    pass
+    """Exploratory data analysis tool."""
 
 
 entry_point.add_command(edapy.csv.entry_point)

diff --git a/edapy/csv/describe.py b/edapy/csv/describe.py
@@ -1,13 +1,17 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
+"""Describe a CSV."""
+
 # Core Library
 import logging
 from typing import Any, Dict, List, Tuple
 
 # Third party
 import pandas as pd
 
+logger = logging.getLogger(__name__)
+
 
 def describe_pandas_df(
     df: pd.DataFrame, dtype: Dict[str, Any] = None
@@ -140,6 +144,7 @@ def _generate_column_info(
     df: pd.DataFrame, dtype: Dict[str, Any]
 ) -> Tuple[Dict[str, List], Dict[str, Any]]:
     """
+    Generate information about a column.
 
     Parameters
     ----------
@@ -173,7 +178,7 @@ def _generate_column_info(
             and column_name not in dtype
         )
         if is_suspicious_cat:
-            logging.warning(
+            logger.warning(
                 "Column '{}' has only {} different values ({}). "
                 "You might want to make it a 'category'".format(
                     column_name, value_count, value_list

diff --git a/edapy/images/__init__.py b/edapy/images/__init__.py
@@ -18,6 +18,8 @@
 # First party
 import edapy.images.exif
 
+logger = logging.getLogger(__name__)
+
 
 ###############################################################################
 # CLI                                                                         #
@@ -102,7 +104,7 @@ def get_image_info(image_path):
         elif key in cfg["ignore_keys"]:
             continue
         else:
-            logging.debug("Key '{}' is unknown.".format(key))
+            logger.debug("Key '{}' is unknown.".format(key))
 
     return info
 

diff --git a/edapy/pdf.py b/edapy/pdf.py
@@ -7,7 +7,6 @@
 import logging
 import os
 import shutil
-import sys
 from collections import OrderedDict
 from difflib import SequenceMatcher
 from tempfile import mkstemp
@@ -19,11 +18,7 @@
 import PyPDF2.utils
 from PyPDF2 import PdfFileReader
 
-logging.basicConfig(
-    format="%(asctime)s %(levelname)s %(message)s",
-    level=logging.DEBUG,
-    stream=sys.stdout,
-)
+logger = logging.getLogger(__name__)
 
 
 ###############################################################################
@@ -100,30 +95,30 @@ def get_pdf_info(pdf_path):
             info["is_errornous"] = True
             return info
         except KeyError as e:
-            logging.warning(
+            logger.warning(
                 "https://github.com/mstamy2/PyPDF2/issues/388 for "
                 f" PDF '{pdf_path}': {e}"
             )
             return info
         except OSError as e:
-            logging.warning(f"OSError for PDF '{pdf_path}': {e}")
+            logger.warning(f"OSError for PDF '{pdf_path}': {e}")
             return info
         except AssertionError as e:
-            logging.warning(f"AssertionError for PDF '{pdf_path}': {e}")
+            logger.warning(f"AssertionError for PDF '{pdf_path}': {e}")
             return info
         except TypeError as e:
-            logging.warning(f"TypeError for PDF '{pdf_path}': {e}")
+            logger.warning(f"TypeError for PDF '{pdf_path}': {e}")
             return info
 
         try:
             tl_toc = [el for el in pdf_toread.outlines if not isinstance(el, list)]
             info["nb_toc_top_level"] = len(tl_toc)
         except PyPDF2.utils.PdfReadError as e:
-            logging.error(f"{pdf_path}: PyPDF2.utils.PdfReadError {e}")
+            logger.error(f"{pdf_path}: PyPDF2.utils.PdfReadError {e}")
         except ValueError as e:
-            logging.error(f"{pdf_path}: ValueError {e}")
+            logger.error(f"{pdf_path}: ValueError {e}")
         except TypeError as e:
-            logging.error(f"{pdf_path}: TypeError {e}")
+            logger.error(f"{pdf_path}: TypeError {e}")
 
         info = enhance_pdf_info(info, pdf_toread, pdf_path, keys, ignore_keys)
     return info
@@ -171,7 +166,7 @@ def enhance_pdf_info(
                     and not key.startswith("/FL#")
                 )
                 if log:
-                    logging.error(
+                    logger.error(
                         "Unknown key '{key}' "
                         "(Value: {value}) for PDF '{pdf}'".format(
                             pdf=pdf_path, key=key, value=pdf_info[key]