Maint: GitHub Actions Black (#35)

* maint: make black verbose

* add: workflow dispatch

* add: diff to see concerns

* maint: update requirements, update to black v24, run

* maint: rename 'lint' jobs for clarity

* maint: re-run black after rebase from main

* maint: additional flake8 violation by black

.flake8

@@ -8,5 +8,5 @@ exclude =
     bluesky_adaptive/_version.py,
     docs/source/conf.py
 # There are some errors produced by 'black', therefore unavoidable
-ignore = E203, W503
+ignore = E203, W503, E701
 max-line-length = 115

.github/workflows/black.yml

@@ -1,9 +1,9 @@
 name: Check Code Style - BLACK
 
-on: [push, pull_request]
+on: [push, pull_request, workflow_dispatch]
 
 jobs:
-  lint:
+  lint-black:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -18,4 +18,4 @@ jobs:
           pip install black
       - name: Run black
         run: |
-          black . --check
+          black . --check --verbose --diff

.github/workflows/flake8.yml

@@ -3,7 +3,7 @@ name: Check Code Style - FLAKE8
 on: [push, pull_request]
 
 jobs:
-  lint:
+  lint-flake8:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

.github/workflows/isort.yml

@@ -3,7 +3,7 @@ name: Check Code Style - ISORT
 on: [push, pull_request]
 
 jobs:
-  lint:
+  lint-isort:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

bluesky_adaptive/agents/simple.py

@@ -14,6 +14,7 @@
     - measurement_plan_kwargs
     - unpack_run
 """
+
 from abc import ABC
 from logging import getLogger
 from typing import Generator, Sequence, Tuple, Union

bluesky_adaptive/on_stop.py

@@ -12,6 +12,7 @@
 This corresponds to a "middle" scale of adaptive integration into
 data collection.
 """
+
 from queue import Queue
 
 import event_model

bluesky_adaptive/recommendations.py

@@ -1,4 +1,5 @@
 """Toy recommendation engines for testing / demo purposes."""
+
 from bluesky.utils import RunEngineControlException
 
 

bluesky_adaptive/server/worker.py

@@ -25,12 +25,10 @@ class EState(enum.Enum):
     CLOSED = "closed"  # For completeness
 
 
-class RejectedError(RuntimeError):
-    ...
+class RejectedError(RuntimeError): ...
 
 
 class WorkerProcess(Process):
-
     """
     The class implementing the Worker process.
 

bluesky_adaptive/tests/test_botorch_agents.py

@@ -54,8 +54,7 @@ def unpack_run(self, run: BlueskyRun) -> Tuple[Union[float, ArrayLike], Union[fl
         return self.counter, np.random.rand(10)
 
 
-class TestGPAgent(OfflineAgentMixin, SingleTaskGPAgentBase):
-    ...
+class TestGPAgent(OfflineAgentMixin, SingleTaskGPAgentBase): ...
 
 
 def test_gp_agent(tiled_profile, tiled_node):

bluesky_adaptive/tests/test_sklearn_agents.py

@@ -60,12 +60,10 @@ def unpack_run(self, run: BlueskyRun) -> Tuple[Union[float, ArrayLike], Union[fl
         return self.counter, np.random.rand(10)
 
 
-class TestDecompAgent(DummyAgentMixin, DecompositionAgentBase):
-    ...
+class TestDecompAgent(DummyAgentMixin, DecompositionAgentBase): ...
 
 
-class TestClusterAgent(DummyAgentMixin, ClusterAgentBase):
-    ...
+class TestClusterAgent(DummyAgentMixin, ClusterAgentBase): ...
 
 
 @pytest.mark.parametrize("estimator", [PCA(2), NMF(2)], ids=["PCA", "NMF"])

requirements-dev.txt

@@ -3,6 +3,7 @@
 codecov
 coverage
 flake8
+black
 pytest
 sphinx
 # These are dependencies of various sphinx extensions for documentation.