Format source code to PEP8 using Ruff

* added ruff docs

* style: Run ruff and black before yapf pass

* yapf -r -i (23 fixes)

* fixed conf.py and ran ruff format .

* fixed conf.py 2

* formatted argparser.py

* formatted src/rocprof_compute_analyze

* formatted src/rocprof_compute_profile

* formatted soc_base.py

* formatted rocprof_compute_tui

* formatted gui_components

* formatted src/utils

* formatted tests/

* format extra files

* cleanup

* fix test_utils.py

* fixed typos

* Update pyproject.toml

* Update README.md

* Update test_utils.py
[rocm-systems] ROCm/rocm-systems#36 (commit 58d2a01)

Author: jamessiddeley-amd

.github/workflows/formatting.yml

@@ -25,14 +25,26 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install black isort
+        python -m pip install ruff
         if [ -f requirements.txt ]; then python -m pip install -r requirements.txt; fi
-    - name: Run black formatter
-      uses: psf/black@stable
-      with:
-        use_pyproject: true
-    - name: Run isort formatter
-      uses: isort/isort-action@master
+    - name: Run Ruff Linter and Import Sorter
+      run: |
+        ruff check . --fix --exit-zero
+    - name: Run Ruff Formatter
+      run: |
+        ruff format .
+    - name: Check for formatting/linting changes
+      run: |
+        git config --global user.name 'github-actions'
+        git config --global user.email 'github-actions@github.com'
+        git add -A .
+        if ! git diff --cached --quiet; then
+          echo "::error::Files were modified by ruff. Please run 'ruff check . --fix && ruff format .' locally and commit the changes."
+          git diff --cached --patch # Show the diff in the logs
+          exit 1
+        else
+          echo "Ruff found no issues or all issues were fixed and files are clean."
+        fi
 
   cmake:
     runs-on: ubuntu-22.04

.pre-commit-config.yaml

@@ -7,13 +7,12 @@ repos:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  # Python import sorting
-  - repo: https://github.com/pycqa/isort
-    rev: 6.0.1
+    # Python import sorting and formatting
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version. Check https://github.com/astral-sh/ruff-pre-commit#version-compatibility,
+    # for the latest ruff version supported by the hook.
+    rev: v0.12.7
     hooks:
-      - id: isort
-  # Python formatting (Using this mirror lets us use mypyc-compiled black, which is about 2x faster)
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 25.1.0
-    hooks:
-      - id: black
+      - id: ruff-check
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format

README.md

@@ -104,3 +104,42 @@ style reference is provided below for convenience:
   url          = {https://doi.org/10.5281/zenodo.7314631}
 }
 ```
+
+### Contribution Guidelines
+
+To ensure code quality and consistency, we use **Ruff**, a fast Python linter and formatter. Before submitting a pull request, please ensure your code is formatted and linted correctly.
+
+-----
+
+### Installing and Running Ruff
+
+Ruff is available on PyPI and can be installed using `pip`:
+
+```bash
+pip install ruff
+```
+
+Once installed, you can run Ruff from the command line. To check for linting errors and formatting issues, navigate to the project root and run:
+
+```bash
+ruff check .
+ruff format --check .
+```
+
+To automatically fix most of the issues detected, you can use the `--fix` flag with the `check` command and run the `format` command without the `--check` flag:
+
+```bash
+ruff check --fix .
+ruff format .
+```
+
+-----
+
+### Disabling Formatting for Specific Sections
+
+There may be instances where you need to disable Ruff's formatting on a specific block of code. You can do this using special comments:
+
+  * **`# fmt: off`** and **`# fmt: on`**: These comments can be used to disable and re-enable formatting for a block of code.
+  * **`# fmt: skip`**: This comment, placed at the end of a line, will prevent Ruff from formatting that specific statement.
+
+You can also disable specific linting rules for a line by using `# noqa: <rule_code>`.

docs/archive/docs-1.x/conf.py

@@ -13,10 +13,14 @@
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
-# documentation root, use str(Path(<rel_path>).absolute().resolve()) to make it absolute, like shown here.
-#
+# documentation root, use str(Path(<rel_path>).absolute().resolve())
+# to make it absolute, like shown here.
 from pathlib import Path
 
+from pygments.styles import get_all_styles
+from recommonmark.parser import CommonMarkParser
+from recommonmark.transform import AutoStructify
+
 sys.path.insert(0, str(Path("..").absolute().resolve()))
 
 repo_version = "unknown"
@@ -68,7 +72,6 @@ def install(package):
     ".md": "markdown",
 }
 
-from recommonmark.parser import CommonMarkParser
 
 source_parsers = {".md": CommonMarkParser}
 
