fortitude-lint 0.7.5__py3-none-win32.whl → 0.8.0rc1__py3-none-win32.whl

fortitude/__main__.py

@@ -3,30 +3,91 @@
 Adapted from the ``ruff`` launcher script.
 """
 
-import subprocess
+from __future__ import annotations
+
+import os
 import sys
 import sysconfig
-from pathlib import Path
 
 
-def find_exe() -> Path:
-    """Return the compiled ``fortitude`` executable path."""
+def find_fortitude_bin() -> str:
+    """Return the fortitude binary path."""
+
+    fortitude_exe = "fortitude" + sysconfig.get_config_var("EXE")
+
+    scripts_path = os.path.join(sysconfig.get_path("scripts"), fortitude_exe)
+    if os.path.isfile(scripts_path):
+        return scripts_path
+
+    if sys.version_info >= (3, 10):
+        user_scheme = sysconfig.get_preferred_scheme("user")
+    elif os.name == "nt":
+        user_scheme = "nt_user"
+    elif sys.platform == "darwin" and sys._framework:
+        user_scheme = "osx_framework_user"
+    else:
+        user_scheme = "posix_user"
+
+    user_path = os.path.join(
+        sysconfig.get_path("scripts", scheme=user_scheme), fortitude_exe
+    )
+    if os.path.isfile(user_path):
+        return user_path
 
-    exe_name = "fortitude" + sysconfig.get_config_var("EXE")
+    # Search in `bin` adjacent to package root (as created by `pip install --target`).
+    pkg_root = os.path.dirname(os.path.dirname(__file__))
+    target_path = os.path.join(pkg_root, "bin", fortitude_exe)
+    if os.path.isfile(target_path):
+        return target_path
 
-    scripts_path = Path(sysconfig.get_path("scripts"))
-    if (exe := scripts_path / exe_name).is_file():
-        return exe
+    # Search for pip-specific build environments.
+    #
+    # Expect to find fortitude in <prefix>/pip-build-env-<rand>/overlay/bin/fortitude
+    # Expect to find a "normal" folder at <prefix>/pip-build-env-<rand>/normal
+    #
+    # See: https://github.com/pypa/pip/blob/102d8187a1f5a4cd5de7a549fd8a9af34e89a54f/src/pip/_internal/build_env.py#L87
+    paths = os.environ.get("PATH", "").split(os.pathsep)
+    if len(paths) >= 2:
 
-    user_scheme = sysconfig.get_preferred_scheme("user")
-    user_path = Path(sysconfig.get_path("scripts", scheme=user_scheme))
-    if (exe := user_path / exe_name).is_file():
-        return exe
+        def get_last_three_path_parts(path: str) -> list[str]:
+            """Return a list of up to the last three parts of a path."""
+            parts = []
 
-    msg = "Could not locate compiled fortitude executable"
-    raise RuntimeError(msg)
+            while len(parts) < 3:
+                head, tail = os.path.split(path)
+                if tail or head != path:
+                    parts.append(tail)
+                    path = head
+                else:
+                    parts.append(path)
+                    break
+
+            return parts
+
+        maybe_overlay = get_last_three_path_parts(paths[0])
+        maybe_normal = get_last_three_path_parts(paths[1])
+        if (
+            len(maybe_normal) >= 3
+            and maybe_normal[-1].startswith("pip-build-env-")
+            and maybe_normal[-2] == "normal"
+            and len(maybe_overlay) >= 3
+            and maybe_overlay[-1].startswith("pip-build-env-")
+            and maybe_overlay[-2] == "overlay"
+        ):
+            # The overlay must contain the fortitude binary.
+            candidate = os.path.join(paths[0], fortitude_exe)
+            if os.path.isfile(candidate):
+                return candidate
+
+    raise FileNotFoundError(scripts_path)
 
 
 if __name__ == "__main__":
-    completed_process = subprocess.run([str(find_exe()), *sys.argv[1:]])
-    sys.exit(completed_process.returncode)
+    fortitude = find_fortitude_bin()
+    if sys.platform == "win32":
+        import subprocess
+
+        completed_process = subprocess.run([fortitude, *sys.argv[1:]])
+        sys.exit(completed_process.returncode)
+    else:
+        os.execvp(fortitude, [fortitude, *sys.argv[1:]])

{fortitude_lint-0.7.5.dist-info → fortitude_lint-0.8.0rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fortitude-lint
-Version: 0.7.5
+Version: 0.8.0rc1
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -14,11 +14,12 @@ Provides-Extra: lint
 License-File: LICENSE
 Summary: A Fortran linter, written in Rust and installable with Python
 Keywords: Fortran,linter
-Author-email: Liam Pattinson <liampattinson@gmail.com>, Peter Hill <peter.hill@york.ac.uk>
-Requires-Python: >=3.10
+Author-email: Liam Pattinson <liampattinson@gmail.com>, Peter Hill <peter.hill@york.ac.uk>, Ian McInerney <i.mcinerney17@imperial.ac.uk>
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 Project-URL: Repository, https://github.com/PlasmaFAIR/fortitude
 
+[![Fortitude](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/PlasmaFAIR/fortitude/main/docs/assets/badge/v0.json)](https://github.com/PlasmaFAIR/fortitude)
 [![PyPI](https://img.shields.io/pypi/v/fortitude-lint.svg)](https://pypi.org/project/fortitude-lint)
 [![License](https://img.shields.io/pypi/l/fortitude-lint.svg)](https://github.com/PlasmaFAIR/fortitude/blob/main/LICENSE)
 ![Tests](https://github.com/PlasmaFAIR/fortitude/actions/workflows/test.yml/badge.svg)
@@ -30,18 +31,38 @@ Project-URL: Repository, https://github.com/PlasmaFAIR/fortitude
 A Fortran linter, inspired by (and built upon) [Ruff](https://github.com/astral-sh/ruff).
 Written in Rust :crab: and installable with Python :snake:.
 
+<p align="center">
+  <picture align="center">
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/performance_plot_dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="docs/assets/performance_plot_light.svg">
+    <img alt="Shows a bar chart with benchmark results." src="docs/assets/performance_plot_light.svg">
+  </picture>
+</p>
+
+<p align="center">
+  <i>Linting 43 files from the GS2 repo.</i>
+</p>
+
 - :zap: Blazingly fast, up to hundreds of times faster than other open-source Fortran
   linters.
 - :wrench: Automatically fixes linter warnings.
-- :chart_with_upwards_trend: 50+ rules, with many more planned.
+- :chart_with_upwards_trend: Almost 100 rules, with many more planned.
 - :page_with_curl: Multiple output formats, including SARIF and GitHub/GitLab CI.
 - :handshake: Follows [community best
   practices](https://fortran-lang.org/learn/best_practices/).
 - :muscle: Built on a robust [tree-sitter](https://tree-sitter.github.io/tree-sitter/)
   parser.
 
+Fortitude is developed by
+[PlasmaFAIR](https://plasmafair.readthedocs.io), improving the
+sustainability of plasma science research software.
+
+![PlasmaFAIR logo](docs/assets/plasmafair_logo.svg)
+
 ## Table of Contents
 
+For more detail, please see our [documentation](https://fortitude.readthedocs.io).
+
 - [Installation](#installation)
 - [Usage](#usage)
 - [Contributing](#contributing)
@@ -76,7 +97,7 @@ It can also be installed as a pure Rust project:
 ```bash
 git clone https://github.com/PlasmaFAIR/fortitude
 cd fortitude
-cargo install --path fortitude
+cargo install --path crates/fortitude
 ```
 
 Fortitude can also be installed via [other package managers](https://fortitude.readthedocs.io/en/stable/installation/)
@@ -100,11 +121,11 @@ fortitude check --file-extensions=f90,fpp
 
 Be default, Fortitude will ignore files and directories in your `.gitignore`.
 This can be disabled by setting `--no-respect-gitignore`. Additional excludes
-can be set using `--excludes`:
+can be set using `--extend-exclude`:
 
 ```bash
 # Don't check in the `benchmarks/` and `tests/` directories.
-fortitude check --exclude=benchmarks,tests
+fortitude check --extend-exclude=benchmarks,tests
 ```
 
 You can select or ignore individual rules or whole groups with
@@ -146,6 +167,15 @@ fortitude explain S
 fortitude explain obsolescent superfluous-implicit-none
 ```
 
+Use `--summary` to get a brief overview:
+
+```bash
+# Overview of all rules
+fortitude explain --summary
+# Overview of all style rules
+fortitude explain style --summary
+```
+
 To see further commands and optional arguments, try using `--help`:
 
 ```bash
@@ -155,9 +185,6 @@ fortitude check --help
 
 ### Fixes
 
-> [!NOTE]
-> Added in v0.6.0
-
 Fortitude can automatically fix some lint warnings, such as
 unnecessary `implicit none` statements, missing double-colons in
 variable declarations, and more. Just pass the `--fix` flag to
@@ -173,9 +200,6 @@ Run `fortitude explain` to see which rules have fixes available.
 
 ### Preview
 
-> [!NOTE]
-> Added in v0.6.0
-
 Some fortitude rules are only available through an opt-in preview
 mode to give the community some time to evaluate them and provide
 feedback. To enable preview rules, pass the `--preview` flag to
@@ -201,12 +225,11 @@ preview = true
 
 Run `fortitude explain` to see which rules are in preview mode.
 
-
-
 ## Configuration
 
-Fortitude will look for either a `fortitude.toml` or `fpm.toml` file in the
-current directory, or one of its parents. If using `fortitude.toml`, settings
+Fortitude will look for either a `fortitude.toml`, `.fortitude.toml` or `fpm.toml`
+file in the current directory, or one of its parents.
+If using `fortitude.toml` or `.fortitude.toml`, settings
 should be under the command name:
 
 ```toml
@@ -234,6 +257,30 @@ rules on top of those in the configuration file.
 fortitude check --extend-select=OB
 ```
 
+A description of configuration options can be viewed using the `config`
+command:
+
+```bash
+# View all options under the 'check' heading
+fortitude config check
+# Get description of the 'extend-select' option
+fortitude config check.extend-select
+```
+
+## Editor Integration
+
+> [!NOTE]
+> Added in v0.8.0
+
+Fortitude can be integrated into text editors and IDEs that support the
+Language Server Protocol (LSP), providing real-time diagnostics and
+code actions for applying fixes as you work.
+
+Please see the [documentation](fortitude.readthedocs.io/en/stable/editors) for
+details on setting this up for your editor.
+
+A VSCode plugin is in development, and will be released shortly.
+
 ## pre-commit
 
 [Pre-commit](https://pre-commit.com/) hooks for Fortitude are available
@@ -245,11 +292,10 @@ See [table of rules](https://fortitude.readthedocs.io/en/stable/rules/) for a li
 
 ## Contributing
 
-Please feel free to add or suggest new rules or comment on the layout of the project
-while it's still at this early stage of development. See
-[`CONTRIBUTING.md`](CONTRIBUTING.md) for a guide on contributing to the project, and
-[`README.dev.md`](README.dev.md) for details on building the project from source,
-running tests, and linting/formatting the code. Please consult our [code of
+Please feel free to add or suggest new rules and features! See
+[`CONTRIBUTING.md`](CONTRIBUTING.md) for a guide on contributing to the project.
+This also includes instructions for building the project from source, running
+tests, and linting/formatting the code. Please consult our [code of
 conduct](CODE_OF_CONDUCT.md) before contributing.
 
 ## License

fortitude_lint-0.8.0rc1.dist-info/RECORD

@@ -0,0 +1,7 @@
+fortitude/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fortitude/__main__.py,sha256=YRdc0JUPzp91_gmOUIaJqAmDRg4td4P30ZY6_Pqu67I,3162
+fortitude_lint-0.8.0rc1.data/scripts/fortitude.exe,sha256=5juY92cbYp4IhRc5_buGzE4-qk5yP8jihgLY3JQfm-Y,14517760
+fortitude_lint-0.8.0rc1.dist-info/METADATA,sha256=azReSMUDjBU0oVe6RRpPiiLoUoGTNNMqCZ3_KIZw1lk,9780
+fortitude_lint-0.8.0rc1.dist-info/WHEEL,sha256=WDMAB4uGoBTLFFNNHYBIIVDGp2BkavHkkLG_raftdhA,90
+fortitude_lint-0.8.0rc1.dist-info/licenses/LICENSE,sha256=1kdFuOEkOoA_aOl6qzkTs8JdsW5k5ngnYOqqzsduqbg,2319
+fortitude_lint-0.8.0rc1.dist-info/RECORD,,

{fortitude_lint-0.7.5.dist-info → fortitude_lint-0.8.0rc1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.9.3)
+Generator: maturin (1.10.2)
 Root-Is-Purelib: false
 Tag: py3-none-win32

fortitude_lint-0.7.5.dist-info/RECORD

@@ -1,7 +0,0 @@
-fortitude/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fortitude/__main__.py,sha256=3PqWgiZHqg8yC1Q88UazUmufNvBqSdMdDKh6067ryEc,889
-fortitude_lint-0.7.5.data/scripts/fortitude.exe,sha256=FINY1MljybtBNIV39h1omuMQIExDtH_D8lN6DbqTXvw,11827200
-fortitude_lint-0.7.5.dist-info/METADATA,sha256=TpBp53viFVKzDwALSG4SpPDgcPQD2TMaFbFRE3_fmxI,8035
-fortitude_lint-0.7.5.dist-info/WHEEL,sha256=Q4EuPurnoomImVpjwa0YbplsthbqY-uCz1VRFQ9bQ98,89
-fortitude_lint-0.7.5.dist-info/licenses/LICENSE,sha256=1kdFuOEkOoA_aOl6qzkTs8JdsW5k5ngnYOqqzsduqbg,2319
-fortitude_lint-0.7.5.dist-info/RECORD,,