Refactored logging

s-raza · s-raza · commit 503e35c52aea · 2019-09-22T18:53:32.000+04:00
diff --git a/RatesBot/DB/RatesDB.py b/RatesBot/DB/RatesDB.py
@@ -25,86 +25,55 @@
 from RatesBot.Tools.ScreenColors import clr
 import RatesBot.Config as cfg
 
-ratesdb_logger = colorlog.getLogger('RatesBot.RatesDB')
-
-class RatesDB():
+class RatesDB(Logger):
     
     def __init__(self, *args, **kwargs):
+        super(RatesDB, self).__init__(*args, **kwargs)
         
-        
-        self.db_uname = kwargs['db_uname'] if (kwargs.get('db_uname') is not None) else "ratesuser"
-        self.db_pass = kwargs['db_pass'] if (kwargs.get('db_pass') is not None) else "ratesuserpass"
-        self.db_host = kwargs['db_host'] if (kwargs.get('db_host') is not None) else "localhost"
-        self.db_name = kwargs['db_name'] if (kwargs.get('db_name') is not None) else "ratesdb"
+        self.db_uname = self.init_kwarg('db_uname', default="ratesuser") 
+        self.db_pass = self.init_kwarg('db_pass', default="ratesuserpass")
+        self.db_host = self.init_kwarg('db_host', default="localhost")
+        self.db_name = self.init_kwarg('db_name', default="ratesdb")
         
         self.conn_str = "mysql+mysqldb://{}:{}@{}/{}?charset=utf8mb4".format(self.db_uname, self.db_pass, self.db_host, self.db_name)
-        
         self.engine = create_engine(self.conn_str)
-        
         self.base = Base
-        
         self.base.metadata.create_all(self.engine)
-        
         self.session = scoped_session( sessionmaker(bind=self.engine) )
         
-        
     def __get_service_inst(self, service):
         
         '''Get the instance of a service from the database, create it if it does not exist by name.'''
         
         service_inst = self.session.query(Service).filter_by(name=service.service_name).first()
         
-        
-        
         if service_inst is None:
-            
             new_service = self.__add_service(service_name=service.service_name, url=service.url)
-            
             return new_service
-        
         else:
-            
             return service_inst
         
-        
-        
     def __add_service(self, service_name, url):
         '''Insert a new service in the databse'''
         
         inst = Service(name=service_name, url=url)
-        
         self.session.add(inst)
         
         return inst
         
-        
-        
     def get_last_rates(self, service):
         '''Query the database to get the last row inserted into the database'''
         
         service_inst = self.__get_service_inst(service)
-        
-        #last_insert = self.session.query(Rate).filter_by(id=select([func.max(Rate.id)])).one()
-        
         last_insert = self.session.query(Rate).filter(Rate.id == self.session.query(func.max(Rate.id)).filter(Rate.service_id==service_inst.id)).one()
         
         return [last_insert.rate_morning,last_insert.rate_evening]
         
-        
-        
     def insert_rate(self, service):
         '''Insert rates into the database, which were queried from the service'''
         
         service_inst = self.__get_service_inst(service)
-        
         service_inst.rates.append(Rate(rate_morning=service.rate_morning, rate_evening=service.rate_evening))
-        
         self.session.commit()
-        
-        return service_inst
 
-        
-        
-        
-        
-        
+        return service_inst
diff --git a/RatesBot/Main.py b/RatesBot/Main.py
@@ -20,12 +20,13 @@
 
 import schedule
 import time
-from Rates.GetRates import check_rates
+from Rates.GetRates import RateChecker
 
 def main(freq_mins=5):
 
-    check_rates()
-    schedule.every(freq_mins).minutes.do(check_rates)
+    rates = RateChecker(debug_level='d')
+    rates.check_rates()
+    schedule.every(freq_mins).minutes.do(rates.check_rates)
 
     while 1:
 
diff --git a/RatesBot/Rates/GetRates.py b/RatesBot/Rates/GetRates.py
@@ -22,32 +22,31 @@
 import telegram
 import RatesBot.Config as cfg
 
-Rates_logger = colorlog.getLogger('RatesBot.GetRates')
-#Service_logger.setLevel(logging.DEBUG)
+class RateChecker(Logger):
 
-bot = telegram.Bot(token=cfg.bot_token)
-chat_id = cfg.chat_id
+    def __init__(self, *args, **kwargs):
+        super(RateChecker, self).__init__(*args, **kwargs)
 
