refc: Replace black with ruff format

flexcompute · May 31, 2024 · f55fc2c · f55fc2c
1 parent aefb080
commit f55fc2c
Show file tree

Hide file tree

Showing 10 changed files with 56 additions and 80 deletions.
diff --git a/.github/workflows/run_tests.yml b/.github/workflows/run_tests.yml
@@ -148,7 +148,7 @@ jobs:
     #----------------------------------------------
     - name: Run tests
       run: |
-        poetry run black . --check --diff
+        poetry run ruff format . --check --diff
         poetry run ruff check tidy3d --fix --exit-non-zero-on-fix
         poetry run pytest -rA tests
         poetry run pytest -rA tests/_test_data/_test_datasets_no_vtk.py
diff --git a/.github/workflows/update_coverage.yml b/.github/workflows/update_coverage.yml
@@ -82,7 +82,7 @@ jobs:
     - name: Run tests
       run: |
         source $VENV
-        black . --check --diff
+        ruff format . --check --diff
         ruff check tidy3d --fix --exit-non-zero-on-fix
         coverage run -m pytest -rA tests
         coverage report -m

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,12 +1,7 @@
 repos:
-  - repo: https://github.com/psf/black
-    rev: 23.12.1
-    hooks:
-    - id: black
-      name: black <<< NOTE:, if you get a message stating that "All done! n file(s) reformatted", you must git add and commit the changes again to complete the commit. >>>
-
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.3.2"
+    rev: "v0.2.2"
     hooks:
      - id: ruff
-       args: [ --fix ]
+       args: [ --fix ]
+     - id: ruff-format
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -52,6 +52,7 @@ joblib = "*"
 # development core
 bump-my-version =  {version="*", optional = true}
 black = {version="23.12.1", optional = true}
+ruff = {version="0.2.2", optional = true}
 coverage = {version="*", optional = true}
 dill = {version="*", optional = true}
 ipython = {version="*", optional = true}
@@ -60,10 +61,8 @@ pre-commit = {version="*", optional = true}
 pylint = {version="*", optional = true}
 pytest = {version="*", optional = true}
 pytest-timeout = {version="*", optional = true}
-ruff = {version="0.3.2", optional = true}
 tox = {version="*", optional = true}
 
-
 # gdspy
 gdspy = {version="*", optional = true}
 
@@ -111,8 +110,8 @@ devsim = {version="*", optional = true}
 cma = {version="*", optional = true}
 
 [tool.poetry.extras]
-dev = ['bump-my-version', 'black', "coverage", 'dill', 'divparams', 'gdspy', 'gdstk', 'gdstk', 'grcwa', 'ipython', 'ipython', 'jax', 'jaxlib', 'jinja2',
-  'jupyter', 'jupyterblack', 'myst-parser', 'memory_profiler', 'nbconvert', 'nbdime', 'nbsphinx', 'networkx', 'optax', 'pre-commit',
+dev = ['bump-my-version', "coverage", 'dill', 'divparams', 'gdspy', 'gdstk', 'gdstk', 'grcwa', 'ipython', 'ipython', 'jax', 'jaxlib', 'jinja2',
+  'jupyter', 'myst-parser', 'memory_profiler', 'nbconvert', 'nbdime', 'nbsphinx', 'networkx', 'optax', 'pre-commit',
   'pydata-sphinx-theme', 'pylint', 'pyswarms', 'pytest', 'pytest-timeout', 'rtree', 'ruff', 'sax', 'signac', 'sphinx',
   'sphinx-book-theme', 'sphinx-copybutton', 'sphinx-favicon', 'sphinx-notfound-page', 'sphinx-sitemap', 'sphinx-tabs', 'sphinxemoji', 'tmm', 'tox', 'trimesh',
   'scikit-rf', 'vtk', 'devsim', 'cma']
@@ -141,30 +140,29 @@ requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.black]
+target-version = ["py39"]
 line-length = 100
-include = '\.pyi?$'
-exclude = '''
-/(
-    \.git
-  | \.hg
-  | \.mypy_cache
-  | \.tox
-  | \.venv
-  | _build
-  | buck-out
-  | build
-  | dist
-)/
-'''
-
+extend-exclude = "docs/faq/|docs/notebooks/"
 
 [tool.ruff]
-lint.ignore-init-module-imports = true
-lint.typing-modules = ["tidy3d.components.types"] # without this Literal["something fails"]
+target-version = "py39"
 line-length = 100
-fix = true
-lint.ignore = [
-  "E501",  # line too long, handled by black
+extend-exclude = ["docs/faq/", "docs/notebooks/"]
+
+[tool.ruff.lint]
+ignore-init-module-imports = true
+typing-modules = ["tidy3d.components.types"] # without this Literal["something fails"]
+select = [
+  "E",  # pycodestyle errors
+  "W",  # pycodestyle warnings
+  "F",  # pyflakes
+  "C",  # flake8-comprehensions
+  "B",  # flake8-bugbear
+  "UP",
+  "NPY201", # numpy 2.* compatibility check
+]
+ignore = [
+  "E501",
   "B008",  # do not perform function calls in argument defaults
   "C901",  # too complex
   "UP007", # use x | y instead of union[x,y] (does not work)
@@ -177,16 +175,6 @@ lint.ignore = [
   "UP035", # TODO decide what to do here
 ]
 
-lint.select = [
-  "E",  # pycodestyle errors
-  "W",  # pycodestyle warnings
-  "F",  # pyflakes
-  "C",  # flake8-comprehensions
-  "B",  # flake8-bugbear
-  "UP",
-  "NPY201", # numpy 2.* compatibility check
-]
-
 [tool.bumpversion]
 current_version = "2.7.0rc2"
 parse = """(?x)
@@ -228,5 +216,3 @@ replace = "\nversion = \"{new_version}\""
 filename = "tidy3d/version.py"
 search = "{current_version}"
 replace = "{new_version}"
-
-target-version = "py310"
diff --git a/tidy3d/components/data/dataset.py b/tidy3d/components/data/dataset.py
@@ -2859,7 +2859,7 @@ def _get_numpy_array(data_array: Union[ArrayLike, DataArray, UnstructuredGridDat
 
 
 def _zeros_like(
-    data_array: Union[ArrayLike, xr.DataArray, UnstructuredGridDataset]
+    data_array: Union[ArrayLike, xr.DataArray, UnstructuredGridDataset],
 ) -> Union[ArrayLike, xr.DataArray, UnstructuredGridDataset]:
     """Get a zeroed replica of dataarray/dataset."""
     if isinstance(data_array, UnstructuredGridDataset):
@@ -2870,7 +2870,7 @@ def _zeros_like(
 
 
 def _ones_like(
-    data_array: Union[ArrayLike, xr.DataArray, UnstructuredGridDataset]
+    data_array: Union[ArrayLike, xr.DataArray, UnstructuredGridDataset],
 ) -> Union[ArrayLike, xr.DataArray, UnstructuredGridDataset]:
     """Get a unity replica of dataarray/dataset."""
     if isinstance(data_array, UnstructuredGridDataset):

diff --git a/tidy3d/components/grid/mesher.py b/tidy3d/components/grid/mesher.py
@@ -1129,9 +1129,7 @@ def fun_scale(new_scale):
                 if isclose(new_scale, 1.0):
                     return len_interval - small_dl * (1 + num_step)
                 return (
-                    len_interval
-                    - small_dl * (1 - new_scale**num_step) / (1 - new_scale)
-                    - small_dl
+                    len_interval - small_dl * (1 - new_scale**num_step) / (1 - new_scale) - small_dl
                 )
 
             # solve for new scaling factor

diff --git a/tidy3d/components/medium.py b/tidy3d/components/medium.py
@@ -1249,7 +1249,7 @@ def _validate_isreal_dataarray(dataarray: CustomSpatialDataType) -> bool:
 
     @staticmethod
     def _validate_isreal_dataarray_tuple(
-        dataarray_tuple: Tuple[CustomSpatialDataType, ...]
+        dataarray_tuple: Tuple[CustomSpatialDataType, ...],
     ) -> bool:
         """Validate that the dataarray is real"""
         return np.all([AbstractCustomMedium._validate_isreal_dataarray(f) for f in dataarray_tuple])

diff --git a/tidy3d/components/parameter_perturbation.py b/tidy3d/components/parameter_perturbation.py
@@ -77,7 +77,7 @@ def ensure_temp_in_range(
     sample: Callable[
         Union[ArrayLike[float], CustomSpatialDataType],
         Union[ArrayLike[float], ArrayLike[Complex], CustomSpatialDataType],
-    ]
+    ],
 ) -> Callable[
     Union[ArrayLike[float], CustomSpatialDataType],
     Union[ArrayLike[float], ArrayLike[Complex], CustomSpatialDataType],
@@ -418,7 +418,7 @@ def ensure_charge_in_range(
             Union[ArrayLike[float], CustomSpatialDataType],
         ],
         Union[ArrayLike[float], ArrayLike[Complex], CustomSpatialDataType],
-    ]
+    ],
 ) -> Callable[
     [
         Union[ArrayLike[float], CustomSpatialDataType],

diff --git a/tidy3d/plugins/microwave/models/coupled_microstrip.py b/tidy3d/plugins/microwave/models/coupled_microstrip.py
@@ -62,11 +62,7 @@ def _z0_even_odd(
     Q3 = 0.1975 + (16.6 + (8.4 / g) ** 6) ** -0.387 + np.log(g**10 / (1 + (g / 3.4) ** 10)) / 241
     Q4 = (2 * Q1 / Q2) * (np.exp(-g) * u**Q3 + (2 - np.exp(-g)) * u**-Q3) ** -1
     Q5 = 1.794 + 1.14 * np.log(1 + 0.638 / (g + 0.517 * g**2.43))
-    Q6 = (
-        0.2305
-        + np.log(g**10 / (1 + (g / 5.8) ** 10)) / 281.3
-        + np.log(1 + 0.598 * g**1.154) / 5.1
-    )
+    Q6 = 0.2305 + np.log(g**10 / (1 + (g / 5.8) ** 10)) / 281.3 + np.log(1 + 0.598 * g**1.154) / 5.1
     Q7 = (10 + 190 * g**2) / (1 + 82.3 * g**3)
     Q8 = np.exp(-6.5 - 0.95 * np.log(g) - (g / 0.15) ** 5)
     Q9 = np.log(Q7) * (Q8 + 1 / 16.5)