Skip to content

Commit c643eb0

Browse files
tobiasraabetobiasraabe
committed
fix issue with base class.
1 parent c76d127 commit c643eb0

8 files changed

+156
-118
lines changed

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,6 @@ src/_pytask/_version.py
2222
*.pkl
2323

2424
tests/test_jupyter/*.txt
25+
.mypy_cache
26+
.pytest_cache
27+
.ruff_cache

‎.pre-commit-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ repos:
109109
hooks:
110110
- id: check-manifest
111111
args: [--no-build-isolation]
112-
additional_dependencies: [setuptools-scm, toml, wheel]
112+
additional_dependencies: [hatchling, hatch-vcs]
113113
- repo: meta
114114
hooks:
115115
- id: check-hooks-apply

‎pyproject.toml

+24-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
[build-system]
2-
build-backend = "setuptools.build_meta"
3-
requires = ["setuptools>=64", "setuptools_scm>=8"]
4-
5-
[tool.setuptools_scm]
6-
version_file = "src/_pytask/_version.py"
7-
81
[project]
92
name = "pytask"
103
description = "In its highest aspirations, pytask tries to be pytest as a build system."
@@ -38,6 +31,7 @@ dependencies = [
3831
"rich",
3932
"sqlalchemy>=2",
4033
'tomli>=1; python_version < "3.11"',
34+
"typed-settings[option-groups]",
4135
'typing-extensions; python_version < "3.9"',
4236
"universal-pathlib>=0.2.2",
4337
]
@@ -90,6 +84,26 @@ Tracker = "https://github.com/pytask-dev/pytask/issues"
9084
[project.scripts]
9185
pytask = "pytask:cli"
9286

87+
[build-system]
88+
requires = ["hatchling", "hatch_vcs"]
89+
build-backend = "hatchling.build"
90+
91+
[tool.rye]
92+
managed = true
93+
dev-dependencies = []
94+
95+
[tool.hatch.metadata]
96+
allow-direct-references = true
97+
98+
[tool.hatch.build.hooks.vcs]
99+
version-file = "src/_pytask/_version.py"
100+
101+
[tool.hatch.build.targets.wheel]
102+
packages = ["src/pytask"]
103+
104+
[tool.hatch.version]
105+
source = "vcs"
106+
93107
[tool.setuptools]
94108
include-package-data = true
95109
zip-safe = false
@@ -103,6 +117,9 @@ license-files = ["LICENSE"]
103117
where = ["src"]
104118
namespaces = false
105119

120+
[tool.setuptools_scm]
121+
version_file = "src/_pytask/_version.py"
122+
106123
[tool.ruff]
107124
target-version = "py38"
108125
fix = true

‎src/_pytask/logging.py

+5-2
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,11 @@ def pytask_extend_command_line_interface(
6868
@hookimpl
6969
def pytask_parse_config(config: Settings) -> None:
7070
"""Parse configuration."""
71-
if config.editor_url_scheme not in ("no_link", "file") and IS_WINDOWS_TERMINAL:
72-
config.editor_url_scheme = "file"
71+
if (
72+
config.common.editor_url_scheme not in ("no_link", "file")
73+
and IS_WINDOWS_TERMINAL
74+
):
75+
config.common.editor_url_scheme = "file"
7376
warnings.warn(
7477
"Windows Terminal does not support url schemes to applications, yet."
7578
"See https://github.com/pytask-dev/pytask/issues/171 for more information. "

‎src/_pytask/parameters.py

+102
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,79 @@
22

33
from __future__ import annotations
44

5+
import importlib.util
56
from pathlib import Path
67
from typing import TYPE_CHECKING
8+
from typing import Iterable
79

810
import click
911
import typed_settings as ts
1012
from click import Context
1113
from pluggy import PluginManager
1214

15+
from _pytask.path import import_path
1316
from _pytask.pluginmanager import hookimpl
17+
from _pytask.pluginmanager import register_hook_impls_from_modules
18+
from _pytask.pluginmanager import storage
1419

1520
if TYPE_CHECKING:
1621
from _pytask.settings import SettingsBuilder
1722

1823

24+
def _hook_module_callback(
25+
ctx: Context,
26+
name: str, # noqa: ARG001
27+
value: tuple[str, ...],
28+
) -> Iterable[str | Path]:
29+
"""Register the user's hook modules from the configuration file."""
30+
if not value:
31+
return value
32+
33+
parsed_modules = []
34+
for module_name in value:
35+
if module_name.endswith(".py"):
36+
path = Path(module_name)
37+
if ctx.params["config"]:
38+
path = ctx.params["config"].parent.joinpath(path).resolve()
39+
else:
40+
path = Path.cwd().joinpath(path).resolve()
41+
42+
if not path.exists():
43+
msg = (
44+
f"The hook module {path} does not exist. "
45+
"Please provide a valid path."
46+
)
47+
raise click.BadParameter(msg)
48+
module = import_path(path, ctx.params["root"])
49+
parsed_modules.append(module.__name__)
50+
else:
51+
spec = importlib.util.find_spec(module_name)
52+
if spec is None:
53+
msg = (
54+
f"The hook module {module_name!r} is not importable. "
55+
"Please provide a valid module name."
56+
)
57+
raise click.BadParameter(msg)
58+
parsed_modules.append(module_name)
59+
60+
# If there are hook modules, we register a hook implementation to add them.
61+
# ``pytask_add_hooks`` is a historic hook specification, so even command line
62+
# options can be added.
63+
if parsed_modules:
64+
65+
class HookModule:
66+
@staticmethod
67+
@hookimpl
68+
def pytask_add_hooks(pm: PluginManager) -> None:
69+
"""Add hooks."""
70+
register_hook_impls_from_modules(pm, parsed_modules)
71+
72+
pm = storage.get()
73+
pm.register(HookModule)
74+
75+
return parsed_modules
76+
77+
1978
def _path_callback(
2079
ctx: Context, # noqa: ARG001
2180
param: click.Parameter, # noqa: ARG001
@@ -29,6 +88,49 @@ def _path_callback(
2988
class Common:
3089
"""Common settings for the command line interface."""
3190

91+
debug_pytask: bool = ts.option(
92+
default=False,
93+
click={"param_decls": ("--debug-pytask",), "is_flag": True},
94+
help="Trace all function calls in the plugin framework.",
95+
)
96+
editor_url_scheme: str = ts.option(
97+
default="file",
98+
click={"param_decls": ["--editor-url-scheme"]},
99+
help=(
100+
"Use file, vscode, pycharm or a custom url scheme to add URLs to task "
101+
"ids to quickly jump to the task definition. Use no_link to disable URLs."
102+
),
103+
)
104+
ignore: tuple[str, ...] = ts.option(
105+
factory=tuple,
106+
help=(
107+
"A pattern to ignore files or directories. Refer to 'pathlib.Path.match' "
108+
"for more info."
109+
),
110+
click={"param_decls": ["--ignore"], "multiple": True},
111+
)
112+
verbose: int = ts.option(
113+
default=1,
114+
help="Make pytask verbose (>= 0) or quiet (= 0).",
115+
click={
116+
"param_decls": ["-v", "--verbose"],
117+
"type": click.IntRange(0, 2),
118+
"count": True,
119+
},
120+
)
121+
hook_module: tuple[str, ...] = ts.option(
122+
factory=list,
123+
help="Path to a Python module that contains hook implementations.",
124+
click={
125+
"param_decls": ["--hook-module"],
126+
"multiple": True,
127+
"is_eager": True,
128+
"callback": _hook_module_callback,
129+
},
130+
)
131+
config_file: Path | None = ts.option(
132+
default=None, click={"param_decls": ["--config-file"], "hidden": True}
133+
)
32134
paths: tuple[Path, ...] = ts.option(
33135
factory=tuple,
34136
click={

‎src/_pytask/settings.py

+1-105
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,17 @@
11
from __future__ import annotations
22

3-
import importlib.util
43
from enum import Enum
5-
from pathlib import Path
6-
from typing import Iterable
74

8-
import click
95
import typed_settings as ts
106
from click import BadParameter
117
from click import Context
12-
from pluggy import PluginManager
138
from sqlalchemy.engine import URL
149
from sqlalchemy.engine import make_url
1510
from sqlalchemy.exc import ArgumentError
1611

1712
from _pytask.capture_utils import CaptureMethod
1813
from _pytask.capture_utils import ShowCapture
1914
from _pytask.click import EnumChoice
20-
from _pytask.path import import_path
21-
from _pytask.pluginmanager import hookimpl
22-
from _pytask.pluginmanager import register_hook_impls_from_modules
23-
from _pytask.pluginmanager import storage
24-
25-
26-
def _hook_module_callback(
27-
ctx: Context,
28-
name: str, # noqa: ARG001
29-
value: tuple[str, ...],
30-
) -> Iterable[str | Path]:
31-
"""Register the user's hook modules from the configuration file."""
32-
if not value:
33-
return value
34-
35-
parsed_modules = []
36-
for module_name in value:
37-
if module_name.endswith(".py"):
38-
path = Path(module_name)
39-
if ctx.params["config"]:
40-
path = ctx.params["config"].parent.joinpath(path).resolve()
41-
else:
42-
path = Path.cwd().joinpath(path).resolve()
43-
44-
if not path.exists():
45-
msg = (
46-
f"The hook module {path} does not exist. "
47-
"Please provide a valid path."
48-
)
49-
raise click.BadParameter(msg)
50-
module = import_path(path, ctx.params["root"])
51-
parsed_modules.append(module.__name__)
52-
else:
53-
spec = importlib.util.find_spec(module_name)
54-
if spec is None:
55-
msg = (
56-
f"The hook module {module_name!r} is not importable. "
57-
"Please provide a valid module name."
58-
)
59-
raise click.BadParameter(msg)
60-
parsed_modules.append(module_name)
61-
62-
# If there are hook modules, we register a hook implementation to add them.
63-
# ``pytask_add_hooks`` is a historic hook specification, so even command line
64-
# options can be added.
65-
if parsed_modules:
66-
67-
class HookModule:
68-
@staticmethod
69-
@hookimpl
70-
def pytask_add_hooks(pm: PluginManager) -> None:
71-
"""Add hooks."""
72-
register_hook_impls_from_modules(pm, parsed_modules)
73-
74-
pm = storage.get()
75-
pm.register(HookModule)
76-
77-
return parsed_modules
7815

7916

8017
@ts.settings
@@ -227,48 +164,7 @@ class Markers:
227164

228165

229166
@ts.settings
230-
class Settings:
231-
debug_pytask: bool = ts.option(
232-
default=False,
233-
click={"param_decls": ("--debug-pytask",), "is_flag": True},
234-
help="Trace all function calls in the plugin framework.",
235-
)
236-
editor_url_scheme: str = ts.option(
237-
default="file",
238-
click={"param_decls": ["--editor-url-scheme"]},
239-
help=(
240-
"Use file, vscode, pycharm or a custom url scheme to add URLs to task "
241-
"ids to quickly jump to the task definition. Use no_link to disable URLs."
242-
),
243-
)
244-
ignore: tuple[str, ...] = ts.option(
245-
factory=tuple,
246-
help=(
247-
"A pattern to ignore files or directories. Refer to 'pathlib.Path.match' "
248-
"for more info."
249-
),
250-
click={"param_decls": ["--ignore"], "multiple": True},
251-
)
252-
verbose: int = ts.option(
253-
default=1,
254-
help="Make pytask verbose (>= 0) or quiet (= 0).",
255-
click={
256-
"param_decls": ["-v", "--verbose"],
257-
"type": click.IntRange(0, 2),
258-
"count": True,
259-
},
260-
)
261-
hook_module: tuple[str, ...] = ts.option(
262-
factory=list,
263-
help="Path to a Python module that contains hook implementations.",
264-
click={
265-
"param_decls": ["--hook-module"],
266-
"multiple": True,
267-
"is_eager": True,
268-
"callback": _hook_module_callback,
269-
},
270-
)
271-
config_file: Path | None = None
167+
class Settings: ...
272168

273169

274170
@ts.settings

‎src/_pytask/settings_utils.py

+19-2
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def __call__(
8181
self,
8282
path: Path,
8383
settings_cls: SettingsClass, # noqa: ARG002
84-
options: OptionList, # noqa: ARG002
84+
options: OptionList,
8585
) -> SettingsDict:
8686
"""
8787
Load settings from a TOML file and return them as a dict.
@@ -120,9 +120,26 @@ def __call__(
120120
if self.deprecated and not _ALREADY_PRINTED_DEPRECATION_MSG:
121121
_ALREADY_PRINTED_DEPRECATION_MSG = True
122122
console.print(self.deprecated)
123-
settings["config_file"] = path
123+
settings["common.config_file"] = path
124+
settings = self._rewrite_paths_of_options(settings, options)
124125
return cast(SettingsDict, settings)
125126

127+
def _rewrite_paths_of_options(
128+
self, settings: SettingsDict, options: OptionList
129+
) -> SettingsDict:
130+
"""Rewrite paths of options in the settings."""
131+
option_paths = {option.path for option in options}
132+
for name in list(settings):
133+
if name in option_paths:
134+
continue
135+
136+
for option_path in option_paths:
137+
if name in option_path:
138+
settings[option_path] = settings.pop(name)
139+
break
140+
141+
return settings
142+
126143

127144
def load_settings(settings_cls: Any) -> Any:
128145
"""Load the settings."""

‎src/_pytask/traceback.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ class Traceback:
5151
_show_locals: ClassVar[bool] = False
5252
suppress: ClassVar[tuple[Path, ...]] = (
5353
_PLUGGY_DIRECTORY,
54-
_PYTASK_DIRECTORY,
54+
# _PYTASK_DIRECTORY,
5555
TREE_UTIL_LIB_DIRECTORY,
5656
)
5757

0 commit comments

Comments
 (0)