reconfigured logging #101

Author: bensteUEM

churchtools_api/calendar.py

@@ -4,6 +4,7 @@
 from datetime import datetime
 from churchtools_api.churchtools_api_abstract import ChurchToolsApiAbstract
 
+logger = logging.getLogger(__name__)
 
 class ChurchToolsApiCalendar(ChurchToolsApiAbstract):
     """ Part definition of ChurchToolsApi which focuses on calendars
@@ -35,7 +36,7 @@ def get_calendars(self) -> list[dict]:
             response_content = json.loads(response.content)
             return response_content['data'].copy()
         else:
-            logging.warning(
+            logger.warning(
                 "Something went wrong fetching events: %s", response.status_code)
 
     def get_calendar_appointments(
@@ -88,7 +89,7 @@ def get_calendar_appointments(
             if len(to_) == 10:
                 params['to'] = to_
         elif 'to_' in kwargs.keys():
-            logging.warning(
+            logger.warning(
                 'Use of to_ is only allowed together with from_')
 
         response = self.session.get(url=url, params=params, headers=headers)
@@ -102,7 +103,7 @@ def get_calendar_appointments(
             result = [response_data] if isinstance(response_data, dict) else response_data
 
             if len(result) == 0:
-                logging.info(
+                logger.info(
                     'There are not calendar appointments with the requested params')
                 return
             # clean result
@@ -115,17 +116,17 @@ def get_calendar_appointments(
                 return merged_appointments
             elif 'appointment' in result[0].keys():
                 if len(result[0]['calculatedDates']) > 2:
-                    logging.info('returning a series calendar appointment!')
+                    logger.info('returning a series calendar appointment!')
                     return result
                 else:
-                    logging.debug(
+                    logger.debug(
                         'returning a simplified single calendar appointment with one date')
                     return [appointment['appointment']
                             for appointment in result]
             else:
-                logging.warning('unexpected result')
+                logger.warning('unexpected result')
 
         else:
-            logging.warning(
+            logger.warning(
                 "Something went wrong fetching calendar appointments: %s",
                 response.status_code)

churchtools_api/churchtools_api.py

@@ -10,6 +10,7 @@
 from churchtools_api.calendar import ChurchToolsApiCalendar
 from churchtools_api.resources import ChurchToolsApiResources
 
+logger = logging.getLogger(__name__)
 
 class ChurchToolsApi(ChurchToolsApiPersons, ChurchToolsApiEvents, ChurchToolsApiGroups,
                      ChurchToolsApiSongs, ChurchToolsApiFiles, ChurchToolsApiCalendar, ChurchToolsApiResources):
@@ -48,7 +49,7 @@ def __init__(self, domain, ct_token=None, ct_user=None, ct_password=None):
         elif ct_user is not None and ct_password is not None:
             self.login_ct_rest_api(ct_user=ct_user, ct_password=ct_password)
 
-        logging.debug('ChurchToolsApi init finished')
+        logger.debug('ChurchToolsApi init finished')
 
     def login_ct_rest_api(self, **kwargs):
         """
@@ -68,26 +69,26 @@ def login_ct_rest_api(self, **kwargs):
         self.session = requests.Session()
 
         if 'ct_token' in kwargs.keys():
-            logging.info('Trying Login with token')
+            logger.info('Trying Login with token')
             url = self.domain + '/api/whoami'
             headers = {"Authorization": 'Login ' + kwargs['ct_token']}
             response = self.session.get(url=url, headers=headers)
 
             if response.status_code == 200:
                 response_content = json.loads(response.content)
