From daa3f52bd195c7dab4469ed891b81f42aa6576c3 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Fri, 29 Dec 2023 15:15:05 +0900 Subject: [PATCH] Update pyproject.toml to add options of ruff (#32) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- pyproject.toml | 14 ++++++++++++++ src/pvgmsh/__init__.py | 25 +++++++++++++++++-------- src/pvgmsh/_version.py | 3 ++- 3 files changed, 33 insertions(+), 9 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 7ff52368..f12c0bf6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,3 +33,17 @@ checks = [ "EX01", # Examples: Will eventually enforce "YD01", # Yields: No plan to enforce ] + +[tool.ruff] +line-length = 150 + +[tool.ruff.lint] +select = ["ALL"] +ignore = [ + "D203", + "D212", + "ISC001", +] + +[tool.ruff.format] +docstring-code-format = true diff --git a/src/pvgmsh/__init__.py b/src/pvgmsh/__init__.py index 377492ae..70a2345d 100644 --- a/src/pvgmsh/__init__.py +++ b/src/pvgmsh/__init__.py @@ -1,14 +1,22 @@ """PvGmsh package for 3D mesh generation.""" +from __future__ import annotations + +import tempfile + import gmsh +import numpy as np import pyvista as pv -import tempfile + from pvgmsh._version import __version__ # noqa: F401 -import numpy as np -def frontal_delaunay_2d(edge_source, target_size=None): - """The Frontal-Delaunay 2D mesh algorithm. +def frontal_delaunay_2d( + edge_source: pv.PolyData, + target_size: float | None, +) -> pv.UnstructuredGrid: + """ + Frontal-Delaunay 2D mesh algorithm. Parameters ---------- @@ -73,9 +81,7 @@ def frontal_delaunay_2d(edge_source, target_size=None): >>> plotter = pv.Plotter(off_screen=True) >>> _ = plotter.add_mesh(mesh, show_edges=True, line_width=4, color="white") >>> _ = plotter.add_mesh(geometry, show_edges=True, line_width=4, color="blue") - >>> _ = plotter.add_points( - ... geometry.points, style="points", point_size=20, color="blue" - ... ) + >>> _ = plotter.add_points(geometry.points, style="points", point_size=20, color="blue") >>> plotter.show(cpos="xy", screenshot="frontal_delaunay_2d_01.png") """ gmsh.initialize() @@ -101,7 +107,10 @@ def frontal_delaunay_2d(edge_source, target_size=None): gmsh.model.mesh.generate(2) with tempfile.NamedTemporaryFile( - mode="w+", encoding="utf-8", newline="\n", suffix=".msh" + mode="w+", + encoding="utf-8", + newline="\n", + suffix=".msh", ) as fp: gmsh.write(fp.name) mesh = pv.read(fp.name) diff --git a/src/pvgmsh/_version.py b/src/pvgmsh/_version.py index ea6adc02..2a10af46 100644 --- a/src/pvgmsh/_version.py +++ b/src/pvgmsh/_version.py @@ -1,4 +1,5 @@ -"""Version info for pvgmsh. +""" +Version info for pvgmsh. On the ``main`` branch, use 'dev0' to denote a development version. For example: