pyscaffoldext-pre-commit-ruff 1.0.0__py3-none-any.whl

pyscaffoldext/pre_commit_ruff/__init__.py

@@ -0,0 +1,12 @@
+"""Extend PyScaffold with --pre-commit-ruff."""
+
+from importlib.metadata import PackageNotFoundError, version  # pragma: no cover
+
+try:
+    # Change here if project is renamed and does not equal the package name
+    dist_name = "pyscaffoldext-pre-commit-ruff"
+    __version__ = version(dist_name)
+except PackageNotFoundError:  # pragma: no cover
+    __version__ = "unknown"
+finally:
+    del version, PackageNotFoundError

pyscaffoldext/pre_commit_ruff/extension.py

@@ -0,0 +1,139 @@
+"""Add pre-commit-ruff extension."""
+
+from argparse import ArgumentParser
+from functools import partial, reduce
+from typing import List
+
+from pyscaffold import structure, toml
+from pyscaffold.actions import Action, ActionParams, ScaffoldOpts, Structure
+from pyscaffold.extensions import Extension, include
+from pyscaffold.extensions.pre_commit import PreCommit
+from pyscaffold.operations import FileOp, no_overwrite
+from pyscaffold.structure import (
+    AbstractContent,
+    Node,
+    ResolvedLeaf,
+    reify_leaf,
+)
+from pyscaffold.templates import get_template
+from pyscaffold.update import ConfigUpdater
+
+from . import templates as my_templates
+
+PYPROJ_INSERT_AFTER = 'version_scheme = "no-guess-dev"\n'
+
+
+class PreCommitRuff(Extension):
+    """Generate pre-commit configuration file for Ruff (includes `--pre-commit`)."""
+
+    def augment_cli(self, parser: ArgumentParser):
+        """Augments the command-line interface parser.
+
+        See :obj:`~pyscaffold.extension.Extension.augment_cli`.
+        """
+        parser.add_argument(
+            self.flag,
+            help=self.help_text,
+            nargs=0,
+            action=include(
+                PreCommit(),
+                self,
+            ),
+        )
+        return self
+
+    def activate(self, actions: List[Action]) -> List[Action]:
+        """Activates See :obj:`pyscaffold.extension.Extension.activate`.
+
+        Args:
+            actions (list): list of actions to perform
+
+        Returns:
+            list: updated list of actions
+        """
+        return self.register(
+            actions,
+            add_files,
+            after="pyscaffold.extensions.pre_commit:add_files",
+        )
+
+
+def add_files(struct: Structure, opts: ScaffoldOpts) -> ActionParams:
+    """Replace .pre-commit-config.yaml. Update setup.cfg and pyproject.toml.
+
+    Add mypy section to setup.cfg.
+    Remove flake8 section from setup.cfg. Ruff replaces flake8.
+
+    Add ruff configuration to pyproject.toml.
+    """
+    files: Structure = {
+        ".pre-commit-config.yaml": (
+            get_template(
+                name="pre-commit-ruff-config",
+                relative_to=my_templates.__name__,
+            ),
+            no_overwrite(),
+        ),
+        "setup.cfg": modify_setupcfg(struct["setup.cfg"], opts),
+    }
+
+    struct = structure.modify(
+        struct,
+        "pyproject.toml",
+        partial(modify_pyproject, opts),
+    )
+    return structure.merge(struct, files), opts
+
+
+def modify_setupcfg(definition: Node, opts: ScaffoldOpts) -> ResolvedLeaf:
+    """Modify setup.cfg to add template settings before it is written.
+
+    See :obj:`pyscaffold.operations`.
+    """
+    content, action = reify_leaf(definition, opts)  # pyright: ignore [reportArgumentType]
+
+    setupcfg = ConfigUpdater().read_string(str(content))
+
+    modifiers = (add_setupcfg,)
+    new_setupcfg = reduce(lambda acc, fn: fn(acc, opts), modifiers, setupcfg)
+
+    return str(new_setupcfg), action
+
+
+def add_setupcfg(setupcfg: ConfigUpdater, opts) -> ConfigUpdater:
+    """Add section(s) to setup.cfg."""
+    template = ConfigUpdater().read_string(
+        str(
+            structure.reify_content(
+                get_template(
+                    name="setup_cfg",
+                    relative_to=my_templates.__name__,
+                ),
+                opts,
+            ),
+        )
+    )
+
+    setupcfg.remove_section("flake8")
+
+    for k in template:
+        setupcfg["pyscaffold"].add_before.section(k)
+        setupcfg[k] = template[k].detach()
+    setupcfg["pyscaffold"].add_before.space(newlines=1)
+
+    return setupcfg
+
+
+def modify_pyproject(
+    opts: ScaffoldOpts, content: AbstractContent, file_op: FileOp
+) -> ResolvedLeaf:
+    """Add Ruff configuration to pyproject.toml."""
+    pyproj_new = toml.loads(
+        "\n".join(
+            (
+                str(structure.reify_content(content, opts)),
+                str(structure.reify_content(my_templates.pyproject_toml, opts)),
+            )
+        )
+    )
+    return toml.dumps(pyproj_new), file_op

