Clean up code (#19)

* fix missing variable

* clean up code, switch to f-strings

Author: SathyaBhat

source-code/chapter-3/python-app/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Sathya
+Copyright (c) 2015 Sathyajith Bhat
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

source-code/chapter-3/python-app/README.md

@@ -6,13 +6,16 @@ Refer to the [book repo](https://github.com/apress/practical-docker-with-python)
 
 ### Getting started 
 
-Install the requirements with pip
+- Clone the repo or download the code
+- Install the requirements with pip
 
     pip3 install -r requirements.txt
 
-Start the bot 
-
-    NBT_ACCESS_TOKEN=<token> python newsbot.py
+- Set the environment variable `NBT_ACCESS_TOKEN` where the value is the Bot token generated using Telegram BotFather.
+    - See instructions on how to generate the token in Chapter 3 or [refer to this guide](https://core.telegram.org/bots/api#authorizing-your-bot)
+    - See this guide on [how to set environment variables](https://core.telegram.org/bots/api#authorizing-your-bot)
+- Start the bot 
+    python newsbot.py
 
 where `<token>` is the [Telegram Bot API](https://core.telegram.org/bots/api) token
 

source-code/chapter-3/python-app/constants.py

@@ -1,11 +1,15 @@
 __author__ = 'Sathyajith'
 
-import os
+from os import environ
+from sys import exit
 ERR_NO_SOURCE = 'No sources defined! Set a source using /source list, of, sub, reddits'
 skip_list = []
 sources_dict = {}
+UPDATE_PERIOD = 1
+FALSE_RESPONSE = {"ok": False}
 
-BOT_KEY = os.environ['NBT_ACCESS_TOKEN']
-API_BASE = 'https://api.telegram.org/bot'
-UPDATE_PERIOD = 6
-FALSE_RESPONSE = {"ok": False}
+BOT_KEY = environ.get('NBT_ACCESS_TOKEN')
+if not BOT_KEY:
+    print("Telegram access token not set, exiting.")
+    exit(1)
+API_BASE = f'https://api.telegram.org/bot{BOT_KEY}'

source-code/chapter-3/python-app/main.py

@@ -12,15 +12,15 @@ def get_last_updated():
         f.close()
     except FileNotFoundError:
         last_updated = 0
-    log.debug('Last updated id: {0}'.format(last_updated))
+    log.debug(f"Last updated id: {last_updated}")
     return last_updated
 
 if __name__ == '__main__':
 
     try:
-        log.debug('Starting up')
+        log.info("Starting up")
         States.last_updated = get_last_updated()
         while True:
             handle_incoming_messages(States.last_updated)
     except KeyboardInterrupt:
-        log.info('Received KeybInterrupt, exiting')
+        log.info("Received KeybInterrupt, exiting")

source-code/chapter-3/python-app/newsbot.py

@@ -4,30 +4,25 @@
 __author__ = 'Sathyajith'
 
 
-def summarize(url):
-    log.info('Not yet implemented!')
-    return url
-
-
 def get_latest_news(sub_reddits):
     log.debug('Fetching news from reddit')
     r = praw.Reddit(user_agent='Practical Docker With Python tutorial')
     # Can change the subreddit or add more.
     sub_reddits = clean_up_subreddits(sub_reddits)
-    log.debug('Fetching subreddits: {0}'.format(sub_reddits))
+    log.debug(f"Fetching subreddits: {sub_reddits}")
     submissions = r.get_subreddit(sub_reddits).get_top(limit=5)
     submission_content = ''
     try:
         for post in submissions:
-            submission_content += summarize(post.title + ' - ' + post.url) + '\n'
+            submission_content += f"{post.title} - {post.url} \n\n"
     except praw.errors.Forbidden:
-            log.debug('subreddit {0} is private'.format(sub_reddits))
+            log.info(f"subreddit {sub_reddits} is private".format())
             submission_content = "Sorry couldn't fetch; subreddit is private"
     except praw.errors.InvalidSubreddit:
-            log.debug('Subreddit {} is invalid or doesn''t exist.'.format(sub_reddits))
+            log.info(f"Subreddit {sub_reddits} is invalid or doesn''t exist.")
             submission_content = "Sorry couldn't fetch; subreddit doesn't seem to exist"
     except praw.errors.NotFound :
-            log.debug('Subreddit {} is invalid or doesn''t exist.'.format(sub_reddits))
+            log.info(f"Subreddit {sub_reddits} is invalid or doesn''t exist.")
             submission_content = "Sorry couldn't fetch; something went wrong, please do send a report to @sathyabhat"
     return submission_content
 

source-code/chapter-3/python-app/reddit.py

@@ -10,9 +10,9 @@
 
 
 def get_updates(last_updated):
-    log.debug('Checking for requests, last updated passed is: {}'.format(last_updated))
+    log.debug('Checking for requests, last updated passed is: {last_updated}')
     sleep(UPDATE_PERIOD)
-    response = requests.get(API_BASE + BOT_KEY + '/getUpdates', params={'offset': last_updated+1})
+    response = requests.get(f"{API_BASE}/getUpdates", params={'offset': last_updated+1})
     json_response = FALSE_RESPONSE
     if response.status_code != 200:
         # wait for a bit, try again
@@ -23,14 +23,14 @@ def get_updates(last_updated):
     except ValueError:
         sleep(UPDATE_PERIOD*20)
         get_updates(last_updated)
-    log.info('received response: {}'.format(json_response))
+    log.info(f"received response: {json_response}")
     return json_response
 
 
 def post_message(chat_id, text):
-    log.info('posting {} to {}'.format(text, chat_id))
+    log.debug(f"posting {text} to {chat_id}")
     payload = {'chat_id': chat_id, 'text': text}
-    requests.post(API_BASE + BOT_KEY + '/sendMessage', data=payload)
+    requests.post(f"{API_BASE}/sendMessage", data=payload)
 
 
 def handle_incoming_messages(last_updated):
@@ -49,26 +49,23 @@ def handle_incoming_messages(last_updated):
                 chat_text = ''
                 split_chat_text.append(chat_text)
                 log.debug('Looks like no chat text was detected... moving on')
-            try:
-                if 'message' in req:
-                    person_id = req['message']['from']['id']
-                else:
-                    person_id = ['edited_message']['from']['id']
-            except KeyError:
-                pass
 
-            log.info('Chat text received: {0}'.format(chat_text))
+            if 'message' in req:
+                person_id = req['message']['from']['id']
+            else:
+                person_id = req['edited_message']['from']['id']
+
+            log.info(f"Chat text received: {chat_text}")
             r = re.search('(source+)(.*)', chat_text)
 
             if (r is not None and r.group(1) == 'source'):
                 if r.group(2):
                     sources_dict[person_id] = r.group(2)
-                    log.debug('Sources set for {0} to {1}'.format(sources_dict[person_id], r.group(2)))
-                    post_message(person_id, 'Sources set as {0}!'.format(r.group(2)))
+                    post_message(person_id, f"Sources set as {r.group(2)}!")
                 else:
                     post_message(person_id, 'We need a comma separated list of subreddits! No subreddit, no news :-(')
             if chat_text == '/stop':
-                log.debug('Added {0} to skip list'.format(chat_sender_id))
+                log.debug(f"Added {chat_sender_id} to skip list")
                 skip_list.append(chat_sender_id)
                 post_message(chat_sender_id, "Ok, we won't send you any more messages.")
 
@@ -95,5 +92,5 @@ def handle_incoming_messages(last_updated):
                 f.write(str(last_updated))
                 States.last_updated = last_updated
                 log.debug(
-                    'Updated last_updated to {0}'.format(last_updated))
+                    f'Updated last_updated to {last_updated}')
             f.close()