sigil-cli 1.4.0__tar.gz → 1.4.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {sigil_cli-1.4.0/src/sigil_cli.egg-info → sigil_cli-1.4.2}/PKG-INFO +3 -3
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/README.md +2 -2
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/pyproject.toml +1 -1
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/cli_tools/init.py +1 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/datasource/datasource.py +2 -4
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/datasource/yml_source.py +8 -9
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/entrypoint.py +7 -3
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/stages/builder.py +1 -1
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/stages/parser.py +4 -2
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/stages/script_loader.py +40 -3
- {sigil_cli-1.4.0 → sigil_cli-1.4.2/src/sigil_cli.egg-info}/PKG-INFO +3 -3
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/tests/test_scriptloader.py +1 -1
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/LICENSE +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/setup.cfg +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/__init__.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/__main__.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/cli_tools/__init__.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/cli_tools/tree.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/cli_tools/validate.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/datasource/__init__.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/models/__init__.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/models/argparser.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/models/argument.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/models/command.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/models/script.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/stages/__init__.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil/stages/resolver.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil_cli.egg-info/SOURCES.txt +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil_cli.egg-info/dependency_links.txt +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil_cli.egg-info/entry_points.txt +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil_cli.egg-info/requires.txt +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/src/sigil_cli.egg-info/top_level.txt +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/tests/test_builder.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/tests/test_cli_init.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/tests/test_cli_tree.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/tests/test_cli_validate.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/tests/test_integration.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/tests/test_reader.py +0 -0
- {sigil_cli-1.4.0 → sigil_cli-1.4.2}/tests/test_resolver.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: sigil-cli
|
|
3
|
-
Version: 1.4.
|
|
3
|
+
Version: 1.4.2
|
|
4
4
|
Summary: Configuration driven CLI builder with subcommands and script loading
|
|
5
5
|
Author-email: Kenzo Staelens <kenzostael@gmail.com>
|
|
6
6
|
License: MIT
|
|
@@ -295,11 +295,11 @@ class JsonReader:
|
|
|
295
295
|
...
|
|
296
296
|
|
|
297
297
|
|
|
298
|
-
run_from_config("/path/to/config",
|
|
298
|
+
run_from_config("/path/to/config", datasource=JsonReader)
|
|
299
299
|
```
|
|
300
300
|
|
|
301
301
|
You can also pass a pre‑loaded dictionary directly by wrapping it:
|
|
302
302
|
|
|
303
303
|
```python
|
|
304
|
-
run_from_config(my_dict,
|
|
304
|
+
run_from_config(my_dict, datasource=DictReader)
|
|
305
305
|
```
|
|
@@ -265,11 +265,11 @@ class JsonReader:
|
|
|
265
265
|
...
|
|
266
266
|
|
|
267
267
|
|
|
268
|
-
run_from_config("/path/to/config",
|
|
268
|
+
run_from_config("/path/to/config", datasource=JsonReader)
|
|
269
269
|
```
|
|
270
270
|
|
|
271
271
|
You can also pass a pre‑loaded dictionary directly by wrapping it:
|
|
272
272
|
|
|
273
273
|
```python
|
|
274
|
-
run_from_config(my_dict,
|
|
274
|
+
run_from_config(my_dict, datasource=DictReader)
|
|
275
275
|
```
|
|
@@ -5,15 +5,13 @@ from pathlib import Path
|
|
|
5
5
|
# currently network based datasources are not planned
|
|
6
6
|
# but if you do *need* one for some reason, feel free to make a PR
|
|
7
7
|
class DataSource(ABC):
|
|
8
|
-
@classmethod
|
|
9
8
|
@abstractmethod
|
|
10
|
-
def read_manifest(
|
|
9
|
+
def read_manifest(self, target: Path) -> list | None:
|
|
11
10
|
# current implementation expects a list of files, or none on error
|
|
12
11
|
...
|
|
13
12
|
|
|
14
|
-
@classmethod
|
|
15
13
|
@abstractmethod
|
|
16
|
-
def read_configuration(
|
|
14
|
+
def read_configuration(self, target: Path) -> dict | None:
|
|
17
15
|
# raw data roughly mapping to internal models
|
|
18
16
|
# validation happens in a later stage
|
|
19
17
|
# datasources shouldn't need to validate
|
|
@@ -8,10 +8,11 @@ from .datasource import DataSource
|
|
|
8
8
|
_logger = logging.getLogger(__name__)
|
|
9
9
|
|
|
10
10
|
|
|
11
|
+
# base defines abstract as not-classmethod
|
|
12
|
+
# though instantiation is not a requirement
|
|
13
|
+
# if you don't need instance data, classmethods are fine too
|
|
11
14
|
class YmlSource(DataSource):
|
|
12
|
-
|
|
13
|
-
@classmethod
|
|
14
|
-
def read(cls, target):
|
|
15
|
+
def read(self, target):
|
|
15
16
|
try:
|
|
16
17
|
with open(target) as f:
|
|
17
18
|
return yaml.load(f.read(), Loader=yaml.SafeLoader)
|
|
@@ -23,14 +24,12 @@ class YmlSource(DataSource):
|
|
|
23
24
|
return
|
|
24
25
|
|
|
25
26
|
|
|
26
|
-
|
|
27
|
-
def read_manifest(cls, manifest_file: Path) -> list | None:
|
|
27
|
+
def read_manifest(self, target: Path) -> list | None:
|
|
28
28
|
# indirection? yes
|
|
29
29
|
# can new datasources implement a better manifest vs data? also yes
|
|
30
|
-
return
|
|
30
|
+
return self.read(target)
|
|
31
31
|
|
|
32
32
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
return cls.read(target)
|
|
33
|
+
def read_configuration(self, target: Path) -> dict | None:
|
|
34
|
+
return self.read(target)
|
|
36
35
|
|
|
@@ -1,15 +1,19 @@
|
|
|
1
1
|
import logging
|
|
2
2
|
import sys
|
|
3
|
+
from pathlib import Path
|
|
3
4
|
from typing import Any
|
|
4
5
|
|
|
5
|
-
from .datasource import YmlSource
|
|
6
|
+
from .datasource import DataSource, YmlSource
|
|
6
7
|
from .stages import Builder, Parser, Resolver, ScriptLoader
|
|
7
8
|
|
|
8
9
|
_logger = logging.getLogger(__name__)
|
|
9
10
|
|
|
10
11
|
# default to yamlloader, use whatever datastore you feel like
|
|
11
|
-
def run_from_config(
|
|
12
|
-
|
|
12
|
+
def run_from_config(
|
|
13
|
+
config_root: str | Path,
|
|
14
|
+
datasource: DataSource | type[DataSource] = YmlSource
|
|
15
|
+
) -> None:
|
|
16
|
+
raw_data = Parser(datasource).load(config_root)
|
|
13
17
|
resolved = Resolver.resolve_inheritance(raw_data)
|
|
14
18
|
# parser beyond here is an argparser
|
|
15
19
|
parser = Builder.build(resolved)
|
|
@@ -11,7 +11,9 @@ _logger = logging.getLogger(__name__)
|
|
|
11
11
|
# This class converts raw data to dataclasses
|
|
12
12
|
# it takes a datasource class to interface with any desired IO
|
|
13
13
|
class Parser:
|
|
14
|
-
def __init__(self, datasource: DataSource):
|
|
14
|
+
def __init__(self, datasource: DataSource | type[DataSource]):
|
|
15
|
+
if isinstance(datasource, type):
|
|
16
|
+
datasource: DataSource = datasource()
|
|
15
17
|
self.datasource = datasource
|
|
16
18
|
|
|
17
19
|
@classmethod
|
|
@@ -28,7 +30,7 @@ class Parser:
|
|
|
28
30
|
|
|
29
31
|
def load(
|
|
30
32
|
self,
|
|
31
|
-
config_root: str,
|
|
33
|
+
config_root: str | Path,
|
|
32
34
|
manifest_file='manifest.yml',
|
|
33
35
|
) -> dict[str, ParserConfig]:
|
|
34
36
|
config_root_path = Path(config_root)
|
|
@@ -11,6 +11,36 @@ from sigil.models import LibArgParser, ParserConfig, SubcommandModule
|
|
|
11
11
|
_logger = logging.getLogger(__name__)
|
|
12
12
|
|
|
13
13
|
class ScriptLoader:
|
|
14
|
+
@classmethod
|
|
15
|
+
def _construct_package_name(
|
|
16
|
+
cls,
|
|
17
|
+
config_root_path: Path,
|
|
18
|
+
module_dir: Path,
|
|
19
|
+
module_name: str
|
|
20
|
+
) -> str:
|
|
21
|
+
module_dir_str = str(module_dir)
|
|
22
|
+
if module_dir_str not in sys.path:
|
|
23
|
+
sys.path.insert(0, module_dir_str)
|
|
24
|
+
|
|
25
|
+
root_str = str(config_root_path)
|
|
26
|
+
if root_str not in sys.path:
|
|
27
|
+
sys.path.insert(0, root_str)
|
|
28
|
+
|
|
29
|
+
try:
|
|
30
|
+
rel_path = module_dir.relative_to(config_root_path)
|
|
31
|
+
except ValueError:
|
|
32
|
+
# If the module is outside config_root, fallback to a safe unique namespace
|
|
33
|
+
rel_path = Path("_dynamic_") / module_dir.name
|
|
34
|
+
|
|
35
|
+
package_name = ".".join(rel_path.parts) # e.g., "subcommands.foo"
|
|
36
|
+
fully_qualified_name = (
|
|
37
|
+
f"{package_name}.{module_name}"
|
|
38
|
+
if package_name
|
|
39
|
+
else module_name
|
|
40
|
+
)
|
|
41
|
+
return fully_qualified_name
|
|
42
|
+
|
|
43
|
+
|
|
14
44
|
@classmethod
|
|
15
45
|
def import_module(
|
|
16
46
|
cls,
|
|
@@ -23,10 +53,17 @@ class ScriptLoader:
|
|
|
23
53
|
f"no root path declared for script loading, skipping {module_name}"
|
|
24
54
|
)
|
|
25
55
|
return None
|
|
26
|
-
config_root_path = Path(config_root)
|
|
27
|
-
|
|
56
|
+
config_root_path = Path(config_root).resolve()
|
|
57
|
+
module_dir = (config_root_path/path).resolve()
|
|
58
|
+
file_path = str(module_dir/f'{module_name}.py')
|
|
59
|
+
|
|
60
|
+
package_name = cls._construct_package_name(
|
|
61
|
+
config_root_path,
|
|
62
|
+
module_dir,
|
|
63
|
+
module_name
|
|
64
|
+
)
|
|
28
65
|
|
|
29
|
-
spec = importlib.util.spec_from_file_location(
|
|
66
|
+
spec = importlib.util.spec_from_file_location(package_name, file_path)
|
|
30
67
|
if not spec:
|
|
31
68
|
raise FileNotFoundError(file_path)
|
|
32
69
|
module = importlib.util.module_from_spec(spec)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: sigil-cli
|
|
3
|
-
Version: 1.4.
|
|
3
|
+
Version: 1.4.2
|
|
4
4
|
Summary: Configuration driven CLI builder with subcommands and script loading
|
|
5
5
|
Author-email: Kenzo Staelens <kenzostael@gmail.com>
|
|
6
6
|
License: MIT
|
|
@@ -295,11 +295,11 @@ class JsonReader:
|
|
|
295
295
|
...
|
|
296
296
|
|
|
297
297
|
|
|
298
|
-
run_from_config("/path/to/config",
|
|
298
|
+
run_from_config("/path/to/config", datasource=JsonReader)
|
|
299
299
|
```
|
|
300
300
|
|
|
301
301
|
You can also pass a pre‑loaded dictionary directly by wrapping it:
|
|
302
302
|
|
|
303
303
|
```python
|
|
304
|
-
run_from_config(my_dict,
|
|
304
|
+
run_from_config(my_dict, datasource=DictReader)
|
|
305
305
|
```
|
|
@@ -52,7 +52,7 @@ def test_script_loader_import_module_mock(mock_importlib, tmp_path):
|
|
|
52
52
|
loader.import_module(str(tmp_path), "scripts", "my_script")
|
|
53
53
|
|
|
54
54
|
mock_importlib.spec_from_file_location.assert_called_once_with(
|
|
55
|
-
"my_script", str(tmp_path / "scripts" / "my_script.py")
|
|
55
|
+
"scripts.my_script", str(tmp_path / "scripts" / "my_script.py")
|
|
56
56
|
)
|
|
57
57
|
mock_importlib.module_from_spec.assert_called_once_with(mock_spec)
|
|
58
58
|
mock_spec.loader.exec_module.assert_called_once_with(mock_module)
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|