pyscaffoldext/pre_commit_ruff/templates/__init__.py

@@ -0,0 +1,17 @@
+"""Location for pre-commit-ruff templates."""
+
+import string
+
+from pyscaffold import toml
+from pyscaffold.actions import ScaffoldOpts
+from pyscaffold.templates import get_template
+
+
+def pyproject_toml(opts: ScaffoldOpts) -> str:
+    """Load and substitute template."""
+    template: string.Template = get_template(
+        name="pyproject_toml",
+        relative_to=__name__,
+    )
+    config = toml.loads(template.safe_substitute(opts))
+    return toml.dumps(config)

pyscaffoldext/pre_commit_ruff/templates/pre-commit-ruff-config.template

@@ -0,0 +1,37 @@
+exclude: '^docs/conf.py'
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+  - id: trailing-whitespace
+  - id: check-added-large-files
+  - id: check-ast
+  - id: check-json
+  - id: check-merge-conflict
+  - id: check-xml
+  - id: check-yaml
+  - id: debug-statements
+  - id: end-of-file-fixer
+  - id: requirements-txt-fixer
+  - id: mixed-line-ending
+    args: ['--fix=auto']  # replace 'auto' with 'lf' to enforce Linux/Mac line endings or 'crlf' for Windows
+
+# ruff-pre-commit
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.6.9
+  hooks:
+    # Run the linter.
+    - id: ruff
+      types_or: [ python, pyi ]
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
+      types_or: [ python, pyi ]
+
+## Check for misspells in documentation files:
+# - repo: https://github.com/codespell-project/codespell
+#   rev: v2.3.0
+#   hooks:
+#   - id: codespell

pyscaffoldext/pre_commit_ruff/templates/pyproject_toml.template

@@ -0,0 +1,30 @@
+[tool.ruff]
+# In addition to the standard set of exclusions, omit all tests, plus a specific file.
+# ruff-format modifies dictionary wrapping and docstring indentation if not excluded.
+extend-exclude = ["docs/conf.py", "setup.py", "tests/conftest.py"]
+
+[tool.ruff.lint]
+extend-select = [
+  # pydocstyle
+  # "D",
+  # pycodestyle
+  "E",
+  # Warning
+  "W",
+  # Pyflakes
+  "F",
+  # pyupgrade
+  # "UP",
+  # flake8-bugbear
+  "B",
+  # flake8-simplify
+  "SIM",
+  # isort
+  "I",
+]
+
+[tool.ruff.lint.pydocstyle]
+# convention = "google"
+
+[tool.ruff.format]
+docstring-code-format = true

pyscaffoldext/pre_commit_ruff/templates/setup_cfg.template

@@ -0,0 +1,9 @@
+[mypy]
+exclude = (?x)(
+    \.tox/
+    | build/
+    | dist/
+    | docs/
+    )
+ignore_missing_imports = True
+follow_imports = silent

pyscaffoldext_pre_commit_ruff-1.0.0.dist-info/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 John D. Fisher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyscaffoldext_pre_commit_ruff-1.0.0.dist-info/METADATA