-                logging.info(
+                logger.info(
                     'Token Login Successful as {}'.format(
                         response_content['data']['email']))
                 self.session.headers['CSRF-Token'] = self.get_ct_csrf_token()
                 return json.loads(response.content)['data']['id']
             else:
-                logging.warning(
+                logger.warning(
                     "Token Login failed with {}".format(
                         response.content.decode()))
                 return False
 
         elif 'ct_user' in kwargs.keys() and 'ct_password' in kwargs.keys():
-            logging.info('Trying Login with Username/Password')
+            logger.info('Trying Login with Username/Password')
             url = self.domain + '/api/login'
             data = {
                 'username': kwargs['ct_user'],
@@ -97,11 +98,11 @@ def login_ct_rest_api(self, **kwargs):
             if response.status_code == 200:
                 response_content = json.loads(response.content)
                 person = self.who_am_i()
-                logging.info(
+                logger.info(
                     'User/Password Login Successful as {}'.format(person['email']))
                 return person['id']
             else:
-                logging.warning(
+                logger.warning(
                     "User/Password Login failed with {}".format(response.content.decode()))
                 return False
 
@@ -118,11 +119,11 @@ def get_ct_csrf_token(self):
         response = self.session.get(url=url)
         if response.status_code == 200:
             csrf_token = json.loads(response.content)["data"]
-            logging.info(
+            logger.info(
                 "CSRF Token erfolgreich abgerufen {}".format(csrf_token))
             return csrf_token
         else:
-            logging.warning(
+            logger.warning(
                 "CSRF Token not updated because of Response {}".format(
                     response.content.decode()))
 
@@ -139,17 +140,17 @@ def who_am_i(self):
         if response.status_code == 200:
             response_content = json.loads(response.content)
             if 'email' in response_content['data'].keys():
-                logging.info(
+                logger.info(
                     'Who am I as {}'.format(
                         response_content['data']['email']))
                 return response_content['data']
             else:
-                logging.warning(
+                logger.warning(
                     'User might not be logged in? {}'.format(
                         response_content['data']))
                 return False
         else:
-            logging.warning(
+            logger.warning(
                 "Checking who am i failed with {}".format(
                     response.status_code))
             return False
@@ -166,10 +167,10 @@ def check_connection_ajax(self):
         }
         response = self.session.post(url=url, headers=headers)
         if response.status_code == 200:
-            logging.debug("Response AJAX Connection successful")
+            logger.debug("Response AJAX Connection successful")
             return True
         else:
-            logging.debug(
+            logger.debug(
                 "Response AJAX Connection failed with {}".format(
                     json.load(
                         response.content)))
@@ -188,12 +189,12 @@ def get_global_permissions(self) -> dict:
         if response.status_code == 200:
             response_content = json.loads(response.content)
             response_data = response_content['data'].copy()
-            logging.debug(
+            logger.debug(
                 "First response of Global Permissions successful {}".format(response_content))
 
             return response_data
         else:
-            logging.warning(
+            logger.warning(
                 "Something went wrong fetching global permissions: {}".format(
                     response.status_code))
 
@@ -226,10 +227,10 @@ def get_services(self, **kwargs):
                         result[item['id']] = item
                     response_data = result
 
-            logging.debug("Services load successful {}".format(response_data))
+            logger.debug("Services load successful with {} entries".format(len(response_data)))
             return response_data
         else:
-            logging.info(
+            logger.info(
                 "Services requested failed: {}".format(
                     response.status_code))
             return None
@@ -257,10 +258,10 @@ def get_tags(self, type='songs'):
         if response.status_code == 200:
             response_content = json.loads(response.content)
             response_data = response_content['data'].copy()
-            logging.debug(
+            logger.debug(
                 "SongTags load successful {}".format(response_content))
 
             return response_content['data']
         else:
-            logging.warning(
+            logger.warning(
                 "Something went wrong fetching Song-tags: {}".format(response.status_code))

churchtools_api/churchtools_api_abstract.py

@@ -2,6 +2,8 @@
 import json
 import logging
 
+logger = logging.getLogger(__name__)
+
 class ChurchToolsApiAbstract(ABC):
     """This abstract is used to define minimum references available for all api parts
 
@@ -31,7 +33,7 @@ def combine_paginated_response_data(
         if meta := response_content.get("meta"):
             if pagination := meta.get("pagination"):
                 for page in range(pagination["current"], pagination["lastPage"]):
-                    logging.debug(
+                    logger.debug(
                         "running paginated request for page {} of {}".format(
                             page + 1,
                             pagination["lastPage"] + 1,