Skip to content

Add use_cache parameter to all methods #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SharpBit merged 3 commits into from
Dec 23, 2020
+49 −22
Merged

Add use_cache parameter to all methods #79

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7273cd8
Add use_cache argument to all functions
fourjr Dec 23, 2020
81ee2e4
Fix some bugs
fourjr Dec 23, 2020
37d83c6
Fix flake8
fourjr Dec 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 49 additions & 22 deletions brawlstats/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,14 @@ def _resolve_cache(self, url):
log.debug('GET {} got result from cache.'.format(url))
return data

async def _arequest(self, url):
async def _arequest(self, url, use_cache=True):
"""Async method to request a url."""
# Try and retrieve from cache
cache = self._resolve_cache(url)
if use_cache:
cache = self._resolve_cache(url)
else:
cache = None

if cache is not None:
return cache

Expand All @@ -141,13 +145,16 @@ async def _arequest(self, url):

return data

def _request(self, url):
def _request(self, url, use_cache=True):
"""Sync method to request a url."""
if self.is_async:
return self._arequest(url)
return self._arequest(url, use_cache)

# Try and retrieve from cache
cache = self._resolve_cache(url)
if use_cache:
cache = self._resolve_cache(url)
else:
cache = None
if cache is not None:
return cache

Expand All @@ -162,12 +169,12 @@ def _request(self, url):

return data

async def _aget_model(self, url, model, key=None):
async def _aget_model(self, url, model, use_cache=True, key=None):
"""Method to turn the response data into a Model class for the async client."""
if self.prevent_ratelimit:
# Use self.lock if prevent_ratelimit=True
async with self.lock:
data = await self._arequest(url)
data = await self._arequest(url, use_cache)
await asyncio.sleep(0.1)
else:
data = await self._arequest(url)
Expand All @@ -181,13 +188,13 @@ async def _aget_model(self, url, model, key=None):

return model(self, data)

def _get_model(self, url, model, key=None):
def _get_model(self, url, model, use_cache=True, key=None):
"""Method to turn the response data into a Model class for the sync client."""
if self.is_async:
# Calls the async function
return self._aget_model(url, model=model, key=key)
return self._aget_model(url, model=model, use_cache=use_cache, key=key)

data = self._request(url)
data = self._request(url, use_cache)
if self.prevent_ratelimit:
time.sleep(0.1)

Expand All @@ -201,80 +208,91 @@ def _get_model(self, url, model, key=None):
return model(self, data)

@typecasted
def get_player(self, tag: bstag) -> Player:
def get_player(self, tag: bstag, use_cache=True) -> Player:
"""Gets a player's stats.

Parameters
----------
tag : str
A valid player tag.
Valid characters: 0289PYLQGRJCUV
use_cache : bool, optional
Whether to use the internal 3 minutes cache, by default True

Returns
-------
Player
A player object with all of its attributes.
"""
url = '{}/{}'.format(self.api.PROFILE, tag)
return self._get_model(url, model=Player)
return self._get_model(url, model=Player, use_cache=use_cache)

get_profile = get_player

@typecasted
def get_battle_logs(self, tag: bstag) -> BattleLog:
def get_battle_logs(self, tag: bstag, use_cache=True) -> BattleLog:
"""Gets a player's battle logs.

Parameters
----------
tag : str
A valid player tag.
Valid characters: 0289PYLQGRJCUV
use_cache : bool, optional
Whether to use the internal 3 minutes cache, by default True

Returns
-------
BattleLog
A player battle object with all of its attributes.
"""
url = '{}/{}/battlelog'.format(self.api.PROFILE, tag)
return self._get_model(url, model=BattleLog)
return self._get_model(url, model=BattleLog, use_cache=use_cache)

@typecasted
def get_club(self, tag: bstag) -> Club:
def get_club(self, tag: bstag, use_cache=True) -> Club:
"""Gets a club's stats.

Parameters
----------
tag : str
A valid club tag.
Valid characters: 0289PYLQGRJCUV
use_cache : bool, optional
Whether to use the internal 3 minutes cache, by default True

Returns
-------
Club
A club object with all of its attributes.
"""
url = '{}/{}'.format(self.api.CLUB, tag)
return self._get_model(url, model=Club)
return self._get_model(url, model=Club, use_cache=use_cache)

@typecasted
def get_club_members(self, tag: bstag) -> Members:
def get_club_members(self, tag: bstag, use_cache=True) -> Members:
"""Gets the members of a club.

Parameters
----------
tag : str
A valid club tag.
Valid characters: 0289PYLQGRJCUV
use_cache : bool, optional
Whether to use the internal 3 minutes cache, by default True

Returns
-------
Members
A list of the members in a club.
"""
url = '{}/{}/members'.format(self.api.CLUB, tag)
return self._get_model(url, model=Members)
return self._get_model(url, model=Members, use_cache=use_cache)

def get_rankings(self, *, ranking: str, region: str=None, limit: int=200, brawler: Union[str, int]=None) -> Ranking:
def get_rankings(
self, *, ranking: str, region: str=None, limit: int=200,
brawler: Union[str, int]=None, use_cache=True
) -> Ranking:
"""Gets the top count players/clubs/brawlers.

Parameters
Expand All @@ -287,6 +305,8 @@ def get_rankings(self, *, ranking: str, region: str=None, limit: int=200, brawle
The number of top players or clubs to fetch, by default 200
brawler : Union[str, int], optional
The brawler name or ID, by default None
use_cache : bool, optional
Whether to use the internal 3 minutes cache, by default True

Returns
-------
Expand Down Expand Up @@ -327,15 +347,17 @@ def get_rankings(self, *, ranking: str, region: str=None, limit: int=200, brawle
if ranking == 'brawlers':
url = '{}/{}/{}/{}?limit={}'.format(self.api.RANKINGS, region, ranking, brawler, limit)

return self._get_model(url, model=Ranking)
return self._get_model(url, model=Ranking, use_cache=use_cache)

def get_constants(self, key: str=None) -> Constants:
def get_constants(self, key: str=None, use_cache=True) -> Constants:
"""Gets Brawl Stars constants extracted from the app.

Parameters
----------
key : str, optional
Any key to get specific data, by default None
use_cache : bool, optional
Whether to use the internal 3 minutes cache, by default True

Returns
-------
Expand All @@ -344,9 +366,14 @@ def get_constants(self, key: str=None) -> Constants:
"""
return self._get_model(self.api.CONSTANTS, model=Constants, key=key)

def get_brawlers(self) -> Brawlers:
def get_brawlers(self, use_cache=True) -> Brawlers:
"""Gets available brawlers and information about them.

Parameters
----------
use_cache : bool, optional
Whether to use the internal 3 minutes cache, by default True

Returns
-------
Brawlers
Expand Down