mirror/galaxy-integrations-python-api
1
0
Fork 0
mirror of https://github.com/gogcom/galaxy-integrations-python-api.git synced 2026-04-18 13:16:53 -04:00
Code Issues Packages Projects Releases Wiki Activity

GPI-1122 get_local_size docs clarification about unknown size and 0 value use-cases

Browse Source
This commit is contained in:
Mieszko Banczerowski
2020-02-03 11:23:01 +01:00
parent 083b9f869f
commit 62206318bd
2 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/galaxy/api/plugin.py
View File

@@ -706,7 +706,7 @@ class Plugin:
This method is called by the GOG Galaxy Client.
:param stored_credentials: If the client received any credentials to store locally
in the previous session they will be passed here as a parameter.
in the previous session they will be passed here as a parameter.
Example of possible override of the method:
@@ -1034,14 +1034,17 @@ class Plugin:
"""
return None
async def get_local_size(self, game_id: str, context: Any) -> int:
"""Override this method to return installed game size in bytes.
async def get_local_size(self, game_id: str, context: Any) -> Optional[int]:
"""Override this method to return installed game size.
.. note::
It is preferable to use more efficient way of game size retrieval than iterating over all local files.
It is preferable to avoid iterating over local game files when overriding this method.
If possible, please use a more efficient way of game size retrieval.
:param context: the value returned from :meth:`prepare_local_size_context`
:return: game size in bytes
:return: game size (in bytes) or `None` if game size cannot be determined;
'0' if the game is not installed, or if it is not present locally (e.g. installed
on another machine and accessible via remote connection, playable via web browser etc.)
"""
raise NotImplementedError()

4
src/galaxy/api/types.py
View File

@@ -62,10 +62,10 @@ class NextStep:
return NextStep("web_session", PARAMS, cookies=COOKIES, js=JS)
:param auth_params: configuration options: {"window_title": :class:`str`, "window_width": :class:`str`,
"window_height": :class:`int`, "start_uri": :class:`int`, "end_uri_regex": :class:`str`}
"window_height": :class:`int`, "start_uri": :class:`int`, "end_uri_regex": :class:`str`}
:param cookies: browser initial set of cookies
:param js: a map of the url regex patterns into the list of *js* scripts that should be executed
on every document at given step of internal browser authentication.
on every document at given step of internal browser authentication.
"""
next_step: str
auth_params: Dict[str, str]