+        self.bot = telegram.Bot(token=cfg.bot_token)
+        self.chat_id = cfg.chat_id
 
-
-def check_rates():
-    '''
-    Execute scraping and parsing of each service. If rates have changed since last checking, send a telegram message.
-    This is done for each of the services implemented as a dervied class of the ServiceBase class.
-    '''
-        
-    for service in ServiceBase.__subclasses__():
-        
-        srv = service(total_units = cfg.total_units)
-        
-        srv.get_rates()
-        
-        if srv.rates_changed():
-            Rates_logger.info("Rates changed: {}".format(srv.service_name))
-            Rates_logger.info("Sending Message: {}".format(srv.prices_text))
-            bot.send_message(chat_id=chat_id, text=srv.prices_text)
-        else:
-            Rates_logger.info("Rates not Changed ({})".format(srv.service_name))
+    def check_rates(self):
+        '''
+        Execute scraping and parsing of each service. If rates have changed since last checking, send a telegram message.
+        This is done for each of the services implemented as a dervied class of the ServiceBase class.
+        '''
+            
+        for service in ServiceBase.__subclasses__():
+            
+            srv = service(total_units = cfg.total_units, debug_level=self.debug_level)
+            srv.get_rates()
+            
+            if srv.rates_changed():
+                self.logger.info("Rates changed: {}".format(srv.service_name))
+                self.logger.info("Sending Message: {}".format(srv.prices_text))
+                self.bot.send_message(chat_id=self.chat_id, text=srv.prices_text)
+            else:
+                self.logger.info("Rates not Changed ({})".format(srv.service_name))
             
             
                 
diff --git a/RatesBot/Services/Service.py b/RatesBot/Services/Service.py
@@ -17,46 +17,29 @@
 #
 # You should have received a copy of the GNU General Public License along with this program.
 # If not, see <https://www.gnu.org/licenses/>
-
 from RatesBot.Tools.LoggerLib import *
 from RatesBot.Tools.ScreenColors import clr
 from bs4 import BeautifulSoup
 import urllib2
-
 from RatesBot.DB.RatesDB import RatesDB
-
 import RatesBot.Config as cfg
 
-Service_logger = colorlog.getLogger('RatesBot.Service')
-#Service_logger.setLevel(logging.DEBUG)
-
-            
-class ServiceBase(object):
+class ServiceBase(Logger):
     '''Common base class for all services that provide rates'''
     
     def __init__(self, *args, **kwargs):
-    
-        
-        self.url = kwargs['url']
-        
-        self.service_name = kwargs['service_name']
-        
-        self.total_units = kwargs['total_units'] if (kwargs.get('total_units') is not None) else 1
+        super(ServiceBase, self).__init__(*args, **kwargs)
         
+        self.url = self.init_kwarg('url')
+        self.service_name = self.init_kwarg('service_name')
+        self.total_units = self.init_kwarg('total_units', default=1)
         self.page = ""
-        
         self.soup = ""
-        
         self._rate_morning = 0.00
-        
         self._rate_evening = 0.00
-        
         self._prices_text = ""
-        
         self.db = RatesDB(db_uname=cfg.db['uname'],db_pass=cfg.db['pass'],db_host=cfg.db['host'],db_name=cfg.db['name'])
-        
         self.user_agent = 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.0.7) Gecko/2009021910 Firefox/3.0.7'
-        
         self.headers = {'User-Agent':self.user_agent,} 
 
     @property
@@ -82,124 +65,94 @@ def current_value_morning(self):
         
     @property
     def current_value_evening(self):
-        
         return self.total_units*self._rate_evening
         
-        
-        
     @property
     def value_text_morning(self):
-        
         return "\n\nTotal Value ({} units @ {}) : {}".format(self.total_units, self._rate_morning, self.current_value_morning)
     
-    
     @property
     def value_text_evening(self):
-        
         return "\n\nTotal Value ({} units @ {}) : {}".format(self.total_units, self._rate_evening, self.current_value_evening)
     
-    
     @property
     def value_text(self):
-        
         return self.value_text_morning + self.value_text_evening
     
     @property
     def prices_text(self):
-        
         return self._prices_text + self.value_text
     
-    
     def __read_url(self):
         
