refactoring and add various comments

[rainbowstream.git] / rainbowstream / rainbow.py

diff --git a/rainbowstream/rainbow.py b/rainbowstream/rainbow.py
index 233f441df1b0df9c5667792d06e689ee17a03668..55e062cb5b0a5c38243dabbe54048cb6513c1c42 100644 (file)
--- a/rainbowstream/rainbow.py
+++ b/rainbowstream/rainbow.py
@@ -11,7 +11,6 @@ import argparse
 import time
 import requests
 import webbrowser
 import time
 import requests
 import webbrowser

-import json

 
 from twitter.stream import TwitterStream, Timeout, HeartbeatTimeout, Hangup
 from twitter.api import *
 
 from twitter.stream import TwitterStream, Timeout, HeartbeatTimeout, Hangup
 from twitter.api import *


@@ -28,9 +27,13 @@ from .db import *
 from .c_image import *
 from .py3patch import *
 
 from .c_image import *
 from .py3patch import *
 

-
+# Global values

 g = {}
 g = {}

+
+# Database

 db = RainbowDB()
 db = RainbowDB()

+
+# Commands

 cmdset = [
     'switch',
     'trend',
 cmdset = [
     'switch',
     'trend',


@@ -64,6 +67,7 @@ cmdset = [
     'report',
     'list',
     'cal',
     'report',
     'list',
     'cal',

+    'config',

     'theme',
     'h',
     'c',
     'theme',
     'h',
     'c',


@@ -133,19 +137,22 @@ def authen():
         CONSUMER_SECRET)
 
 
         CONSUMER_SECRET)
 
 

-def get_decorated_name():
+def init():

     """
     """

-    Beginning of every line
+    Init function

     """
     """

+    # Get name

     t = Twitter(auth=authen())
     name = '@' + t.account.verify_credentials()['screen_name']
     g['original_name'] = name[1:]
     g['decorated_name'] = color_func(c['DECORATED_NAME'])('[' + name + ']: ')
     t = Twitter(auth=authen())
     name = '@' + t.account.verify_credentials()['screen_name']
     g['original_name'] = name[1:]
     g['decorated_name'] = color_func(c['DECORATED_NAME'])('[' + name + ']: ')

-
+    # Theme init

     files = os.listdir(os.path.dirname(__file__) + '/colorset')
     themes = [f.split('.')[0] for f in files if f.split('.')[-1] == 'json']
     g['themes'] = themes
     db.theme_store(c['THEME'])
     files = os.listdir(os.path.dirname(__file__) + '/colorset')
     themes = [f.split('.')[0] for f in files if f.split('.')[-1] == 'json']
     g['themes'] = themes
     db.theme_store(c['THEME'])

+    # Semaphore init
+    db.semaphore_store(False)

 
 
 def switch():
 
 
 def switch():


@@ -154,7 +161,6 @@ def switch():
     """
     try:
         target = g['stuff'].split()[0]
     """
     try:
         target = g['stuff'].split()[0]

-

         # Filter and ignore
         args = parse_arguments()
         try:
         # Filter and ignore
         args = parse_arguments()
         try:


@@ -169,7 +175,6 @@ def switch():
         except:
             printNicely(red('Sorry, wrong format.'))
             return
         except:
             printNicely(red('Sorry, wrong format.'))
             return

-

         # Public stream
         if target == 'public':
             keyword = g['stuff'].split()[1]
         # Public stream
         if target == 'public':
             keyword = g['stuff'].split()[1]


@@ -186,7 +191,6 @@ def switch():
                     args))
             p.start()
             g['stream_pid'] = p.pid
                     args))
             p.start()
             g['stream_pid'] = p.pid

-

         # Personal stream
         elif target == 'mine':
             # Kill old process
         # Personal stream
         elif target == 'mine':
             # Kill old process


@@ -224,7 +228,6 @@ def trend():
         town = g['stuff'].split()[1]
     except:
         town = ''
         town = g['stuff'].split()[1]
     except:
         town = ''

-

     avail = t.trends.available()
     # World wide
     if not country:
     avail = t.trends.available()
     # World wide
     if not country:


@@ -799,7 +802,7 @@ def get_slug():
     """
     Get Slug Decorator
     """
     """
     Get Slug Decorator
     """

-     # Get list name
+    # Get list name

     list_name = raw_input(light_magenta('Give me the list\'s name: '))
     # Get list name and owner
     try:
     list_name = raw_input(light_magenta('Give me the list\'s name: '))
     # Get list name and owner
     try:


@@ -808,7 +811,8 @@ def get_slug():
             slug = slug[1:]
         return owner, slug
     except:
             slug = slug[1:]
         return owner, slug
     except:

-        printNicely(light_magenta('List name should follow "@owner/list_name" format.'))
+        printNicely(
+            light_magenta('List name should follow "@owner/list_name" format.'))

         raise Exception('Wrong list name')
 
 
         raise Exception('Wrong list name')
 
 


@@ -1074,6 +1078,52 @@ def cal():
     show_calendar(month, date, rel)
 
 
     show_calendar(month, date, rel)
 
 

+def config():
+    """
+    Browse and change config
+    """
+    all_config = get_all_config()
+    g['stuff'] = g['stuff'].strip()
+    # List all config
+    if not g['stuff']:
+        for k in all_config:
+            line = ' ' * 2 + \
+                light_green(k) + ': ' + light_yellow(str(all_config[k]))
+            printNicely(line)
+        guide = 'Detailed explanation can be found at ' + \
+            color_func(c['TWEET']['link'])(
+                'http://rainbowstream.readthedocs.org/en/latest/#config-explanation')
+        printNicely(guide)
+    # Print specific config
+    elif len(g['stuff'].split()) == 1:
+        if g['stuff'] in all_config:
+            k = g['stuff']
+            line = ' ' * 2 + \
+                light_green(k) + ': ' + light_yellow(str(all_config[k]))
+            printNicely(line)
+        else:
+            printNicely(red('No config key like this.'))
+    # Print specific config's default value
+    elif len(g['stuff'].split()) == 2 and g['stuff'].split()[-1] == 'default':
+        key = g['stuff'].split()[0]
+        value = get_default_config(key)
+        line = ' ' * 2 + light_green(key) + ': ' + light_magenta(value)
+        printNicely(line)
+    # Set specific config
+    elif len(g['stuff'].split()) == 3 and g['stuff'].split()[1] == '=':
+        key = g['stuff'].split()[0]
+        value = g['stuff'].split()[-1]
+        try:
+            set_config(key, value)
+            printNicely(light_green('Updated successfully.'))
+        except:
+            printNicely(light_magenta('Not valid value.'))
+            return
+        reload_config()
+    else:
+        printNicely(light_magenta('Sorry I can\'s understand.'))
+
+

 def theme():
     """
     List and change theme
 def theme():
     """
     List and change theme


@@ -1089,24 +1139,7 @@ def theme():
             printNicely(line)
     elif g['stuff'] == 'current_as_default':
         # Set as default
             printNicely(line)
     elif g['stuff'] == 'current_as_default':
         # Set as default

-        def fixup(adict, k, v):
-            for key in adict.keys():
-                if key == k:
-                    adict[key] = v
-                elif type(adict[key]) is dict:
-                    fixup(adict[key], k, v)
-        # Modify
-        path = os.environ.get(
-            'HOME',
-            os.environ.get(
-                'USERPROFILE',
-                '')) + os.sep + '.rainbow_config.json'
-        data = load_config(rainbow_config)
-        fixup(data, 'THEME', c['THEME'])
-        # Save
-        with open(path, 'w') as out:
-            json.dump(data, out, indent = 4)
-        os.system('chmod 777 ' + path)
+        set_config('THEME', c['THEME'])

         printNicely(light_green('Okay it will be applied from next time :)'))
     else:
         # Change theme
         printNicely(light_green('Okay it will be applied from next time :)'))
     else:
         # Change theme


@@ -1155,8 +1188,9 @@ def help_discover():
         magenta('@mdo') + '.\n'
     usage += s * 2 + light_green('view @mdo') + \
         ' will show ' + magenta('@mdo') + '\'s home.\n'
         magenta('@mdo') + '.\n'
     usage += s * 2 + light_green('view @mdo') + \
         ' will show ' + magenta('@mdo') + '\'s home.\n'

-    usage += s * 2 + light_green('s #AKB48') + ' will search for "' + \
-        light_yellow('AKB48') + '" and return 5 newest tweet.\n'
+    usage += s * 2 + light_green('s AKB48') + ' will search for "' + \
+        light_yellow('AKB48') + '" and return 5 newest tweet. ' + \
+        'Search can be performed with or without hashtag.\n'

     printNicely(usage)
 
 
     printNicely(usage)
 
 


@@ -1317,7 +1351,6 @@ def help():
     """
     s = ' ' * 2
     h, w = os.popen('stty size', 'r').read().split()
     """
     s = ' ' * 2
     h, w = os.popen('stty size', 'r').read().split()

-

     # Start
     usage = '\n'
     usage += s + 'Hi boss! I\'m ready to serve you right now!\n'
     # Start
     usage = '\n'
     usage += s + 'Hi boss! I\'m ready to serve you right now!\n'


