]> jfr.im git - z_archive/twitter.git/blobdiff - twitter/cmdline.py
Make twitter-log work with py 3.2
[z_archive/twitter.git] / twitter / cmdline.py
index df3b90cfd6c1083e2b7d8f253e8bb23cd436512f..a167c1412bd34063ff3ed9bc61721902564aa489 100644 (file)
@@ -1,3 +1,4 @@
+# encoding: utf-8
 """
 USAGE:
 
@@ -6,15 +7,21 @@ USAGE:
 
 ACTIONS:
  authorize      authorize the command-line tool to interact with Twitter
- follow         add the specified user to your follow list
+ follow         follow a user
  friends        get latest tweets from your friends (default action)
  help           print this help text that you are currently reading
- leave          remove the specified user from your following list
+ leave          stop following a user
+ list           get list of a user's lists; give a list name to get
+                    tweets from that list
+ mylist         get list of your lists; give a list name to get tweets
+                    from that list
  public         get latest public tweets
- replies        get latest replies
+ pyprompt       start a Python prompt for interacting with the twitter
+                    object directly
+ replies        get latest replies to you
  search         search twitter (Beware: octothorpe, escape it)
  set            set your twitter status
- shell          login the twitter shell
+ shell          login to the twitter shell
 
 
 OPTIONS:
@@ -28,8 +35,8 @@ OPTIONS:
  -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
-    --no-ssl                use HTTP instead of more secure HTTPS
+ -d --datestamp             show date before status lines
+    --no-ssl                use less-secure HTTP instead of HTTPS
     --oauth <filename>      filename to read/store oauth credentials to
 
 FORMATS for the --format option
@@ -54,6 +61,8 @@ prompt: <twitter_shell_prompt e.g. '[cyan]twitter[R]> '>
  home directory.
 """
 
+from __future__ import print_function
+
 CONSUMER_KEY='uS6hO2sV6tDKIOeVjhnFnQ'
 CONSUMER_SECRET='MEYTOS97VvlHX7K1rwHPEqVpTSqZ71HtvoK4sVuYk'
 
@@ -63,14 +72,22 @@ from getopt import gnu_getopt as getopt, GetoptError
 from getpass import getpass
 import re
 import os.path
-from ConfigParser import SafeConfigParser
+try:
+    from ConfigParser import SafeConfigParser
+except ImportError:
+    from configparser import ConfigParser as SafeConfigParser
 import datetime
-from urllib import quote
+try:
+    from urllib.parse import quote
+except ImportError:
+    from urllib2 import quote
 import webbrowser
 
