mirror
/
ValvePython.steam
mirror of https://github.com/ValvePython/steam
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

update and tweaks docs and sphinx conf

0.9
Rossen Georgiev 6 years ago
parent
94c5e5ab6f
commit
e39c049e0e
4 changed files with 48 additions and 51 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      docs/conf.py
  2. 75
      steam/client/__init__.py
  3. 18
      steam/client/builtins/leaderboards.py
  4. 2
      steam/webauth.py

4
docs/conf.py
View File

@ -52,7 +52,7 @@ master_doc = 'index'
from steam import __version__, __author__ from steam import __version__, __author__
project = u'steam' project = u'steam'
copyright = u'2016, %s' % __author__ copyright = u'2019, %s' % __author__
author = __author__ author = __author__
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
@ -295,7 +295,7 @@ texinfo_documents = [
intersphinx_mapping = { intersphinx_mapping = {
'python': ('https://docs.python.org/3.6', None), 'python': ('https://docs.python.org/3.6', None),
'gevent': ('http://www.gevent.org', None), 'gevent': ('http://www.gevent.org', None),
'requests': ('http://docs.python-requests.org/en/master', None), 'requests': ('https://2.python-requests.org/en/master/', None),
} }
# AUTODOC # AUTODOC

75
steam/client/__init__.py
View File

@ -220,9 +220,9 @@ class SteamClient(CMClient, BuiltinBase):
The delay is reset upon a successful login. The delay is reset upon a successful login.
:param maxdelay: maximum delay in seconds before connect (0-120s) :param maxdelay: maximum delay in seconds before connect (0-120s)
:type maxdelay: :class:`int` :type maxdelay: :class:`int`
:param retry: see :meth:`.CMClient.connect` :param retry: see :meth:`.CMClient.connect`
:type retry: :class:`int` :type retry: :class:`int`
:return: successful connection :return: successful connection
:rtype: :class:`bool` :rtype: :class:`bool`
""" """
@ -236,14 +236,15 @@ class SteamClient(CMClient, BuiltinBase):
def wait_msg(self, event, timeout=None, raises=None): def wait_msg(self, event, timeout=None, raises=None):
"""Wait for a message, similiar to :meth:`.wait_event` """Wait for a message, similiar to :meth:`.wait_event`
:param event: :class:`.EMsg' or job id :param event: event id
:type event: :class:`.EMsg` or job id
:param timeout: seconds to wait before timeout :param timeout: seconds to wait before timeout
:type timeout: :class:`int` :type timeout: :class:`int`
:param raises: On timeout when ``False` returns :class:`None`, else raise :class:`gevent.Timeout` :param raises: On timeout when ``False`` returns :class:`None`, else raise :class:`gevent.Timeout`
:type raises: :class:`bool` :type raises: :class:`bool`
:return: returns a message or :class:`None` :return: returns a message or :class:`None`
:rtype: :class:`None`, or `proto message` :rtype: :class:`None`, or `proto message`
:raises: ``gevent.Timeout`` :raises: :class:`gevent.Timeout`
""" """
resp = self.wait_event(event, timeout, raises) resp = self.wait_event(event, timeout, raises)
@ -251,13 +252,12 @@ class SteamClient(CMClient, BuiltinBase):
return resp[0] return resp[0]
def send(self, message, body_params=None): def send(self, message, body_params=None):
""".. versionchanged:: 0.8.4 """Send a message to CM
Send a message to CM
:param message: a message instance :param message: a message instance
:type message: :class:`.Msg`, :class:`.MsgProto` :type message: :class:`.Msg`, :class:`.MsgProto`
:param body_params: a dict with params to the body (only :class:`.MsgProto`) :param body_params: a dict with params to the body (only :class:`.MsgProto`)
:type body_params: dict :type body_params: dict
""" """
if not self.connected: if not self.connected:
self._LOG.debug("Trying to send message when not connected. (discarded)") self._LOG.debug("Trying to send message when not connected. (discarded)")
@ -268,16 +268,15 @@ class SteamClient(CMClient, BuiltinBase):
CMClient.send(self, message) CMClient.send(self, message)
def send_job(self, message, body_params=None): def send_job(self, message, body_params=None):
""".. versionchanged:: 0.8.4 """Send a message as a job
Send a message as a job
.. note:: .. note::
Not all messages are jobs, you'll have to find out which are which Not all messages are jobs, you'll have to find out which are which
:param message: a message instance :param message: a message instance
:type message: :class:`.Msg`, :class:`.MsgProto` :type message: :class:`.Msg`, :class:`.MsgProto`
:param body_params: a dict with params to the body (only :class:`.MsgProto`) :param body_params: a dict with params to the body (only :class:`.MsgProto`)
:type body_params: dict :type body_params: dict
:return: ``jobid`` event identifier :return: ``jobid`` event identifier
:rtype: :class:`str` :rtype: :class:`str`
@ -305,23 +304,22 @@ class SteamClient(CMClient, BuiltinBase):
return "job_%d" % jobid return "job_%d" % jobid
def send_job_and_wait(self, message, body_params=None, timeout=None, raises=False): def send_job_and_wait(self, message, body_params=None, timeout=None, raises=False):
""".. versionchanged:: 0.8.4 """Send a message as a job and wait for the response.
Send a message as a job and wait for the response.
.. note:: .. note::
Not all messages are jobs, you'll have to find out which are which Not all messages are jobs, you'll have to find out which are which
:param message: a message instance :param message: a message instance
:type message: :class:`.Msg`, :class:`.MsgProto` :type message: :class:`.Msg`, :class:`.MsgProto`
:param body_params: a dict with params to the body (only :class:`.MsgProto`) :param body_params: a dict with params to the body (only :class:`.MsgProto`)
:type body_params: dict :type body_params: dict
:param timeout: (optional) seconds to wait :param timeout: (optional) seconds to wait
:type timeout: :class:`int` :type timeout: :class:`int`
:param raises: (optional) On timeout if ``False`` return ``None``, else raise ``gevent.Timeout`` :param raises: (optional) On timeout if ``False`` return ``None``, else raise :class:`gevent.Timeout`
:type raises: :class:`bool` :type raises: :class:`bool`
:return: response proto message :return: response proto message
:rtype: :class:`.Msg`, :class:`.MsgProto` :rtype: :class:`.Msg`, :class:`.MsgProto`
:raises: ``gevent.Timeout`` :raises: :class:`gevent.Timeout`
""" """
job_id = self.send_job(message, body_params) job_id = self.send_job(message, body_params)
response = self.wait_event(job_id, timeout, raises=raises) response = self.wait_event(job_id, timeout, raises=raises)
@ -330,22 +328,21 @@ class SteamClient(CMClient, BuiltinBase):
return response[0].body return response[0].body
def send_message_and_wait(self, message, response_emsg, body_params=None, timeout=None, raises=False): def send_message_and_wait(self, message, response_emsg, body_params=None, timeout=None, raises=False):
""".. versionchanged:: 0.8.4 """Send a message to CM and wait for a defined answer.
Send a message to CM and wait for a defined answer.
:param message: a message instance :param message: a message instance
:type message: :class:`.Msg`, :class:`.MsgProto` :type message: :class:`.Msg`, :class:`.MsgProto`
:param response_emsg: emsg to wait for :param response_emsg: emsg to wait for
:type response_emsg: :class:`.EMsg`,:class:`int` :type response_emsg: :class:`.EMsg`,:class:`int`
:param body_params: a dict with params to the body (only :class:`.MsgProto`) :param body_params: a dict with params to the body (only :class:`.MsgProto`)
:type body_params: dict :type body_params: dict
:param timeout: (optional) seconds to wait :param timeout: (optional) seconds to wait
:type timeout: :class:`int` :type timeout: :class:`int`
:param raises: (optional) On timeout if ``False`` return ``None``, else raise ``gevent.Timeout`` :param raises: (optional) On timeout if ``False`` return ``None``, else raise :class:`gevent.Timeout`
:type raises: :class:`bool` :type raises: :class:`bool`
:return: response proto message :return: response proto message
:rtype: :class:`.Msg`, :class:`.MsgProto` :rtype: :class:`.Msg`, :class:`.MsgProto`
:raises: ``gevent.Timeout`` :raises: :class:`gevent.Timeout`
""" """
self.send(message, body_params) self.send(message, body_params)
response = self.wait_event(response_emsg, timeout, raises=raises) response = self.wait_event(response_emsg, timeout, raises=raises)
@ -368,7 +365,7 @@ class SteamClient(CMClient, BuiltinBase):
returns ``None`` if :attr:`credential_location` is not set, or file is not found/inaccessible returns ``None`` if :attr:`credential_location` is not set, or file is not found/inaccessible
:param username: username :param username: username
:type username: :class:`str` :type username: :class:`str`
:return: sentry file contents, or ``None`` :return: sentry file contents, or ``None``
:rtype: :class:`bytes`, :class:`None` :rtype: :class:`bytes`, :class:`None`
""" """
@ -449,17 +446,17 @@ class SteamClient(CMClient, BuiltinBase):
"""Login as a specific user """Login as a specific user
:param username: username :param username: username
:type username: :class:`str` :type username: :class:`str`
:param password: password :param password: password
:type password: :class:`str` :type password: :class:`str`
:param login_key: login key, instead of password :param login_key: login key, instead of password
:type login_key: :class:`str` :type login_key: :class:`str`
:param auth_code: email authentication code :param auth_code: email authentication code
:type auth_code: :class:`str` :type auth_code: :class:`str`
:param two_factor_code: 2FA authentication code :param two_factor_code: 2FA authentication code
:type two_factor_code: :class:`str` :type two_factor_code: :class:`str`
:param login_id: number used for identifying logon session :param login_id: number used for identifying logon session
:type login_id: :class:`int` :type login_id: :class:`int`
:return: logon result, see `CMsgClientLogonResponse.eresult <https://github.com/ValvePython/steam/blob/513c68ca081dc9409df932ad86c66100164380a6/protobufs/steammessages_clientserver.proto#L95-L118>`_ :return: logon result, see `CMsgClientLogonResponse.eresult <https://github.com/ValvePython/steam/blob/513c68ca081dc9409df932ad86c66100164380a6/protobufs/steammessages_clientserver.proto#L95-L118>`_
:rtype: :class:`.EResult` :rtype: :class:`.EResult`

18
steam/client/builtins/leaderboards.py
View File

@ -19,11 +19,11 @@ class Leaderboards(object):
Find a leaderboard Find a leaderboard
:param app_id: application id :param app_id: application id
:type app_id: :class:`int` :type app_id: :class:`int`
:param name: leaderboard name :param name: leaderboard name
:type name: :class:`str` :type name: :class:`str`
:return: leaderboard instance :return: leaderboard instance
:rtype: :class:`SteamLeaderboard` :rtype: :class:`.SteamLeaderboard`
:raises: :class:`LookupError` on message timeout or error :raises: :class:`LookupError` on message timeout or error
""" """
message = MsgProto(EMsg.ClientLBSFindOrCreateLB) message = MsgProto(EMsg.ClientLBSFindOrCreateLB)
@ -103,13 +103,13 @@ class SteamLeaderboard(object):
"""Get leaderboard entries. """Get leaderboard entries.
:param start: start entry, not index (e.g. rank 1 is ``start=1``) :param start: start entry, not index (e.g. rank 1 is ``start=1``)
:type start: :class:`int` :type start: :class:`int`
:param end: end entry, not index (e.g. only one entry then ``start=1,end=1``) :param end: end entry, not index (e.g. only one entry then ``start=1,end=1``)
:type end: :class:`int` :type end: :class:`int`
:param data_request: data being requested :param data_request: data being requested
:type data_request: :class:`steam.enums.common.ELeaderboardDataRequest` :type data_request: :class:`steam.enums.common.ELeaderboardDataRequest`
:param steam_ids: list of steam ids when using :prop:`.ELeaderboardDataRequest.Users` :param steam_ids: list of steam ids when using :attr:`.ELeaderboardDataRequest.Users`
:type steamids: :class:`list` :type steamids: :class:`list`
:return: a list of entries, see ``CMsgClientLBSGetLBEntriesResponse`` :return: a list of entries, see ``CMsgClientLBSGetLBEntriesResponse``
:rtype: :class:`list` :rtype: :class:`list`
:raises: :class:`LookupError` on message timeout or error :raises: :class:`LookupError` on message timeout or error
@ -167,7 +167,7 @@ class SteamLeaderboard(object):
See :class:`steam.util.throttle.ConstantRateLimit` for ``times`` and ``seconds`` parameters. See :class:`steam.util.throttle.ConstantRateLimit` for ``times`` and ``seconds`` parameters.
:param chunk_size: number of entries per request :param chunk_size: number of entries per request
:type chunk_size: :class:`int` :type chunk_size: :class:`int`
:returns: generator object :returns: generator object
:rtype: :class:`generator` :rtype: :class:`generator`

2
steam/webauth.py
View File

@ -10,7 +10,7 @@ The session can be used to access ``steamcommunity.com``, ``store.steampowered.c
Keep in mind if you are trying to write robust code. Keep in mind if you are trying to write robust code.
.. note:: .. note::
If you are using :class:`.SteamClient` take a look at :meth:`.get_web_session()` If you are using :class:`.SteamClient` take a look at :meth:`.SteamClient.get_web_session()`
.. note:: .. note::
If you need to authenticate as a mobile device for things like trading confirmations If you need to authenticate as a mobile device for things like trading confirmations

Write Preview
Loading…
Cancel
Save