@@ -1327,7 +1360,6 @@ def help():
     usage += s + 'Any update from Twitter will show up ' + \
         light_yellow('immediately') + '.\n'
     usage += s + 'In addtion, following commands are available right now:\n'
     usage += s + 'Any update from Twitter will show up ' + \
         light_yellow('immediately') + '.\n'
     usage += s + 'In addtion, following commands are available right now:\n'

-

     # Twitter help section
     usage += '\n'
     usage += s + grey(u'\u266A' + ' Twitter help\n')
     # Twitter help section
     usage += '\n'
     usage += s + grey(u'\u266A' + ' Twitter help\n')


@@ -1343,7 +1375,6 @@ def help():
         ' will show help for list commands.\n'
     usage += s * 2 + light_green('h stream') + \
         ' will show help for stream commands.\n'
         ' will show help for list commands.\n'
     usage += s * 2 + light_green('h stream') + \
         ' will show help for stream commands.\n'

-

     # Smart shell
     usage += '\n'
     usage += s + grey(u'\u266A' + ' Smart shell\n')
     # Smart shell
     usage += '\n'
     usage += s + grey(u'\u266A' + ' Smart shell\n')


@@ -1351,22 +1382,33 @@ def help():
         'will be evaluate by Python interpreter.\n'
     usage += s * 2 + 'Even ' + light_green('cal') + ' will show the calendar' + \
         ' for current month.\n'
         'will be evaluate by Python interpreter.\n'
     usage += s * 2 + 'Even ' + light_green('cal') + ' will show the calendar' + \
         ' for current month.\n'

-
-    # Screening
+    # Config

     usage += '\n'
     usage += '\n'

-    usage += s + grey(u'\u266A' + ' Screening \n')
-    usage += s * 2 + light_green('theme') + ' will list available theme.' + \
+    usage += s + grey(u'\u266A' + ' Config \n')
+    usage += s * 2 + light_green('theme') + ' will list available theme. ' + \

         light_green('theme monokai') + ' will apply ' + light_yellow('monokai') + \
         ' theme immediately.\n'
         light_green('theme monokai') + ' will apply ' + light_yellow('monokai') + \
         ' theme immediately.\n'

+    usage += s * 2 + light_green('config') + ' will list all config.\n'
+    usage += s * 3 + \
+        light_green('config ASCII_ART') + ' will output current value of ' +\
+        light_yellow('ASCII_ART') + ' config key.\n'
+    usage += s * 3 + \
+        light_green('config ASCII_ART default') + ' will output default value of ' + \
+        light_yellow('ASCII_ART') + ' config key.\n'
+    usage += s * 3 + \
+        light_green('config ASCII_ART = False') + ' will set value of ' + \
+        light_yellow('ASCII_ART') + ' config key to ' + \
+        light_yellow('False') + '.\n'
+    # Screening
+    usage += '\n'
+    usage += s + grey(u'\u266A' + ' Screening \n')

     usage += s * 2 + light_green('h') + ' will show this help again.\n'
     usage += s * 2 + light_green('c') + ' will clear the screen.\n'
     usage += s * 2 + light_green('q') + ' will quit.\n'
     usage += s * 2 + light_green('h') + ' will show this help again.\n'
     usage += s * 2 + light_green('c') + ' will clear the screen.\n'
     usage += s * 2 + light_green('q') + ' will quit.\n'

-

     # End
     usage += '\n'
     usage += s + '-' * (int(w) - 4) + '\n'
     usage += s + 'Have fun and hang tight! \n'
     # End
     usage += '\n'
     usage += s + '-' * (int(w) - 4) + '\n'
     usage += s + 'Have fun and hang tight! \n'

-

     # Show help
     d = {
         'discover': help_discover,
     # Show help
     d = {
         'discover': help_discover,


@@ -1451,6 +1493,7 @@ def process(cmd):
             report,
             list,
             cal,
             report,
             list,
             cal,

+            config,

             theme,
             help,
             clear,
             theme,
             help,
             clear,


@@ -1510,6 +1553,7 @@ def listen():
                 'del'
             ],  # list
             [],  # cal
                 'del'
             ],  # list
             [],  # cal

+            [key for key in dict(get_all_config())],  # config

             g['themes'] + ['current_as_default'],  # theme
             [
                 'discover',
             g['themes'] + ['current_as_default'],  # theme
             [
                 'discover',


@@ -1536,24 +1580,28 @@ def listen():
         except:
             cmd = ''
         g['cmd'] = cmd
         except:
             cmd = ''
         g['cmd'] = cmd

-        # Save cmd to global variable and call process

         try:
         try:

+            # Lock the semaphore
+            db.semaphore_update(True)
+            # Save cmd to global variable and call process

             g['stuff'] = ' '.join(line.split()[1:])
             g['stuff'] = ' '.join(line.split()[1:])

+            # Process the command

             process(cmd)()
             process(cmd)()

+            # Not re-display
+            if cmd in ['switch', 't', 'rt', 'rep']:
+                g['prefix'] = False
+            else:
+                g['prefix'] = True
+            # Release the semaphore lock
+            db.semaphore_update(False)

         except Exception:
             printNicely(red('OMG something is wrong with Twitter right now.'))
         except Exception:
             printNicely(red('OMG something is wrong with Twitter right now.'))

-        # Not redisplay prefix
-        if cmd in ['switch', 't', 'rt', 'rep']:
-            g['prefix'] = False
-        else:
-            g['prefix'] = True

 
 
 def stream(domain, args, name='Rainbow Stream'):
     """
     Track the stream
     """
 
 
 def stream(domain, args, name='Rainbow Stream'):
     """
     Track the stream
     """

-

     # The Logo
     art_dict = {
         c['USER_DOMAIN']: name,
     # The Logo
     art_dict = {
         c['USER_DOMAIN']: name,


@@ -1562,24 +1610,20 @@ def stream(domain, args, name='Rainbow Stream'):
     }
     if c['ASCII_ART']:
         ascii_art(art_dict[domain])
     }
     if c['ASCII_ART']:
         ascii_art(art_dict[domain])

-

     # These arguments are optional:
     stream_args = dict(
         timeout=args.timeout,
         block=not args.no_block,
         heartbeat_timeout=args.heartbeat_timeout)
     # These arguments are optional:
     stream_args = dict(
         timeout=args.timeout,
         block=not args.no_block,
         heartbeat_timeout=args.heartbeat_timeout)

-

     # Track keyword
     query_args = dict()
     if args.track_keywords:
         query_args['track'] = args.track_keywords
     # Track keyword
     query_args = dict()
     if args.track_keywords:
         query_args['track'] = args.track_keywords

-

     # Get stream
     stream = TwitterStream(
         auth=authen(),
         domain=domain,
         **stream_args)
     # Get stream
     stream = TwitterStream(
         auth=authen(),
         domain=domain,
         **stream_args)

-

     try:
         if domain == c['USER_DOMAIN']:
             tweet_iter = stream.user(**query_args)
     try:
         if domain == c['USER_DOMAIN']:
             tweet_iter = stream.user(**query_args)


@@ -1590,8 +1634,6 @@ def stream(domain, args, name='Rainbow Stream'):
                 tweet_iter = stream.statuses.filter(**query_args)
             else:
                 tweet_iter = stream.statuses.sample()
                 tweet_iter = stream.statuses.filter(**query_args)
             else:
                 tweet_iter = stream.statuses.sample()

-
-        # Iterate over the stream.

         for tweet in tweet_iter:
             if tweet is None:
                 printNicely("-- None --")
         for tweet in tweet_iter:
             if tweet is None:
                 printNicely("-- None --")


@@ -1606,6 +1648,7 @@ def stream(domain, args, name='Rainbow Stream'):
                     t=tweet,
                     iot=args.image_on_term,
                     keyword=args.track_keywords,
                     t=tweet,
                     iot=args.image_on_term,
                     keyword=args.track_keywords,

+                    check_semaphore=True,

                     fil=args.filter,
                     ig=args.ignore,
                 )
                     fil=args.filter,
                     ig=args.ignore,
                 )


@@ -1619,11 +1662,10 @@ def fly():
     """
     Main function
     """
     """
     Main function
     """

-    # Spawn stream process
+    # Initial

     args = parse_arguments()
     try:
     args = parse_arguments()
     try:

-        get_decorated_name()
-
+        init()

     except TwitterHTTPError:
         printNicely('')
         printNicely(
     except TwitterHTTPError:
         printNicely('')
         printNicely(


@@ -1633,7 +1675,7 @@ def fly():
         save_history()
         os.system('rm -rf rainbow.db')
         sys.exit()
         save_history()
         os.system('rm -rf rainbow.db')
         sys.exit()

-
+    # Spawn stream process

     p = Process(
         target=stream,
         args=(
     p = Process(
         target=stream,
         args=(


@@ -1641,7 +1683,6 @@ def fly():
             args,
             g['original_name']))
     p.start()
             args,
             g['original_name']))
     p.start()

-

     # Start listen process
     time.sleep(0.5)
     g['reset'] = True
     # Start listen process
     time.sleep(0.5)
     g['reset'] = True