pre-commit config added

github actions updated

py3.12 enabled in tests

Author: ml31415

.github/workflows/ci.yaml

@@ -27,9 +27,9 @@ jobs:
         os: ["ubuntu-latest"]
         python-version: ["3.9", "3.10", "3.11", "3.12"]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
-          fetch-depth: 10 # Fetch all history for all branches and tags.
+          fetch-depth: 1
       - name: Set environment variables
         run: |
           echo "CONDA_ENV_FILE=ci/environment.yml" >> $GITHUB_ENV
@@ -49,7 +49,7 @@ jobs:
       # We only want to install this on one run, because otherwise we'll have
       # duplicate annotations.
       - name: Install error reporter
-        if: ${{ matrix.os }} == 'ubuntu-latest' and ${{ matrix.python-version }} == '3.10'
+        if: ${{ matrix.os }} == 'ubuntu-latest' and ${{ matrix.python-version }} == '3.11'
         run: |
           python -m pip install pytest-github-actions-annotate-failures
 

.github/workflows/pypi-release.yaml

@@ -12,13 +12,13 @@ jobs:
     runs-on: ubuntu-latest
     if: github.repository == 'ml31415/numpy-groupies'
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         name: Install Python
         with:
-          python-version: "3.10"
+          python-version: "3.11"
 
       - name: Install dependencies
         run: |
@@ -39,7 +39,7 @@ jobs:
           else
             echo "✅ Looks good"
           fi
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: releases
           path: dist
@@ -48,11 +48,11 @@ jobs:
     needs: build-artifacts
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         name: Install Python
         with:
-          python-version: "3.10"
-      - uses: actions/download-artifact@v3
+          python-version: "3.11"
+      - uses: actions/download-artifact@v4
         with:
           name: releases
           path: dist
@@ -80,7 +80,7 @@ jobs:
     if: github.event_name == 'release'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: releases
           path: dist
@@ -89,4 +89,4 @@ jobs:
         with:
           user: __token__
           password: ${{ secrets.PYPI_TOKEN }}
-          verbose: true
+          verbose: true

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: debug-statements
+      - id: detect-private-key
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+        exclude: (.pre-commit-config\.yaml)
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.7
+    hooks:
+      - id: ruff
+      - id: ruff-format
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell

README.md

@@ -1,8 +1,7 @@
 [![GitHub Workflow CI Status](https://img.shields.io/github/actions/workflow/status/ml31415/numpy-groupies/ci.yaml?branch=master&logo=github&style=flat)](https://github.com/ml31415/numpy-groupies/actions)
 [![PyPI](https://img.shields.io/pypi/v/numpy-groupies.svg?style=flat)](https://pypi.org/project/numpy-groupies/)
 [![Conda-forge](https://img.shields.io/conda/vn/conda-forge/numpy_groupies.svg?style=flat)](https://anaconda.org/conda-forge/numpy_groupies)
-[![Supported Versions](https://img.shields.io/pypi/pyversions/numpy-groupies.svg)](https://pypi.org/project/numpy-groupies)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fml31415%2Fnumpy-groupies%2Fmaster%2Fpyproject.toml)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/numpy-groupies)
 
 # numpy-groupies

numpy_groupies/benchmarks/generic.py

@@ -91,7 +91,10 @@ def benchmark_data(size=5e5, seed=100):
 def benchmark(implementations, repeat=5, size=5e5, seed=100, raise_errors=False):
     a, nana, group_idx = benchmark_data(size=size, seed=seed)
 
-    print("function" + "".join(impl.__name__.rsplit("_", 1)[1].rjust(14) for impl in implementations))
+    print(
+        "function"
+        + "".join(impl.__name__.rsplit("_", 1)[1].rjust(14) for impl in implementations)
+    )
     print("-" * (9 + 14 * len(implementations)))
     for func in func_list:
         func_name = getattr(func, "__name__", func)
@@ -122,9 +125,9 @@ def benchmark(implementations, repeat=5, size=5e5, seed=100, raise_errors=False)
                     print("FAIL".rjust(14), end="")
                 else:
                     t0 = min(
-                        timeit.Timer(lambda: aggregatefunc(group_idx, used_a, func=func)).repeat(
-                            repeat=repeat, number=1
-                        )
+                        timeit.Timer(
+                            lambda: aggregatefunc(group_idx, used_a, func=func)
+                        ).repeat(repeat=repeat, number=1)
                     )
                     print(f"{t0 * 1000:.3f}".rjust(14), end="")
             sys.stdout.flush()
@@ -147,6 +150,10 @@ def benchmark(implementations, repeat=5, size=5e5, seed=100, raise_errors=False)
 
 
 if __name__ == "__main__":
-    implementations = _implementations if "--purepy" in sys.argv else _implementations[1:]
-    implementations = implementations if "--pandas" in sys.argv else implementations[:-1]
+    implementations = (
+        _implementations if "--purepy" in sys.argv else _implementations[1:]
+    )
+    implementations = (
+        implementations if "--pandas" in sys.argv else implementations[:-1]
+    )
     benchmark(implementations, raise_errors=False)

numpy_groupies/benchmarks/simple.py

@@ -28,7 +28,9 @@ def aggregate_group_loop(*args, **kwargs):
 print("aggregate(test_group_idx, test_a, sz=8, func='min', fill_value=np.nan):")
 print(aggregate_np(test_group_idx, test_a, size=8, func="min", fill_value=np.nan))
 # array([3.2, -15., nan, 88., nan, nan, nan, nan])
-print("aggregate_py(test_group_idx, test_a, sz=5, func=lambda x: ' + '.join(str(xx) for xx in x),fill_value='')")
+print(
+    "aggregate_py(test_group_idx, test_a, sz=5, func=lambda x: ' + '.join(str(xx) for xx in x),fill_value='')"
+)
 print(
     aggregate_py(
         test_group_idx,
@@ -43,7 +45,10 @@ def aggregate_group_loop(*args, **kwargs):
 print("")
 print("---------testing--------------")
 print("compare against group-and-loop with numpy")
-testable_funcs = {aliasing[f]: f for f in (np.sum, np.prod, np.any, np.all, np.min, np.max, np.std, np.var, np.mean)}
+testable_funcs = {
+    aliasing[f]: f
+    for f in (np.sum, np.prod, np.any, np.all, np.min, np.max, np.std, np.var, np.mean)
+}
 test_group_idx = np.random.randint(0, int(1e3), int(1e5))
 test_a = np.random.rand(int(1e5)) * 100 - 50
 test_a[test_a > 25] = 0  # for use with bool functions
@@ -73,7 +78,9 @@ def aggregate_group_loop(*args, **kwargs):
 
 print("")
 print("----------benchmarking-------------")
-print("Note that the actual observed speedup depends on a variety of properties of the input.")
+print(
+    "Note that the actual observed speedup depends on a variety of properties of the input."
+)
 print("Here we are using 100,000 indices uniformly picked from [0, 1000).")
 print("Specifically, about 25% of the values are 0 (for use with bool operations),")
 print("the remainder are uniformly distributed on [-50,25).")
@@ -109,12 +116,19 @@ def aggregate_group_loop(*args, **kwargs):
             func = f if acc_func is aggregate_group_loop else name
             reps = 3 if acc_func is aggregate_py else 20
             times[ii] = (
-                timeit.Timer(lambda: acc_func(test_group_idx, test_a, func=func)).timeit(number=reps) / reps * 10
+                timeit.Timer(
+                    lambda: acc_func(test_group_idx, test_a, func=func)
+                ).timeit(number=reps)
+                / reps
+                * 10
             )
             print(f"{times[ii] * 1000:.1f}ms".rjust(13), end="")
         except NotImplementedError:
             print("no-impl".rjust(13), end="")
 
     denom = min(t for t in times if t is not None)
-    ratios = [("-".center(4) if t is None else str(round(t / denom, 1))).center(5) for t in times]
+    ratios = [
+        ("-".center(4) if t is None else str(round(t / denom, 1))).center(5)
+        for t in times
+    ]
     print("   ", (":".join(ratios)))

pyproject.toml

@@ -59,3 +59,10 @@ include = ["numpy_groupies*"]
 
 [tool.setuptools_scm]
 write_to = "numpy_groupies/_version.py"
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+
+[tool.codespell]
+ignore-words-list = "nd,"
+ignore-regex = ".*codespell-ignore$"