Merge pull request #43 from moj-analytical-services/logging

Add logging

CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v3.0.1 - 2021-02-12
+
+### Changed
+- The `wrangler.py` module now has logging.  To observe the arguments and sql queries being run, turn on logging at DEBUG level using e.g.
+
+```
+import logging
+logging.basicConfig()
+logging.getLogger("pydbtools").setLevel(logging.DEBUG)
+```
 ## v3.0.0 - 2021-01-26
 
 ### Changed

pydbtools/wrangler.py

@@ -3,6 +3,8 @@
 import os
 import sqlparse
 import warnings
+import logging
+import pprint
 
 import inspect
 import functools
@@ -17,6 +19,9 @@
     replace_temp_database_name_reference,
 )
 
+
+logger = logging.getLogger(__name__)
+
 # Wrapper used to set parameters in the athena wrangler functions
 # before they are called
 def init_athena_params(func=None, *, allow_boto3_session=False):
@@ -26,7 +31,7 @@ def init_athena_params(func=None, *, allow_boto3_session=False):
 
     Args:
         func (Callable): An function from wr.athena that requires
-        boto3_session. If the func has an s3_output this is also 
+        boto3_session. If the func has an s3_output this is also
         standardised.
 
     Returns:
@@ -109,7 +114,8 @@ def wrapper(*args, **kwargs):
                 argmap["database"] = temp_db_name
             else:
                 argmap["database"] = None
-
+        logger.debug(f"Modifying function {func.__name__}")
+        logger.debug(pprint.pformat(dict(argmap)))
         return func(**argmap)
 
     return wrapper

pyproject.toml

@@ -1,7 +1,7 @@
 [tool]
 [tool.poetry]
 name = "pydbtools"
-version = "3.0.0"
+version = "3.0.1"
 description = "A python package to query data via amazon athena and bring it into a pandas df"
 license = "MIT"
 authors = ["Karik Isichei <[email protected]>"]