X-Git-Url: https://jfr.im/git/z_archive/twitter.git/blobdiff_plain/772fbdd143ceee9a1626672f8abadd3378cdb64a..662f757601dc4f7db85c09211b9e81359106942f:/twitter/cmdline.py diff --git a/twitter/cmdline.py b/twitter/cmdline.py index d36e873..c70e705 100644 --- a/twitter/cmdline.py +++ b/twitter/cmdline.py @@ -4,9 +4,12 @@ USAGE: twitter [action] [options] ACTIONS: - + follow add the specified user to your follow list 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 public get latest public tweets + replies get latest replies set set your twitter status OPTIONS: @@ -17,38 +20,66 @@ OPTIONS: in a while (default: every 5 minutes) -R --refresh-rate set the refresh rate (in seconds) -f --format specify the output format for status updates + -c --config read username and password from given config + file (default ~/.twitter) + -l --length 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 default one line per status verbose multiple lines per status, more verbose status info - urls nothing but URLs. Dare you click them? + urls nothing but URLs + ansi ansi colour (rainbow mode) + +CONFIG FILES + + The config file should contain a [twitter] header, and all the desired options + you wish to set, like so: + +[twitter] +email: +password: +format: """ import sys import time -from getopt import getopt +from getopt import getopt, GetoptError from getpass import getpass import re +import os.path +from ConfigParser import SafeConfigParser from api import Twitter, TwitterError +import ansi -options = { +# Please don't change this, it was provided by the fine folks at Twitter. +# If you change it, it will not work. +AGENT_STR = "twittercommandlinetoolpy" + +OPTIONS = { 'email': None, 'password': None, 'action': 'friends', 'refresh': False, 'refresh_rate': 600, 'format': 'default', + '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', - 'refresh-rate'] - short_opts = "e:p:f:h?rR:" - opts, extra_args = getopt(args, short_opts, long_opts) - + '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: if opt in ('-e', '--email'): options['email'] = arg @@ -60,21 +91,53 @@ def parse_args(args, options): 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'): print __doc__ sys.exit(0) - + elif opt in ('-c', '--config'): + options['config_filename'] = arg + if extra_args: options['action'] = extra_args[0] options['extra_args'] = extra_args[1:] + +def get_time_string(status, options): + timestamp = options["timestamp"] + datestamp = options["datestamp"] + t = time.strptime(status['created_at'], "%a %b %d %H:%M:%S +0000 %Y") + 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): def __call__(self, status): - return (u"%s %s" %( + 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() + + def __call__(self, status, options): + colour = self._colourMap.colourFor(status['user']['screen_name']) + return (u"%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): + def __call__(self, status, options): return (u"-- %s (%s) on %s\n%s\n" %( status['user']['screen_name'], status['user']['location'], @@ -83,18 +146,49 @@ class VerboseStatusFormatter(object): 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 "" -formatters = { +class AdminFormatter(object): + def __call__(self, action, user): + user_str = u"%s (%s)" %(user['screen_name'], user['name']) + if action == "follow": + return u"You are now following %s.\n" %(user_str) + else: + return u"You are no longer following %s.\n" %(user_str) + +class VerboseAdminFormatter(object): + def __call__(self, action, user): + return(u"-- %s: %s (%s): %s" % ( + "Following" if action == "follow" else "Leaving", + user['screen_name'], + user['name'], + user['url'])) + +status_formatters = { 'default': StatusFormatter, 'verbose': VerboseStatusFormatter, - 'urls': URLStatusFormatter + 'urls': URLStatusFormatter, + 'ansi': AnsiStatusFormatter } - + +admin_formatters = { + 'default': AdminFormatter, + 'verbose': VerboseAdminFormatter, + 'urls': AdminFormatter, + 'ansi': AdminFormatter +} + def get_status_formatter(options): - sf = formatters.get(options['format']) + sf = status_formatters.get(options['format']) + if (not sf): + raise TwitterError( + "Unknown formatter '%s'" %(options['format'])) + return sf() + +def get_admin_formatter(options): + sf = admin_formatters.get(options['format']) if (not sf): raise TwitterError( "Unknown formatter '%s'" %(options['format'])) @@ -108,22 +202,58 @@ class NoSuchAction(Action): print >> sys.stderr, "No such action: ", options['action'] sys.exit(1) +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) + statuses = self.getStatuses(twitter, options) sf = get_status_formatter(options) for status in statuses: - statusStr = sf(status) + statusStr = sf(status, options) if statusStr.strip(): - print statusStr.encode(sys.stdout.encoding, 'replace') - + printNicely(statusStr) + +class AdminAction(Action): + def __call__(self, twitter, options): + if not options['extra_args'][0]: + raise TwitterError("You need to specify a user (screen name)") + af = get_admin_formatter(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 + else: + printNicely(af(options['action'], user)) + 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): - 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): + def getStatuses(self, twitter, options): + return reversed(twitter.statuses.replies(count=options["length"])) + +class FollowAction(AdminAction): + def getUser(self, twitter, user): + return twitter.friendships.create(id=user) + +class LeaveAction(AdminAction): + def getUser(self, twitter, user): + return twitter.friendships.destroy(id=user) class SetStatusAction(Action): def __call__(self, twitter, options): @@ -133,38 +263,75 @@ class SetStatusAction(Action): status = (statusTxt.encode('utf8', 'replace')) twitter.statuses.update(status=status) +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, } +def loadConfig(filename): + options = dict(OPTIONS) + if os.path.exists(filename): + cp = SafeConfigParser() + cp.read([filename]) + for option in ('email', 'password', 'format'): + if cp.has_option('twitter', option): + options[option] = cp.get('twitter', option) + return options + +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 + sys.exit(1) + + config_options = loadConfig( + arg_options.get('config_filename') or OPTIONS.get('config_filename')) -def main(): - return main_with_args(sys.argv[1:]) + # 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(): + if v: options[k] = v -def main_with_args(args): - parse_args(args, options) - if options['refresh'] and options['action'] == 'set': - print >> sys.stderr, "You can't repeatedly set your status, silly" + 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) + if options['email'] and not options['password']: options['password'] = getpass("Twitter password: ") - twitter = Twitter(options['email'], options['password']) + + twitter = Twitter(options['email'], options['password'], agent=AGENT_STR) action = actions.get(options['action'], NoSuchAction)() + try: doAction = lambda : action(twitter, options) - if (options['refresh']): + + if (options['refresh'] and isinstance(action, StatusAction)): while True: doAction() time.sleep(options['refresh_rate']) else: doAction() + except TwitterError, e: - print >> sys.stderr, e.message + print >> sys.stderr, e.args[0] print >> sys.stderr, "Use 'twitter -h' for help." sys.exit(1) except KeyboardInterrupt: pass -