Flake & Make

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+ignore = E203, E221, E241, E266, W291, E302, F403, F405, E501, W503, E741

.github/workflows/build.yml

@@ -6,10 +6,11 @@ on:
       - v**
     branches:
       - master
+
 jobs:
   build-test:
     runs-on: ubuntu-20.04
-    container: python:${{ matrix.python }}-slim
+    container: python:${{ matrix.python }}
     strategy:
       matrix:
         python: ['3.10']
@@ -20,15 +21,10 @@ jobs:
         with:
           fetch-depth: 0
       - name: Install pip dependencies
-        run: |
-          pip install -r requirements.txt
-          pip install -e .
+        run: make pip-development
       - name: Build and Test
-        run: |
-          python scripts/generate_init.py --check
-          black --check .
-          mypy pyteal
-          pytest
+        run: make build-and-test
+
   build-docset:
     runs-on: ubuntu-20.04
     container: python:3.10  # Needs `make`, can't be slim
@@ -38,21 +34,15 @@ jobs:
         with:
           fetch-depth: 0
       - name: Install pip dependencies
-        run: |
-          pip install -r requirements.txt
-          pip install -r docs/requirements.txt
-          pip install doc2dash
+        run: make pip-docs
       - name: Make docs
-        run: |
-          cd docs
-          make html
-          doc2dash --name pyteal --index-page index.html --online-redirect-url https://pyteal.readthedocs.io/en/ _build/html
-          tar -czvf pyteal.docset.tar.gz pyteal.docset
+        run: make docs
       - name: Archive docset
         uses: actions/upload-artifact@v2
         with:
           name: pyteal.docset
           path: docs/pyteal.docset.tar.gz
+
   upload-to-pypi:
     runs-on: ubuntu-20.04
     container: python:3.10
@@ -64,9 +54,9 @@ jobs:
         with:
           fetch-depth: 0
       - name: Install dependencies
-        run: pip install wheel
+        run: make pip-wheel
       - name: Build package
-        run: python setup.py sdist bdist_wheel
+        run: make bdist-wheel
       - name: Release
         uses: pypa/gh-action-pypi-publish@release/v1
         with:

.gitignore

@@ -1,5 +1,3 @@
-.DS_Store
-
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -54,8 +52,8 @@ coverage.xml
 .pytest_cache/
 
 # Tests generating TEAL output to compared against an expected example.
-tests/teal/*.teal
-!tests/teal/*_expected.teal
+tests/**/*.teal
+!tests/**/*_expected.teal
 
 # Translations
 *.mo
@@ -76,6 +74,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+pyteal.docset*
 
 # PyBuilder
 target/
@@ -133,3 +132,6 @@ dmypy.json
 # IDE
 .idea
 .vscode
+
+# mac OS
+.DS_Store

Makefile

@@ -0,0 +1,48 @@
+pip:
+	pip install -e .
+
+pip-development: pip
+	pip install -e.[development]
+
+pip-docs: pip-development
+	pip install -r docs/requirements.txt
+	pip install doc2dash
+
+pip-wheel:
+	pip install wheel
+
+bdist-wheel:
+	python setup.py sdist bdist_wheel
+
+docs:
+	cd docs && \
+	make html && \
+	doc2dash --name pyteal --index-page index.html --online-redirect-url https://pyteal.readthedocs.io/en/ _build/html && \
+	tar -czvf pyteal.docset.tar.gz pyteal.docset
+
+build:
+	python -m scripts.generate_init --check
+
+ALLPY = docs examples pyteal scripts tests *.py
+black:
+	black --check $(ALLPY)
+
+flake8:
+	flake8 $(ALLPY)
+
+MYPY = pyteal scripts
+mypy:
+	mypy $(MYPY)
+
+lint: black flake8 mypy
+
+test-unit:
+	pytest
+
+build-and-test: build lint test-unit
+
+# Extras:
+coverage:
+	pytest --cov-report html --cov=pyteal
+
+.PHONY: build docs

README.md

@@ -51,16 +51,19 @@ Active venv:
  * `. venv/bin/activate.fish` (if your shell is fish)
 
 Pip install PyTeal in editable state
- * `pip install -e .`
+ * `make pip`
 
 Install dependencies:
-* `pip install -r requirements.txt`
+* `make pip-development`
 
 Type checking using mypy:
-* `mypy pyteal`
+* `make mypy`
 
 Run tests:
-* `pytest`
+* `make test-unit`
 
 Format code:
-* `black .`
+* `make black`
+
+Lint using flake8:
+* `make flake8`

examples/application/vote_deploy.py

@@ -1,7 +1,6 @@
 # based off https://github.com/algorand/docs/blob/cdf11d48a4b1168752e6ccaf77c8b9e8e599713a/examples/smart_contracts/v2/python/stateful_smart_contracts.py
 
 import base64
-import datetime
 
 from algosdk.future import transaction
 from algosdk import account, mnemonic

examples/signature/periodic_payment_deploy.py

@@ -1,9 +1,13 @@
 #!/usr/bin/env python3
 
-from pyteal import *
-import uuid, params, base64
+import base64
+import params
+import uuid
+
 from algosdk import algod, transaction, account, mnemonic
-from periodic_payment import periodic_payment, tmpl_amt
+from periodic_payment import periodic_payment
+
+from pyteal import *
 
 # --------- compile & send transaction using Goal and Python SDK ----------
 

examples/signature/recurring_swap_deploy.py

@@ -1,11 +1,19 @@
 #!/usr/bin/env python3
 
-from pyteal import *
+import base64
 from nacl import encoding, hash
-from recurring_swap import recurring_swap, tmpl_provider
-from algosdk import algod, account
+import params
+import re
+import time
+import uuid
+
+from algosdk import algod
 from algosdk.future import transaction
