Merge pull request #22 from stevenhua0320/pre-commit-auto

style: apply pre-commit hooks with no manual edits

Author: sbillinge

.flake8

@@ -0,0 +1,13 @@
+# As of now, flake8 does not natively support configuration via pyproject.toml
+# https://github.com/microsoft/vscode-flake8/issues/135
+[flake8]
+exclude =
+    .git,
+    __pycache__,
+    build,
+    dist,
+    docs/source/conf.py
+max-line-length = 79
+# Ignore some style 'errors' produced while formatting by 'black'
+# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#labels-why-pycodestyle-warnings
+extend-ignore = E203

.isort.cfg

@@ -0,0 +1,5 @@
+[settings]
+# Keep import statement below line_length character limit
+line_length = 79
+multi_line_output = 3
+include_trailing_comma = True

.pre-commit-config.yaml

@@ -0,0 +1,66 @@
+default_language_version:
+  python: python3
+ci:
+  autofix_commit_msg: |
+    [pre-commit.ci] auto fixes from pre-commit hooks
+  autofix_prs: true
+  autoupdate_branch: "pre-commit-autoupdate"
+  autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
+  autoupdate_schedule: monthly
+  skip: [no-commit-to-branch]
+  submodules: false
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-added-large-files
+  - repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+      - id: black
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.0.0
+    hooks:
+      - id: flake8
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+  - repo: https://github.com/kynan/nbstripout
+    rev: 0.7.1
+    hooks:
+      - id: nbstripout
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: no-commit-to-branch
+        name: Prevent Commit to Main Branch
+        args: ["--branch", "main"]
+        stages: [pre-commit]
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli
+  # prettier - multi formatter for .json, .yml, and .md files
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: f12edd9c7be1c20cfa42420fd0e6df71e42b51ea # frozen: v4.0.0-alpha.8
+    hooks:
+      - id: prettier
+        additional_dependencies:
+          - "prettier@^3.2.4"
+  # docformatter - PEP 257 compliant docstring formatter
+  - repo: https://github.com/s-weigand/docformatter
+    rev: 5757c5190d95e5449f102ace83df92e7d3b06c6c
+    hooks:
+      - id: docformatter
+        additional_dependencies: [tomli]
+        args: [--in-place, --config, ./pyproject.toml]

src/diffpy/srxplanargui/imageplot.py

@@ -101,38 +101,50 @@ class ImagePlot(HasTraits):
     )
     avgmask = DelegatesTo(
         "srxconfig",
-        desc=("Mask the pixels too bright or too dark compared to"
-              " the average intensity at the similar diffraction angle"),
+        desc=(
+            "Mask the pixels too bright or too dark compared to"
+            " the average intensity at the similar diffraction angle"
+        ),
     )
     brightpixelr = DelegatesTo(
         "srxconfig",
-        desc=("Pixels with intensity large than this relative threshold"
-              " (times the local environment) value will be masked"),
+        desc=(
+            "Pixels with intensity large than this relative threshold"
+            " (times the local environment) value will be masked"
+        ),
     )
     brightpixelsize = DelegatesTo(
         "srxconfig", desc="Size of testing area for detecting bright pixels"
     )
     darkpixelr = DelegatesTo(
         "srxconfig",
-        desc=("Pixels with intensity less than this relative threshold"
-              " (times the local environment) value will be masked"),
+        desc=(
+            "Pixels with intensity less than this relative threshold"
+            " (times the local environment) value will be masked"
+        ),
     )
     avgmaskhigh = DelegatesTo(
         "srxconfig",
-        desc=("Comparing to the average intensity at "
-              "similar diffraction angle, \npixels with intensity larger than"
-              " avg_int*high will be masked"),
+        desc=(
+            "Comparing to the average intensity at "
+            "similar diffraction angle, \npixels with intensity larger than"
+            " avg_int*high will be masked"
+        ),
     )
     avgmasklow = DelegatesTo(
         "srxconfig",
-        desc=("Comparing to the average intensity at "
-              "similar diffraction angle, \npixels with intensity less than "
-              "avg_int*low will be masked"),
+        desc=(
+            "Comparing to the average intensity at "
+            "similar diffraction angle, \npixels with intensity less than "
+            "avg_int*low will be masked"
+        ),
     )
     cropedges = DelegatesTo(
         "srxconfig",
-        desc=("The number of pixels masked"
-              " at each edge (left, right, top, bottom)"),
+        desc=(
+            "The number of pixels masked"
+            " at each edge (left, right, top, bottom)"
+        ),
     )
 
     def createPlot(self):
@@ -231,7 +243,7 @@ def addPointMask(self, ndx, remove=None):
         """Param ndx -- (x,y) float."""
         x, y = ndx
         r = self.pts - np.array((x, y))
-        r = np.sum(r ** 2, axis=1)
+        r = np.sum(r**2, axis=1)
         mask = r < ((self.pointmaskradius + 1) ** 2)
         mask = mask.reshape(self.staticmask.shape)
         if remove:
@@ -318,9 +330,11 @@ def _enableMaskEditing(self):
             self.plot.tools.remove(self.pan)
         self.plot.overlays.append(self.lstool)
         self.titlebak = self.plot.title
-        self.plot.title = ("Click: add a vertex; "
-                           "<Ctrl>+Click: remove a vertex; \n          "
-                           "<Enter>: finish the selection")
+        self.plot.title = (
+            "Click: add a vertex; "
+            "<Ctrl>+Click: remove a vertex; \n          "
+            "<Enter>: finish the selection"
+        )
         return
 
     def _disableMaskEditing(self):