Allow setting max column width and simplify cli and config

Signed-off-by: Bernát Gábor <[email protected]>

Author: gaborbernat

.gitignore

@@ -7,5 +7,6 @@ dist
 
 /target
 /pyproject-*.toml
-/src/pyproject_fmt/_lib.cpython-*
+/src/pyproject_fmt/_lib.abi3*
 /tarpaulin-report.html
+/build_rs_cov.profraw

Cargo.toml

@@ -10,9 +10,7 @@ edition = "2021"
 [lib]
 name = "_lib"
 path = "rust/src/main.rs"
-crate-type = [
-    "cdylib",
-]
+crate-type = ["cdylib"]
 
 [dependencies]
 taplo = { version = "0.13.0" }                          # formatter
@@ -21,12 +19,8 @@ lexical-sort = { version = "0.3.1" }
 regex = { version = "1.10.4" }
 
 [features]
-extension-module = [
-    "pyo3/extension-module",
-]
-default = [
-    "extension-module",
-]
+extension-module = ["pyo3/extension-module"]
+default = ["extension-module"]
 
 [lints.clippy]
 all = "warn"

rust/src/main.rs

@@ -21,6 +21,7 @@ mod helpers;
 #[must_use]
 pub fn format_toml(
     content: &str,
+    column_width: usize,
     indent: usize,
     keep_full_version: bool,
     max_supported_python: (u8, u8),
@@ -48,7 +49,7 @@ pub fn format_toml(
         compact_arrays: false,        // do not compact for easier diffs
         compact_inline_tables: false, // do not compact for easier diffs
         compact_entries: false,       // do not compact for easier diffs
-        column_width: 1,              // always expand arrays per https://github.com/tamasfe/taplo/issues/390
+        column_width,                 // always expand arrays per https://github.com/tamasfe/taplo/issues/390
         indent_tables: false,
         indent_entries: false,
         inline_table_expand: true,
@@ -62,10 +63,13 @@ pub fn format_toml(
     format_syntax(root_ast, options)
 }
 
+/// # Errors
+///
+/// Will return `PyErr` if an error is raised during formatting.
 #[pymodule]
 #[pyo3(name = "_lib")]
 #[cfg(not(tarpaulin_include))]
-fn _lib(m: &Bound<'_, PyModule>) -> PyResult<()> {
+pub fn _lib(m: &Bound<'_, PyModule>) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(format_toml, m)?)?;
     Ok(())
 }
@@ -156,7 +160,7 @@ mod tests {
         #[case] keep_full_version: bool,
         #[case] max_supported_python: (u8, u8),
     ) {
-        let got = format_toml(start, indent, keep_full_version, max_supported_python, (3, 8));
+        let got = format_toml(start, 1, indent, keep_full_version, max_supported_python, (3, 8));
         assert_eq!(got, expected);
     }
 }

src/pyproject_fmt/__main__.py

@@ -8,10 +8,10 @@
 from typing import TYPE_CHECKING, Iterable, Sequence
 
 from pyproject_fmt._lib import format_toml
-from pyproject_fmt.cli import PyProjectFmtNamespace, cli_args
+from pyproject_fmt.cli import cli_args
 
 if TYPE_CHECKING:
-    from pyproject_fmt.config import Config
+    from pyproject_fmt.cli import Config
 
 GREEN = "\u001b[32m"
 RED = "\u001b[31m"
@@ -33,21 +33,22 @@ def color_diff(diff: Iterable[str]) -> Iterable[str]:
             yield line
 
 
-def _handle_one(config: Config, opts: PyProjectFmtNamespace) -> bool:
+def _handle_one(config: Config) -> bool:
     formatted = format_toml(
         config.toml,
+        column_width=config.column_width,
         indent=config.indent,
         keep_full_version=config.keep_full_version,
         max_supported_python=(config.max_supported_python.major, config.max_supported_python.minor),
         min_supported_python=(config.min_supported_python.major, config.min_supported_python.minor),
     )
     before = config.toml
     changed = before != formatted
-    if opts.stdout:  # stdout just prints new format to stdout
+    if config.stdout:  # stdout just prints new format to stdout
         print(formatted, end="")  # noqa: T201
         return changed
 
-    if before != formatted and not opts.check:
+    if before != formatted and not config.check:
         config.pyproject_toml.write_text(formatted, encoding="utf-8")
     try:
         name = str(config.pyproject_toml.relative_to(Path.cwd()))
@@ -72,8 +73,8 @@ def run(args: Sequence[str] | None = None) -> int:
     :param args: CLI arguments
     :return: exit code
     """
-    opts = cli_args(sys.argv[1:] if args is None else args)
-    results = [_handle_one(config, opts) for config in opts.configs]
+    configs = cli_args(sys.argv[1:] if args is None else args)
+    results = [_handle_one(config) for config in configs]
     return 1 if any(results) else 0  # exit with non success on change
 
 

src/pyproject_fmt/_lib.pyi

@@ -1,6 +1,7 @@
-def format_toml(
+def format_toml(  # noqa: PLR0913
     content: str,
     *,
+    column_width: int,
     indent: int,
     keep_full_version: bool,
     max_supported_python: tuple[int, int],

src/pyproject_fmt/cli.py

@@ -2,6 +2,14 @@
 
 from __future__ import annotations
 
+import sys
+from dataclasses import dataclass
+
+if sys.version_info >= (3, 11):  # pragma: >=3.11 cover
+    import tomllib
+else:  # pragma: <3.11 cover
+    import tomli as tomllib
+
 import os
 from argparse import (
     ArgumentDefaultsHelpFormatter,
@@ -15,33 +23,39 @@
 
 from packaging.version import Version
 
-from .config import DEFAULT_INDENT, DEFAULT_MAX_SUPPORTED_PYTHON, DEFAULT_MIN_SUPPORTED_PYTHON, Config
-
 
 class PyProjectFmtNamespace(Namespace):
     """Options for pyproject-fmt tool."""
 
     inputs: list[Path]
     stdout: bool
     check: bool
+
+    column_width: int
     indent: int
     keep_full_version: bool
     max_supported_python: Version
     min_supported_python: Version
 
+
+@dataclass(frozen=True)
+class Config:
+    """Configuration flags for the formatting."""
+
+    pyproject_toml: Path
+    stdout: bool  # push to standard out
+    check: bool  # check only
+
+    column_width: int  #: maximum column width
+    indent: int  #: indentation to apply
+    keep_full_version: bool  #: whether to keep full dependency versions
+    max_supported_python: Version  #: the maximum supported Python version
+    min_supported_python: Version  #: the minimum supported Python version
+
     @property
-    def configs(self) -> list[Config]:
-        """:return: configurations"""
-        return [
-            Config.from_file(
-                filename=toml,
-                indent=self.indent,
-                keep_full_version=self.keep_full_version,
-                max_supported_python=self.max_supported_python,
-                min_supported_python=self.min_supported_python,
-            )
-            for toml in self.inputs
-        ]
+    def toml(self) -> str:
+        """:return: the toml files content"""
+        return self.pyproject_toml.read_text(encoding="utf-8")
 
 
 def pyproject_toml_path_creator(argument: str) -> Path:
@@ -88,43 +102,84 @@ def _build_cli() -> ArgumentParser:
     group.add_argument("--check", action="store_true", help=msg)
     msg = "keep full dependency versions. For example do not change version 1.0.0 to 1"
     parser.add_argument("--keep-full-version", action="store_true", help=msg)
+    parser.add_argument(
+        "--column-width",
+        type=int,
+        default=1,
+        help="max column width in the file",
+    )
     parser.add_argument(
         "--indent",
         type=int,
-        default=DEFAULT_INDENT,
+        default=2,
         help="number of spaces to indent",
     )
     parser.add_argument(
         "--min-supported-python",
         type=Version,
-        default=DEFAULT_MIN_SUPPORTED_PYTHON,
+        default="3.8",
         help="latest Python version the project supports (e.g. 3.8)",
     )
     parser.add_argument(
         "--max-supported-python",
         type=Version,
-        default=DEFAULT_MAX_SUPPORTED_PYTHON,
+        default="3.12",
         help="latest Python version the project supports (e.g. 3.13)",
     )
     msg = "pyproject.toml file(s) to format"
     parser.add_argument("inputs", nargs="+", type=pyproject_toml_path_creator, help=msg)
     return parser
 
 
-def cli_args(args: Sequence[str]) -> PyProjectFmtNamespace:
+def cli_args(args: Sequence[str]) -> list[Config]:
     """
     Load the tools options.
 
     :param args: CLI arguments
     :return: the parsed options
     """
     parser = _build_cli()
-    result = PyProjectFmtNamespace()
-    parser.parse_args(namespace=result, args=args)
-    return result
+    opt = PyProjectFmtNamespace()
+    parser.parse_args(namespace=opt, args=args)
+    res = []
+    for pyproject_toml in opt.inputs:
+        column_width = opt.column_width
+        indent = opt.indent
+        keep_full_version = opt.keep_full_version
+        max_supported_python = opt.max_supported_python
+        min_supported_python = opt.min_supported_python
+        with pyproject_toml.open("rb") as file_handler:
+            config = tomllib.load(file_handler)
+            if "tool" in config and "pyproject-fmt" in config["tool"]:
+                for key, entry in config["tool"]["pyproject-fmt"].items():
+                    if key == "column_width":
+                        column_width = int(entry)
+                    elif key == "indent":
+                        indent = int(entry)
+                    elif key == "keep_full_version":
+                        keep_full_version = bool(entry)
+                    elif key == "max_supported_python":
+                        max_supported_python = Version(entry)
+                    elif key == "min_supported_python":  # pragma: no branch
+                        min_supported_python = Version(entry)
+        res.append(
+            Config(
+                pyproject_toml=pyproject_toml,
+                stdout=opt.stdout,
+                check=opt.check,
+                column_width=column_width,
+                indent=indent,
+                keep_full_version=keep_full_version,
+                max_supported_python=max_supported_python,
+                min_supported_python=min_supported_python,
+            )
+        )
+
+    return res
 
 
 __all__ = [
+    "Config",
     "PyProjectFmtNamespace",
     "cli_args",
 ]

src/pyproject_fmt/config.py

@@ -9,9 +9,11 @@ def __call__(
         start: str,
         expected: str,
         *,
+        column_width: int = ...,
         indent: int = ...,
         keep_full_version: bool = ...,
         max_supported_python: tuple[int, int] = ...,
+        min_supported_python: tuple[int, int] = ...,
     ) -> None: ...