From 81026bb8c3f44e86af264bae4b0392fe95f9ebde Mon Sep 17 00:00:00 2001 From: Max Rakitin Date: Sun, 16 Jul 2023 13:11:48 -0400 Subject: [PATCH 1/2] STY: add `black` formatter for Jupyter notebooks --- .pre-commit-config.yaml | 5 ++++ docs/source/notebooks/elements.ipynb | 41 ++++++++++++++++------------ docs/source/notebooks/madx.ipynb | 17 ++++++++---- 3 files changed, 40 insertions(+), 23 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c54fb967..dd83b947 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -11,6 +11,11 @@ repos: rev: 23.3.0 hooks: - id: black + language_version: python3.10 + - id: black-jupyter + language_version: python3.10 + exclude: ^(.*\.py) + args: [--line-length=78] - repo: https://github.com/pycqa/flake8 rev: 6.0.0 hooks: diff --git a/docs/source/notebooks/elements.ipynb b/docs/source/notebooks/elements.ipynb index ef14de7b..76425c58 100644 --- a/docs/source/notebooks/elements.ipynb +++ b/docs/source/notebooks/elements.ipynb @@ -41,8 +41,7 @@ "connection = SirepoBluesky(\"http://localhost:8000\")\n", "\n", "data, schema = connection.auth(\"srw\", \"00000002\")\n", - "classes, objects = create_classes(connection.data,\n", - " connection=connection)\n", + "classes, objects = create_classes(connection.data, connection=connection)\n", "globals().update(**objects)\n", "\n", "aperture.horizontalSize.kind = \"hinted\"\n", @@ -71,10 +70,13 @@ "nrows = int(np.ceil(num_frames / ncols))\n", "\n", "fig = plt.figure()\n", - "grid = ImageGrid(fig, (1, 2, ncols, nrows),\n", - " nrows_ncols=(nrows, ncols),\n", - " axes_pad=0.5,\n", - " aspect=False)\n", + "grid = ImageGrid(\n", + " fig,\n", + " (1, 2, ncols, nrows),\n", + " nrows_ncols=(nrows, ncols),\n", + " axes_pad=0.5,\n", + " aspect=False,\n", + ")\n", "\n", "for ax, im in zip(grid, w9_image[:, ...]):\n", " ax.imshow(im, aspect=\"auto\")" @@ -103,13 +105,16 @@ "connection = SirepoBluesky(\"http://localhost:8000\")\n", "\n", "data, schema = connection.auth(\"shadow\", \"00000002\")\n", - "classes, objects = create_classes(connection.data,\n", - " connection=connection)\n", + "classes, objects = create_classes(connection.data, connection=connection)\n", "globals().update(**objects)\n", "\n", - "print(f\"Number of points before change: {data['models']['simulation']['npoint']}\")\n", - "data['models']['simulation']['npoint'] = 1000000\n", - "print(f\"Number of points after change: {data['models']['simulation']['npoint']}\")\n", + "print(\n", + " f\"Number of points before change: {data['models']['simulation']['npoint']}\"\n", + ")\n", + "data[\"models\"][\"simulation\"][\"npoint\"] = 1000000\n", + "print(\n", + " f\"Number of points after change: {data['models']['simulation']['npoint']}\"\n", + ")\n", "aperture.horizontalSize.kind = \"hinted\"\n", "w9.duration.kind = \"hinted\"\n", "\n", @@ -136,10 +141,13 @@ "nrows = int(np.ceil(num_frames / ncols))\n", "\n", "fig = plt.figure()\n", - "grid = ImageGrid(fig, (1, 2, ncols, nrows),\n", - " nrows_ncols=(nrows, ncols),\n", - " axes_pad=0.5,\n", - " aspect=False)\n", + "grid = ImageGrid(\n", + " fig,\n", + " (1, 2, ncols, nrows),\n", + " nrows_ncols=(nrows, ncols),\n", + " axes_pad=0.5,\n", + " aspect=False,\n", + ")\n", "\n", "for ax, im in zip(grid, w9_image[:, ...]):\n", " ax.imshow(im, aspect=\"auto\")" @@ -169,8 +177,7 @@ "\n", "data, schema = connection.auth(\"shadow\", \"00000002\")\n", "\n", - "classes, objects = create_classes(connection.data,\n", - " connection=connection)\n", + "classes, objects = create_classes(connection.data, connection=connection)\n", "globals().update(**objects)\n", "\n", "bsr = BeamStatisticsReport(name=\"bsr\", connection=connection)\n", diff --git a/docs/source/notebooks/madx.ipynb b/docs/source/notebooks/madx.ipynb index 101d03a5..ebefe1cf 100644 --- a/docs/source/notebooks/madx.ipynb +++ b/docs/source/notebooks/madx.ipynb @@ -35,14 +35,18 @@ "connection = SirepoBluesky(\"http://localhost:8000\")\n", "\n", "data, schema = connection.auth(\"madx\", \"00000002\")\n", - "classes, objects = create_classes(connection.data,\n", - " connection=connection,\n", - " extra_model_fields=[\"rpnVariables\", \"commands\"])\n", + "classes, objects = create_classes(\n", + " connection.data,\n", + " connection=connection,\n", + " extra_model_fields=[\"rpnVariables\", \"commands\"],\n", + ")\n", "globals().update(**objects)\n", "\n", - "madx_flyer = MADXFlyer(connection=connection,\n", - " root_dir=\"/tmp/sirepo-bluesky-data\",\n", - " report=\"elementAnimation250-20\")\n", + "madx_flyer = MADXFlyer(\n", + " connection=connection,\n", + " root_dir=\"/tmp/sirepo-bluesky-data\",\n", + " report=\"elementAnimation250-20\",\n", + ")\n", "\n", "(uid1,) = RE(bp.fly([madx_flyer]))\n", "hdr1 = db[uid1]\n", @@ -68,6 +72,7 @@ " yield from bps.mv(parameter.value, value)\n", " return (yield from bp.fly([madx_flyer]))\n", "\n", + "\n", "(uid2,) = RE(madx_plan())\n", "hdr2 = db[uid2]\n", "tbl2 = hdr2.table(stream_name=\"madx_flyer\", fill=True)\n", From 67a258e2d62878b6e361319b02d293960e6c7734 Mon Sep 17 00:00:00 2001 From: Max Rakitin Date: Tue, 18 Jul 2023 10:14:33 -0400 Subject: [PATCH 2/2] STY: use `black` default for max line len of 88 symbols and reformat --- .pre-commit-config.yaml | 2 +- docs/source/notebooks/elements.ipynb | 8 ++------ 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index dd83b947..c5060334 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -15,7 +15,7 @@ repos: - id: black-jupyter language_version: python3.10 exclude: ^(.*\.py) - args: [--line-length=78] + args: [--line-length=88] - repo: https://github.com/pycqa/flake8 rev: 6.0.0 hooks: diff --git a/docs/source/notebooks/elements.ipynb b/docs/source/notebooks/elements.ipynb index 76425c58..bd8320fc 100644 --- a/docs/source/notebooks/elements.ipynb +++ b/docs/source/notebooks/elements.ipynb @@ -108,13 +108,9 @@ "classes, objects = create_classes(connection.data, connection=connection)\n", "globals().update(**objects)\n", "\n", - "print(\n", - " f\"Number of points before change: {data['models']['simulation']['npoint']}\"\n", - ")\n", + "print(f\"Number of points before change: {data['models']['simulation']['npoint']}\")\n", "data[\"models\"][\"simulation\"][\"npoint\"] = 1000000\n", - "print(\n", - " f\"Number of points after change: {data['models']['simulation']['npoint']}\"\n", - ")\n", + "print(f\"Number of points after change: {data['models']['simulation']['npoint']}\")\n", "aperture.horizontalSize.kind = \"hinted\"\n", "w9.duration.kind = \"hinted\"\n", "\n",