Add dataclasses, sync/async, feature-parity with the js-client and tests

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+omit =
+    build_sync.py
+    conftest.py
+    tests/*

.devcontainer/Dockerfile

@@ -0,0 +1,21 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.203.0/containers/python-3/.devcontainer/base.Dockerfile
+
+# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster
+ARG VARIANT="3.10-bullseye"
+FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image.
+# COPY requirements.txt /tmp/pip-tmp/
+# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \
+#    && rm -rf /tmp/pip-tmp
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

.devcontainer/devcontainer.json

@@ -0,0 +1,81 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.203.0/containers/python-3
+{
+	"name": "Python 3",
+	"runArgs": [
+		"--init"
+	],
+	"build": {
+		"dockerfile": "Dockerfile",
+		"context": "..",
+		"args": {
+			// Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6
+			// Append -bullseye or -buster to pin to an OS version.
+			// Use -bullseye variants on local on arm64/Apple Silicon.
+			"VARIANT": "3.10-bullseye",
+			// Options
+			"NODE_VERSION": "lts/*"
+		}
+	},
+	// Set *default* container specific settings.json values on container create.
+	"settings": {
+		"python.pythonPath": "/usr/local/bin/python",
+		"python.languageServer": "Pylance",
+		"python.linting.enabled": true,
+		"python.linting.flake8Enabled": true,
+		"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+		"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+		"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+		"python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+		"python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+		"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+		"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+		"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+		"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint",
+		"python.analysis.diagnosticMode": "workspace",
+		"files.exclude": {
+			"**/.ipynb_checkpoints": true,
+			"**/.pytest_cache": true,
+			"**/*pycache*": true
+		},
+		"python.formatting.provider": "black",
+		"python.linting.flake8Args": [
+			"--max-line-length=88",
+			"--extend-ignore=E203"
+		],
+		"editor.formatOnSave": true,
+		"editor.codeActionsOnSave": {
+			"source.organizeImports": true
+		},
+		"python.sortImports.args": [
+			"--multi-line=3",
+			"--trailing-comma",
+			"--force-grid-wrap=0",
+			"--use-parentheses",
+			"--line-width=88",
+		]
+	},
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"ms-python.python",
+		"ms-python.vscode-pylance",
+		"ms-azuretools.vscode-docker",
+		"donjayamanne.githistory",
+		"felipecaputo.git-project-manager",
+		"github.copilot-nightly",
+		"eamodio.gitlens",
+		"davidanson.vscode-markdownlint"
+	],
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "pip3 install --user -r requirements.txt",
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode",
+	"features": {
+		"docker-in-docker": "latest",
+		"git": "latest",
+		"git-lfs": "latest",
+		"github-cli": "latest"
+	}
+}

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    target-branch: "main"

.github/workflows/ci.yml

@@ -1,47 +1,32 @@
 name: CI
 
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-  workflow_dispatch:
+on: [pull_request, push, workflow_dispatch]
 
 jobs:
   test:
-    name: Test / OS ${{ matrix.os }} / Node ${{ matrix.node }}
+    name: Test / OS ${{ matrix.os }} / Python ${{ matrix.python-version }}
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: [3.7, 3.8, 3.9, '3.10']
     runs-on: ${{ matrix.os }}
     # TODO(fedden): We need to discuss these steps: We could just use a test-supabase instance or we could update the docker image and use that for the tests.
     steps:
-    - uses: actions/checkout@v2
+    - name: Clone Repository
+      uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install flake8 pytest requests
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Login to Docker Hub
-      uses: docker/login-action@v1
+    - name: Set up Poetry
+      uses: abatilo/actions-poetry@v2.1.4
       with:
-        username: ${{ secrets.DOCKER_HUB_USERNAME }}
-        password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+        poetry-version: 1.1.11
     - name: Build Docker image
-      run: |
-        cd infra
-        docker-compose down
-        docker-compose up -d
+      run: make run_infra
     - name: Sleep for 5 seconds
-      uses: jakejarvis/wait-action@master
-      with:
-        time: "5s"
-    - name: Test with pytest
-      run: |
-        pytest -sx
-
+      run: sleep 5
+    - name: Run Tests
+      run: make tests
+    - name: Upload Coverage
+      uses: codecov/codecov-action@v1

.pre-commit-config.yaml

@@ -0,0 +1,46 @@
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v4.0.1
+      hooks:
+          - id: trailing-whitespace
+          - id: check-added-large-files
+          - id: end-of-file-fixer
+          - id: mixed-line-ending
+            args: ["--fix=lf"]
+
+    - repo: https://github.com/pycqa/isort
+      rev: 5.10.1
+      hooks:
+          - id: isort
+            args:
+                [
+                    "--profile",
+                    "black",
+                    "--multi-line=3",
+                    "--trailing-comma",
+                    "--force-grid-wrap=0",
+                    "--use-parentheses",
+                    "--line-width=88",
+                ]
+
+    - repo: https://github.com/myint/autoflake.git
+      rev: v1.4
+      hooks:
+          - id: autoflake
+            args:
+                [
+                    "--in-place",
+                    "--remove-all-unused-imports",
+                    "--ignore-init-module-imports",
+                ]
+
+    - repo: https://github.com/ambv/black
+      rev: 21.11b0
+      hooks:
+          - id: black
+
+    - repo: https://github.com/asottile/pyupgrade
+      rev: v2.29.1
+      hooks:
+          - id: pyupgrade
+            args: ["--py37-plus", "--keep-runtime-typing"]

Makefile

