Merge pull request #83 from OpenXbox/fix/py3.7+_compat

Feat: Python 3.7+ compatibility

Author: tuxuser

.pre-commit-config.yaml

@@ -1,27 +1,27 @@
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.7.2
+    rev: v2.20.0
     hooks:
       - id: pyupgrade
         args: [--py36-plus]
   - repo: https://github.com/psf/black
-    rev: 20.8b1
+    rev: 22.10.0
     hooks:
       - id: black
         args:
           - --safe
           - --quiet
         files: ^((xbox|tests)/.+)?[^/]+\.py$
   - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.8.3
+    rev: 5.0.4
     hooks:
       - id: flake8
         additional_dependencies:
           # - flake8-docstrings==1.5.0
           - pydocstyle==5.1.1
         files: ^(xbox)/.+\.py$
   - repo: https://github.com/PyCQA/bandit
-    rev: 1.6.2
+    rev: 1.7.4
     hooks:
       - id: bandit
         args:
@@ -30,7 +30,7 @@ repos:
           - --configfile=bandit.yaml
         files: ^(xbox|tests)/.+\.py$
   - repo: https://github.com/PyCQA/isort
-    rev: 5.5.3
+    rev: 5.10.1
     hooks:
       - id: isort
   - repo: https://github.com/pre-commit/pre-commit-hooks

Dockerfile

@@ -2,7 +2,7 @@
 
 #########################################
 # Image WITH C compiler, building wheels for next stage
-FROM python:3.6-alpine as bigimage
+FROM python:3.10-alpine as bigimage
 
 ENV LANG C.UTF-8
 
@@ -17,7 +17,7 @@ RUN pip wheel --wheel-dir=/root/wheels /src/xbox-webapi
 
 #########################################
 # Image WITHOUT C compiler, installing the component from wheel
-FROM python:3.6-alpine as smallimage
+FROM python:3.10-alpine as smallimage
 
 RUN apk add --no-cache openssl
 

README.md

@@ -19,7 +19,7 @@ Authentication is supported via OAuth2.
 
 ## Dependencies
 
-- Python >= 3.6
+- Python >= 3.7
 - Libraries: aiohttp, appdirs, ms_cv, pydantic, urwid, yarl, ecdsa
 
 ## How to use
@@ -32,19 +32,18 @@ pip install xbox-webapi
 
 Authentication
 
-```text
-# Note: you must use non child account (> 18 years old)
-# 
-# Token save location: If tokenfile is not provided via cmdline, fallback
-# of <appdirs.user_data_dir>/tokens.json is used as save-location
-#
-# Specifically:
-# Windows: C:\\Users\\<username>\\AppData\\Local\\OpenXbox\\xbox
-# Mac OSX: /Users/<username>/Library/Application Support/xbox/tokens.json
-# Linux: /home/<username>/.local/share/xbox
-#
-# For more information, see: https://pypi.org/project/appdirs and module: xbox.webapi.scripts.constants
+**Note: You must use non child account (> 18 years old)**
+
+Token save location: If tokenfile is not provided via cmdline, fallback of `<appdirs.user_data_dir>/tokens.json` is used as save-location
+
+Specifically:
+Windows: `C:\\Users\\<username>\\AppData\\Local\\OpenXbox\\xbox`
+Mac OSX: `/Users/<username>/Library/Application Support/xbox/tokens.json`
+Linux: `/home/<username>/.local/share/xbox`
+
+For more information, see: <https://pypi.org/project/appdirs> and module: `xbox.webapi.scripts.constants`
 
+```
 xbox-authenticate --client-id <client-id> --client-secret <client-secret>
 ```
 
@@ -60,19 +59,22 @@ API usage
 ```py
 import sys
 import asyncio
-from aiohttp import ClientSession
+from aiohttp import ClientSession, ClientResponseError
 from xbox.webapi.api.client import XboxLiveClient
 from xbox.webapi.authentication.manager import AuthenticationManager
 from xbox.webapi.authentication.models import OAuth2TokenResponse
-from xbox.webapi.common.exceptions import AuthenticationException
-from xbox import *
-client_id = 'YOUR CLIENT ID HERE'
-client_secret = 'YOUR CLIENT SECRET HERE'
+from xbox.webapi.scripts import CLIENT_ID, CLIENT_SECRET, TOKENS_FILE
+
+# This uses the default client identification by OpenXbox
+# Feel free to use your own here
+client_id = CLIENT_ID
+client_secret = CLIENT_SECRET
+tokens_file = TOKENS_FILE
+
 """
 For doing authentication, see xbox/webapi/scripts/authenticate.py
 """
 async def async_main():
-    tokens_file = "./tokens.json" # replace with path in auth scrip or just paste file with tokens here
     async with ClientSession() as session:
         auth_mgr = AuthenticationManager(
               session, client_id, client_secret, ""

pyproject.toml

@@ -1,3 +1,3 @@
 [tool.black]
-target-version = ["py36", "py37", "py38"]
+target-version = ["py37", "py38", "py39", "py310", "py311"]
 exclude = 'generated'

readme_example.py

@@ -1,19 +1,21 @@
-# this is just script from README.md
 import sys
 import asyncio
-from aiohttp import ClientSession
+from aiohttp import ClientSession, ClientResponseError
 from xbox.webapi.api.client import XboxLiveClient
 from xbox.webapi.authentication.manager import AuthenticationManager
 from xbox.webapi.authentication.models import OAuth2TokenResponse
-from xbox.webapi.common.exceptions import AuthenticationException
-from xbox import *
-client_id = 'YOUR CLIENT ID HERE'
-client_secret = 'YOUR CLIENT SECRET HERE'
+from xbox.webapi.scripts import CLIENT_ID, CLIENT_SECRET, TOKENS_FILE
+
+# This uses the default client identification by OpenXbox
+# Feel free to use your own here
+client_id = CLIENT_ID
+client_secret = CLIENT_SECRET
+tokens_file = TOKENS_FILE
+
 """
 For doing authentication, see xbox/webapi/scripts/authenticate.py
 """
 async def async_main():
-    tokens_file = "./tokens.json" # replace with path in auth scrip or just paste file with tokens here
     async with ClientSession() as session:
         auth_mgr = AuthenticationManager(
               session, client_id, client_secret, ""

requirements.txt

@@ -8,7 +8,6 @@ urwid
 yarl
 
 # aiohttp speedups
-cchardet
 aiodns
 
 # Dev
@@ -18,11 +17,11 @@ pylint
 aresponses
 
 # pre-commit
-pre-commit==2.7.1
-pyupgrade==2.7.2
-black==20.8b1
-flake8==3.8.3
+pre-commit==2.20.0
+pyupgrade==3.2.0
+black==22.10.0
+flake8==5.0.4
 # flake8-docstrings==1.5.0
-pydocstyle==5.1.1
-bandit==1.6.2
-isort==5.5.3
+pydocstyle==6.1.1
+bandit==1.7.4
+isort==5.10.1

setup.py

@@ -23,9 +23,11 @@
         "License :: OSI Approved :: MIT License",
         "Topic :: Software Development :: Libraries :: Python Modules",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
     ],
     test_suite="tests",
     install_requires=[

tests/conftest.py

@@ -4,6 +4,7 @@
 
 from aiohttp import ClientSession
 import pytest
+import pytest_asyncio
 
 from xbox.webapi.api.client import XboxLiveClient
 from xbox.webapi.authentication.manager import AuthenticationManager
@@ -19,7 +20,7 @@
 collect_ignore = ["setup.py"]
 
 
-@pytest.fixture(scope="function")
+@pytest_asyncio.fixture(scope="function")
 async def auth_mgr(event_loop):
     session = ClientSession(loop=event_loop)
     mgr = AuthenticationManager(session, "abc", "123", "http://localhost")
@@ -32,4 +33,4 @@ async def auth_mgr(event_loop):
 
 @pytest.fixture(scope="function")
 def xbl_client(auth_mgr):
-    yield XboxLiveClient(auth_mgr)
+    return XboxLiveClient(auth_mgr)

xbox/webapi/authentication/manager.py

@@ -111,7 +111,6 @@ async def _oauth2_token_request(self, data: dict) -> OAuth2TokenResponse:
         resp = await self.session.post(
             "https://login.live.com/oauth20_token.srf", data=data
         )
-        # print(await resp.content.read())
         resp.raise_for_status()
         return OAuth2TokenResponse.parse_raw(await resp.text())
 

xbox/webapi/scripts/authenticate.py

@@ -29,10 +29,9 @@ async def auth_callback(request):
     )
 
 
-async def async_main(
+async def do_auth(
     client_id: str, client_secret: str, redirect_uri: str, token_filepath: str
 ):
-
     async with ClientSession() as session:
         auth_mgr = AuthenticationManager(
             session, client_id, client_secret, redirect_uri
@@ -53,10 +52,11 @@ async def async_main(
             await auth_mgr.request_tokens(code)
 
         with open(token_filepath, mode="w") as f:
+            print(f"Finished authentication, writing tokens to {token_filepath}")
             f.write(auth_mgr.oauth.json())
 
 
-def main():
+async def async_main():
     parser = argparse.ArgumentParser(description="Authenticate with XBL")
     parser.add_argument(
         "--tokens",
@@ -82,21 +82,16 @@ def main():
         default=os.environ.get("REDIRECT_URI", REDIRECT_URI),
         help="OAuth2 Redirect URI",
     )
-
     args = parser.parse_args()
-
     app = web.Application()
     app.add_routes([web.get("/auth/callback", auth_callback)])
     runner = web.AppRunner(app)
 
-    loop = asyncio.get_event_loop()
-    loop.run_until_complete(runner.setup())
+    await runner.setup()
     site = web.TCPSite(runner, "localhost", 8080)
-    loop.run_until_complete(site.start())
-    loop.run_until_complete(
-        async_main(args.client_id, args.client_secret, args.redirect_uri, args.tokens)
-    )
+    await site.start()
+    await do_auth(args.client_id, args.client_secret, args.redirect_uri, args.tokens)
 
 
 if __name__ == "__main__":
-    main()
+    asyncio.run(async_main())