Merge pull request #936 from RonnyPfannschmidt/try-ruff

introduce ruff as a linter

Author: RonnyPfannschmidt

.pre-commit-config.yaml

@@ -27,6 +27,11 @@ repos:
     hooks:
     - id: pyupgrade
       args: [--py38-plus]
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.0.291
+  hooks:
+    - id: ruff
+      args: [--fix, --exit-non-zero-on-fix]
 - repo: https://github.com/tox-dev/pyproject-fmt
   rev: "1.1.0"
   hooks:

MANIFEST.in

@@ -1,6 +1,8 @@
 exclude *.nix
 exclude .pre-commit-config.yaml
+exclude changelog.d/*
 exclude .git_archival.txt
+exclude .readthedocs.yaml
 include *.py
 include testing/*.py
 include tox.ini
@@ -10,5 +12,14 @@ include *.toml
 include mypy.ini
 include testing/Dockerfile.*
 include src/setuptools_scm/.git_archival.txt
+include README.md
+include CHANGELOG.md
+
+
 recursive-include testing *.bash
 prune nextgen
+
+recursive-include docs *.md
+include docs/examples/version_scheme_code/*.py
+include docs/examples/version_scheme_code/*.toml
+include mkdocs.yml

changelog.d/20230922_220934_opensource_try_ruff.md

@@ -0,0 +1,4 @@
+
+### Changed
+
+- introduce ruff as a linter

hatch.toml

@@ -1,3 +1,13 @@
+[envs.test]
+extras = ["test", "dev"]
+
+[envs.test.scripts]
+all = "pytest {args}"
+
+[[env.test.matrix]]
+python = ["3.8", "3.9", "3.10", "3.11"]
+
+
 [envs.docs]
 python = "3.11"
 extras = ["docs"]

pyproject.toml

@@ -42,7 +42,7 @@ dependencies = [
   "packaging>=20",
   "setuptools",
   'tomli>=1; python_version < "3.11"',
-  'typing-extensions; python_version < "3.11"',
+  "typing-extensions",
 ]
 [project.optional-dependencies]
 docs = [
@@ -108,5 +108,25 @@ version = { attr = "_own_version_helper.version"}
 
 [tool.setuptools_scm]
 
+[tool.ruff]
+select = ["E", "F", "B", "U", "YTT", "C", "DTZ", "PYI", "PT"]
+ignore = ["B028"]
+
+[tool.pytest.ini_options]
+testpaths = ["testing"]
+filterwarnings = [
+  "error",
+  "ignore:.*tool\\.setuptools_scm.*",
+  "ignore:.*git archive did not support describe output.*:UserWarning",
+]
+log_level = "debug"
+log_cli_level = "info"
+# disable unraisable until investigated
+addopts = ["-p", "no:unraisableexception"]
+markers = [
+  "issue(id): reference to github issue",
+  "skip_commit: allows to skip committing in the helpers",
+]
+
 [tool.scriv]
 format = "md"

src/setuptools_scm/_config.py

@@ -65,8 +65,7 @@ def _check_absolute_root(root: _t.PathT, relative_to: _t.PathT | None) -> str:
             and not os.path.commonpath([root, relative_to]) == root
         ):
             warnings.warn(
-                "absolute root path '%s' overrides relative_to '%s'"
-                % (root, relative_to)
+                f"absolute root path '{root}' overrides relative_to '{relative_to}'"
             )
         if os.path.isdir(relative_to):
             warnings.warn(

src/setuptools_scm/_file_finders/__init__.py

@@ -44,7 +44,7 @@ def scm_find_files(
         # dirpath with symlinks resolved
         realdirpath = os.path.normcase(os.path.realpath(dirpath))
 
-        def _link_not_in_scm(n: str) -> bool:
+        def _link_not_in_scm(n: str, realdirpath: str = realdirpath) -> bool:
             fn = os.path.join(realdirpath, os.path.normcase(n))
             return os.path.islink(fn) and fn not in scm_files
 

src/setuptools_scm/_file_finders/hg.py

@@ -34,7 +34,7 @@ def _hg_ls_files_and_dirs(toplevel: str) -> tuple[set[str], set[str]]:
     hg_dirs = {toplevel}
     res = _run(["hg", "files"], cwd=toplevel)
     if res.returncode:
-        (), ()
+        return set(), set()
     for name in res.stdout.splitlines():
         name = os.path.normcase(name).replace("/", os.path.sep)
         fullname = os.path.join(toplevel, name)

src/setuptools_scm/_version_cls.py

@@ -84,6 +84,8 @@ def _validate_version_cls(
             try:
                 return cast(Type[_VersionT], import_name(version_cls))
             except:  # noqa
-                raise ValueError(f"Unable to import version_cls='{version_cls}'")
+                raise ValueError(
+                    f"Unable to import version_cls='{version_cls}'"
+                ) from None
         else:
             return version_cls

src/setuptools_scm/git.py

@@ -8,6 +8,7 @@
 import warnings
 from datetime import date
 from datetime import datetime
+from datetime import timezone
 from os.path import samefile
 from pathlib import Path
 from typing import Callable
@@ -268,7 +269,7 @@ def _git_parse_inner(
             tag=tag, distance=distance, dirty=dirty, node=node, config=config
         )
     branch = wd.get_branch()
-    node_date = wd.get_head_date() or date.today()
+    node_date = wd.get_head_date() or datetime.now(timezone.utc).date()
     return dataclasses.replace(version, branch=branch, node_date=node_date)