codeforces_python_client.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "e2a1d0ca",
   "metadata": {},
   "outputs": [],
   "source": [
    "# default_exp core"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "791d539d",
   "metadata": {},
   "source": [
    "# Codeforces API Python Client\n",
    "\n",
    "Some methods are protected, requiring the api_key and secret."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "45903ddf",
   "metadata": {},
   "outputs": [],
   "source": [
    "#hide\n",
    "from nbdev.showdoc import *"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "a10c9b47",
   "metadata": {},
   "outputs": [],
   "source": [
    "#export\n",
    "import datetime\n",
    "import time\n",
    "import random\n",
    "import string\n",
    "\n",
    "import requests\n",
    "import inflection"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "3cf31c5f",
   "metadata": {},
   "outputs": [],
   "source": [
    "#export\n",
    "class Base:\n",
    "    _fields = None\n",
    "    def __init__(self, content: dict) -> None:\n",
    "        self.init(content)\n",
    "        \n",
    "    def init(self, content: dict) -> None:\n",
    "        if not self._fields:\n",
    "            raise ValueError('_fields is not set for the class')\n",
    "        for field, val_type in self._fields.items():\n",
    "            val = content.get(field)\n",
    "            if val is None:\n",
    "                setattr(self, inflection.underscore(field), val)\n",
    "            else:\n",
    "                setattr(self, inflection.underscore(field), val_type(val))\n",
    "            \n",
    "    def __repr__(self):\n",
    "        return str(self.__dict__)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "3d225923",
   "metadata": {},
   "outputs": [],
   "source": [
    "#export\n",
    "class Contest(Base):\n",
    "    _fields = {\n",
    "        'id': int,\n",
    "        'name': str,\n",
    "        'type': str,\n",
    "        'phase': str,\n",
    "        'frozen': bool,\n",
    "        'durationSeconds': int,\n",
    "        'startTimeSeconds': int,\n",
    "        'relativeTimeSeconds': int,\n",
    "        'preparedBy': int,\n",
    "        'websiteUrl': str,\n",
    "        'description': str,\n",
    "        'difficulty': int,\n",
    "        'kind': str,\n",
    "        'icpcRegion': str,\n",
    "        'country': str,\n",
    "        'city': str,\n",
    "        'season': str,\n",
    "    }\n",
    "    \n",
    "    def __init__(self, contest):\n",
    "        super().__init__(contest)\n",
    "        self.duration_hours = self.duration_seconds / (60*60)\n",
    "        if self.start_time_seconds:\n",
    "            self.start_time = datetime.datetime.fromtimestamp(self.start_time_seconds)\n",
    "            self.end_time = self.start_time + datetime.timedelta(seconds=self.duration_seconds)\n",
    "    \n",
    "    \n",
    "class User(Base):\n",
    "    _fields = {\n",
    "        'handle': str,\n",
    "        'email': str,\n",
    "        'vkId': str,\n",
    "        'openId': str,\n",
    "        'firstName': str,\n",
    "        'lastName': str,\n",
    "        'country': str,\n",
    "        'city': str,\n",
    "        'organization': str,\n",
    "        'contribution': int,\n",
    "        'rank': str,\n",
    "        'rating': int,\n",
    "        'maxRank': str,\n",
    "        'maxRating': int,\n",
    "        'lastOnlineTimeSeconds': int,\n",
    "        'registrationTimeSeconds': int,\n",
    "        'friendOfCount': int,\n",
    "        'avatar': str,\n",
    "        'titlePhoto': str\n",
    "    }\n",
    "    \n",
    "    \n",
    "class Problem(Base):\n",
    "    _fields = {\n",
    "        'contestId': int,\n",
    "        'problemsetName': str,\n",
    "        'index': str,\n",
    "        'name': str,\n",
    "        'type': str,\n",
    "        'points': float,\n",
    "        'rating': int,\n",
    "        'tags': list\n",
    "    }\n",
    "    \n",
    "    \n",
    "class UserRating(Base):\n",
    "    _fields = {\n",
    "        'contestId': int,\n",
    "        'contestName': str,\n",
    "        'handle': str,\n",
    "        'rank': int,\n",
    "        'ratingUpdateTimeSeconds': int,\n",
    "        'oldRating': int,\n",
    "        'newRating': int\n",
    "    }\n",
    "    \n",
    "    \n",
    "class BlogEntry(Base):\n",
    "    _fields = {\n",
    "        'id': int,\n",
    "        'originalLocale': str,\n",
    "        'creationTimeSeconds': int,\n",
    "        'authorHandle': str,\n",
    "        'title': str,\n",
    "        'content': str,\n",
    "        'locale': str,\n",
    "        'modificationTimeSeconds': int,\n",
    "        'allowViewHistory': bool,\n",
    "        'tags': list,\n",
    "        'rating': int\n",
    "    }\n",
    "    \n",
    "    \n",
    "class Comment(Base):\n",
    "    _fields = {\n",
    "        'id': int,\n",
    "        'creationTimeSeconds': int,\n",
    "        'commentatorHandle': str,\n",
    "        'locale': str,\n",
    "        'text': str,\n",
    "        'parentCommentId': int,\n",
    "        'rating': int\n",
    "    }\n",
    "    \n",
    "    \n",
    "    \n",
    "class Party(Base):\n",
    "    _fields = {\n",
    "        'contestId': int,\n",
    "        'members': list,\n",
    "        'participantType': str,\n",
    "        'teamId': int,\n",
    "        'teamName': str,\n",
    "        'ghost': bool,\n",
    "        'room': int,\n",
    "        'startTimeSeconds': int\n",
    "    }\n",
    "    \n",
    "    \n",
    "class ProblemStatistics(Base):\n",
    "    _fields = {\n",
    "        'contestId': int,\n",
    "        'index': str,\n",
    "        'solvedCount': int\n",
    "    }\n",
    "    \n",
    "    \n",
    "class ProblemResult(Base):\n",
    "    _fields = {\n",
    "        'points': float,\n",
    "        'penalty': int,\n",
    "        'rejectedAttemptCount': int,\n",
    "        'type': str,\n",
    "        'bestSubmissionTimeSeconds': int\n",
    "    }\n",
    "    \n",
    "    \n",
    "class RecentAction(Base):\n",
    "    _fields = {\n",
    "        'timeSeconds': int,\n",
    "        'blogEntry': BlogEntry,\n",
    "        'comment': Comment\n",
    "    }\n",
    "    \n",
    "    \n",
    "class Hack(Base):\n",
    "    _fields = {\n",
    "        'id': int,\n",
    "        'creationTiemSeconds': int,\n",
    "        'hacker': Party,\n",
    "        'defender': Party,\n",
    "        'verdict': str,\n",
    "        'problem': Problem,\n",
    "        'test': str,\n",
    "        'judgeProtocol': object\n",
    "    }\n",
    "    \n",
    "    \n",
    "class Submission(Base):\n",
    "    _fields = {\n",
    "        'id': int,\n",
    "        'contestId': int,\n",
    "        'creationTimeSeconds': int,\n",
    "        'relativeTimeSeconds': int,\n",
    "        'problem': Problem,\n",
    "        'author': Party,\n",
    "        'programmingLanguage': str,\n",
    "        'verdict': str,\n",
    "        'testset': str,\n",
    "        'passedTestCount': int,\n",
    "        'timeConsumedMillis': int,\n",
    "        'memoryConsumedBytes': int,\n",
    "        'points': float\n",
    "    }\n",
    "    \n",
    "\n",
    "class RanklistRow(Base):\n",
    "    _fields = {\n",
    "        'party': Party,\n",
    "        'rank': int,\n",
    "        'points': float,\n",
    "        'penalty': int,\n",
    "        'successfulHackCount': int,\n",
    "        'unsuccessfulHackCount': int,\n",
    "        'problemResults': list,\n",
    "        'lastSubmissionTimeSeconds': int\n",
    "    }\n",
    "    \n",
    "    \n",
    "class Standings(Base):\n",
    "    _fields = {\n",
    "        'contest': Contest,\n",
    "        'problems': list,\n",
    "        'rows': list,\n",
    "    }"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "a29401da",
   "metadata": {},
   "outputs": [],
   "source": [
    "#export\n",
    "class CFApi:\n",
    "    _url_pack = {\n",
    "        'blog.comments': 'https://codeforces.com/api/blogEntry.comments',\n",
    "        'blog.view': 'https://codeforces.com/api/blogEntry.view',\n",
    "        'contest.list': 'https://codeforces.com/api/contest.list',\n",
    "        'contest.standings': 'https://codeforces.com/api/contest.standings',\n",
    "        'problemset.problems': 'https://codeforces.com/api/problemset.problems',\n",
    "        'user.info': 'https://codeforces.com/api/user.info',\n",
    "        'user.rating': 'https://codeforces.com/api/user.rating',\n",
    "        'user.status': 'https://codeforces.com/api/user.status',\n",
    "    }\n",
    "    \n",
    "    _BASE_API = 'https://codeforces.com/api/'\n",
    "    \n",
    "    def __init__(self, api_key=None, secret=None, lang='eu'):\n",
    "        self.api_key = api_key\n",
    "        self.secret = secret\n",
    "        self.lang = lang\n",
    "        self.anonymous = True\n",
    "        # check for supply of both\n",
    "        if self.api_key and self.secret:\n",
    "            self.anonymous = False\n",
    "        \n",
    "    \n",
    "    def _generate_secret_params(self, method_name: str, params) -> dict: \n",
    "        cur_time = int(time.time())\n",
    "        rand_char = random.choices(string.printable, k=6)\n",
    "        rand_char = \"\".join(rand_char)\n",
    "        \n",
    "        sorted_params = {key: val for key, val in sorted(params.items())}  # only for Python3.6 and above\n",
    "        params_encoded = requests.urllib3.request.urlencode(sorted_params)\n",
    "        \n",
    "        api_sig = f'{rand_char}/{method_name}?{params_encoded}#{self.secret}'\n",
    "        api_sig = hashlib.sha512(api_sig)\n",
    "        secret_params = {\n",
    "            'apiKey': self.api_key,\n",
    "            'time': str(cur_time),\n",
    "            'apiSig': api_sig\n",
    "        }\n",
    "        return secret_params\n",
    "    \n",
    "    \n",
    "    def _get_data(self, method_name: str, params: dict = None):\n",
    "        url = self._BASE_API + method_name\n",
    "        cur_time = datetime.datetime.now().timestamp()\n",
    "        if params is None:\n",
    "            params = {}\n",
    "        \n",
    "        if not self.anonymous:\n",
    "            secret_params = self._generate_secret_params(method_name, params)\n",
    "            params.update(secret_params)\n",
    "            \n",
    "        res = requests.get(url, params=params)\n",
    "        if res.status_code != 200:\n",
    "            pass # raise Error\n",
    "        res = res.json()\n",
    "        if res['status'] != 'OK':\n",
    "            raise Exception(res)\n",
    "        return res['result']\n",
    "    \n",
    "    \n",
    "    def get_contests(self, gym=False):\n",
    "        method_name = 'contest.list'\n",
    "        params = {'gym': gym}\n",
    "        contests = self._get_data(method_name, params)\n",
    "        contests = [Contest(contest) for contest in contests]\n",
    "        return contests\n",
    "    \n",
    "    \n",
    "    def get_problems(self, tags=None):\n",
    "        method_name = 'problemset.problems'\n",
    "        if isinstance(tags, str):\n",
    "            tags = [tags]\n",
    "        if tags:\n",
    "            tags = \";\".join(tags)\n",
    "        params = {'tags': tags}\n",
    "        res = self._get_data(method_name, params)\n",
    "        problems = [Problem(problem) for problem in res['problems']]\n",
    "        return problems\n",
    "    \n",
    "    \n",
    "    def get_user_info(self, handles):\n",
    "        method_name = 'user.info'\n",
    "        if isinstance(handles, str):\n",
    "            handles = [handles]\n",
    "        handles = \";\".join(handles)\n",
    "        params = {'handles': handles}\n",
    "        users = self._get_data(method_name, params)\n",
    "        users = [User(user) for user in users]\n",
    "        return users\n",
    "    \n",
    "    \n",
    "    def get_user_ratings(self, handle):\n",
    "        method_name = 'user.rating'\n",
    "        params = {'handle': handle}\n",
    "        user_ratings = self._get_data(method_name, params)\n",
    "        user_ratings = [UserRating(rating) for rating in user_ratings]\n",
    "        return user_ratings\n",
    "    \n",
    "    \n",
    "    def get_user_submissions(self, handle: str):\n",
    "        # from and count\n",
    "        method_name = 'user.status'\n",
    "        params = {'handle': handle}\n",
    "        submissions = self._get_data(method_name, params)\n",
    "        submissions = [Submission(submission) for submission in submissions]\n",
    "        return submissions\n",
    "    \n",
    "    \n",
    "    def get_blog_comments(self, blog_id: int) -> Comment:\n",
    "        method_name = 'blogEntry.comments'\n",
    "        params = {'blogEntryId': blog_id}\n",
    "        comments = self._get_data(method_name, params)\n",
    "        comments = [Comment(comment) for comment in comments]\n",
    "        return comments\n",
    "    \n",
    "    \n",
    "    def get_blog_entry(self, blog_id: int) -> BlogEntry:\n",
    "        method_name = 'blogEntry.comments'\n",
    "        params = {'blogEntryId': blog_id}\n",
    "        blog = self._get_data(method_name, params)\n",
    "        blog = BlogEntry(blog)\n",
    "        return blog\n",
    "    \n",
    "    def get_contest_standings(self, contest_id: int):\n",
    "        method_name = 'contest.standings'\n",
    "        params = {'contestId': contest_id}\n",
    "        standings = self._get_data(method_name, params)\n",
    "        standings = Standings(standings)\n",
    "        return standings"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "3571b1b9",
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "codeforces_python_client",
   "language": "python",
   "name": "codeforces_python_client"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}