Add HSR pure fiction (thesadru#157)

.flake8

@@ -6,6 +6,7 @@ exclude = tests, test.py
 # D105: Missing docstring in magic method
 # D106: Missing docstring Model.Config
 # D419: Docstring is empty
+# E704: Multiple statements on one line (def)
 # S101: Use of assert for type checking
 # S303: Use of md5
 # S311: Use of pseudo-random generators
@@ -14,7 +15,8 @@ exclude = tests, test.py
 ignore = 
     A001, A002, A003,
     C408,
-    D105, D106, D419
+    D105, D106, D419,
+    E704,
     S101, S303, S311, S324,
     W503,
 

genshin/__init__.py

@@ -6,6 +6,7 @@
 
 Source Code: https://github.com/thesadru/genshin.py
 """
+
 from . import models, utility
 from .client import *
 from .constants import *

genshin/__main__.py

@@ -1,4 +1,5 @@
 """CLI tools."""
+
 import asyncio
 import datetime
 import functools

genshin/client/__init__.py

@@ -1,4 +1,5 @@
 """Default client implementation."""
+
 from . import components
 from .cache import *
 from .clients import *

genshin/client/cache.py

@@ -1,4 +1,5 @@
 """Cache for client."""
+
 from __future__ import annotations
 
 import abc

genshin/client/clients.py

@@ -1,4 +1,5 @@
 """A simple HTTP client for API endpoints."""
+
 from .components import (
     calculator,
     chronicle,

genshin/client/compatibility.py

@@ -1,4 +1,5 @@
 """Reverse-compatibility layer for previous versions."""
+
 from __future__ import annotations
 
 import typing

genshin/client/components/base.py

@@ -1,4 +1,5 @@
 """Base ABC Client."""
+
 import abc
 import asyncio
 import base64

genshin/client/components/calculator/__init__.py

@@ -1,2 +1,3 @@
 """Calculator client."""
+
 from .client import *

genshin/client/components/calculator/calculator.py

@@ -2,6 +2,7 @@
 
 Over-engineered for the sake of extendability and maintainability.
 """
+
 from __future__ import annotations
 
 import abc

genshin/client/components/calculator/client.py

@@ -1,4 +1,5 @@
 """Calculator client."""
+
 from __future__ import annotations
 
 import asyncio

genshin/client/components/chronicle/__init__.py

@@ -1,2 +1,3 @@
 """Battle chronicle client components."""
+
 from .client import *

genshin/client/components/chronicle/client.py

@@ -1,4 +1,5 @@
 """Battle chronicle component."""
+
 from . import genshin, honkai, starrail
 
 __all__ = ["BattleChronicleClient"]

genshin/client/components/chronicle/starrail.py

@@ -1,4 +1,5 @@
 """StarRail battle chronicle component."""
+
 import asyncio
 import typing
 
@@ -126,3 +127,15 @@ async def get_starrail_rogue(
         payload = dict(schedule_type=schedule_type, need_detail="true")
         data = await self._request_starrail_record("rogue", uid, lang=lang, payload=payload)
         return models.StarRailRogue(**data)
+
+    async def get_starrail_pure_fiction(
+        self,
+        uid: typing.Optional[int] = None,
+        *,
+        previous: bool = False,
+        lang: typing.Optional[str] = None,
+    ) -> models.StarRailPureFiction:
+        """Get starrail pure fiction runs."""
+        payload = dict(schedule_type=2 if previous else 1, need_all="true")
+        data = await self._request_starrail_record("challenge_story", uid, lang=lang, payload=payload)
+        return models.StarRailPureFiction(**data)

genshin/client/components/daily.py

@@ -1,4 +1,5 @@
 """Daily reward component."""
+
 import asyncio
 import datetime
 import functools
@@ -150,8 +151,7 @@ async def claim_daily_reward(  # noqa: D102 missing docstring in overload?
         lang: typing.Optional[str] = None,
         reward: typing.Literal[True] = ...,
         challenge: typing.Optional[typing.Mapping[str, str]] = None,
-    ) -> models.DailyReward:
-        ...
+    ) -> models.DailyReward: ...
 
     @typing.overload
     async def claim_daily_reward(  # noqa: D102 missing docstring in overload?
@@ -161,8 +161,7 @@ async def claim_daily_reward(  # noqa: D102 missing docstring in overload?
         lang: typing.Optional[str] = None,
         reward: typing.Literal[False],
         challenge: typing.Optional[typing.Mapping[str, str]] = None,
-    ) -> None:
-        ...
+    ) -> None: ...
 
     async def claim_daily_reward(
         self,

genshin/client/components/diary.py

@@ -1,4 +1,5 @@
 """Diary component."""
+
 import datetime
 import functools
 import typing

genshin/client/components/gacha.py

@@ -1,4 +1,5 @@
 """Wish component."""
+
 import asyncio
 import functools
 import typing

genshin/client/components/geetest/__init__.py

@@ -2,4 +2,5 @@
 
 Credits to M-307 - https://github.com/mrwan200
 """
+
 from .client import *

genshin/client/components/geetest/client.py

@@ -1,4 +1,5 @@
 """Geetest client component."""
+
 import json
 import typing
 

genshin/client/components/geetest/server.py

@@ -1,4 +1,5 @@
 """Aiohttp webserver used for captcha solving and email verification."""
+
 from __future__ import annotations
 
 import asyncio

genshin/client/components/hoyolab.py

@@ -1,4 +1,5 @@
 """Hoyolab component."""
+
 import asyncio
 import typing
 

genshin/client/components/lineup.py

@@ -1,4 +1,5 @@
 """Lineup component."""
+
 import functools
 import typing
 

genshin/client/components/teapot.py

@@ -1,4 +1,5 @@
 """Teapot component."""
+
 import functools
 import typing
 

genshin/client/components/transaction.py

@@ -1,4 +1,5 @@
 """Transaction client."""
+
 import functools
 import typing
 import urllib.parse

genshin/client/components/wiki.py

@@ -1,4 +1,5 @@
 """Wiki component."""
+
 import typing
 
 from genshin import types
@@ -34,44 +35,39 @@ async def get_wiki_previews(  # noqa: D102 missing docstring in overload?
         menu: typing.Literal[models.WikiPageType.CHARACTER],
         *,
         lang: typing.Optional[str] = None,
-    ) -> typing.Sequence[models.CharacterPreview]:
-        ...
+    ) -> typing.Sequence[models.CharacterPreview]: ...
 
     @typing.overload
     async def get_wiki_previews(  # noqa: D102 missing docstring in overload?
         self,
         menu: typing.Literal[models.WikiPageType.WEAPON],
         *,
         lang: typing.Optional[str] = None,
-    ) -> typing.Sequence[models.WeaponPreview]:
-        ...
+    ) -> typing.Sequence[models.WeaponPreview]: ...
 
     @typing.overload
     async def get_wiki_previews(  # noqa: D102 missing docstring in overload?
         self,
         menu: typing.Literal[models.WikiPageType.ARTIFACT],
         *,
         lang: typing.Optional[str] = None,
-    ) -> typing.Sequence[models.ArtifactPreview]:
-        ...
+    ) -> typing.Sequence[models.ArtifactPreview]: ...
 
     @typing.overload
     async def get_wiki_previews(  # noqa: D102 missing docstring in overload?
         self,
         menu: typing.Literal[models.WikiPageType.ENEMY],
         *,
         lang: typing.Optional[str] = None,
-    ) -> typing.Sequence[models.EnemyPreview]:
-        ...
+    ) -> typing.Sequence[models.EnemyPreview]: ...
 
     @typing.overload
     async def get_wiki_previews(  # noqa: D102 missing docstring in overload?
         self,
         menu: int,
         *,
         lang: typing.Optional[str] = None,
-    ) -> typing.Sequence[models.BaseWikiPreview]:
-        ...
+    ) -> typing.Sequence[models.BaseWikiPreview]: ...
 
     async def get_wiki_previews(
         self,

genshin/client/manager/__init__.py

@@ -1,3 +1,4 @@
 """Cookie managers."""
+
 from .cookie import *
 from .managers import *

genshin/client/manager/cookie.py

@@ -15,6 +15,7 @@
     - stoken (v2) + mid -> ltoken_v2 (token_type=2)
     - stoken (v2) + mid -> cookie_token_v2 (token_type=4)
 """
+
 from __future__ import annotations
 
 import typing

genshin/client/manager/managers.py

@@ -1,4 +1,5 @@
 """Cookie managers for making authenticated requests."""
+
 from __future__ import annotations
 
 import abc

genshin/client/ratelimit.py

@@ -1,4 +1,5 @@
 """Ratelimit handlers."""
+
 import asyncio
 import functools
 import typing

genshin/client/routes.py

@@ -1,4 +1,5 @@
 """API routes."""
+
 import abc
 import typing
 

genshin/constants.py

@@ -1,4 +1,5 @@
 """Constants hardcoded for optimizations."""
+
 from . import types
 
 __all__ = ["LANGS"]

genshin/errors.py

@@ -1,4 +1,5 @@
 """Errors received from the API."""
+
 import typing
 
 __all__ = [

genshin/models/__init__.py

@@ -1,4 +1,5 @@
 """API models."""
+
 from .genshin import *
 from .honkai import *
 from .hoyolab import *

genshin/models/genshin/__init__.py

@@ -1,4 +1,5 @@
 """Genshin models."""
+
 from .calculator import *
 from .character import *
 from .chronicle import *

genshin/models/genshin/calculator.py

@@ -1,4 +1,5 @@
 """Genshin calculator models."""
+
 from __future__ import annotations
 
 import collections

genshin/models/genshin/chronicle/__init__.py

@@ -1,4 +1,5 @@
 """Battle chronicle models."""
+
 from .abyss import *
 from .activities import *
 from .characters import *

genshin/models/genshin/chronicle/activities.py

@@ -1,4 +1,5 @@
 """Chronicle activities models."""
+
 import datetime
 import re
 import typing

genshin/models/genshin/chronicle/notes.py

@@ -1,4 +1,5 @@
 """Genshin chronicle notes."""
+
 import datetime
 import enum
 import typing

genshin/models/genshin/chronicle/tcg.py

@@ -1,4 +1,5 @@
 """Genshin serenitea pot replica display models."""
+
 from __future__ import annotations
 
 import enum

genshin/models/genshin/constants.py

@@ -1,4 +1,5 @@
 """Genshin model constants."""
+
 import typing
 
 __all__ = ["CHARACTER_NAMES", "DBChar"]

genshin/models/genshin/daily.py

@@ -1,4 +1,5 @@
 """Daily reward models."""
+
 import calendar
 import datetime
 import typing

genshin/models/genshin/diary.py

@@ -1,4 +1,5 @@
 """Genshin diary models."""
+
 import datetime
 import enum
 import typing

genshin/models/genshin/gacha.py

@@ -1,4 +1,5 @@
 """Genshin wish models."""
+
 import datetime
 import enum
 import re

genshin/models/genshin/lineup.py

@@ -1,4 +1,5 @@
 """Genshin lineup models."""
+
 from __future__ import annotations
 
 import datetime

genshin/models/genshin/teapot.py

@@ -1,4 +1,5 @@
 """Genshin serenitea pot replica display models."""
+
 from __future__ import annotations
 
 import datetime

genshin/models/genshin/wiki.py

@@ -1,4 +1,5 @@
 """Genshin wish models."""
+
 import enum
 import json
 import typing

genshin/models/honkai/__init__.py

@@ -1,4 +1,5 @@
 """Honkai models."""
+
 from .battlesuit import *
 from .chronicle import *
 from .constants import *

genshin/models/honkai/battlesuit.py

@@ -1,4 +1,5 @@
 """Honkai battlesuit model."""
+
 import logging
 import re
 import typing

genshin/models/honkai/chronicle/__init__.py

@@ -1,4 +1,5 @@
 """Battle chronicle models."""
+
 from .battlesuits import *
 from .modes import *
 from .stats import *

genshin/models/honkai/chronicle/battlesuits.py

@@ -1,4 +1,5 @@
 """Honkai chronicle battlesuits."""
+
 import re
 import typing