gb dZddlmZddlmZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl m Z mZddlZddlZddlmZddlZ ddlmZmZmZmZddlmZdd lmZmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&dd l'm(Z(dd l)m*Z*m+Z+m,Z,m-Z-m.Z.ddl/m0Z0m1Z1ejddkDre3Z4dZ5e6Z7e jpe9Z:Gdde6Z;y#e$rdd lmZmZdd lmZmZddlmZYwxYw)z=A library that provides a Python interface to the Twitter API)division)print_functionN)OAuth1OAuth2)uuid4)urlparse urlunparse urlencode quote_plus) __version__)rr )r r ) r _FileCacheCategory DirectMessageListStatusTrendUser UserStatus) RateLimit)calc_expected_status_lengthis_urlparse_media_fileenf_typeparse_arg_list) TwitterError"PythonTwitterDeprecationWarning330)iceZdZdZdZdZdddddddeddddddddddfdZed Z dd Z d Z dd Z d Z ddZ ddZddZddZdZdZ ddZ ddZ ddZ ddZ ddZddZ ddZ ddZ ddZ ddZdZdZ dd Z e!fd!Z" dd"Z#dd#Z$ dd$Z% dd%Z& dd&Z' dd'Z( dd(Z) dd)Z* dd*Z+ dd+Z, dd,Z- dd-Z. dd.Z/ dd/Z0 dd0Z1 dd1Z2 dd2Z3 dd3Z4 dd4Z5 dd5Z6 dd6Z7d7Z8 dd8Z9 dd9Z: dd:Z; dd;Z< dd<Z= dd=Z> dd>Z? dd?Z@ dd@ZA ddAZB ddBZC ddCZD ddDZE ddEZF ddFZG ddGZHddHZIddIZJ ddJZK ddKZLddLZM ddMZN ddNZO ddOZP ddPZQ ddQZR ddRZS ddSZT ddTZUedUZVddVZW ddWZX ddXZY ddYZZ ddZZ[ dd[Z\ dd\Z] dd]Z^ dd^Z_ dd_Z` dd`Za ddaZb ddbZc ddcZd dddZe ddeZf ddfZg ddgZhddhZi ddiZj ddjZkddkZldlZmdmZndnZodoZpdpZqdqZrdrZsdsZtddtZuduZvdvZwdwZxedxZyedyZzdzZ{ed{Z|d|Z}dd}Z~dd~Zy)ApiaA python interface into the Twitter API By default, the Api caches results for 1 minute. Example usage: To create an instance of the twitter.Api class, with no authentication: >>> import twitter >>> api = twitter.Api() To fetch a single user's public status messages, where "user" is either a Twitter "short name" or their user id. >>> statuses = api.GetUserTimeline(user) >>> print([s.text for s in statuses]) To use authentication, instantiate the twitter.Api class with a consumer key and secret; and the oAuth key and secret: >>> api = twitter.Api(consumer_key='twitter consumer key', consumer_secret='twitter consumer secret', access_token_key='the_key_given', access_token_secret='the_key_secret') To fetch your friends (after being authenticated): >>> users = api.GetFriends() >>> print([u.name for u in users]) To post a twitter status message (after being authenticated): >>> status = api.PostUpdate('I love python-twitter!') >>> print(status.text) I love python-twitter! There are many other methods, including: >>> api.PostUpdates(status) >>> api.PostDirectMessage(user, text) >>> api.GetUser(user) >>> api.GetReplies() >>> api.GetUserTimeline(user) >>> api.GetHomeTimeline() >>> api.GetStatus(status_id) >>> api.GetStatuses(status_ids) >>> api.DestroyStatus(status_id) >>> api.GetFriends(user) >>> api.GetFollowers() >>> api.GetFeatured() >>> api.GetDirectMessages() >>> api.GetSentDirectMessages() >>> api.PostDirectMessage(user, text) >>> api.DestroyDirectMessage(message_id) >>> api.DestroyFriendship(user) >>> api.CreateFriendship(user) >>> api.LookupFriendship(user) >>> api.VerifyCredentials() <z Twitter APINFicompatctjrJdtjjvr*ddl}|jj j d}|j|tj|_ ||_ | |_ ||_ d|_|r|dkrtj d||_d|_|j'||j)|j+t-|_||_||_||_| d|_n| |_| d|_n| |_| d |_n| |_| |_|j<d krtj d |r|st?||gs tAd d i|jC||||||r ddl"m#}d|jL_'tQjRtQjTjWtPjXtQjTd}|jWtPjXd|_-t]j^|_0y#tH$rddl%}YwxYw)a Instantiate a new twitter.Api object. Args: consumer_key (str): Your Twitter user's consumer_key. consumer_secret (str): Your Twitter user's consumer_secret. access_token_key (str): The oAuth access token key value you retrieved from running get_access_token.py. access_token_secret (str): The oAuth access token's secret, also retrieved from the get_access_token.py run. application_only_auth: Use Application-Only Auth instead of User Auth. Defaults to False [Optional] input_encoding (str, optional): The encoding used to encode input strings. request_header (dict, optional): A dictionary of additional HTTP request headers. cache (object, optional): The cache instance to use. Defaults to DEFAULT_CACHE. Use None to disable caching. base_url (str, optional): The base URL to use to contact the Twitter API. Defaults to https://api.twitter.com. stream_url (str, optional): The base URL to use for streaming endpoints. Defaults to 'https://stream.twitter.com/1.1'. upload_url (str, optional): The base URL to use for uploads. Defaults to 'https://upload.twitter.com/1.1'. chunk_size (int, optional): Chunk size to use for chunked (multi-part) uploads of images/videos/gifs. Defaults to 1MB. Anything under 16KB and you run the risk of erroring out on 15MB files. use_gzip_compression (bool, optional): Set to True to tell enable gzip compression for any call made to Twitter. Defaults to False. debugHTTP (bool, optional): Set to True to enable debug output from urllib2 when performing any HTTP requests. Defaults to False. timeout (int, optional): Set timeout (in seconds) of the http/https requests. If None the requests lib default will be used. Defaults to None. sleep_on_rate_limit (bool, optional): Whether to sleep an appropriate amount of time if a rate limit is hit for an endpoint. tweet_mode (str, optional): Whether to use the new (as of Sept. 2016) extended tweet mode. See docs for details. Choices are ['compatibility', 'extended']. proxies (dict, optional): A dictionary of proxies for the request to pass through, if not specified allows requests lib to use environmental variables for proxy if any. APPENGINE_RUNTIMErNzVWarning: The Twitter streaming API sends 30s keepalives, the given timeout is shorter!zhttps://api.twitter.com/1.1zhttps://stream.twitter.com/1.1zhttps://upload.twitter.com/1.1i@zA chunk size lower than 16384 may result in too many requests to the Twitter API when uploading videos. You are strongly advised to increase it above 16384messagez*Missing oAuth Consumer Key or Access Tokenzrequests.packages.urllib3T)1osenvironkeys$requests_toolbelt.adapters.appengineadapters appengine monkeypatchSetCacherDEFAULT_CACHE_TIMEOUT_cache_timeout_input_encoding _use_gzip _debugHTTP_shortlink_sizewarningswarn_timeout _Api__auth_InitializeRequestHeaders_InitializeUserAgent_InitializeDefaultParametersr rate_limitsleep_on_rate_limit tweet_modeproxiesbase_url stream_url upload_url chunk_sizeallrSetCredentials http.clientclient ImportErrorhttplibHTTPConnection debuglevellogging basicConfig getLoggersetLevelDEBUG propagaterequestsSession_session)self consumer_keyconsumer_secretaccess_token_keyaccess_token_secretapplication_only_authinput_encodingrequest_headerscacherArBrCrDuse_gzip_compression debugHTTPtimeoutr>r?r@requests_toolbelt http_client requests_logs /opt/Tautulli/lib/twitter/api.py__init__z Api.__init__sX ::"bjjoo&77;!**44@@B e!77--#! w| MMr s   &&7 !!# ))+#+#6 $  9DM$DM  >DO(DO  >DO(DO$ ??Y & MM> @  !S*:@I9~$\?%57JL  r~c|jRd|jz}|j|d}|j|jj d}||_|jS)zGet basic help configuration details from Twitter. Args: None Returns: dict: Sets self._config and returns dict of help config values. z%s/help/configuration.jsonGETutf-8)rrA _RequestUrl_ParseAndCheckTwittercontentrt)rVrmresprns reGetHelpConfigurationzApi.GetHelpConfigurationds^ << .>C##C/D--dll.A.A'.JKDDL||r~c:|j}|r|dS|dS)agReturns number of characters reserved per URL included in a tweet. Args: https (bool, optional): If True, return number of characters reserved for https urls or, if False, return number of character reserved for http urls. Returns: (int): Number of characters reserved per URL. short_url_length_httpsshort_url_length)r)rVhttpsconfigs reGetShortUrlLengthzApi.GetShortUrlLengthts-**, 23 3,- -r~cXd|_d|_d|_d|_d|_d|_y)z0Clear any credentials for this instance N)rrrrrr9rVs reClearCredentialszApi.ClearCredentialss3" $!%$(!! r~cd|jz}i}|rtdt||d<|rtdt||d<|rtdt||d<|rtdt||d<| rtdt| |d<| rtdt| |d<|||gS|||d<|`t |t st |t r,d j|Dcgc] }t|c}|d <ntd t||d <| rtd t| |d <td t||d <| d vr| |d<|&dj||}|j|d}n|j|d|}|j|jjd}| r|S|jddDcgc]}tj |c}Scc}wcc}w)aOReturn twitter search results for a given term. You must specify one of term, geocode, or raw_query. Args: term (str, optional): Term to search by. Optional if you include geocode. raw_query (str, optional): A raw query as a string. This should be everything after the "?" in the URL (i.e., the query parameters). You are responsible for all type checking and ensuring that the query string is properly formatted, as it will only be URL-encoded before be passed directly to Twitter with no other checks performed. For advanced usage only. *This will override any other parameters passed* since_id (int, optional): Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occurred since the since_id, the since_id will be forced to the oldest ID available. max_id (int, optional): Returns only statuses with an ID less than (that is, older than) or equal to the specified ID. until (str, optional): Returns tweets generated before the given date. Date should be formatted as YYYY-MM-DD. since (str, optional): Returns tweets generated since the given date. Date should be formatted as YYYY-MM-DD. geocode (str or list or tuple, optional): Geolocation within which to search for tweets. Can be either a string in the form of "latitude,longitude,radius" where latitude and longitude are floats and radius is a string such as "1mi" or "1km" ("mi" or "km" are the only units allowed). For example: >>> api.GetSearch(geocode="37.781157,-122.398720,1mi"). Otherwise, you can pass a list of either floats or strings for lat/long and a string for radius: >>> api.GetSearch(geocode=[37.781157, -122.398720, "1mi"]) >>> # or: >>> api.GetSearch(geocode=(37.781157, -122.398720, "1mi")) >>> # or: >>> api.GetSearch(geocode=("37.781157", "-122.398720", "1mi")) count (int, optional): Number of results to return. Default is 15 and maxmimum that Twitter returns is 100 irrespective of what you type in. lang (str, optional): Language for results as ISO 639-1 code. Default is None (all languages). locale (str, optional): Language of the search query. Currently only 'ja' is effective. This is intended for language-specific consumers and the default should work in the majority of cases. result_type (str, optional): Type of result which should be returned. Default is "mixed". Valid options are "mixed, "recent", and "popular". include_entities (bool, optional): If True, each tweet will include a node called "entities". This node offers a variety of metadata about the tweet in a discrete structure, including: user_mentions, urls, and hashtags. return_json (bool, optional): If True JSON data will be returned, instead of twitter.Userret Returns: list: A sequence of twitter.Status instances, one for each message containing the term, within the bounds of the geocoded area, or given by the raw_query. z%s/search/tweets.jsonsince_idmax_iduntilsincelanglocaleq,geocodeinclude_entitiescount)mixedpopularrecent result_typez{url}?{raw_query})rm raw_queryrrnrstatuses)rArintstr isinstancelisttuplejoinboolrrrrrrtgetrNewFromJsonDict)rVtermrrrrrrrrrrr return_jsonrm parametersgeorrnxs re GetSearchz Api.GetSearchsb& 5 %-j#x%HJz " #+Hc6#BJx "*7C"?Jw  "*7C"?Jw  !)&#t!   Nu:#& 3X'YZZ$#(Jw   Q),X :&  O'*6{ 8$ &'J{ # ,-J( ) 01J, --4J) *U<))$,,*=*=g*FG378a&&q)881 N"I/K#LMM N  Q"I/N#OPP Q  O"I/L#MNN O9s(CC/ D 6D#C,/D D c (d|jz} i} |rtdt|| d<n|r|| d<|rtdt|| d<|rtdt|| d<|rtdt|| d<tdt|| d<tdt|| d<td t|| d <|j | d | } |j | j jd } | D cgc]} tj| c} Scc} w) asFetch the sequence of public Status messages for a single user. The twitter.Api instance must be authenticated if the user is private. Args: user_id (int, optional): Specifies the ID of the user for whom to return the user_timeline. Helpful for disambiguating when a valid user ID is also a valid screen name. screen_name (str, optional): Specifies the screen name of the user for whom to return the user_timeline. Helpful for disambiguating when a valid screen name is also a user ID. since_id (int, optional): Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occurred since the since_id, the since_id will be forced to the oldest ID available. max_id (int, optional): Returns only statuses with an ID less than (that is, older than) or equal to the specified ID. count (int, optional): Specifies the number of statuses to retrieve. May not be greater than 200. include_rts (bool, optional): If True, the timeline will contain native retweets (if they exist) in addition to the standard stream of tweets. trim_user (bool, optional): If True, statuses will only contain the numerical user ID only. Otherwise a full user object will be returned for each status. exclude_replies (bool, optional) If True, this will prevent replies from appearing in the returned timeline. Using exclude_replies with the count parameter will mean you will receive up-to count tweets - this is because the count parameter retrieves that many tweets before filtering out retweets and replies. This parameter is only supported for JSON and XML responses. Returns: A sequence of Status instances, one for each message up to count z%s/statuses/user_timeline.jsonuser_id screen_namerrr include_rtsrrrrr rArrrrrrrtrr)rVrrrrrrrrrmrrrnrs reGetUserTimelinezApi.GetUserTimelines d/$--@ $,YW$EJy ! (3J} % %-j#x%HJz " #+Hc6#BJx "*7C"?Jw $,]D+$N =!"*;i"H ;(01BD/(Z $%U<))$,,*=*=g*FG378a&&q)888s0Dc ld|jz}tdt|tdt|tdt|tdt|tdt|d}|j |d| }|j |j jd } tj| S) a1Returns a single status message, specified by the status_id parameter. Args: status_id: The numeric ID of the status you are trying to retrieve. trim_user: When set to True, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Omit this parameter to receive the complete user object. [Optional] include_my_retweet: When set to True, any Tweets returned that have been retweeted by the authenticating user will include an additional current_user_retweet node, containing the ID of the source status for the retweet. [Optional] include_entities: If False, the entities node will be disincluded. This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. [Optional] Returns: A twitter.Status instance representing that status message z%s/statuses/show.json status_idrinclude_my_retweetrinclude_ext_alt_text)rrrrrrrrr) rVrrrrrrmrrrns re GetStatusz Api.GetStatus0s8&7;Y7!+tY?"*+?GY"Z ();TCS T$,-CTK_$`  U<))$,,*=*=g*FG%%d++r~c d|jz}tdt|}|ri}ng}d}tdt|tdt||d}|t|krdj |||dzD cgc]} t td t | c} |d <|j|d | } |j| jjd } |rW|j| d jD cic](\} } t | | rtj| nd*c} } n&|| Dcgc]}tj|c}z }|dz }|t|kr|Scc} wcc} } wcc}w)aReturns a list of status messages, specified by the status_ids parameter. Args: status_ids: A list of the numeric ID of the statuses you are trying to retrieve. trim_user: When set to True, each tweet returned in a timeline will include a user object including only the status authors numerical ID. Omit this parameter to receive the complete user object. [Optional] include_entities: If False, the entities node will be disincluded. This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. [Optional] map: If True, returns a dictionary with status id as key and returned status data (or None if tweet does not exist or is inaccessible) as value. Otherwise returns an unordered list of successfully retrieved Tweets. [Optional] Returns: A dictionary or unordered list (depending on the parameter 'map') of twitter Status instances representing the status messages. z%s/statuses/lookup.jsonmaprrr)rrrrdrrrrrN)rArrlenrrrrrrrtupdateitemsrr)rV status_idsrrrrmresultoffsetrrrrnrwvaluedataitems re GetStatuseszApi.GetStatuses[s8(4==9udC( FF!+tY? ();TCS T s:&"xxeopvw}ADxDfE)FXaXk3 -R)S)F GJt ##CZ#@D--dll.A.A'.JKD nrswnxn~n~oAB`j`cejs3x5&*@*@*GVZZBCDQ611(;QQ cMFs:& )F BQs2!E1>-E6 9E<c ,d|jz} i} | t|| d<n||| d<n tddi||| d<|durd | d <|durd | d <|durd | d <||d vr tddi|| d<|r"t |t s tddi|| d<| "t | t s tddi| | d<|j | d| d} |j| jjd} | S#t$rtddiwxYw)a`Returns information allowing the creation of an embedded representation of a Tweet on third party sites. Specify tweet by the id or url parameter. Args: status_id: The numeric ID of the status you are trying to embed. url: The url of the status you are trying to embed. maxwidth: The maximum width in pixels that the embed should be rendered at. This value is constrained to be between 250 and 550 pixels. [Optional] hide_media: Specifies whether the embedded Tweet should automatically expand images. [Optional] hide_thread: Specifies whether the embedded Tweet should automatically show the original message in the case that the embedded Tweet is a reply. [Optional] omit_script: Specifies whether the embedded Tweet HTML should include a