@@ -0,0 +1,87 @@
+Metadata-Version: 2.1
+Name: pyscaffoldext-pre-commit-ruff
+Version: 1.0.0
+Summary: Add a short description here!
+Home-page: https://github.com/pyscaffold/pyscaffold/
+Author: John D. Fisher
+Author-email: jdfenw@gmail.com
+License: MIT
+Project-URL: Documentation, https://pyscaffold.org/
+Platform: any
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst; charset=UTF-8
+License-File: LICENSE.txt
+Requires-Dist: pyscaffold<5.0a0,>=4.6
+Provides-Extra: testing
+Requires-Dist: tox; extra == "testing"
+Requires-Dist: pre-commit; extra == "testing"
+Requires-Dist: setuptools_scm; extra == "testing"
+Requires-Dist: virtualenv; extra == "testing"
+Requires-Dist: configupdater; extra == "testing"
+Requires-Dist: pytest; extra == "testing"
+Requires-Dist: pytest-cov; extra == "testing"
+Requires-Dist: pytest-xdist; extra == "testing"
+
+pyscaffoldext-pre-commit-ruff
+=============================
+
+`PyScaffold`_ extension to use the `Ruff Linter`_ and `Ruff Formatter`_
+in place of the `Pre Commit Extension`_, ``putup --pre-commit`` defaults
+`flake8`_ and `isort`_.
+
+The ``ruff`` configuration is added to ``pyproject.toml`` because
+``ruff`` does not support ``setup.cfg``. Some `Ruff Linter`_ recommended
+settings are commented out, for consistency with `PyScaffold`_'s
+``flake8`` settings.
+
+`Codespell`_ is added to `pre-commit`_ configuration in
+``.pre-commit-config.yaml``; uncomment to enable.
+
+`Mypy`_ settings are added to ``setup.cfg``.
+
+Usage
+-----
+
+Just install this package with
+``pip install pyscaffoldext-pre-commit-ruff`` and note that ``putup -h``
+shows a new option ``--pre-commit-ruff``. Use this flag to use the `Ruff
+Linter`_ and `Ruff Formatter`_ in place of ``putup --pre-commit``
+defaults `flake8`_ and `isort`_.
+
+.. _pyscaffold-notes:
+
+Making Changes & Contributing
+-----------------------------
+
+This project uses `pre-commit`_, please make sure to install it before
+making any changes:
+
+::
+
+   uv tool install pre-commit
+   cd pyscaffoldext-pre-commit-ruff
+   pre-commit install
+
+It is a good idea to update the hooks to the latest version:
+
+::
+
+   pre-commit autoupdate
+
+Note
+----
+
+This project has been set up using PyScaffold 4.6. For details and usage
+information on PyScaffold see https://pyscaffold.org/.
+
+.. _PyScaffold: https://pyscaffold.org/
+.. _Ruff Linter: https://docs.astral.sh/ruff/linter/
+.. _Ruff Formatter: https://docs.astral.sh/ruff/formatter/
+.. _Pre Commit Extension: https://pyscaffold.org/en/stable/features.html#pre-commit-hooks
+.. _flake8: https://flake8.pycqa.org/
+.. _isort: https://pycqa.github.io/isort/
+.. _Codespell: https://github.com/codespell-project/codespell
+.. _pre-commit: https://pre-commit.com/
+.. _Mypy: https://mypy.readthedocs.io/

pyscaffoldext_pre_commit_ruff-1.0.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+pyscaffoldext/pre_commit_ruff/__init__.py,sha256=hzzhRQkDfDauc3xveaWFFwEDMen00Mn0PyhI75N86CE,421
+pyscaffoldext/pre_commit_ruff/extension.py,sha256=B_HPCbsNX0FuOVNdfqFtOccyDyDkbF3fx2gZghRoZmw,4015
+pyscaffoldext/pre_commit_ruff/templates/__init__.py,sha256=H76fRc_mD1QNaJcspIT3buow8GqtLoM0QvsahGX3Pro,468
+pyscaffoldext/pre_commit_ruff/templates/pre-commit-ruff-config.template,sha256=mZItptCbvQ2MofJPYVnwVWhd7WtGQImPmKCi-EOjqx0,926
+pyscaffoldext/pre_commit_ruff/templates/pyproject_toml.template,sha256=AeV9KS5lryU49LXe9JgURIdanG45mboHo7uKk8P2iCU,574
+pyscaffoldext/pre_commit_ruff/templates/setup_cfg.template,sha256=GoQ4Dqoo3xHtzyb6cSQWru0rWB-BQort07SvEzol2K0,131
+pyscaffoldext_pre_commit_ruff-1.0.0.dist-info/LICENSE.txt,sha256=acMhROUubMKbVsgxX3k_ysr2NX_FSrmTDt076TiV_3o,1081
+pyscaffoldext_pre_commit_ruff-1.0.0.dist-info/METADATA,sha256=IgjsmpVsljSBV51mKzeOy4Qd4L_bMwYjKyDUnkXJNEI,2778
+pyscaffoldext_pre_commit_ruff-1.0.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+pyscaffoldext_pre_commit_ruff-1.0.0.dist-info/entry_points.txt,sha256=lO0-4Df5v33SH_j9Y87UiovpARXKJoZNxAywMsIKKOQ,89
+pyscaffoldext_pre_commit_ruff-1.0.0.dist-info/top_level.txt,sha256=zac9JJq83qBJe5oCWbtXhQVr8mJ5TZFW2jCFlSQ6n0Y,14
+pyscaffoldext_pre_commit_ruff-1.0.0.dist-info/RECORD,,

pyscaffoldext_pre_commit_ruff-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.6.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyscaffoldext_pre_commit_ruff-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pyscaffold.cli]
+pre_commit_ruff = pyscaffoldext.pre_commit_ruff.extension:PreCommitRuff

pyscaffoldext_pre_commit_ruff-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyscaffoldext