def test_get_meta_url_with_weekly_anime_requests_and_offset():
assert (
utils.get_meta_url(
utils.BASE_URL, "requests", type="anime", period="weekly", offset=2,
)
== "https://api.jikan.moe/v3/meta/requests/anime/weekly/2"
)
def test_get_meta_url():
assert (
utils.get_meta_url(
utils.BASE_URL, "status", type=None, period=None, offset=None
)
== "https://api.jikan.moe/v3/meta/status"
)
def test_get_meta_url_with_no_type_and_period():
assert (
utils.get_meta_url(
utils.BASE_URL, "requests", type=None, period="weekly", offset=None,
)
== "https://api.jikan.moe/v3/meta/requests"
)
def meta(
self,
request: str,
type: Optional[str] = None,
period: Optional[str] = None,
offset: Optional[int] = None,
) -> Dict[str, Any]:
"""Gets meta information regarding the Jikan API.
Args:
request (:obj:`str`): Type of request. Possible values are requests
and status.
type (:obj:`str`, optional): Type of information to get for
requests. Possible values are in the Jikan API documentation.
Defaults to None.
period (:obj:`str`, optional): Time period to get for requests.
Possible values are today, weekly, and monthly. Defaults to
None.
offset (:obj:`int`, optional): 1,000 requests are shown per page.
Offset is used to show more. Defaults to None.
Returns:
Dict: Dictionary containing meta information.
Examples:
>>> jikan.meta('requests')
>>> jikan.meta('requests', type='anime', period='today')
>>> jikan.meta('status')
"""
url = utils.get_meta_url(self.base, request, type, period, offset)
return self._request(url, request=request, type=type, period=period)
