Update templates for new projects (#624)

* Update templates for new projects

* add coverage

* final Ruff update

* fix

* back to pytest-cov for subprocesses and xdist

Author: ofek

docs/config/project-templates.md

@@ -32,7 +32,7 @@ The list of licenses should be composed of [SPDX identifiers](https://spdx.org/l
 
 ### Tests
 
-This adds a `tests` directory with [pytest](https://github.com/pytest-dev/pytest) functionality.
+This adds a `tests` directory with environments for testing and linting.
 
 === ":octicons-file-code-16: config.toml"
 

docs/environment.md

@@ -59,16 +59,16 @@ hatch run python -c "import sys;print(sys.executable)"
 
 You can also run any [scripts](config/environment/overview.md#scripts) that have been defined.
 
-You'll notice that in the `pyproject.toml` file there are already scripts defined in the `default` environment. Try running the `cov` command, which invokes [pytest](https://github.com/pytest-dev/pytest) with some flags for tracking [coverage](https://github.com/nedbat/coveragepy):
+You'll notice that in the `pyproject.toml` file there are already scripts defined in the `default` environment. Try running the `test` command, which invokes [pytest](https://github.com/pytest-dev/pytest) with some default arguments:
 
 ```
-hatch run cov
+hatch run test
 ```
 
-All additional arguments are passed through to scripts, so for example if you wanted to see the version of `pytest` and which plugins are installed you could do:
+All additional arguments are passed through to that script, so for example if you wanted to see the version of `pytest` and which plugins are installed you could do:
 
 ```
-hatch run cov -VV
+hatch run test -VV
 ```
 
 ## Dependencies

docs/intro.md

@@ -18,9 +18,10 @@ This would create the following structure in your current working directory:
 
 ```
 hatch-demo
-├── hatch_demo
-│   ├── __about__.py
-│   └── __init__.py
+├── src
+│   └── hatch_demo
+│       ├── __about__.py
+│       └── __init__.py
 ├── tests
 │   └── __init__.py
 ├── LICENSE.txt

docs/version.md

@@ -12,14 +12,14 @@ The `regex` source requires an option `path` that represents a relative path to
 
     ```toml
     [tool.hatch.version]
-    path = "hatch_demo/__about__.py"
+    path = "src/hatch_demo/__about__.py"
     ```
 
 === ":octicons-file-code-16: hatch.toml"
 
     ```toml
     [version]
-    path = "hatch_demo/__about__.py"
+    path = "src/hatch_demo/__about__.py"
     ```
 
 The default pattern looks for a variable named `__version__` or `VERSION` that is set to a string containing the version, optionally prefixed with the lowercase letter `v`.

pyproject.toml

@@ -77,7 +77,6 @@ exclude = [
 ]
 
 [tool.black]
-include = '\.pyi?$'
 line-length = 120
 skip-string-normalization = true
 target-version = ["py37"]
@@ -104,12 +103,17 @@ select = [
   "YTT",
 ]
 ignore = [
+  # Allow non-abstract empty methods in abstract base classes
   "B027",
-  "FBT003",
+  # Ignore McCabe complexity
   "C901",
-  "S105",
+  # Allow boolean positional values in function calls, like `dict.get(... True)`
+  "FBT003",
+  # Ignore checks for possible passwords
+  "S105", "S106", "S107",
 ]
 unfixable = [
+  # Don't touch unused imports
   "F401",
 ]
 
@@ -128,7 +132,6 @@ ban-relative-imports = "all"
 "backend/tests/downstream/integrate.py" = ["T201"]
 "scripts/*" = ["T201"]
 # Tests can use relative imports and assertions
-"tests/*" = ["I252", "S101"]
 "tests/**/*" = ["I252", "S101"]
 
 [tool.mypy]
@@ -175,8 +178,8 @@ omit = [
 ]
 
 [tool.coverage.paths]
-hatch = ["src", "*/hatch/src"]
-hatchling = ["backend/src", "*/hatch/backend/src"]
+hatch = ["src/hatch", "*/hatch/src/hatch"]
+hatchling = ["backend/src/hatchling", "*/hatch/backend/src/hatchling"]
 tests = ["tests", "*/hatch/tests"]
 
 [tool.coverage.report]

src/hatch/template/files_default.py

@@ -9,7 +9,7 @@ def __init__(self, template_config: dict, plugin_config: dict):
 
 class MetadataFile(File):
     def __init__(self, template_config: dict, plugin_config: dict):
-        super().__init__(Path(template_config['package_name'], '__about__.py'), "__version__ = '0.0.1'\n")
+        super().__init__(Path(template_config['package_name'], '__about__.py'), '__version__ = "0.0.1"\n')
 
 
 class Readme(File):
@@ -68,6 +68,7 @@ class PyProject(File):
 
 [project]
 name = "{project_name_normalized}"
+dynamic = ["version"]
 description = {description!r}
 readme = "{readme_file_path}"
 requires-python = ">=3.7"
@@ -88,7 +89,6 @@ class PyProject(File):
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
 dependencies = {dependency_data}
-dynamic = ["version"]
 
 [project.urls]{project_url_data}{cli_scripts}
 
@@ -140,19 +140,81 @@ def __init__(self, template_config: dict, plugin_config: dict):
   "pytest-cov",
 ]
 [tool.hatch.envs.default.scripts]
-cov = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov={package_location}{template_config['package_name']} --cov=tests {{args}}"
-no-cov = "cov --no-cov {{args}}"
+test = "pytest --no-cov {{args:tests}}"
+test-cov = "pytest --cov --cov-report=term-missing --cov-config=pyproject.toml {{args:tests}}"
 
-[[tool.hatch.envs.test.matrix]]
+[[tool.hatch.envs.all.matrix]]
 python = ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
+[tool.hatch.envs.lint]
+detached = true
+dependencies = [
+  "black",
+  "mypy",
+  "ruff",
+]
+[tool.hatch.envs.lint.scripts]
+typing = "mypy --install-types --non-interactive {{args:{package_location}{template_config['package_name']} tests}}"
+style = [
+  "ruff {{args:.}}",
+  "black --check --diff {{args:.}}",
+]
+fmt = [
+  "black {{args:.}}",
+  "ruff --fix {{args:.}}",
+  "style",
+]
+all = [
+  "style",
+  "typing",
+]
+
+[tool.black]
+target-version = ["py37"]
+line-length = 120
+skip-string-normalization = true
+
+[tool.ruff]
+target-version = "py37"
+line-length = 120
+select = ["A", "B", "C", "E", "F", "FBT", "I", "M", "N", "Q", "RUF", "S", "T", "U", "W", "YTT"]
+ignore = [
+  # Allow non-abstract empty methods in abstract base classes
+  "B027",
+  # Ignore McCabe complexity
+  "C901",
+  # Allow boolean positional values in function calls, like `dict.get(... True)`
+  "FBT003",
+  # Ignore checks for possible passwords
+  "S105", "S106", "S107",
+]
+unfixable = [
+  # Don't touch unused imports
+  "F401",
+]
+
+[tool.ruff.isort]
+known-first-party = ["{template_config['package_name']}"]
+
+[tool.ruff.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+[tool.ruff.per-file-ignores]
+# Tests can use relative imports and assertions
+"tests/**/*" = ["I252", "S101"]
+
 [tool.coverage.run]
+source_pkgs = ["{template_config['package_name']}", "tests"]
 branch = true
 parallel = true
 omit = [
   "{package_location}{template_config['package_name']}/__about__.py",
 ]
 
+[tool.coverage.paths]
+{template_config['package_name']} = ["{package_location}{template_config['package_name']}", "*/{template_config['project_name_normalized']}/{package_location}{template_config['package_name']}"]
+tests = ["tests", "*/{template_config['project_name_normalized']}/tests"]
+
 [tool.coverage.report]
 exclude_lines = [
   "no cov",

src/hatch/template/files_feature_cli.py

@@ -6,8 +6,8 @@ class PackageEntryPoint(File):
     TEMPLATE = """\
 import sys
 
-if __name__ == '__main__':
-    from .cli import {package_name}
+if __name__ == "__main__":
+    from {package_name}.cli import {package_name}
 
     sys.exit({package_name}())
 """
@@ -20,14 +20,14 @@ class CommandLinePackage(File):
     TEMPLATE = """\
 import click
 
-from ..__about__ import __version__
+from {package_name}.__about__ import __version__
 
 
-@click.group(context_settings={{'help_option_names': ['-h', '--help']}}, invoke_without_command=True)
-@click.version_option(version=__version__, prog_name={project_name!r})
+@click.group(context_settings={{"help_option_names": ["-h", "--help"]}}, invoke_without_command=True)
+@click.version_option(version=__version__, prog_name="{project_name}")
 @click.pass_context
 def {package_name}(ctx: click.Context):
-    click.echo('Hello world!')
+    click.echo("Hello world!")
 """
 
     def __init__(self, template_config: dict, plugin_config: dict):

tests/helpers/templates/new/basic.py

@@ -26,7 +26,7 @@ def get_files(**kwargs):
 # SPDX-FileCopyrightText: {kwargs['year']}-present {kwargs['author']} <{kwargs['email']}>
 #
 # SPDX-License-Identifier: MIT
-__version__ = '0.0.1'
+__version__ = "0.0.1"
 """,
         ),
         File(
@@ -64,6 +64,7 @@ def get_files(**kwargs):
 
 [project]
 name = "{kwargs['project_name_normalized']}"
+dynamic = ["version"]
 description = ''
 readme = "README.md"
 requires-python = ">=3.7"
@@ -84,7 +85,6 @@ def get_files(**kwargs):
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
 dependencies = []
-dynamic = ["version"]
 
 [project.urls]
 Documentation = "https://github.com/unknown/{kwargs['project_name_normalized']}#readme"

tests/helpers/templates/new/default.py

@@ -28,7 +28,7 @@ def get_files(**kwargs):
 # SPDX-FileCopyrightText: {kwargs['year']}-present {kwargs['author']} <{kwargs['email']}>
 #
 # SPDX-License-Identifier: MIT
-__version__ = '0.0.1'
+__version__ = "0.0.1"
 """,
         ),
         File(
@@ -74,6 +74,7 @@ def get_files(**kwargs):
 
 [project]
 name = "{kwargs['project_name_normalized']}"
+dynamic = ["version"]
 description = '{description}'
 readme = "README.md"
 requires-python = ">=3.7"
@@ -94,7 +95,6 @@ def get_files(**kwargs):
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
 dependencies = []
-dynamic = ["version"]
 
 [project.urls]
 Documentation = "https://github.com/unknown/{kwargs['project_name_normalized']}#readme"
@@ -110,19 +110,81 @@ def get_files(**kwargs):
   "pytest-cov",
 ]
 [tool.hatch.envs.default.scripts]
-cov = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=src/{kwargs['package_name']} --cov=tests {{args}}"
-no-cov = "cov --no-cov {{args}}"
+test = "pytest --no-cov {{args:tests}}"
+test-cov = "pytest --cov --cov-report=term-missing --cov-config=pyproject.toml {{args:tests}}"
 
-[[tool.hatch.envs.test.matrix]]
+[[tool.hatch.envs.all.matrix]]
 python = ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
+[tool.hatch.envs.lint]
+detached = true
+dependencies = [
+  "black",
+  "mypy",
+  "ruff",
+]
+[tool.hatch.envs.lint.scripts]
+typing = "mypy --install-types --non-interactive {{args:src/{kwargs['package_name']} tests}}"
+style = [
+  "ruff {{args:.}}",
+  "black --check --diff {{args:.}}",
+]
+fmt = [
+  "black {{args:.}}",
+  "ruff --fix {{args:.}}",
+  "style",
+]
+all = [
+  "style",
+  "typing",
+]
+
+[tool.black]
+target-version = ["py37"]
+line-length = 120
+skip-string-normalization = true
+
+[tool.ruff]
+target-version = "py37"
+line-length = 120
+select = ["A", "B", "C", "E", "F", "FBT", "I", "M", "N", "Q", "RUF", "S", "T", "U", "W", "YTT"]
+ignore = [
+  # Allow non-abstract empty methods in abstract base classes
+  "B027",
+  # Ignore McCabe complexity
+  "C901",
+  # Allow boolean positional values in function calls, like `dict.get(... True)`
+  "FBT003",
+  # Ignore checks for possible passwords
+  "S105", "S106", "S107",
+]
+unfixable = [
+  # Don't touch unused imports
+  "F401",
+]
+
+[tool.ruff.isort]
+known-first-party = ["{kwargs['package_name']}"]
+
+[tool.ruff.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+[tool.ruff.per-file-ignores]
+# Tests can use relative imports and assertions
+"tests/**/*" = ["I252", "S101"]
+
 [tool.coverage.run]
+source_pkgs = ["{kwargs['package_name']}", "tests"]
 branch = true
 parallel = true
 omit = [
   "src/{kwargs['package_name']}/__about__.py",
 ]
 
+[tool.coverage.paths]
+{kwargs['package_name']} = ["src/{kwargs['package_name']}", "*/{kwargs['project_name_normalized']}/src/{kwargs['package_name']}"]
+tests = ["tests", "*/{kwargs['project_name_normalized']}/tests"]
+
 [tool.coverage.report]
 exclude_lines = [
   "no cov",