-import uuid, params, re, base64, time
+
+from pyteal import *
+
+from recurring_swap import recurring_swap
+
 
 # ------- generate provider's account -----------------------------------------------
 key_fn = str(uuid.uuid4()) + ".key"

pyteal/__init__.py

@@ -1,6 +1,6 @@
-from .ast import *
+from .ast import *  # noqa: F401
 from .ast import __all__ as ast_all
-from .ir import *
+from .ir import *  # noqa: F401
 from .ir import __all__ as ir_all
 from .compiler import (
     MAX_TEAL_VERSION,

pyteal/__init__.pyi

@@ -1,9 +1,9 @@
 ## File generated from scripts/generate_init.py.
 ## DO NOT EDIT DIRECTLY
 
-from .ast import *
+from .ast import *  # noqa: F401
 from .ast import __all__ as ast_all
-from .ir import *
+from .ir import *  # noqa: F401
 from .ir import __all__ as ir_all
 from .compiler import (
     MAX_TEAL_VERSION,

pyteal/ast/acct.py

@@ -1,13 +1,8 @@
-from typing import TYPE_CHECKING
-
 from ..types import TealType, require_type
 from ..ir import Op
 from .expr import Expr
 from .maybe import MaybeValue
 
-if TYPE_CHECKING:
-    from ..compiler import CompileOptions
-
 
 class AccountParam:
     @classmethod

pyteal/ast/acct_test.py

@@ -1,5 +1,3 @@
-import pytest
-
 from .. import *
 
 # this is not necessary but mypy complains if it's not included

pyteal/ast/asset.py

@@ -1,9 +1,6 @@
-from enum import Enum
-
 from ..types import TealType, require_type
 from ..ir import Op
 from .expr import Expr
-from .leafexpr import LeafExpr
 from .maybe import MaybeValue
 
 

pyteal/ast/cond.py

@@ -4,8 +4,6 @@
 from ..ir import TealOp, Op, TealSimpleBlock, TealConditionalBlock
 from ..errors import TealInputError
 from .expr import Expr
-from .err import Err
-from .if_ import If
 
 if TYPE_CHECKING:
     from ..compiler import CompileOptions

pyteal/ast/err_test.py

@@ -1,5 +1,3 @@
-import pytest
-
 from .. import *
 
 

pyteal/ast/for_.py

@@ -4,8 +4,6 @@
 from ..ir import TealSimpleBlock, TealConditionalBlock
 from ..errors import TealCompileError
 from .expr import Expr
-from .seq import Seq
-from .int import Int
 
 if TYPE_CHECKING:
     from ..compiler import CompileOptions

pyteal/ast/gitxn.py

@@ -6,7 +6,6 @@
 from ..ir import TealOp, Op, TealBlock
 from .expr import Expr
 from .txn import TxnExpr, TxnField, TxnObject, TxnaExpr
-from ..types import require_type, TealType
 
 if TYPE_CHECKING:
     from ..compiler import CompileOptions

pyteal/ast/if_.py

@@ -1,7 +1,7 @@
 from typing import TYPE_CHECKING
 
 from ..errors import TealCompileError, TealInputError
-from ..types import TealType, require_type, types_match
+from ..types import TealType, require_type
 from ..ir import TealSimpleBlock, TealConditionalBlock
 from .expr import Expr
 

pyteal/ast/itxn_test.py

@@ -4,7 +4,7 @@
 from ..types import types_match
 
 # this is not necessary but mypy complains if it's not included
-from .. import MAX_GROUP_SIZE, CompileOptions
+from .. import CompileOptions
 
 teal4Options = CompileOptions(version=4)
 teal5Options = CompileOptions(version=5)

pyteal/ast/maybe.py

@@ -1,4 +1,4 @@
-from typing import List, Union, TYPE_CHECKING
+from typing import List, Union
 
 from pyteal.ast.multi import MultiValue
 
@@ -7,9 +7,6 @@
 from .expr import Expr
 from .scratch import ScratchLoad, ScratchSlot
 
-if TYPE_CHECKING:
-    from ..compiler import CompileOptions
-
 
 class MaybeValue(MultiValue):
     """Represents a get operation returning a value that may not exist."""

pyteal/ast/maybe_test.py

@@ -1,5 +1,3 @@
-import pytest
-
 from .. import *
 
 # this is not necessary but mypy complains if it's not included

pyteal/ast/methodsig.py

@@ -3,7 +3,6 @@
 
 from pyteal.types import TealType
 
-from ..types import TealType
 from ..ir import TealOp, Op, TealBlock
 from .leafexpr import LeafExpr
 

pyteal/ast/multi_test.py

@@ -1,6 +1,8 @@
 from typing import List
 
-from .. import *
+from pyteal import *
+from pyteal.ast import *
+from pyteal.ir import *
 
 options = CompileOptions()
 
@@ -168,15 +170,17 @@ def test_multi_value():
                     )
                     __test_single_conditional(expr, op, args, iargs, reducer)
 
-                    reducer = lambda value, hasValue: Seq(Assert(hasValue), value)
+                    reducer = lambda value, hasValue: Seq(  # noqa: E731
+                        Assert(hasValue), value
+                    )
                     expr = MultiValue(
                         op, [type, TealType.uint64], immediate_args=iargs, args=args
                     )
                     __test_single_assert(expr, op, args, iargs, reducer)
 
                     hasValueVar = ScratchVar(TealType.uint64)
                     valueVar = ScratchVar(type)
-                    reducer = lambda value, hasValue: Seq(
+                    reducer = lambda value, hasValue: Seq(  # noqa: E731
                         hasValueVar.store(hasValue), valueVar.store(value)
                     )
                     expr = MultiValue(