-        Service_logger.info("Reading website: {}".format(self.url))
+        self.logger.info("Reading website: {}".format(self.url))
         req = urllib2.Request(self.url, headers=self.headers)
         self.page = urllib2.urlopen(req)
         
     def __parse_html(self):
         
-        Service_logger.info("Parsing HTML: {}".format(self.url))
+        self.logger.info("Parsing HTML: {}".format(self.url))
         
         self.soup = BeautifulSoup(self.page.read(),features="html.parser")
 
-        
-    
     def db_save(self):
         '''Save rates to the database'''
         
         self.db.insert_rate(self)
-        
         self.db.session.close()
-        
         self.db.session.remove()
-        
-        Service_logger.info("Rates saved to Database")
-        
+        self.logger.info("Rates saved to Database")
         
     def db_last_rates(self):
         '''Get the last rates inserted in the DB for the service'''
-        
-        Service_logger.debug("Getting last saved rates from the DB")
 
         last_rates = self.db.get_last_rates(self)
-        
         self.db.session.close()
-        
         self.db.session.remove()
-        
-        Service_logger.debug("Last rates from DB: {}".format(str(last_rates)))
+        self.logger.debug("Last rates from DB: {}".format(str(last_rates)))
         
         return last_rates
-        
-        
-        
+
     def get_rates(self):
         '''
         Retreive rates from a provider.
         This method should be implemented for each of the derived classes that will be implemented for each of the service.
         It should populate the fields - _prices_text, _rate_morning and _rate_evening after scraping the service and return prices_text
         '''
-        
         self.__read_url()
-        
         self.__parse_html()
             
     def rates_changed(self):
         '''Check latest rates from a service and compare to saved rates from last time the rates were checked.'''
 
+        self.logger.debug("Current rates from {} : {}".format(self.service_name, "[{}, {}]".format(self.rate_morning,self.rate_evening)))
+
         if [self.rate_morning,self.rate_evening] == self.db_last_rates():
             return False
         else:
-            
             self.db_save()
             
             return True
-        
-            
+
     def format_rate(self, rate):
-        
         return 0.00 if (rate == "" or rate == "-") else float(rate.split()[0])
 
  
 class KTRates(ServiceBase):
     '''Class derived from ServiceBase. Retrieves gold rates from www.khaleejtimes.com'''
-    
+
     def __init__(self, *args, **kwargs):
         
         url = "http://www.khaleejtimes.com/gold-forex/"
-        
         service_name = "Khaleej Times"
-        
         super(KTRates, self).__init__(url=url, service_name=service_name, *args, **kwargs)
         
-        
-        
     def get_rates(self):
     
         super(KTRates, self).get_rates()
         
         for i in self.soup.findAll('tr',{'class':'gold_r1'}):
-    
+
             if "22" in i.td.text:
                 rates = i.text.replace(" ","").replace("\r\n","").strip().split("\n")
                 break
@@ -213,7 +166,6 @@ def get_rates(self):
             self._prices_text += "\nMorning - {}\nEvening - {}\nYesterday - {}".format(rates[1], rates[2], rates[3])
         
         self._rate_morning = self.format_rate(rates[1])
-        
         self._rate_evening = self.format_rate(rates[2])
         
         return self.prices_text
@@ -224,25 +176,18 @@ class GPDRates(ServiceBase):
     def __init__(self, *args, **kwargs):
     
         url = "http://www.goldpricesdubai.com/"
-        
         service_name = "Gold Prices Dubai"
-        
         super(GPDRates, self).__init__(url=url, service_name=service_name, *args, **kwargs)
         
         
     def get_rates(self):
     
         super(GPDRates, self).get_rates()
         
-        
         rates = [txt.text for txt in self.soup.findAll('table',{'class':'now'})[0].findChildren('tr')[6].findChildren('td')]
-        
         self._prices_text += "\n{} gold prices updated\n".format(self.service_name)
-        
         self._prices_text += "\nMorning - {}\nEvening - {}".format(rates[0],rates[1])
-        
         self._rate_morning = self.format_rate(rates[0])
-        
         self._rate_evening = self.format_rate(rates[1])
         
         return self.prices_text
diff --git a/RatesBot/Tools/Kwargs.py b/RatesBot/Tools/Kwargs.py
diff --git a/RatesBot/Tools/LoggerLib.py b/RatesBot/Tools/LoggerLib.py
