From f5d6bc848cfb64b8f8db23c155c3dcaef24e31a5 Mon Sep 17 00:00:00 2001 From: Rossen Georgiev Date: Wed, 22 Jul 2015 10:38:48 +0100 Subject: [PATCH 1/5] WebAPI: moved doc() to __doc__; doc() now prints --- README.rst | 9 ++++++--- steam/webapi.py | 13 +++++++++++++ 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 4afad08..4194572 100644 --- a/README.rst +++ b/README.rst @@ -38,7 +38,7 @@ The response will be deserialized using the appropriate module unless ``raw`` is .. code:: python - >>> print api.ISteamUser.ResolveVanityURL.doc() # method doc + >>> api.ISteamUser.ResolveVanityURL.__doc__ # method doc """ ResolveVanityURL (v0001) @@ -51,8 +51,11 @@ The response will be deserialized using the appropriate module unless ``raw`` is - The vanity URL to get a SteamID for """ - >>> print api.ISteamUser.doc() # interface and all methods - >>> print api.doc() # all available interfaces + + # or calling doc() will print it + >>> api.ISteamUser.ResolveVanityURL.doc() # method doc + >>> api.ISteamUser.doc() # interface and all methods + >>> api.doc() # all available interfaces Checkout the wiki for a `list of the currently available API interfaces`_. diff --git a/steam/webapi.py b/steam/webapi.py index ef29d01..2ab0566 100644 --- a/steam/webapi.py +++ b/steam/webapi.py @@ -1,3 +1,4 @@ +from __future__ import print_function import requests @@ -124,6 +125,10 @@ class WebAPI(object): return vdf.load(resp.raw) def doc(self): + print(self.__doc__) + + @property + def __doc__(self): doc = "Steam Web API - List of all interfaces\n\n" for interface in self.interfaces: doc += interface.doc() @@ -167,6 +172,10 @@ class WebAPIInterface(object): return self._parent.https def doc(self): + print(self.__doc__) + + @property + def __doc__(self): doc = "%s\n%s\n" % (self.name, '-'*len(self.name)) for method in self.methods: doc += " %s\n" % method.doc().replace("\n", "\n ") @@ -276,6 +285,10 @@ class WebAPIMethod(object): return self._parent.https def doc(self): + print(self.__doc__) + + @property + def __doc__(self): doc = "%(httpmethod)s %(name)s (v%(version)04d)\n" % self._dict if 'description' in self._dict: From cbde28afea086ea57ad4c1dd2aaf0e032e7d7e31 Mon Sep 17 00:00:00 2001 From: Rossen Georgiev Date: Wed, 22 Jul 2015 13:17:09 +0100 Subject: [PATCH 2/5] WebAPI: fix regression w/ required param check fix #1 --- steam/webapi.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/steam/webapi.py b/steam/webapi.py index 2ab0566..87c58dc 100644 --- a/steam/webapi.py +++ b/steam/webapi.py @@ -233,7 +233,7 @@ class WebAPIMethod(object): optional = param['optional'] # raise if we are missing a required parameter - if not optional and name not in kwargs: + if not optional and name not in kwargs and name != 'key': raise ValueError("Method requires %s to be set" % repr(name)) # populate params that will be passed to _api_request From 8fd391c5c72f65025eada09c1628eeef7b9c1a72 Mon Sep 17 00:00:00 2001 From: Rossen Georgiev Date: Wed, 22 Jul 2015 14:29:34 +0100 Subject: [PATCH 3/5] fix setup.py install fail when missing dependecies --- setup.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index 94fb59f..bfc93b1 100644 --- a/setup.py +++ b/setup.py @@ -4,11 +4,12 @@ from setuptools import setup from codecs import open from os import path -from steam import __version__ here = path.abspath(path.dirname(__file__)) with open(path.join(here, 'README.rst'), encoding='utf-8') as f: long_description = f.read() +with open(path.join(here, 'steam/__init__.py'), encoding='utf-8') as f: + __version__ = f.readline().split('"')[1] setup( name='steam', @@ -16,7 +17,7 @@ setup( description='Module for interacting with various Steam features', long_description=long_description, url='https://github.com/ValvePython/steam', - author='Rossen Georgiev', + author="Rossen Georgiev", author_email='hello@rgp.io', license='MIT', classifiers=[ From 4aa92007af79284afd7ed4adee25557b12898aee Mon Sep 17 00:00:00 2001 From: Rossen Georgiev Date: Wed, 22 Jul 2015 14:30:16 +0100 Subject: [PATCH 4/5] version bump v0.5.1 --- steam/__init__.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/steam/__init__.py b/steam/__init__.py index f1621d1..97af95f 100644 --- a/steam/__init__.py +++ b/steam/__init__.py @@ -1,5 +1,5 @@ -__version__ = "0.5" +__version__ = "0.5.1" __author__ = "Rossen Georgiev" -from .steamid import SteamID -from .webapi import WebAPI +from steam.steamid import SteamID +from steam.webapi import WebAPI From 9897c592e6cd04876a9e9d10e24e57f766f0cf86 Mon Sep 17 00:00:00 2001 From: Rossen Georgiev Date: Wed, 22 Jul 2015 15:05:32 +0100 Subject: [PATCH 5/5] WebAPI: fix set concatenation in python3 --- steam/webapi.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/steam/webapi.py b/steam/webapi.py index 87c58dc..b99b922 100644 --- a/steam/webapi.py +++ b/steam/webapi.py @@ -213,9 +213,8 @@ class WebAPIMethod(object): ) def __call__(self, **kwargs): - possible_kwargs = (set(self._dict['parameters'].keys() + ['key', 'format', 'raw'])) - call_kwargs = set(kwargs.keys()) - unrecognized = call_kwargs.difference(possible_kwargs) + possible_kwargs = set(self._dict['parameters'].keys()) | set(['key', 'format', 'raw']) + unrecognized = set(kwargs.keys()).difference(possible_kwargs) if unrecognized: raise ValueError("Unrecognized parameter %s" % repr(unrecognized.pop()))