Skip to content

/python-twitter

Browse files

Merge pull request #314 from bear/kwargs-consistency 

Consistency in keyword arguments for "id" parameters
  • Loading branch information...
2 parents 7968856 + 7dcdf61 commit bd7e6afe2cab8db3bc8a92a757554b044a694d9d @jeremylow jeremylow committed
Unified Split
Showing with 91 additions and 50 deletions.
  1. +5 −1 Makefile
  2. +40 −2 doc/migration_v30.rst
  3. +46 −47 twitter/api.py
View
6 Makefile
@@ -2,6 +2,7 @@
help:
@echo " env install all production dependencies"
@echo " dev install all dev and production dependencies (virtualenv is assumed)"
+ @echo " docs build documentation"
@echo " clean remove unwanted stuff"
@echo " lint check style with flake8"
@echo " test run tests"
@@ -23,7 +24,10 @@ clean:
rm -fr dist
find . -name '*.pyc' -exec rm -f {} \;
find . -name '*.pyo' -exec rm -f {} \;
- find . -name '*~' -exec rm -f {} \;
+ find . -name '*~' ! -name '*.un~' -exec rm -f {} \;
+
+docs:
+ $(MAKE) -C doc html
lint:
flake8 twitter > violations.flake8.txt
View
42 doc/migration_v30.rst
@@ -4,6 +4,26 @@ Migration from v2 to v3
Changes to Existing Methods
===========================
+:py:func:`twitter.api.Api.CreateFavorite`
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+* kwarg param has been changed to ``status_id`` from ``id`` to be consistent
+ with other method calls and avoid shadowing builtin function ``id``.
+
+:py:func:`twitter.api.Api.DestroyFavorite`
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+* kwarg param has been changed to ``status_id`` from ``id`` to be consistent
+ with other method calls and avoid shadowing builtin function ``id``.
+
+:py:func:`twitter.api.Api.DestroyBlock`
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+* Kwarg ``id`` has been changed to ``user_id`` in order to avoid shadowing
+ a builtin and be more descriptive.
+
+:py:func:`twitter.api.Api.DestroyStatus`
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+* kwarg ``id`` has been changed to ``status_id`` in keeping with the rest of
+ the Api and to avoid shadowing a builtin.
+
:py:func:`twitter.api.Api.GetBlocks`
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
* Method no longer accepts parameters ``user_id`` or ``screen_name`` as these are not honored by Twitter. The data returned will be for the authenticated user only.
@@ -35,18 +55,32 @@ Changes to Existing Methods
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
* No longer accepts ``cursor`` parameter. If you require granular control over the paging of the twitter.list.List members, please user twitter.api.Api.GetListMembersPaged instead.
+:py:func:`twitter.api.Api.GetStatus`
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+* Kwarg ``id`` has been changed to ``status_id`` in keeping with the rest of
+ the Api and to avoid shadowing a builtin.
+
+:py:func:`twitter.api.Api.GetStatusOembed`
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+* Kwarg ``id`` has been changed to ``status_id`` in keeping with the rest of
+ the Api and to avoid shadowing a builtin.
+
:py:func:`twitter.api.Api.GetSearch`
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
* Adds ``raw_query`` method. See :ref:`raw_queries` for more information.
+
+:py:func:`twitter.api.Api.GetTrendsWoeid`
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+* Kwarg ``id`` has been changed to ``woeid`` in order to avoid shadowing
+ a builtin and be more descriptive.
+
:py:func:`twitter.api.Api.GetUserStream`
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
* Parameter 'stall_warning' is now 'stall_warnings' in line with GetStreamFilter and Twitter's naming convention. This should now actually return stall warnings, whereas it did not have any effect previously.
-
:py:func:`twitter.api.Api.LookupFriendship`
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
* Method will now accept a list for either ``user_id`` or ``screen_name``. The list can contain either ints, strings, or :py:mod:`twitter.user.User` objects for either ``user_id`` or ``screen_name``.
* Return value is a list of :py:mod:`twitter.user.UserStatus` objects.
@@ -56,6 +90,10 @@ Changes to Existing Methods
* ``media_additional_owners`` should be a list of user ids representing Twitter users that should be able to use the uploaded media in their tweets. If you pass a list of media, then **additional owners will apply to each object.** If you need more granular control, please use the UploadMedia* methods.
* ``media_category``: Only for use with the AdsAPI. See https://dev.twitter.com/ads/creative/promoted-video-overview if this applies to your application.
+:py:func:`twitter.api.Api.PostRetweet`
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+* Kwarg ``original_id`` has been changed to ``status_id`` in order to avoid shadowing
+ a builtin and be more descriptive.
Deprecation
===========
View
93 twitter/api.py
@@ -1,7 +1,6 @@
#!/usr/bin/env python
#
-# vim: sw=2 ts=2 sts=2
#
# Copyright 2007 The Python-Twitter Developers
#
@@ -107,15 +106,15 @@ class Api(object):
>>> api.GetReplies()
>>> api.GetUserTimeline(user)
>>> api.GetHomeTimeline()
- >>> api.GetStatus(id)
- >>> api.DestroyStatus(id)
+ >>> api.GetStatus(status_id)
+ >>> api.DestroyStatus(status_id)
>>> api.GetFriends(user)
>>> api.GetFollowers()
>>> api.GetFeatured()
>>> api.GetDirectMessages()
>>> api.GetSentDirectMessages()
>>> api.PostDirectMessage(user, text)
- >>> api.DestroyDirectMessage(id)
+ >>> api.DestroyDirectMessage(message_id)
>>> api.DestroyFriendship(user)
>>> api.CreateFriendship(user)
>>> api.LookupFriendship(user)
@@ -490,9 +489,9 @@ def GetTrendsCurrent(self, exclude=None):
Returns:
A list with 10 entries. Each entry contains a trend.
"""
- return self.GetTrendsWoeid(id=1, exclude=exclude)
+ return self.GetTrendsWoeid(woeid=1, exclude=exclude)
- def GetTrendsWoeid(self, id, exclude=None):
+ def GetTrendsWoeid(self, woeid, exclude=None):
"""Return the top 10 trending topics for a specific WOEID, if trending
information is available for it.
@@ -507,7 +506,7 @@ def GetTrendsWoeid(self, id, exclude=None):
A list with 10 entries. Each entry contains a trend.
"""
url = '%s/trends/place.json' % (self.base_url)
- parameters = {'id': id}
+ parameters = {'id': woeid}
if exclude:
parameters['exclude'] = exclude
@@ -723,14 +722,14 @@ def GetUserTimeline(self,
return [Status.NewFromJsonDict(x) for x in data]
def GetStatus(self,
- id,
+ status_id,
trim_user=False,
include_my_retweet=True,
include_entities=True):
- """Returns a single status message, specified by the id parameter.
+ """Returns a single status message, specified by the status_id parameter.
Args:
- id:
+ 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
@@ -754,9 +753,9 @@ def GetStatus(self,
parameters = {}
try:
- parameters['id'] = int(id)
+ parameters['id'] = int(status_id)
except ValueError:
- raise TwitterError({'message': "'id' must be an integer."})
+ raise TwitterError({'message': "'status_id' must be an integer."})
if trim_user:
parameters['trim_user'] = 1
@@ -771,7 +770,7 @@ def GetStatus(self,
return Status.NewFromJsonDict(data)
def GetStatusOembed(self,
- id=None,
+ status_id=None,
url=None,
maxwidth=None,
hide_media=False,
@@ -786,7 +785,7 @@ def GetStatusOembed(self,
Specify tweet by the id or url parameter.
Args:
- id:
+ status_id:
The numeric ID of the status you are trying to embed.
url:
The url of the status you are trying to embed.
@@ -816,15 +815,15 @@ def GetStatusOembed(self,
parameters = {}
- if id is not None:
+ if status_id is not None:
try:
- parameters['id'] = int(id)
+ parameters['id'] = int(status_id)
except ValueError:
- raise TwitterError({'message': "'id' must be an integer."})
+ raise TwitterError({'message': "'status_id' must be an integer."})
elif url is not None:
parameters['url'] = url
else:
- raise TwitterError({'message': "Must specify either 'id' or 'url'"})
+ raise TwitterError({'message': "Must specify either 'status_id' or 'url'"})
if maxwidth is not None:
parameters['maxwidth'] = maxwidth
@@ -852,24 +851,24 @@ def GetStatusOembed(self,
return data
- def DestroyStatus(self, id, trim_user=False):
+ def DestroyStatus(self, status_id, trim_user=False):
"""Destroys the status specified by the required ID parameter.
The authenticating user must be the author of the specified
status.
Args:
- id:
+ status_id:
The numerical ID of the status you're trying to destroy.
Returns:
A twitter.Status instance representing the destroyed status message
"""
try:
- post_data = {'id': int(id)}
+ post_data = {'id': int(status_id)}
except ValueError:
- raise TwitterError({'message': "id must be an integer"})
- url = '%s/statuses/destroy/%s.json' % (self.base_url, id)
+ raise TwitterError({'message': "status_id must be an integer"})
+ url = '%s/statuses/destroy/%s.json' % (self.base_url, status_id)
if trim_user:
post_data['trim_user'] = 1
@@ -1406,11 +1405,11 @@ def PostUpdates(self,
return results
- def PostRetweet(self, original_id, trim_user=False):
+ def PostRetweet(self, status_id, trim_user=False):
"""Retweet a tweet with the Retweet API.
Args:
- original_id:
+ status_id:
The numerical id of the tweet that will be retweeted
trim_user:
If True the returned payload will only contain the user IDs,
@@ -1421,13 +1420,13 @@ def PostRetweet(self, original_id, trim_user=False):
A twitter.Status instance representing the original tweet with retweet details embedded.
"""
try:
- if int(original_id) <= 0:
- raise TwitterError({'message': "'original_id' must be a positive number"})
+ if int(status_id) <= 0:
+ raise TwitterError({'message': "'status_id' must be a positive number"})
except ValueError:
- raise TwitterError({'message': "'original_id' must be an integer"})
+ raise TwitterError({'message': "'status_id' must be an integer"})
- url = '%s/statuses/retweet/%s.json' % (self.base_url, original_id)
- data = {'id': original_id}
+ url = '%s/statuses/retweet/%s.json' % (self.base_url, status_id)
+ data = {'id': status_id}
if trim_user:
data['trim_user'] = 'true'
resp = self._RequestUrl(url, 'POST', data=data)
@@ -1771,24 +1770,24 @@ def GetBlocksIDs(self,
return result
- def DestroyBlock(self, id, trim_user=False):
+ def DestroyBlock(self, user_id, trim_user=False):
"""Destroys the block for the user specified by the required ID
parameter.
The authenticating user must have blocked the user specified by the
required ID parameter.
Args:
- id:
+ user_id:
The numerical ID of the user to be un-blocked.
Returns:
A twitter.User instance representing the un-blocked user.
"""
try:
- post_data = {'user_id': int(id)}
+ post_data = {'user_id': int(user_id)}
except ValueError:
- raise TwitterError({'message': "id must be an integer"})
+ raise TwitterError({'message': "user_id must be an integer"})
url = '%s/blocks/destroy.json' % (self.base_url)
if trim_user:
post_data['trim_user'] = 1
@@ -2640,21 +2639,21 @@ def PostDirectMessage(self,
return DirectMessage.NewFromJsonDict(data)
- def DestroyDirectMessage(self, id, include_entities=True):
+ def DestroyDirectMessage(self, message_id, include_entities=True):
"""Destroys the direct message specified in the required ID parameter.
The twitter.Api instance must be authenticated, and the
authenticating user must be the recipient of the specified direct
message.
Args:
- id: The id of the direct message to be destroyed
+ message_id: The id of the direct message to be destroyed
Returns:
A twitter.DirectMessage instance representing the message destroyed
"""
url = '%s/direct_messages/destroy.json' % self.base_url
- data = {'id': id}
+ data = {'id': message_id}
if not include_entities:
data['include_entities'] = 'false'
@@ -2810,14 +2809,14 @@ def LookupFriendship(self,
def CreateFavorite(self,
status=None,
- id=None,
+ status_id=None,
include_entities=True):
"""Favorites the specified status object or id as the authenticating user.
Returns the favorite status when successful.
Args:
- id:
+ status_id:
The id of the twitter status to mark as a favorite. [Optional]
status:
The twitter.Status object to mark as a favorite. [Optional]
@@ -2829,12 +2828,12 @@ def CreateFavorite(self,
"""
url = '%s/favorites/create.json' % self.base_url
data = {}
- if id:
- data['id'] = id
+ if status_id:
+ data['id'] = status_id
elif status:
data['id'] = status.id
else:
- raise TwitterError({'message': "Specify id or status"})
+ raise TwitterError({'message': "Specify status_id or status"})
if not include_entities:
data['include_entities'] = 'false'
@@ -2845,14 +2844,14 @@ def CreateFavorite(self,
def DestroyFavorite(self,
status=None,
- id=None,
+ status_id=None,
include_entities=True):
"""Un-Favorites the specified status object or id as the authenticating user.
Returns the un-favorited status when successful.
Args:
- id:
+ status_id:
The id of the twitter status to unmark as a favorite. [Optional]
status:
The twitter.Status object to unmark as a favorite. [Optional]
@@ -2864,12 +2863,12 @@ def DestroyFavorite(self,
"""
url = '%s/favorites/destroy.json' % self.base_url
data = {}
- if id:
- data['id'] = id
+ if status_id:
+ data['id'] = status_id
elif status:
data['id'] = status.id
else:
- raise TwitterError({'message': "Specify id or status"})
+ raise TwitterError({'message': "Specify status_id or status"})
if not include_entities:
data['include_entities'] = 'false'

0 comments on commit bd7e6af

Please sign in to comment.
Something went wrong with that request. Please try again.