Add makefile and ci cache (#4)

* Add makefile and ci cache

* Add style check

* Add miniconda incubator to ci

* Add dev reqs

* Add make install

* Move mypy and flake8 reqs out of setup.cfg

* Fix mypy and flake errors. Add isort check

* Remove double quotes plugin

* Add style checker - black

Author: roaffix

.flake8

@@ -0,0 +1,10 @@
+[flake8]
+application-import-names = arrayfire
+import-order-style = pep8
+inline-quotes = double
+max-line-length = 119
+
+
+exclude =
+    .venv/**
+    build/**

.github/workflows/ci.yml

@@ -1,5 +1,9 @@
 name: CI
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   pull_request:
     branches:
@@ -11,8 +15,13 @@ on:
 env:
   DEFAULT_PYTHON_VERSION: "3.8"
 
+defaults:
+  run:
+    shell: bash -l {0}
+
 jobs:
-  build:
+  style:
+    name: Style
     runs-on: ubuntu-latest
 
     steps:
@@ -25,12 +34,102 @@ jobs:
 
       - name: Install requirements
         run: |
-          pip install -r requirements.txt
+          grep -E '^black' dev-requirements.txt | xargs pip install
+
+      - name: Debug info
+        run: |
+          pip freeze
+
+      - name: Run black
+        run: |
+          black --check .
+
+  checks:
+    name: ${{ matrix.task.name }}
+    runs-on: ${{ matrix.task.runs_on }}
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        task:
+          - name: Lint
+            runs_on: ubuntu-latest
+            coverage_report: false
+            platform: cpu
+            run: |
+              make flake8
+              make import-sort
+              make typecheck
+
+          - name: CPU Tests
+            runs_on: ubuntu-latest
+            coverage_report: true
+            platform: cpu
+            run: make tests
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          miniconda-version: "latest"
+          python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
+
+      - name: Set build variables
+        run: |
+          # Get the exact Python version to use in the cache key.
+          echo "PYTHON_VERSION=$(python --version)" >> $GITHUB_ENV
+          echo "RUNNER_ARCH=$(uname -m)" >> $GITHUB_ENV
+          # Use week number in cache key so we can refresh the cache weekly.
+          echo "WEEK_NUMBER=$(date +%V)" >> $GITHUB_ENV
+
+      - uses: actions/cache@v3
+        id: virtualenv-cache
+        with:
+          path: .venv
+          key: >
+            ${{ env.CACHE_PREFIX }}-${{ env.WEEK_NUMBER }}-${{ runner.os }}-${{ env.RUNNER_ARCH }}-
+            ${{ env.PYTHON_VERSION }}-${{ matrix.task.platform }}-${{ hashFiles('setup.py') }}-
+            ${{ hashFiles('*requirements.txt') }}
+
+      - name: Setup virtual environment (no cache hit)
+        if: steps.virtualenv-cache.outputs.cache-hit != 'true'
+        run: |
+          python${{ env.DEFAULT_PYTHON_VERSION }} -m venv .venv
+          source .venv/bin/activate
+          make install
+
+      - name: Setup virtual environment (cache hit)
+        if: steps.virtualenv-cache.outputs.cache-hit == 'true'
+        run: |
+          source .venv/bin/activate
+          pip install --no-deps -e .[all]
 
       - name: Debug info
         run: |
+          source .venv/bin/activate
           pip freeze
 
-      - name: Run tests
+      - name: ${{ matrix.task.name }}
+        run: |
+          source .venv/bin/activate
+          ${{ matrix.task.run }}
+
+      - name: Prepare coverage report
+        if: matrix.task.coverage_report
+        run: |
+          mkdir coverage
+          mv coverage.xml coverage/
+
+      - name: Save coverage report
+        if: matrix.task.coverage_report
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ matrix.task.name }}-coverage
+          path: ./coverage
+
+      - name: Clean up
+        if: always()
         run: |
-          pytest .
+          source .venv/bin/activate
+          pip uninstall --yes arrayfire

.gitignore

@@ -9,7 +9,7 @@ dist/
 
 # dev tools
 
-venv/
+.venv/
 .vscode/
 
 

.isort.cfg

@@ -0,0 +1,3 @@
+[settings]
+line_length = 119
+multi_line_output = 4

Makefile

@@ -0,0 +1,53 @@
+SRC = arrayfire
+
+ifeq ($(shell uname),Darwin)
+ifeq ($(shell which gsed),)
+$(error Please install GNU sed with 'brew install gnu-sed')
+else
+SED = gsed
+endif
+else
+SED = sed
+endif
+
+.PHONY : version
+version : 
+	@python -c 'from arrayfire.version import VERSION; print(f"ArrayFire Python v{VERSION}")'
+
+.PHONY : install
+install :
+	pip install --upgrade pip
+	pip install pip-tools
+	pip-compile requirements.in -o final_requirements.txt --allow-unsafe --rebuild --verbose
+	pip install -e . -r final_requirements.txt
+
+# Testing
+
+.PHONY : flake8
+flake8 :
+	flake8 arrayfire tests examples
+
+.PHONY : import-sort
+import-sort :
+	isort arrayfire tests examples
+
+.PHONY : typecheck
+typecheck :
+	mypy arrayfire tests examples --cache-dir=/dev/null
+
+.PHONY : tests
+tests :
+	pytest --color=yes -v -rf --durations=40 \
+			--cov-config=.coveragerc \
+			--cov=$(SRC) \
+			--cov-report=xml
+
+# Cleaning
+
+.PHONY : clean
+clean :
+	rm -rf .pytest_cache/
+	rm -rf arrayfire.egg-info/
+	rm -rf dist/
+	rm -rf build/
+	find . | grep -E '(\.mypy_cache|__pycache__|\.pyc|\.pyo$$)' | xargs rm -rf

arrayfire/__init__.py

@@ -2,8 +2,19 @@
     # array objects
     "Array",
     # dtypes
-    "int16", "int32", "int64", "uint8", "uint16", "uint32", "uint64", "float32", "float64",
-    "complex64", "complex128", "bool"]
+    "int16",
+    "int32",
+    "int64",
+    "uint8",
+    "uint16",
+    "uint32",
+    "uint64",
+    "float32",
+    "float64",
+    "complex64",
+    "complex128",
+    "bool",
+]
 
 from .dtypes import bool, complex64, complex128, float32, float64, int16, int32, int64, uint8, uint16, uint32, uint64
 from .library.array_object import Array

arrayfire/backend/__init__.py

@@ -2,9 +2,44 @@
     # Backend
     "ArrayBuffer",
     # Operators
-    "add", "sub", "mul", "div", "mod", "pow", "bitnot", "bitand", "bitor", "bitxor", "bitshiftl", "bitshiftr", "lt",
-    "le", "gt", "ge", "eq", "neq"]
+    "add",
+    "sub",
+    "mul",
+    "div",
+    "mod",
+    "pow",
+    "bitnot",
+    "bitand",
+    "bitor",
+    "bitxor",
+    "bitshiftl",
+    "bitshiftr",
+    "lt",
+    "le",
+    "gt",
+    "ge",
+    "eq",
+    "neq",
+]
 
 from .backend import ArrayBuffer
 from .wrapped.operators import (
-    add, bitand, bitnot, bitor, bitshiftl, bitshiftr, bitxor, div, eq, ge, gt, le, lt, mod, mul, neq, pow, sub)
+    add,
+    bitand,
+    bitnot,
+    bitor,
+    bitshiftl,
+    bitshiftr,
+    bitxor,
+    div,
+    eq,
+    ge,
+    gt,
+    le,
+    lt,
+    mod,
+    mul,
+    neq,
+    pow,
+    sub,
+)

arrayfire/backend/backend.py

@@ -5,9 +5,9 @@
 from ..dtypes.helpers import c_dim_t, to_str
 
 # HACK for osx
-# backend_api = ctypes.CDLL("/opt/arrayfire//lib/libafcpu.3.dylib")
+backend_api = ctypes.CDLL("/opt/arrayfire//lib/libafcpu.3.dylib")
 # HACK for windows
-backend_api = ctypes.CDLL("C:/Program Files/ArrayFire/v3/lib/afcpu.dll")
+# backend_api = ctypes.CDLL("C:/Program Files/ArrayFire/v3/lib/afcpu.dll")
 
 
 def safe_call(c_err: int) -> None:

arrayfire/backend/wrapped/constant_array.py

@@ -17,8 +17,13 @@ def _constant_complex(number: Union[int, float], shape: Tuple[int, ...], dtype:
 
     safe_call(
         backend_api.af_constant_complex(
-            ctypes.pointer(out), ctypes.c_double(number.real), ctypes.c_double(number.imag), 4,
-            ctypes.pointer(c_shape.c_array), dtype.c_api_value)
+            ctypes.pointer(out),
+            ctypes.c_double(number.real),
+            ctypes.c_double(number.imag),
+            4,
+            ctypes.pointer(c_shape.c_array),
+            dtype.c_api_value,
+        )
     )
     return out
 
@@ -32,7 +37,8 @@ def _constant_long(number: Union[int, float], shape: Tuple[int, ...], dtype: Dty
 
     safe_call(
         backend_api.af_constant_long(
-            ctypes.pointer(out), ctypes.c_longlong(int(number.real)), 4, ctypes.pointer(c_shape.c_array))
+            ctypes.pointer(out), ctypes.c_longlong(int(number.real)), 4, ctypes.pointer(c_shape.c_array)
+        )
     )
     return out
 
@@ -47,7 +53,8 @@ def _constant_ulong(number: Union[int, float], shape: Tuple[int, ...], dtype: Dt
 
     safe_call(
         backend_api.af_constant_ulong(
-            ctypes.pointer(out), ctypes.c_ulonglong(int(number.real)), 4, ctypes.pointer(c_shape.c_array))
+            ctypes.pointer(out), ctypes.c_ulonglong(int(number.real)), 4, ctypes.pointer(c_shape.c_array)
+        )
     )
     return out
 
@@ -61,7 +68,8 @@ def _constant(number: Union[int, float], shape: Tuple[int, ...], dtype: Dtype, /
 
     safe_call(
         backend_api.af_constant(
-            ctypes.pointer(out), ctypes.c_double(number), 4, ctypes.pointer(c_shape.c_array), dtype.c_api_value)
+            ctypes.pointer(out), ctypes.c_double(number), 4, ctypes.pointer(c_shape.c_array), dtype.c_api_value
+        )
     )
     return out