@@ -0,0 +1,28 @@
+install:
+	poetry install
+
+install_poetry:
+	curl -sSL https://install.python-poetry.org | python -
+	sudo rm -r .venv
+	poetry install
+
+tests: install tests_only tests_pre_commit
+
+tests_pre_commit:
+	poetry run pre-commit run --all-files
+
+tests_only:
+	poetry run pytest --cov=./ --cov-report=xml -vv
+
+run_infra:
+	cd infra &&\
+	docker-compose down &&\
+	docker-compose up -d
+
+run_tests: run_infra tests
+
+build_sync:
+	poetry run unasync gotrue tests
+
+build_run_tests: build_sync run_tests
+	echo "Done"

README.md

@@ -1,10 +1,10 @@
 # Gotrue-py
 
-This is a Python port of the [supabase js gotrue client](https://github.com/supabase/gotrue-js). The current status is that there is not complete feature pairity when compared with the js-client, but this something we are working on.
+This is a Python port of the [supabase js gotrue client](https://github.com/supabase/gotrue-js). The current state is that there is a features parity but with small differences that are mentioned in the section **Differences to the JS client**.
 
 ## Installation
 
-We are still working on making the go-true python library more user-friendly. For now here are some sparse notes on how to install the module
+We are still working on making the `gotrue` python library more user-friendly. For now here are some sparse notes on how to install the module.
 
 ### Poetry
 
@@ -34,9 +34,13 @@ const { data, error } = client.sign_up(...)
 
 The other key difference is we do not use pascalCase to encode variable and method names. Instead we use the snake_case convention adopted in the Python language.
 
-## Usage
+Also, the `gotrue` library for Python parses the date-time string into `datetime` Python objects. The [JS client](https://github.com/supabase/gotrue-js) keeps the date-time as strings.
 
-To instanciate the client, you'll need the URL and any request headers at a minimum.
+## Usage (outdated)
+
+**Important:** This section is outdated, you can be guided by the [JS client documentation](https://supabase.github.io/gotrue-js) because this Python client has a lot of parity with the JS client.
+
+To instantiate the client, you'll need the URL and any request headers at a minimum.
 
 ```python
 from gotrue import Client
@@ -77,23 +81,9 @@ assert client.user() is not None
 assert client.session() is not None
 ```
 
-## Tests
-
-At the moment we use a pre-defined supabase instance to test the functionality. This may change over time. You can run the tests like so:
-
-```bash
-SUPABASE_TEST_KEY="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYW5vbiIsImlhdCI6MTYxMjYwOTMyMiwiZXhwIjoxOTI4MTg1MzIyfQ.XL9W5I_VRQ4iyQHVQmjG0BkwRfx6eVyYB3uAKcesukg" \
-SUPABASE_TEST_URL="https://tfsatoopsijgjhrqplra.supabase.co" \
-pytest -sx
-```
-
 ## Contributions
 
 We would be immensely grateful for any contributions to this project. In particular are the following items:
 
-- [x] Figure out to use either Sessions to manage headers or allow passing in of headers
-- [ ] Add documentation.
-- [ ] Add more tests.
-- [ ] Ensuring feature-parity with the js-client.
-- [ ] Supporting 3rd party provider authentication.
-- [ ] Implement a js port of setTimeout for the refresh session code.
+- Add documentation
+- Update `README.md`

conftest.py

@@ -1,7 +1,9 @@
 from typing import Dict, Tuple
+
 import pytest
 
-# store history of failures per test class name and per index in parametrize (if parametrize used)
+# store history of failures per test class name and per index
+# in parametrize (if parametrize used)
 _test_failed_incremental: Dict[str, Dict[Tuple[int, ...], str]] = {}
 
 
@@ -12,14 +14,19 @@ def pytest_runtest_makereport(item, call):
             # the test has failed
             # retrieve the class name of the test
             cls_name = str(item.cls)
-            # retrieve the index of the test (if parametrize is used in combination with incremental)
-            parametrize_index = (tuple(item.callspec.indices.values())
-                                 if hasattr(item, "callspec") else ())
+            # retrieve the index of the test (if parametrize is used
+            # in combination with incremental)
+            parametrize_index = (
+                tuple(item.callspec.indices.values())
+                if hasattr(item, "callspec")
+                else ()
+            )
             # retrieve the name of the test function
             test_name = item.originalname or item.name
             # store in _test_failed_incremental the original name of the failed test
             _test_failed_incremental.setdefault(cls_name, {}).setdefault(
-                parametrize_index, test_name)
+                parametrize_index, test_name
+            )
 
 
 def pytest_runtest_setup(item):
@@ -28,12 +35,17 @@ def pytest_runtest_setup(item):
         cls_name = str(item.cls)
         # check if a previous test has failed for this class
         if cls_name in _test_failed_incremental:
-            # retrieve the index of the test (if parametrize is used in combination with incremental)
-            parametrize_index = (tuple(item.callspec.indices.values())
-                                 if hasattr(item, "callspec") else ())
-            # retrieve the name of the first test function to fail for this class name and index
-            test_name = _test_failed_incremental[cls_name].get(
-                parametrize_index, None)
-            # if name found, test has failed for the combination of class name & test name
+            # retrieve the index of the test (if parametrize is used
+            # in combination with incremental)
+            parametrize_index = (
+                tuple(item.callspec.indices.values())
+                if hasattr(item, "callspec")
+                else ()
+            )
+            # retrieve the name of the first test function to
+            # fail for this class name and index
+            test_name = _test_failed_incremental[cls_name].get(parametrize_index, None)
+            # if name found, test has failed for the combination of
+            # class name & test name
             if test_name is not None:
-                pytest.xfail("previous test failed ({})".format(test_name))
+                pytest.xfail(f"previous test failed ({test_name})")