fix tabs. i hate tabs

[z_archive/twitter.git] / twitter / cmdline.py

diff --git a/twitter/cmdline.py b/twitter/cmdline.py
index 03234d1c0717d593c73aa3732c44e8d14a61b5a6..ce259239c3362476687504876e60a5e850d05bb9 100644 (file)
--- a/twitter/cmdline.py
+++ b/twitter/cmdline.py
@@ -10,7 +10,9 @@ ACTIONS:
  leave          remove the specified user from your following list
  public         get latest public tweets
  replies        get latest replies
  leave          remove the specified user from your following list
  public         get latest public tweets
  replies        get latest replies

+ search         search twitter (Beware: octothorpe, escape it)

  set            set your twitter status
  set            set your twitter status

+ shell          login the twitter shell

 
 OPTIONS:
 
 
 OPTIONS:
 


@@ -21,7 +23,11 @@ OPTIONS:
  -R --refresh-rate <rate>   set the refresh rate (in seconds)
  -f --format <format>       specify the output format for status updates
  -c --config <filename>     read username and password from given config
  -R --refresh-rate <rate>   set the refresh rate (in seconds)
  -f --format <format>       specify the output format for status updates
  -c --config <filename>     read username and password from given config

-                              file (default ~/.twitter)
+                            file (default ~/.twitter)
+ -l --length <count>        specify number of status updates shown
+                            (default: 20, max: 200)
+ -t --timestamp             show time before status lines
+ -d --datestamp             shoe date before status lines

 
 FORMATS for the --format option
 
 
 FORMATS for the --format option
 


@@ -29,7 +35,7 @@ FORMATS for the --format option
  verbose         multiple lines per status, more verbose status info
  urls            nothing but URLs
  ansi            ansi colour (rainbow mode)
  verbose         multiple lines per status, more verbose status info
  urls            nothing but URLs
  ansi            ansi colour (rainbow mode)

- 
+

 CONFIG FILES
 
  The config file should contain a [twitter] header, and all the desired options
 CONFIG FILES
 
  The config file should contain a [twitter] header, and all the desired options


@@ -39,15 +45,18 @@ CONFIG FILES
 email: <username>
 password: <password>
 format: <desired_default_format_for_output>
 email: <username>
 password: <password>
 format: <desired_default_format_for_output>

+prompt: <twitter_shell_prompt e.g. '[cyan]twitter[R]> '>

 """
 
 import sys
 import time
 """
 
 import sys
 import time

-from getopt import getopt, GetoptError
+from getopt import gnu_getopt as getopt, GetoptError

 from getpass import getpass
 import re
 import os.path
 from ConfigParser import SafeConfigParser
 from getpass import getpass
 import re
 import os.path
 from ConfigParser import SafeConfigParser

+import datetime
+from urllib import quote

 
 from api import Twitter, TwitterError
 import ansi
 
 from api import Twitter, TwitterError
 import ansi


@@ -63,14 +72,18 @@ OPTIONS = {
     'refresh': False,
     'refresh_rate': 600,
     'format': 'default',
     'refresh': False,
     'refresh_rate': 600,
     'format': 'default',

+    'prompt': '[cyan]twitter[R]> ',

     'config_filename': os.environ.get('HOME', '') + os.sep + '.twitter',
     'config_filename': os.environ.get('HOME', '') + os.sep + '.twitter',

+    'length': 20,
+    'timestamp': False,
+    'datestamp': False,

     'extra_args': []
 }
 
 def parse_args(args, options):
     long_opts = ['email', 'password', 'help', 'format', 'refresh',
     'extra_args': []
 }
 
 def parse_args(args, options):
     long_opts = ['email', 'password', 'help', 'format', 'refresh',

-                 'refresh-rate', 'config']
-    short_opts = "e:p:f:h?rR:c:"
+                 'refresh-rate', 'config', 'length', 'timestamp', 'datestamp']
+    short_opts = "e:p:f:h?rR:c:l:td"

     opts, extra_args = getopt(args, short_opts, long_opts)        
 
     for opt, arg in opts:
     opts, extra_args = getopt(args, short_opts, long_opts)        
 
     for opt, arg in opts:


@@ -84,33 +97,58 @@ def parse_args(args, options):
             options['refresh'] = True
         elif opt in ('-R', '--refresh-rate'):
             options['refresh_rate'] = int(arg)
             options['refresh'] = True
         elif opt in ('-R', '--refresh-rate'):
             options['refresh_rate'] = int(arg)

+        elif opt in ('-l', '--length'):
+            options["length"] = int(arg)
+        elif opt in ('-t', '--timestamp'):
+            options["timestamp"] = True
+        elif opt in ('-d', '--datestamp'):
+            options["datestamp"] = True

         elif opt in ('-?', '-h', '--help'):
         elif opt in ('-?', '-h', '--help'):

-            print __doc__
-            sys.exit(0)
+            options['action'] = 'help'

         elif opt in ('-c', '--config'):
             options['config_filename'] = arg
 
         elif opt in ('-c', '--config'):
             options['config_filename'] = arg
 

-    if extra_args:
+    if extra_args and not ('action' in options and options['action'] == 'help'):

         options['action'] = extra_args[0]
     options['extra_args'] = extra_args[1:]
 
         options['action'] = extra_args[0]
     options['extra_args'] = extra_args[1:]
 

+def get_time_string(status, options, format="%a %b %d %H:%M:%S +0000 %Y"):
+    timestamp = options["timestamp"]
+    datestamp = options["datestamp"]
+    t = time.strptime(status['created_at'], format)
+    i_hate_timezones = time.timezone
+    if (time.daylight):
+        i_hate_timezones = time.altzone
+    dt = datetime.datetime(*t[:-3]) - datetime.timedelta(
+        seconds=i_hate_timezones)
+    t = dt.timetuple()
+    if timestamp and datestamp:
+        return time.strftime("%Y-%m-%d %H:%M:%S ", t)
+    elif timestamp:
+        return time.strftime("%H:%M:%S ", t)
+    elif datestamp:
+        return time.strftime("%Y-%m-%d ", t)
+    return ""                             
+

 class StatusFormatter(object):
 class StatusFormatter(object):

-    def __call__(self, status):
-        return (u"%s %s" %(
+    def __call__(self, status, options):
+        return (u"%s%s %s" %(
+            get_time_string(status, options),

             status['user']['screen_name'], status['text']))
 
 class AnsiStatusFormatter(object):
     def __init__(self):
         self._colourMap = ansi.ColourMap()
             status['user']['screen_name'], status['text']))
 
 class AnsiStatusFormatter(object):
     def __init__(self):
         self._colourMap = ansi.ColourMap()

-        
-    def __call__(self, status):
+
+    def __call__(self, status, options):

         colour = self._colourMap.colourFor(status['user']['screen_name'])
         colour = self._colourMap.colourFor(status['user']['screen_name'])

-        return (u"%s%s%s %s" %(
+        return (u"%s%s%s%s %s" %(
+            get_time_string(status, options),

             ansi.cmdColour(colour), status['user']['screen_name'],
             ansi.cmdColour(colour), status['user']['screen_name'],

-            ansi.cmdReset(), status['text']))    
-    
+            ansi.cmdReset(), status['text']))
+

 class VerboseStatusFormatter(object):
 class VerboseStatusFormatter(object):

