feat: migrating linting/formatting exclusively to rust (#750)

* feat: migrating linting/formatting exclusively to rust

* feat: added explicit linting/formatting rules

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: implemented PR corrections

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: moe-ad

.pre-commit-config.yaml

@@ -1,19 +1,10 @@
 repos:
 
-- repo: https://github.com/psf/black
-  rev: 24.10.0
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.7.3
   hooks:
-  - id: black
-
-- repo: https://github.com/pycqa/isort
-  rev: 5.13.2
-  hooks:
-  - id: isort
-
-- repo: https://github.com/PyCQA/flake8
-  rev: 7.1.1
-  hooks:
-  - id: flake8
+    - id: ruff
+    - id: ruff-format
 
 - repo: https://github.com/codespell-project/codespell
   rev: v2.3.0
@@ -43,7 +34,7 @@ repos:
     - id: check-github-workflows
 
 - repo: https://github.com/ansys/pre-commit-hooks
-  rev: v0.4.4
+  rev: v0.4.3
   hooks:
   - id: add-license-headers
     args:

README.rst

@@ -1,6 +1,6 @@
 PyAnsys metapackage
 ===================
-|pyansys| |python| |pypi| |downloads| |GH-CI| |MIT| |black| |pre-commit|
+|pyansys| |python| |pypi| |downloads| |GH-CI| |MIT| |Ruff| |pre-commit|
 
 .. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
    :target: https://docs.pyansys.com/
@@ -26,9 +26,9 @@ PyAnsys metapackage
    :target: https://opensource.org/licenses/MIT
    :alt: MIT
 
-.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
-   :target: https://github.com/psf/black
-   :alt: Black
+.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+   :target: https://github.com/astral-sh/ruff
+   :alt: Ruff
 
 .. |pre-commit| image:: https://results.pre-commit.ci/badge/github/pyansys/pyansys/main.svg
    :target: https://results.pre-commit.ci/latest/github/pyansys/pyansys/main

doc/source/conf.py

@@ -2,15 +2,57 @@
 
 from datetime import datetime
 import os
+from pathlib import Path
 import subprocess
 
 from ansys_sphinx_theme import ansys_favicon, get_version_match
+import github
+import jinja2
+from PIL import Image
+import requests
 import sphinx
 from sphinx.builders.latex import LaTeXBuilder
+import toml
 
 from pyansys import __version__ as pyansys_version
 
-LaTeXBuilder.supported_image_types = ["image/png", "image/pdf", "image/svg+xml"]  # noqa: E501
+# Declare constants
+GENERATED_DIR = Path(__file__).parent / "package_versions"
+
+VERSIONS_TEMPLATE = """
+Package versions in PyAnsys {{ version }}
+============================{{ "=" * version|length }}
+
+The PyAnsys packages delivered in version {{ version }} are:
+{{ ' ' }}
+{%- for entry in table %}
+{{ entry }}
+{%- endfor %}
+"""
+
+INDEX_TEMPLATE = """
+Package versions
+================
+
+Users can find below the list of PyAnsys packages available in the various
+PyAnsys metapackages. The tables shows the package versions available in each
+metapackage release.
+
+.. toctree::
+   :maxdepth: 3
+   {{ ' ' }}
+   {%- for version in versions %}
+   version_{{ version }}
+   {%- endfor %}
+"""
+
+TMP_FILE = Path("tmp_pyproject.toml")
+
+LaTeXBuilder.supported_image_types = [
+    "image/png",
+    "image/pdf",
+    "image/svg+xml",
+]  # noqa: E501
 
 project = "pyansys"
 copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved"
@@ -90,8 +132,8 @@
 # make rst_epilog a variable, so you can add other epilog parts to it
 rst_epilog = ""
 # Read link all targets from file
-with open("links.rst") as f:
-    rst_epilog += f.read()
+with Path.open("links.rst") as file:
+    rst_epilog += file.read()
 
 # Ignore certain URLs
 linkcheck_ignore = [
@@ -123,39 +165,6 @@
 
 def generate_rst_files(versions: list[str], tables: dict[str, list[str]]):
     """Generate the .rst files for the package versions."""
-    from pathlib import Path
-
-    import jinja2
-
-    GENERATED_DIR = Path(__file__).parent / "package_versions"
-
-    VERSIONS_TEMPLATE = """
-Package versions in PyAnsys {{ version }}
-============================{{ "=" * version|length }}
-
-The PyAnsys packages delivered in version {{ version }} are:
-{{ ' ' }}
-{%- for entry in table %}
-{{ entry }}
-{%- endfor %}
-"""
-
-    INDEX_TEMPLATE = """
-Package versions
-================
-
-Users can find below the list of PyAnsys packages available in the various
-PyAnsys metapackages. The tables shows the package versions available in each
-metapackage release.
-
-.. toctree::
-   :maxdepth: 3
-   {{ ' ' }}
-   {%- for version in versions %}
-   version_{{ version }}
-   {%- endfor %}
-"""
-
     # Create Jinja2 environment
     jinja_env = jinja2.Environment(loader=jinja2.BaseLoader())
 
@@ -174,23 +183,19 @@ def generate_rst_files(versions: list[str], tables: dict[str, list[str]]):
         output_filename = GENERATED_DIR / f"version_{version}.rst"
 
         # Write the rendered content to the file
-        with open(output_filename, "w") as f:
-            f.write(rendered_content)
+        output_filename.write_text(rendered_content, encoding="utf-8")
 
     # Generate the index.rst file
     index_template = jinja_env.from_string(INDEX_TEMPLATE)
     rendered_index = index_template.render(versions=versions)
 
     # Write the rendered content to the file
     output_filename = GENERATED_DIR / "index.rst"
-    with open(output_filename, "w") as f:
-        f.write(rendered_index)
+    output_filename.write_text(rendered_index, encoding="utf-8")
 
 
 def get_documentation_link_from_pypi(library: str, version: str) -> str:
     """Get the documentation link from PyPI for a specific library and version."""
-    import requests
-
     # Get the PyPI metadata for the library
     resp = requests.get(f"https://pypi.org/pypi/{library}/{version}/json")
     metadata = resp.json()
@@ -224,8 +229,6 @@ def pyansys_multiversion_docs_link(docs_link: str, version: str) -> str:
     failure, it returns the default link. This is done on a best effort basis.
 
     """
-    import requests
-
     # First, let's check it is an official PyAnsys documentation link
     if "docs.pyansys.com" in docs_link:
         # Clean the link
@@ -247,15 +250,10 @@ def pyansys_multiversion_docs_link(docs_link: str, version: str) -> str:
 
 def build_versions_table(branch: str) -> list[str]:
     """Build the versions table for the PyAnsys libraries."""
-    import requests
-    import toml
-
-    TMP_FILE = "tmp_pyproject.toml"
-
     # Download the pyproject.toml file
     resp = requests.get(f"https://raw.githubusercontent.com/ansys/pyansys/{branch}/pyproject.toml")
-    with open("tmp_pyproject.toml", "wb") as f:
-        f.write(resp.content)
+    with TMP_FILE.open("wb") as file:
+        file.write(resp.content)
 
     # Load the pyproject.toml file using TOML parser
     pyproject_toml = toml.load(TMP_FILE)
@@ -290,7 +288,7 @@ def build_versions_table(branch: str) -> list[str]:
         ]
 
     # Delete the temporary file
-    os.remove(TMP_FILE)
+    TMP_FILE.unlink()
 
     # Build the table
     table = []
@@ -329,8 +327,6 @@ def build_versions_table(branch: str) -> list[str]:
 
 def get_release_branches_in_metapackage():
     """Retrieve the release branches in the PyAnsys metapackage."""
-    import github
-
     # Get the PyAnsys metapackage repository
     g = github.Github(os.getenv("GITHUB_TOKEN", None))
     github_repo = g.get_repo("ansys/pyansys")
@@ -377,8 +373,6 @@ def resize_with_background(input_image_path, output_image_path, target_size):
     target_size : tuple[int, int]
         The target size of the output image as a tuple (width, height) in pixels.
     """
-    from PIL import Image
-
     # Open the input image
     img = Image.open(input_image_path).convert("RGBA")  # Ensure the image has an alpha channel
 
@@ -415,7 +409,6 @@ def resize_with_background(input_image_path, output_image_path, target_size):
 def resize_thumbnails(app: sphinx.application.Sphinx):
     """Resize all images in the current directory to 640x480 pixels."""
     # Process all images
-    from pathlib import Path
 
     thumbnail_dir = Path(__file__).parent.absolute() / "_static" / "thumbnails"
 
@@ -426,8 +419,6 @@ def resize_thumbnails(app: sphinx.application.Sphinx):
 
 def revert_thumbnails(app: sphinx.application.Sphinx, exception):
     """Resize all images in the current directory to 640x480 pixels."""
-    from pathlib import Path
-
     thumbnail_dir = Path(__file__).parent.absolute() / "_static" / "thumbnails"
 
     subprocess.run(["git", "checkout", "--", thumbnail_dir])

pyproject.toml

@@ -110,11 +110,32 @@ Documentation = "https://docs.pyansys.com"
 [tool.flit.module]
 name = "pyansys"
 
-[tool.black]
+[tool.ruff]
 line-length = 100
+fix = true
 
-[tool.isort]
-profile = "black"
-force_sort_within_sections = true
-line_length = 100
-src_paths = ["doc", "src"]
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+docstring-code-format = true
+docstring-code-line-length = "dynamic"
+
+[tool.ruff.lint]
+select = [
+    "E",    # pycodestyle, see https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+    "F",    # pyflakes, see https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "I",    # isort, see https://docs.astral.sh/ruff/rules/#isort-i
+    "N",    # pep8-naming, see https://docs.astral.sh/ruff/rules/#pep8-naming-n
+    "PTH",  # flake8-use-pathlib, https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
+    "TD",   # flake8-todos, https://docs.astral.sh/ruff/rules/#flake8-todos-td
+]
+ignore = [
+    "TD002", # Missing author in TODOs comment
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+force-sort-within-sections = true

src/pyansys/__init__.py

@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 """PyAnsys general package __init__ file."""
+
 import importlib.metadata as importlib_metadata
 
 # Read from the pyproject.toml

tools/catsitemap.py

@@ -103,7 +103,7 @@ def generate_sitemap_index(project_names: list, dest_path: Path) -> None:
 
 if __name__ == "__main__":
     # Create path
-    folder_path = Path(".") / "sitemaps"
+    folder_path = Path() / "sitemaps"
     folder_path.mkdir(parents=True, exist_ok=True)
 
     # Get actual valid URLS and corresponding project names

tools/links.py

@@ -8,16 +8,16 @@
     python links.py
 """
 
-import os
+from pathlib import Path
 import re
 
-ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+ROOT_DIR = Path(__file__).parent.parent
 """Root directory of the project relative to this file."""
 
-PYPROJECT_TOML_FILE = os.path.join(ROOT_DIR, "pyproject.toml")
+PYPROJECT_TOML_FILE = ROOT_DIR / "pyproject.toml"
 """Path to pyproject.toml file."""
 
-DOCS_DIRECTORY = os.path.join(ROOT_DIR, "doc", "source")
+DOCS_DIRECTORY = ROOT_DIR / "doc" / "source"
 """Path to the documentation source directory"""
 
 LINKS = {
@@ -98,7 +98,7 @@ def retrieve_major_minor(package: str):
         The major and minor versions of the package.
 
     """
-    with open(PYPROJECT_TOML_FILE, "r") as file:
+    with PYPROJECT_TOML_FILE.open("r") as file:
         content = file.read()
         pattern = r"\b" + re.escape(package) + r"==(\d+)\.(\d+)"
         match = re.search(pattern, content)
@@ -122,23 +122,20 @@ def search_and_replace(link: str, new_link: str):
         The link to replace the existing one.
     """
     # Traverse the docs directory
-    for root, _, files in os.walk(DOCS_DIRECTORY):
+    for root, _, files in DOCS_DIRECTORY.walk():
         # Skip the _static subdirectory
-        if "_static" in root.split(os.sep):
+        if "_static" in root.parts:
             continue
 
         # Process the files
         for file in files:
-            file_path = os.path.join(root, file)
-            with open(file_path, "r") as f:
-                content = f.read()
+            file_path = root / file
+            content = file_path.read_text(encoding="utf-8")
 
             # Search for the link in the content, replace and save
             if link in content:
                 new_content = content.replace(link, new_link)
-
-                with open(file_path, "w") as f:
-                    f.write(new_content)
+                file_path.write_text(new_content, "utf-8")
 
                 print(f"Replaced '{link}' with '{new_link}' in file: {file_path}")  # noqa: E501