-from api import Twitter, TwitterError
-from oauth import OAuth
-import ansi
+from .api import Twitter, TwitterError
+from .oauth import OAuth, write_token_file, read_token_file
+from .oauth_dance import oauth_dance
+from . import ansi
+from .util import smrt_input, printNicely
 
 OPTIONS = {
     'action': 'friends',
@@ -89,10 +106,10 @@ OPTIONS = {
 
 def parse_args(args, options):
     long_opts = ['help', 'format=', 'refresh', 'oauth=',
-                 'refresh-rate=', 'config=', 'length=', 'timestamp', 
+                 'refresh-rate=', 'config=', 'length=', 'timestamp',
                  'datestamp', 'no-ssl']
     short_opts = "e:p:f:h?rR:c:l:td"
-    opts, extra_args = getopt(args, short_opts, long_opts)        
+    opts, extra_args = getopt(args, short_opts, long_opts)
 
     for opt, arg in opts:
         if opt in ('-f', '--format'):
@@ -136,11 +153,11 @@ def get_time_string(status, options, format="%a %b %d %H:%M:%S +0000 %Y"):
         return time.strftime("%H:%M:%S ", t)
     elif datestamp:
         return time.strftime("%Y-%m-%d ", t)
-    return ""                             
+    return ""
 
 class StatusFormatter(object):
     def __call__(self, status, options):
-        return (u"%s%s %s" %(
+        return ("%s%s %s" %(
             get_time_string(status, options),
             status['user']['screen_name'], status['text']))
 
@@ -150,14 +167,14 @@ class AnsiStatusFormatter(object):
 
     def __call__(self, status, options):
         colour = self._colourMap.colourFor(status['user']['screen_name'])
-        return (u"%s%s%s%s %s" %(
+        return ("%s%s%s%s %s" %(
             get_time_string(status, options),
             ansi.cmdColour(colour), status['user']['screen_name'],
             ansi.cmdReset(), status['text']))
 
 class VerboseStatusFormatter(object):
     def __call__(self, status, options):
-        return (u"-- %s (%s) on %s\n%s\n" %(
+        return ("-- %s (%s) on %s\n%s\n" %(
             status['user']['screen_name'],
             status['user']['location'],
             status['created_at'],
@@ -167,19 +184,44 @@ class URLStatusFormatter(object):
     urlmatch = re.compile(r'https?://\S+')
     def __call__(self, status, options):
         urls = self.urlmatch.findall(status['text'])
-        return u'\n'.join(urls) if urls else ""
+        return '\n'.join(urls) if urls else ""
+
+
+class ListsFormatter(object):
+    def __call__(self, list):
+        if list['description']:
+            list_str = "%-30s (%s)" % (list['name'], list['description'])
+        else:
+            list_str = "%-30s" % (list['name'])
+        return "%s\n" % list_str
+
+class ListsVerboseFormatter(object):
+    def __call__(self, list):
+        list_str = "%-30s\n description: %s\n members: %s\n mode:%s\n" % (list['name'], list['description'], list['member_count'], list['mode'])
+        return list_str
+
+class AnsiListsFormatter(object):
+    def __init__(self):
+        self._colourMap = ansi.ColourMap()
+
+    def __call__(self, list):
+        colour = self._colourMap.colourFor(list['name'])
+        return ("%s%-15s%s %s" %(
+            ansi.cmdColour(colour), list['name'],
+            ansi.cmdReset(), list['description']))
+
 
 class AdminFormatter(object):
     def __call__(self, action, user):
-        user_str = u"%s (%s)" %(user['screen_name'], user['name'])
+        user_str = "%s (%s)" %(user['screen_name'], user['name'])
         if action == "follow":
-            return u"You are now following %s.\n" %(user_str)
+            return "You are now following %s.\n" %(user_str)
         else:
-            return u"You are no longer following %s.\n" %(user_str)
+            return "You are no longer following %s.\n" %(user_str)
 
 class VerboseAdminFormatter(object):
     def __call__(self, action, user):
-        return(u"-- %s: %s (%s): %s" % (
+        return("-- %s: %s (%s): %s" % (
             "Following" if action == "follow" else "Leaving",
             user['screen_name'],
             user['name'],
@@ -187,7 +229,7 @@ class VerboseAdminFormatter(object):
 
 class SearchFormatter(object):
     def __call__(self, result, options):
-        return(u"%s%s %s" %(
+        return("%s%s %s" %(
             get_time_string(result, options, "%a, %d %b %Y %H:%M:%S +0000"),
             result['from_user'], result['text']))
 
@@ -198,7 +240,7 @@ 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 ""
+        return '\n'.join(urls) if urls else ""
 
 class AnsiSearchFormatter(object):
     def __init__(self):
@@ -206,7 +248,7 @@ class AnsiSearchFormatter(object):
 
     def __call__(self, result, options):
         colour = self._colourMap.colourFor(result['from_user'])
-        return (u"%s%s%s%s %s" %(
+        return ("%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']))
@@ -247,6 +289,14 @@ search_formatters = {
 }
 formatters['search'] = search_formatters
 
+lists_formatters = {
+    'default': ListsFormatter,
+    'verbose': ListsVerboseFormatter,
+    'urls': None,
+    'ansi': AnsiListsFormatter
+}
+formatters['lists'] = lists_formatters
+
 def get_formatter(action_type, options):
     formatters_dict = formatters.get(action_type)
     if (not formatters_dict):
@@ -273,13 +323,13 @@ class Action(object):
 
         prompt = 'You really want to %s %s? ' %(subject, sample)
         try:
-            answer = raw_input(prompt).lower()
+            answer = 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
+            print(file=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
@@ -300,7 +350,7 @@ class Action(object):
             else:
                 doAction()
         except KeyboardInterrupt:
-            print >>sys.stderr, '\n[Keyboard Interrupt]'
+            print('\n[Keyboard Interrupt]', file=sys.stderr)
             pass
 
 class NoSuchActionError(Exception):
@@ -310,12 +360,6 @@ class NoSuchAction(Action):
     def __call__(self, twitter, options):
         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):
         statuses = self.getStatuses(twitter, options)
@@ -330,15 +374,14 @@ class SearchAction(Action):
         # 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"
-        twitter.uri=""
+        twitter.uriparts=()
         # 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.decode(get_term_encoding()))
+            [quote(term)
              for term in options['extra_args']])
-        twitter.encoded_args = "q=%s" %(query_string)
 
-        results = twitter.search()['results']
+        results = twitter.search(q=query_string)['results']
         f = get_formatter('search', options)
         for result in results:
             resultStr = f(result, options)
@@ -352,17 +395,44 @@ class AdminAction(Action):
         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."
-            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
+        except TwitterError as 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()
+            print(e)
         else:
             printNicely(af(options['action'], user))
 
+class ListsAction(StatusAction):
+    def getStatuses(self, twitter, options):
+        if not options['extra_args']:
+            raise TwitterError("Please provide a user to query for lists")
+
+        screen_name = options['extra_args'][0]
+
+        if not options['extra_args'][1:]:
+            lists = twitter.user.lists(user=screen_name)['lists']
+            if not lists:
+                printNicely("This user has no lists.")
+            for list in lists:
+                lf = get_formatter('lists', options)
+                printNicely(lf(list))
+            return []
+        else:
+            return reversed(twitter.user.lists.list.statuses(
+                    user=screen_name, list=options['extra_args'][1]))
+
+
+class MyListsAction(ListsAction):
+    def getStatuses(self, twitter, options):
+        screen_name = twitter.account.verify_credentials()['screen_name']
+        options['extra_args'].insert(0, screen_name)
+        return ListsAction.getStatuses(self, twitter, options)
+
+
 class FriendsAction(StatusAction):
     def getStatuses(self, twitter, options):
         return reversed(twitter.statuses.friends_timeline(count=options["length"]))
@@ -385,11 +455,10 @@ class LeaveAction(AdminAction):
 
 class SetStatusAction(Action):
     def __call__(self, twitter, options):
-        statusTxt = (" ".join(options['extra_args']).decode(get_term_encoding())
+        statusTxt = (" ".join(options['extra_args'])
                      if options['extra_args']
-                     else unicode(raw_input("message: ")))
-        status = (statusTxt.encode('utf8', 'replace'))
-        twitter.statuses.update(status=status)
+                     else str(input("message: ")))
+        twitter.statuses.update(status=statusTxt)
 
 class TwitterShell(Action):
 
@@ -408,95 +477,62 @@ class TwitterShell(Action):
         while True:
             options['action'] = ""
             try:
-                args = raw_input(prompt).split()
+                args = 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!'
+                    print('Sorry Xzibit does not work here!', file=sys.stderr)
                     continue
                 elif options['action'] == 'help':
-                    print >>sys.stderr, '''\ntwitter> `action`\n
+                    print('''\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.'''
+                          Full CMD Line help is appended below for your convinience.''', file=sys.stderr)
                 Action()(twitter, options)
                 options['action'] = ''
-            except NoSuchActionError, e:
-                print >>sys.stderr, e
+            except NoSuchActionError as e:
+                print(e, file=sys.stderr)
             except KeyboardInterrupt:
-                print >>sys.stderr, '\n[Keyboard Interrupt]'
+                print('\n[Keyboard Interrupt]', file=sys.stderr)
             except EOFError:
-                print >>sys.stderr
+                print(file=sys.stderr)
                 leaving = self.ask(subject='Leave')
                 if not leaving:
-                    print >>sys.stderr, 'Excellent!'
+                    print('Excellent!', file=sys.stderr)
                 else:
                     raise SystemExit(0)
 
+class PythonPromptAction(Action):
+    def __call__(self, twitter, options):
+        try:
+            while True:
+                smrt_input(globals(), locals())
+        except EOFError:
+            pass
+
 class HelpAction(Action):
     def __call__(self, twitter, options):
-        print __doc__
+        print(__doc__)
 
 class DoNothingAction(Action):
     def __call__(self, twitter, options):
         pass
 
-def parse_oauth_tokens(result):
-    for r in result.split('&'):
-        k, v = r.split('=')
-        if k == 'oauth_token':
-            oauth_token = v
-        elif k == 'oauth_token_secret':
-            oauth_token_secret = v
-    return oauth_token, oauth_token_secret
-
-def oauth_dance(options):
-    print ("Hi there! We're gonna get you all set up to use Twitter"
-           " on the command-line.")
-    twitter = Twitter(
-        auth=OAuth('', '', CONSUMER_KEY, CONSUMER_SECRET),
-        format='')
-    oauth_token, oauth_token_secret = parse_oauth_tokens(
-        twitter.oauth.request_token())
-    print """
-In the web browser window that opens please choose to Allow access to the
-command-line tool. Copy the PIN number that appears on the next page and
-paste or type it here:
-"""
-    webbrowser.open(
-        'http://api.twitter.com/oauth/authorize?oauth_token=' +
-        oauth_token)
-    time.sleep(2) # Sometimes the last command can print some
-                  # crap. Wait a bit so it doesn't mess up the next
-                  # prompt.
-    oauth_verifier = raw_input("Please type the PIN: ").strip()
-    twitter = Twitter(
-        auth=OAuth(
-            oauth_token, oauth_token_secret, CONSUMER_KEY, CONSUMER_SECRET),
-        format='')
-    oauth_token, oauth_token_secret = parse_oauth_tokens(
-        twitter.oauth.access_token(oauth_verifier=oauth_verifier))
-    oauth_file = open(options['oauth_filename'], 'w')
-    print >> oauth_file, oauth_token
-    print >> oauth_file, oauth_token_secret
-    oauth_file.close()
-    print
-    print "That's it! Your authorization keys have been written to %s." % (
-        options['oauth_filename'])
-
-
 actions = {
     'authorize' : DoNothingAction,
     'follow'    : FollowAction,
     'friends'   : FriendsAction,
+    'list'      : ListsAction,
+    'mylist'    : MyListsAction,
     'help'      : HelpAction,
     'leave'     : LeaveAction,
     'public'    : PublicAction,
+    'pyprompt'  : PythonPromptAction,
     'replies'   : RepliesAction,
     'search'    : SearchAction,
     'set'       : SetStatusAction,
@@ -513,54 +549,56 @@ def loadConfig(filename):
                 options[option] = cp.get('twitter', option)
     return options
 
-def read_oauth_file(fn):
-    f = open(fn)
-    return f.readline().strip(), f.readline().strip()
-
 def main(args=sys.argv[1:]):
     arg_options = {}
     try:
         parse_args(args, arg_options)
-    except GetoptError, e:
-        print >> sys.stderr, "I can't do that, %s." %(e)
-        print >> sys.stderr
+    except GetoptError as e:
+        print("I can't do that, %s." %(e), file=sys.stderr)
+        print(file=sys.stderr)
         raise SystemExit(1)
 
-    config_options = loadConfig(
+    config_path = os.path.expanduser(
         arg_options.get('config_filename') or OPTIONS.get('config_filename'))
+    config_options = loadConfig(config_path)
 
     # Apply the various options in order, the most important applied last.
     # Defaults first, then what's read from config file, then command-line
     # arguments.
     options = dict(OPTIONS)
     for d in config_options, arg_options:
-        for k,v in d.items():
+        for k,v in list(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."
+        print("You can only refresh the friends, public, or replies actions.", file=sys.stderr)
+        print("Use 'twitter -h' for help.", file=sys.stderr)
         return 1
 
+    oauth_filename = os.path.expanduser(options['oauth_filename'])
+
     if (options['action'] == 'authorize'
-        or not os.path.exists(options['oauth_filename'])):
-        oauth_dance(options)
+        or not os.path.exists(oauth_filename)):
+        oauth_dance(
+            "the Command-Line Tool", CONSUMER_KEY, CONSUMER_SECRET,
+            options['oauth_filename'])
+
+    oauth_token, oauth_token_secret = read_token_file(oauth_filename)
 
-    oauth_token, oauth_token_secret = read_oauth_file(options['oauth_filename'])
-    
     twitter = Twitter(
         auth=OAuth(
             oauth_token, oauth_token_secret, CONSUMER_KEY, CONSUMER_SECRET),
         secure=options['secure'],
-        api_version='1')
+        api_version='1',
+        domain='api.twitter.com')
 
     try:
         Action()(twitter, options)
-    except NoSuchActionError, e:
-        print >>sys.stderr, e
+    except NoSuchActionError as e:
+        print(e, file=sys.stderr)
         raise SystemExit(1)
-    except TwitterError, e:
-        print >> sys.stderr, e.args[0]
-        print >> sys.stderr, "Use 'twitter -h' for help."
+    except TwitterError as e:
+        print(str(e), file=sys.stderr)
+        print("Use 'twitter -h' for help.", file=sys.stderr)
         raise SystemExit(1)