-    def __call__(self, status):
+    def __call__(self, status, options):

         return (u"-- %s (%s) on %s\n%s\n" %(
             status['user']['screen_name'],
             status['user']['location'],
         return (u"-- %s (%s) on %s\n%s\n" %(
             status['user']['screen_name'],
             status['user']['location'],


@@ -119,7 +157,7 @@ class VerboseStatusFormatter(object):
 
 class URLStatusFormatter(object):
     urlmatch = re.compile(r'https?://\S+')
 
 class URLStatusFormatter(object):
     urlmatch = re.compile(r'https?://\S+')

-    def __call__(self, status):
+    def __call__(self, status, options):

         urls = self.urlmatch.findall(status['text'])
         return u'\n'.join(urls) if urls else ""
 
         urls = self.urlmatch.findall(status['text'])
         return u'\n'.join(urls) if urls else ""
 


@@ -134,17 +172,45 @@ class AdminFormatter(object):
 class VerboseAdminFormatter(object):
     def __call__(self, action, user):
         return(u"-- %s: %s (%s): %s" % (
 class VerboseAdminFormatter(object):
     def __call__(self, action, user):
         return(u"-- %s: %s (%s): %s" % (

-            "Following" if action == "follow" else "Leaving", 
-            user['screen_name'], 
+            "Following" if action == "follow" else "Leaving",
+            user['screen_name'],

             user['name'],
             user['url']))
 
             user['name'],
             user['url']))
 

+class SearchFormatter(object):
+    def __call__(self, result, options):
+        return(u"%s%s %s" %(
+            get_time_string(result, options, "%a, %d %b %Y %H:%M:%S +0000"),
+            result['from_user'], result['text']))
+
+class VerboseSearchFormatter(SearchFormatter):
+    pass #Default to the regular one
+
+class URLSearchFormatter(object):
+    urlmatch = re.compile(r'https?://\S+')
+    def __call__(self, result, options):
+        urls = self.urlmatch.findall(result['text'])
+        return u'\n'.join(urls) if urls else ""
+
+class AnsiSearchFormatter(object):
+    def __init__(self):
+        self._colourMap = ansi.ColourMap()
+
+    def __call__(self, result, options):
+        colour = self._colourMap.colourFor(result['from_user'])
+        return (u"%s%s%s%s %s" %(
+            get_time_string(result, options, "%a, %d %b %Y %H:%M:%S +0000"),
+            ansi.cmdColour(colour), result['from_user'],
+            ansi.cmdReset(), result['text']))
+
+formatters = {}

 status_formatters = {
     'default': StatusFormatter,
     'verbose': VerboseStatusFormatter,
     'urls': URLStatusFormatter,
     'ansi': AnsiStatusFormatter
 status_formatters = {
     'default': StatusFormatter,
     'verbose': VerboseStatusFormatter,
     'urls': URLStatusFormatter,
     'ansi': AnsiStatusFormatter

-}    
+}
+formatters['status'] = status_formatters

 
 admin_formatters = {
     'default': AdminFormatter,
 
 admin_formatters = {
     'default': AdminFormatter,


@@ -152,67 +218,140 @@ admin_formatters = {
     'urls': AdminFormatter,
     'ansi': AdminFormatter
 }
     'urls': AdminFormatter,
     'ansi': AdminFormatter
 }

+formatters['admin'] = admin_formatters

 
 

-def get_status_formatter(options):
-    sf = status_formatters.get(options['format'])
-    if (not sf):
-        raise TwitterError(
-            "Unknown formatter '%s'" %(options['format']))
-    return sf()
+search_formatters = {
+    'default': SearchFormatter,
+    'verbose': VerboseSearchFormatter,
+    'urls': URLSearchFormatter,
+    'ansi': AnsiSearchFormatter
+}
+formatters['search'] = search_formatters

 
 

-def get_admin_formatter(options):
-    sf = admin_formatters.get(options['format'])
-    if (not sf):
+def get_formatter(action_type, options):
+    formatters_dict = formatters.get(action_type)
+    if (not formatters_dict):
+        raise TwitterError(
+            "There was an error finding a class of formatters for your type (%s)"
+            %(action_type))
+    f = formatters_dict.get(options['format'])
+    if (not f):

         raise TwitterError(
         raise TwitterError(

-            "Unknown formatter '%s'" %(options['format']))
-    return sf()
+            "Unknown formatter '%s' for status actions" %(options['format']))
+    return f()

 
 class Action(object):
 
 class Action(object):

+
+    def ask(self, subject='perform this action', careful=False):
+        '''
+        Requests fromt he user using `raw_input` if `subject` should be
+        performed. When `careful`, the default answer is NO, otherwise YES.
+        Returns the user answer in the form `True` or `False`.
+        '''
+        sample = '(y/N)'
+        if not careful:
+            sample = '(Y/n)'
+
+        prompt = 'You really want to %s %s? ' %(subject, sample)
+        try:
+            answer = raw_input(prompt).lower()
+            if careful:
+                return answer in ('yes', 'y')
+            else:
+                return answer not in ('no', 'n')
+        except EOFError:
+            print >>sys.stderr # Put Newline since Enter was never pressed
+            # TODO:
+                #   Figure out why on OS X the raw_input keeps raising
+                #   EOFError and is never able to reset and get more input
+                #   Hint: Look at how IPython implements their console
+            default = True
+            if careful:
+                default = False
+            return default
+
+    def __call__(self, twitter, options):
+        action = actions.get(options['action'], NoSuchAction)()
+        try:
+            doAction = lambda : action(twitter, options)
+            if (options['refresh'] and isinstance(action, StatusAction)):
+                while True:
+                    doAction()
+                    time.sleep(options['refresh_rate'])
+            else:
+                doAction()
+        except KeyboardInterrupt:
+            print >>sys.stderr, '\n[Keyboard Interrupt]'
+            pass
+
+class NoSuchActionError(Exception):

     pass
 
 class NoSuchAction(Action):
     def __call__(self, twitter, options):
     pass
 
 class NoSuchAction(Action):
     def __call__(self, twitter, options):

-        print >> sys.stderr, "No such action: ", options['action']
-        sys.exit(1)
+        raise NoSuchActionError("No such action: %s" %(options['action']))
+
+def printNicely(string):        
+    if sys.stdout.encoding:
+        print string.encode(sys.stdout.encoding, 'replace')
+    else:
+        print string.encode('utf-8')

 
 class StatusAction(Action):
     def __call__(self, twitter, options):
 
 class StatusAction(Action):
     def __call__(self, twitter, options):

-        statuses = self.getStatuses(twitter)
-        sf = get_status_formatter(options)
+        statuses = self.getStatuses(twitter, options)
+        sf = get_formatter('status', options)

         for status in statuses:
         for status in statuses:

-            statusStr = sf(status)
+            statusStr = sf(status, options)

             if statusStr.strip():
             if statusStr.strip():

-                print statusStr.encode(sys.stdout.encoding, 'replace')
+                printNicely(statusStr)
+
+class SearchAction(Action):
+    def __call__(self, twitter, options):
+        # We need to be pointing at search.twitter.com to work, and it is less
+        # tangly to do it here than in the main()
+        twitter.domain="search.twitter.com"
+        # We need to bypass the TwitterCall parameter encoding, so we
+        # don't encode the plus sign, so we have to encode it ourselves
+        query_string = "+".join([quote(term) for term in options['extra_args']])
+        twitter.encoded_args = "q=%s" %(query_string)
+
+        results = twitter.search()['results']
+        f = get_formatter('search', options)
+        for result in results:
+            resultStr = f(result, options)
+            if resultStr.strip():
+                printNicely(resultStr)

 
 class AdminAction(Action):
     def __call__(self, twitter, options):
 
 class AdminAction(Action):
     def __call__(self, twitter, options):

-        if not options['extra_args'][0]:
+        if not (options['extra_args'] and options['extra_args'][0]):

             raise TwitterError("You need to specify a user (screen name)")
             raise TwitterError("You need to specify a user (screen name)")

-        af = get_admin_formatter(options)
+        af = get_formatter('admin', options)

         try:
             user = self.getUser(twitter, options['extra_args'][0])
         except TwitterError, e:
             print "There was a problem following or leaving the specified user."
         try:
             user = self.getUser(twitter, options['extra_args'][0])
         except TwitterError, e:
             print "There was a problem following or leaving the specified user."

-            print "  You may be trying to follow a user you are already following;"
-            print "  Leaving a user you are not currently following;"
-            print "  Or the user may not exist."
-            print "  Sorry."
+            print "You may be trying to follow a user you are already following;"
+            print "Leaving a user you are not currently following;"
+            print "Or the user may not exist."
+            print "Sorry."

             print
             print e
         else:
             print
             print e
         else:

-            print af(options['action'], user).encode(sys.stdout.encoding, 'replace')
+            printNicely(af(options['action'], user))

 
 class FriendsAction(StatusAction):
 
 class FriendsAction(StatusAction):

-    def getStatuses(self, twitter):
-        return reversed(twitter.statuses.friends_timeline())
+    def getStatuses(self, twitter, options):
+        return reversed(twitter.statuses.friends_timeline(count=options["length"]))

 
 class PublicAction(StatusAction):
 
 class PublicAction(StatusAction):

-    def getStatuses(self, twitter):
-        return reversed(twitter.statuses.public_timeline())
+    def getStatuses(self, twitter, options):
+        return reversed(twitter.statuses.public_timeline(count=options["length"]))

 
 class RepliesAction(StatusAction):
 
 class RepliesAction(StatusAction):

-    def getStatuses(self, twitter):
-        return reversed(twitter.statuses.replies())
+    def getStatuses(self, twitter, options):
+        return reversed(twitter.statuses.replies(count=options["length"]))

 
 class FollowAction(AdminAction):
     def getUser(self, twitter, user):
 
 class FollowAction(AdminAction):
     def getUser(self, twitter, user):


@@ -224,24 +363,73 @@ class LeaveAction(AdminAction):
 
 class SetStatusAction(Action):
     def __call__(self, twitter, options):
 
 class SetStatusAction(Action):
     def __call__(self, twitter, options):

-        statusTxt = (u" ".join(options['extra_args']) 
-                     if options['extra_args'] 
+        statusTxt = (u" ".join(options['extra_args'])
+                     if options['extra_args']

                      else unicode(raw_input("message: ")))
         status = (statusTxt.encode('utf8', 'replace'))
         twitter.statuses.update(status=status)
 
                      else unicode(raw_input("message: ")))
         status = (statusTxt.encode('utf8', 'replace'))
         twitter.statuses.update(status=status)
 

+class TwitterShell(Action):
+
+    def render_prompt(self, prompt):
+        '''Parses the `prompt` string and returns the rendered version'''
+        prompt = prompt.strip("'").replace("\\'","'")
+        for colour in ansi.COLOURS_NAMED:
+            if '[%s]' %(colour) in prompt:
+                prompt = prompt.replace(
+                    '[%s]' %(colour), ansi.cmdColourNamed(colour))
+        prompt = prompt.replace('[R]', ansi.cmdReset())
+        return prompt
+
+    def __call__(self, twitter, options):
+        prompt = self.render_prompt(options.get('prompt', 'twitter> '))
+        while True:
+            options['action'] = ""
+            try:
+                args = raw_input(prompt).split()
+                parse_args(args, options)
+                if not options['action']:
+                    continue
+                elif options['action'] == 'exit':
+                    raise SystemExit(0)
+                elif options['action'] == 'shell':
+                    print >>sys.stderr, 'Sorry Xzibit does not work here!'
+                    continue
+                elif options['action'] == 'help':
+                    print >>sys.stderr, '''\ntwitter> `action`\n
+                          The Shell Accepts all the command line actions along with:
+
+                          exit    Leave the twitter shell (^D may also be used)
+
+                          Full CMD Line help is appended below for your convinience.'''
+                Action()(twitter, options)
+                options['action'] = ''
+            except NoSuchActionError, e:
+                print >>sys.stderr, e
+            except KeyboardInterrupt:
+                print >>sys.stderr, '\n[Keyboard Interrupt]'
+            except EOFError:
+                print >>sys.stderr
+                leaving = self.ask(subject='Leave')
+                if not leaving:
+                    print >>sys.stderr, 'Excellent!'
+                else:
+                    raise SystemExit(0)
+

 class HelpAction(Action):
     def __call__(self, twitter, options):
         print __doc__
 
 actions = {
 class HelpAction(Action):
     def __call__(self, twitter, options):
         print __doc__
 
 actions = {

-    'follow': FollowAction,
-    'friends': FriendsAction,
-    'help': HelpAction,
-    'leave': LeaveAction,
-    'public': PublicAction,
-    'replies': RepliesAction,
-    'set': SetStatusAction,
+    'follow'    : FollowAction,
+    'friends'   : FriendsAction,
+    'help'      : HelpAction,
+    'leave'     : LeaveAction,
+    'public'    : PublicAction,
+    'replies'   : RepliesAction,
+    'search'    : SearchAction,
+    'set'       : SetStatusAction,
+    'shell'     : TwitterShell,

 }
 
 def loadConfig(filename):
 }
 
 def loadConfig(filename):


@@ -249,7 +437,7 @@ def loadConfig(filename):
     if os.path.exists(filename):
         cp = SafeConfigParser()
         cp.read([filename])
     if os.path.exists(filename):
         cp = SafeConfigParser()
         cp.read([filename])

-        for option in ('email', 'password', 'format'):
+        for option in ('email', 'password', 'format', 'prompt'):

             if cp.has_option('twitter', option):
                 options[option] = cp.get('twitter', option)
     return options
             if cp.has_option('twitter', option):
                 options[option] = cp.get('twitter', option)
     return options


@@ -261,7 +449,7 @@ def main(args=sys.argv[1:]):
     except GetoptError, e:
         print >> sys.stderr, "I can't do that, %s." %(e)
         print >> sys.stderr
     except GetoptError, e:
         print >> sys.stderr, "I can't do that, %s." %(e)
         print >> sys.stderr

-        sys.exit(1)
+        raise SystemExit(1)

 
     config_options = loadConfig(
         arg_options.get('config_filename') or OPTIONS.get('config_filename'))
 
     config_options = loadConfig(
         arg_options.get('config_filename') or OPTIONS.get('config_filename'))


@@ -273,33 +461,23 @@ def main(args=sys.argv[1:]):
     for d in config_options, arg_options:
         for k,v in d.items():
             if v: options[k] = v
     for d in config_options, arg_options:
         for k,v in d.items():
             if v: options[k] = v

-    
+

     if options['refresh'] and options['action'] not in (
         'friends', 'public', 'replies'):
         print >> sys.stderr, "You can only refresh the friends, public, or replies actions."
         print >> sys.stderr, "Use 'twitter -h' for help."
     if options['refresh'] and options['action'] not in (
         'friends', 'public', 'replies'):
         print >> sys.stderr, "You can only refresh the friends, public, or replies actions."
         print >> sys.stderr, "Use 'twitter -h' for help."

-        sys.exit(1)
-        
+        raise SystemExit(1)
+

     if options['email'] and not options['password']:
         options['password'] = getpass("Twitter password: ")
     if options['email'] and not options['password']:
         options['password'] = getpass("Twitter password: ")

-        
+

     twitter = Twitter(options['email'], options['password'], agent=AGENT_STR)
     twitter = Twitter(options['email'], options['password'], agent=AGENT_STR)

-    action = actions.get(options['action'], NoSuchAction)()
-    

     try:
     try:

-        doAction = lambda : action(twitter, options)
-
-        if (options['refresh'] and isinstance(action, StatusAction)):
-            while True:
-                doAction()
-                time.sleep(options['refresh_rate'])
-        else:
-            doAction()
-
+        Action()(twitter, options)
+    except NoSuchActionError, e:
+        print >>sys.stderr, e
+        raise SystemExit(1)

     except TwitterError, e:
         print >> sys.stderr, e.args[0]
         print >> sys.stderr, "Use 'twitter -h' for help."
     except TwitterError, e:
         print >> sys.stderr, e.args[0]
         print >> sys.stderr, "Use 'twitter -h' for help."

-        sys.exit(1)
-    except KeyboardInterrupt:
-        pass
-
+        raise SystemExit(1)