@@ -94,7 +97,6 @@ def install(package):
 latex_engine = "lualatex"
 latex_show_urls = "footnote"
 
-
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -113,7 +115,6 @@ def install(package):
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
-
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
@@ -136,8 +137,6 @@ def install(package):
     "titles_only": False,
 }
 
-from pygments.styles import get_all_styles
-
 # The name of the Pygments (syntax highlighting) style to use.
 styles = list(get_all_styles())
 preferences = ("emacs", "pastie", "colorful")
@@ -146,8 +145,6 @@ def install(package):
         pygments_style = pref
         break
 
-from recommonmark.transform import AutoStructify
-
 
 # app setup hook
 def setup(app):

docs/archive/docs-2.x/conf.py

@@ -13,10 +13,14 @@
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
-# documentation root, use str(Path(<rel_path>).absolute().resolve()) to make it absolute, like shown here.
-#
+# documentation root, use str(Path(<rel_path>).absolute().resolve()
+# to make it absolute, like shown here.
 from pathlib import Path
 
+from pygments.styles import get_all_styles
+from recommonmark.parser import CommonMarkParser
+from recommonmark.transform import AutoStructify
+
 sys.path.insert(0, str(Path("..").absolute().resolve()))
 
 repo_version = "unknown"
@@ -56,12 +60,10 @@ def install(package):
 
 show_authors = True
 
-
 myst_heading_anchors = 4
 # enable replacement of (tm) & friends
 myst_enable_extensions = ["replacements", "dollarmath"]
 
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -84,8 +86,6 @@ def install(package):
 # sphinxmark_text_spacing = 800
 # sphinxmark_text_opacity = 30
 
-from recommonmark.parser import CommonMarkParser
-
 source_parsers = {".md": CommonMarkParser}
 
 # The master toctree document.
@@ -110,7 +110,6 @@ def install(package):
 latex_engine = "lualatex"
 latex_show_urls = "footnote"
 
-
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -133,7 +132,6 @@ def install(package):
     "sphinxsetup": "verbatimwrapslines=true, verbatimforcewraps=true",
 }
 
-
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
@@ -157,8 +155,6 @@ def install(package):
     "titles_only": False,
 }
 
-from pygments.styles import get_all_styles
-
 # The name of the Pygments (syntax highlighting) style to use.
 styles = list(get_all_styles())
 preferences = ("emacs", "pastie", "colorful")
@@ -167,8 +163,6 @@ def install(package):
         pygments_style = pref
         break
 
-from recommonmark.transform import AutoStructify
-
 
 # app setup hook
 def setup(app):

docs/conf.py

@@ -23,7 +23,6 @@
 
 ##############################################################################
 
-
 # Configuration file for the Sphinx documentation builder.
 #
 # This file only contains a selection of the most common options. For a full

pyproject.toml

@@ -4,36 +4,50 @@ requires-python = ">=3.8"
 
 [project.optional-dependencies]
 developer = [
-    "black>=22.6.0",
-    "isort>=5.12.0",
+    "ruff>=0.12.7",
     "pre-commit",
 ]
 
-[tool.black]
-line-length = 90
-include = '\.py$'
-exclude = '''
-(
-  /(
-      \.eggs
-    | \.git
-    | \.github
-    | \.tox
-    | \.venv
-    | \.misc
-    | \.vscode
-    | \.pyc
-    | dist
-    | external
-    | .pytest_cache
-    | build
-    | build-rocprof_compute
-  )/
-)
-'''
+[tool.ruff]
+line-length = 88
+
+# Ruff's default excludes cover: .bzr, .direnv, .eggs, .git, .git-rewrite, .hg, .ipynb_checkpoints,
+# .mypy_cache, .nox, .pants.d, .pyenv, .pytest_cache, .pytype, .ruff_cache, .svn,
+# .tox, .venv, .vscode, __pypackages__, _build, buck-out, build, dist, node_modules,
+# site-packages, venv
+
+extend-exclude = [
+    ".github",
+    ".misc",
+    "external",
+    "build-rocprof_compute",
+]
+
+[tool.ruff.lint]
+# Enable Pyflakes (F), pycodestyle (E, W for PEP8), and isort (I) rules.
+select = ["E", "W", "F", "I"]
+ignore = ["E713", "E711"]
+fixable = ["ALL"]
+unfixable = []
+
+[tool.ruff.format]
+preview = true
+
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+docstring-code-format = true
+docstring-code-line-length = "dynamic"
 
-[tool.isort]
-profile = "black"
 
 [tool.pytest.ini_options]
 addopts = [