Merge branch 'master' into develop

Author: billbsing

.github/workflows/deploy.yml

@@ -1,4 +1,4 @@
-name: deploy
+name: 🚀 Deploy Docs
 on:
   push:
     branches:
@@ -10,22 +10,22 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout
+    - name: 🛒 Checkout
       uses: actions/checkout@master
-    - name: Set up Python 3.8
+    - name: 🐍 Set up Python 3.10
       uses: actions/setup-python@v4
       with:
-        python-version: 3.8
-    - name: Install dependencies
+        python-version: '3.10'
+    - name: 🧰 Install dependencies
       run: make install IGNORE_VENV=1
-    - name: Build Docs
+    - name: 📚 Build Docs
       run: |
         make docs
         touch docs/build/html/.nojekyll
-    - name: Deploy Docs
+    - name: 🚀 Deploy Docs
       uses: peaceiris/[email protected]
       env:
-        PERSONAL_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+        PERSONAL_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         PUBLISH_BRANCH: gh-pages
         PUBLISH_DIR: docs/build/html
     #- name: Build Package

.github/workflows/testing.yml

@@ -1,19 +1,26 @@
-name: testing
+name: 🧪 Test
 
 on: [push]
 
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
-    - name: Set up Python 3.8
+    - name: 🛒 Checkout
+      uses: actions/checkout@v3
+    - name: 🐍 Set up Python 3.10
       uses: actions/setup-python@v4
       with:
-        python-version: 3.8
-    - name: Install dependencies
+        python-version: '3.10'
+    - name: 🧰 Install dependencies
       run: make install IGNORE_VENV=1
-    - name: Lint
+    - name: 👮 Lint
       run: make lint
-    - name: Test
+    - name: 🔍 Type check
+      uses: jakebailey/pyright-action@v1
+      with:
+        version: 1.1.317
+        python-version: '3.10'
+        warnings: true
+    - name: 🧪 Test
       run: make tests

.gitignore

@@ -6,3 +6,4 @@ build/
 dist/
 /.vscode/
 /.idea/
+/venv/

Makefile

@@ -7,7 +7,7 @@
 
 IGNORE_VENV ?= FALSE
 
-PACKAGE_FOLDERS = convex_api tools
+PACKAGE_FOLDERS = convex_api tools tests
 
 FLAKE8_PARAMETERS = --max-line-length=132 --statistics $(PACKAGE_FOLDERS)
 

README.md

@@ -1,6 +1,7 @@
 # Convex API
 
 ![](https://github.com/Convex-Dev/convex-api-py/workflows/testing/badge.svg)
+[![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
 
 [Documentation](https://convex-dev.github.io/convex-api-py)
 

convex_api/account.py

@@ -4,16 +4,16 @@
 
 
 """
+from __future__ import annotations
 
 import re
-from typing import Union
 from convex_api.key_pair import KeyPair
 
 
 class Account:
 
     @staticmethod
-    def is_address(text: Union[int, str]) -> bool:
+    def is_address(text: int | str) -> bool:
         """
         Returns True if the text value is a valid address.
 
@@ -25,9 +25,9 @@ def is_address(text: Union[int, str]) -> bool:
         return Account.to_address(text) >= 0
 
     @staticmethod
-    def to_address(value: Union['Account', int, str]) -> int:
+    def to_address(value: Account | int | str) -> int:
         """
-        Convert address text with possible leading '#' to an interger address value.
+        Convert address text with possible leading '#' to an integer address value.
 
         :param str text: Address text to convert
 
@@ -47,7 +47,7 @@ def to_address(value: Union['Account', int, str]) -> int:
                 raise ValueError(f'Invalid address {value}')
             return address
 
-    def __init__(self, key_pair: KeyPair, address: Union['Account', int, str], name: Union[str, None] = None):
+    def __init__(self, key_pair: KeyPair, address: Account | int | str, name: str | None = None):
         """
 
         Create a new account with a private key KeyPair.
@@ -133,7 +133,7 @@ def address(self) -> int:
         return self._address
 
     @address.setter
-    def address(self, value: Union['Account', int, str]) -> None:
+    def address(self, value: Account | int | str) -> None:
         """
 
         Sets the network address of this account
@@ -154,7 +154,7 @@ def address(self, value: Union['Account', int, str]) -> None:
         self._address = Account.to_address(value)
 
     @property
-    def name(self) -> Union[str, None]:
+    def name(self) -> str | None:
         return self._name
 
     @name.setter