Return type of endpoint calls changed. Will affect clients.

Used to return full response AND unpacked JSON dictionary.

Now return ONLY full response when logging in, because it contains the
cookies necessary for the login process, but ALL OTHER calls to
endpoints return ONLY JSON dict, which contains the information they
actually need.

This will affect every client who examines a return value.

Author: Julian-O

InstagramAPI/base.py

@@ -135,9 +135,9 @@ def _sendrequest(self, endpoint, post=None, login=False, headers=None):
         """
         :param endpoint: URL to call 
         :param post: data to HTTP POST. If None, do a GET call.
-        :param login: if True, this is a call to login, so no need to check we are logged in.
+        :param login: if True, this is a call to login, so no need to check we are logged in. Also changes return type.
         :param headers: if not None, override default headers
-        :return: tuple: (full_response, extracted dictionary of JSON part) of the response from Instagram
+        :return: tuple: full response from Instagram if login else just extracted dictionary of JSON part
 
         TODO: most clients will only need one or the other of the responses. Can we simplify?
 
@@ -178,10 +178,17 @@ def _sendrequest(self, endpoint, post=None, login=False, headers=None):
                         response.status_code, response.text)
             raise
 
+        if login:
+            # Need full reponse, containing cookies
+            LOGGER.debug("Instagram responded successfully to special login operation.")
+            return response
+
+        # Otherwise, unpack just the JSON part
+
         json_dict = json.loads(response.text)
 
         LOGGER.debug("Instagram responded successfully: %s", json_dict)
-        return response, json_dict
+        return json_dict
 
     @staticmethod
     def _iterator_template(func, field, delaybetweencalls=0):
@@ -190,7 +197,7 @@ def _iterator_template(func, field, delaybetweencalls=0):
         """
         max_id = None
         while True:
-            _, json_dict = func(max_id=max_id)
+            json_dict = func(max_id=max_id)
             max_id = json_dict.get('next_max_id', None)
             for item in json_dict.get(field, []):
                 yield item

InstagramAPI/endpoints.py

@@ -370,7 +370,7 @@ def login(self, force=False):
             self._session = requests.Session()
             # if you need proxy make something like this:
             # self.s.proxies = {"https": "http://proxyip:proxyport"}
-            full_response, _ = self._sendrequest(
+            full_response = self._sendrequest(
                 'si/fetch_headers/?challenge_type=signup&guid=' + self.generate_uuid(False), login=True)
 
             data = {
@@ -382,17 +382,17 @@ def login(self, force=False):
                 'password': self._password,
                 'login_attempt_count': '0'}
 
-            full_response, json_dict = self._sendrequest(
+            full_response = self._sendrequest(
                 'accounts/login/',
                 post=self._generatesignature(json.dumps(data)),
                 login=True)
 
             self._isloggedin = True
-            self._loggedinuserid = json_dict["logged_in_user"]["pk"]
+            self._loggedinuserid = json.loads(full_response.text)["logged_in_user"]["pk"]
             self._ranktoken = "%s_%s" % (self._loggedinuserid, self._uuid)
             self._csrftoken = full_response.cookies["csrftoken"]
 
-            return full_response, json_dict
+            return full_response
 
     def logout(self):
         try:

examples/display_my_user_details.py

@@ -10,8 +10,8 @@
 
 def display():
     api = InstagramAPI(credentials.USERNAME, credentials.PASSWORD)
-    _, login_data = api.login()
-    _, profile_data = api.get_profile_data()
+    _ = api.login()
+    profile_data = api.get_profile_data()
     print("You are logged in as %s." % profile_data[u"user"][u"username"])
     print("Your full name is %s." % profile_data[u"user"][u"full_name"])
     print("Your email address is %s." % profile_data[u"user"][u"email"])