Added different request types support

Author: VadVergasov

codeforces_api/api_request_maker.py

@@ -40,7 +40,7 @@ def __init__(self, api_key=None, secret=None, random_number=1000000):
 
     def generate_request(self, method_name, **fields):
         """
-        Generates request URL for API.
+        Generates request URL and data for API.
         """
 
         request_url = "https://codeforces.com/api/" + str(method_name)
@@ -100,7 +100,7 @@ def get_response(self, request):
         try:
             response = request.json()
             self.check_return_code(response)
-            return response
+            return response["result"]
         except json.decoder.JSONDecodeError as error:
             raise ValueError(
                 "A lot of users, try to reduce the number of users in the list"

codeforces_api/api_requests.py

@@ -12,83 +12,76 @@ class CodeforcesApi(CodeforcesApiRequestMaker):
     """
 
     session = None
+    method = None
 
-    def __init__(self, api_key=None, secret=None, random_number=1000000):
+    def _make_request(self, method, **payload):
+        """
+        Making request to codeforces.com
+
+        Uses different methods (POST or GET) but be aware of 413 error when using GET.
+        """
+        request_data = self.generate_request(method, **payload)
+        request = self.session.request(
+            self.method, request_data["request_url"], data=request_data["data"]
+        )
+        return self.get_response(request)
+
+    def __init__(self, api_key=None, secret=None, random_number=1000000, method="POST"):
         """
         Initializing class. All we will need is a session to optimize performance.
         """
         super().__init__(api_key, secret, random_number)
         self.session = requests.Session()
+        if method == "POST" or method == "GET":
+            self.method = method
+        else:
+            raise ValueError("method should be POST or GET")
 
     def blog_entry_comments(self, blog_entry_id):
         """
         Get blogEntry.commnets for blog, blog_entry_id required.
 
         Returns parsed response from codeforces.com.
         """
-        request_data = self.generate_request(
+        return self._make_request(
             "blogEntry.comments", **{"blogEntryId": str(blog_entry_id)}
         )
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
 
     def blog_entry_view(self, blog_entry_id):
         """
         Get blogEntry.view for blog, blog_entry_id required.
 
         Returns parsed response from codeforces.com.
         """
-        request_data = self.generate_request(
+        return self._make_request(
             "blogEntry.view", **{"blogEntryId": str(blog_entry_id)}
         )
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
 
     def contest_hacks(self, contest_id):
         """
         Get contest.hacks for contest, contest_id required.
 
         Returns parsed response from codeforces.com.
         """
-        request_data = self.generate_request(
-            "contest.hacks", **{"contestId": str(contest_id)}
-        )
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
+        return self._make_request("contest.hacks", **{"contestId": str(contest_id)})
 
     def contest_list(self, gym=False):
         """
         Get all contests you can get all gym by gym parameter.
 
         Returns parsed response from codeforces.com
         """
-        request_data = self.generate_request(
-            "contest.list", **{"gym": str(gym).lower()}
-        )
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
+        return self._make_request("contest.list", **{"gym": str(gym).lower()})
 
     def contest_rating_changes(self, contest_id):
         """
         Get contest.ratingChanges for the contest, contest_id required.
 
         Returns parsed response from codeforces.com.
         """
-        request_data = self.generate_request(
+        return self._make_request(
             "contest.ratingChanges", **{"contestId": str(contest_id)}
         )
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
 
     def contest_standings(
         self,
@@ -132,15 +125,13 @@ def contest_standings(
             handles_str = ""
             for handle in handles:
                 handles_str += str(handle) + ";"
-            request_data = self.generate_request("user.info", **{"handles": handles_str})
+            request_data = self.generate_request(
+                "user.info", **{"handles": handles_str}
+            )
             parameters["handles"] = handles_str
         if room != -1:
             parameters["room"] = str(room)
-        request_data = self.generate_request("contest.standings", **parameters)
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
+        return self._make_request("contest.standings", **parameters)
 
     def contest_status(self, contest_id, handle="", start=-1, count=-1):
         """
@@ -163,11 +154,7 @@ def contest_status(self, contest_id, handle="", start=-1, count=-1):
             parameters["start"] = str(start)
         if count != -1:
             parameters["count"] = str(count)
-        request_data = self.generate_request("contest.status", **parameters)
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
+        return self._make_request("contest.status", **parameters)
 
     def problemset_problems(self, tags=[""], problemset_name=""):
         """
@@ -186,11 +173,7 @@ def problemset_problems(self, tags=[""], problemset_name=""):
             parameters["tags"] = tags
         if problemset_name != "":
             parameters["problemsetName"] = problemset_name
-        request_data = self.generate_request("problemset.problems", **parameters)
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
+        return self._make_request("problemset.problems", **parameters)
 
     def problemset_recent_status(self, count, problemset_name=""):
         """
@@ -211,11 +194,7 @@ def problemset_recent_status(self, count, problemset_name=""):
         }
         if problemset_name != "":
             parameters["problemsetName"] = problemset_name
-        request_data = self.generate_request("problemset.recentStatus", **parameters)
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
+        return self._make_request("problemset.recentStatus", **parameters)
 
     def recent_actions(self, max_count=100):
         """
@@ -229,13 +208,7 @@ def recent_actions(self, max_count=100):
         """
         if max_count > 100:
             raise OverflowError("Max_count should be less or equal to 1000")
-        request_data = self.generate_request(
-            "recentActions", **{"maxCount": str(max_count)}
-        )
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
+        return self._make_request("recentActions", **{"maxCount": str(max_count)})
 
     def user_blog_entries(self, handle):
         """
@@ -247,13 +220,7 @@ def user_blog_entries(self, handle):
         """
         if handle == "":
             raise TypeError("Handle should not be empty")
-        request_data = self.generate_request(
-            "user.blogEntries", **{"handle": str(handle)}
-        )
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
+        return self._make_request("user.blogEntries", **{"handle": str(handle)})
 
     def user_friends(self, only_online=False):
         """
@@ -267,13 +234,9 @@ def user_friends(self, only_online=False):
         """
         if self.anonimus:
             raise TypeError("Auth is required.")
-        request_data = self.generate_request(
+        return self._make_request(
             "user.friends", **{"onlyOnline": str(only_online).lower()}
         )
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
 
     def user_info(self, handles):
         """
@@ -290,11 +253,7 @@ def user_info(self, handles):
         handles_str = ""
         for handle in handles:
             handles_str += str(handle) + ";"
-        request_data = self.generate_request("user.info", **{"handles": handles_str})
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
+        return self._make_request("user.info", **{"handles": handles_str})
 
     def user_rated_list(self, active_only=False):
         """
@@ -304,13 +263,9 @@ def user_rated_list(self, active_only=False):
 
         Returns parsed response from codeforces.com.
         """
-        request_data = self.generate_request(
+        return self._make_request(
             "user.ratedList", **{"activeOnly": str(active_only).lower()}
         )
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
 
     def user_rating(self, handle):
         """
@@ -320,11 +275,7 @@ def user_rating(self, handle):
 
         Returns parsed response from codeforces.com.
         """
-        request_data = self.generate_request("user.rating", **{"handle": str(handle)})
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
+        return self._make_request("user.rating", **{"handle": str(handle)})
 
     def user_status(self, handle, start=-1, count=-1):
         """
@@ -345,8 +296,4 @@ def user_status(self, handle, start=-1, count=-1):
             parameters["from"] = str(start)
         if count != -1:
             parameters["count"] = str(count)
-        request_data = self.generate_request("user.status", **parameters)
-        request = self.session.post(
-            request_data["request_url"], data=request_data["data"]
-        )
-        return self.get_response(request)
+        return self._make_request("user.status", **parameters)

codeforces_api/parse_methods.py

@@ -51,7 +51,7 @@ def get_tags(self, contest_id, index, include_rating=False):
         """
         if self.problem_tags == dict():
             cf_api = CodeforcesApi()
-            for problem in cf_api.problemset_problems()["result"]["problems"]:
+            for problem in cf_api.problemset_problems()["problems"]:
                 if str(problem["contestId"]) not in self.problem_tags.keys():
                     self.problem_tags[str(problem["contestId"])] = dict()
                 self.problem_tags[str(problem["contestId"])][

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name="CodeforcesApiPy",
-    version="1.5.1",
+    version="1.6.0",
     description="Implementation of codeforces.com API",
     platforms="any",
     url="https://github.com/VadVergasov/CodeforcesApiPy",