sigil-cli 1.5.2__tar.gz → 1.5.3__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.
Files changed (46) hide show
  1. {sigil_cli-1.5.2/src/sigil_cli.egg-info → sigil_cli-1.5.3}/PKG-INFO +8 -4
  2. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/README.md +1 -1
  3. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/pyproject.toml +7 -3
  4. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/models/argparser.py +7 -1
  5. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/stages/parser.py +59 -8
  6. {sigil_cli-1.5.2 → sigil_cli-1.5.3/src/sigil_cli.egg-info}/PKG-INFO +8 -4
  7. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/LICENSE +0 -0
  8. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/setup.cfg +0 -0
  9. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/__init__.py +0 -0
  10. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/__main__.py +0 -0
  11. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/cli_tools/__init__.py +0 -0
  12. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/cli_tools/init.py +0 -0
  13. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/cli_tools/tree.py +0 -0
  14. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/cli_tools/util.py +0 -0
  15. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/cli_tools/validate.py +0 -0
  16. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/datasource/__init__.py +0 -0
  17. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/datasource/datasource.py +0 -0
  18. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/datasource/helper.py +0 -0
  19. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/datasource/json_source.py +0 -0
  20. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/datasource/yml_source.py +0 -0
  21. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/entrypoint.py +0 -0
  22. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/models/__init__.py +0 -0
  23. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/models/argument.py +0 -0
  24. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/models/command.py +0 -0
  25. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/models/script.py +0 -0
  26. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/script_sources/__init__.py +0 -0
  27. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/script_sources/filesystem_script_source.py +0 -0
  28. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/script_sources/script_source.py +0 -0
  29. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/stages/__init__.py +0 -0
  30. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/stages/builder.py +0 -0
  31. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/stages/resolver.py +0 -0
  32. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil/stages/script_loader.py +0 -0
  33. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil_cli.egg-info/SOURCES.txt +0 -0
  34. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil_cli.egg-info/dependency_links.txt +0 -0
  35. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil_cli.egg-info/entry_points.txt +0 -0
  36. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil_cli.egg-info/requires.txt +0 -0
  37. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/src/sigil_cli.egg-info/top_level.txt +0 -0
  38. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/tests/test_builder.py +0 -0
  39. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/tests/test_cli_init.py +0 -0
  40. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/tests/test_cli_tree.py +0 -0
  41. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/tests/test_cli_util.py +0 -0
  42. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/tests/test_cli_validate.py +0 -0
  43. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/tests/test_integration.py +0 -0
  44. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/tests/test_reader.py +0 -0
  45. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/tests/test_resolver.py +0 -0
  46. {sigil_cli-1.5.2 → sigil_cli-1.5.3}/tests/test_scriptloader.py +0 -0
@@ -1,21 +1,25 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sigil-cli
3
- Version: 1.5.2
3
+ Version: 1.5.3
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
7
7
  Project-URL: Homepage, https://github.com/kenzo-staelens/sigil
8
8
  Project-URL: Repository, https://github.com/kenzo-staelens/sigil
9
9
  Project-URL: Issues, https://github.com/kenzo-staelens/sigil/issues
10
+ Classifier: Development Status :: 5 - Production/Stable
11
+ Classifier: License :: OSI Approved :: MIT License
10
12
  Classifier: Programming Language :: Python :: 3
11
13
  Classifier: Programming Language :: Python :: 3.10
12
14
  Classifier: Programming Language :: Python :: 3.11
13
15
  Classifier: Programming Language :: Python :: 3.12
14
16
  Classifier: Programming Language :: Python :: 3.13
15
17
  Classifier: Programming Language :: Python :: 3.14
16
- Classifier: Topic :: Software Development :: User Interfaces
17
- Classifier: License :: OSI Approved :: MIT License
18
18
  Classifier: Operating System :: OS Independent
19
+ Classifier: Environment :: Console
20
+ Classifier: Intended Audience :: Developers
21
+ Classifier: Intended Audience :: System Administrators
22
+ Classifier: Typing :: Typed
19
23
  Requires-Python: >=3.10
20
24
  Description-Content-Type: text/markdown
21
25
  License-File: LICENSE
@@ -259,7 +263,7 @@ commands above. You alias and run `main.py`. the `sigil` prefix is a different n
259
263
 
260
264
  ### Misc
261
265
 
262
- `load_ignore` may be used to detaching commands from the command tree for any purpose
266
+ `load: False` may be used to detaching commands from the command tree for any purpose
263
267
  (deprecation, development, etc) or for non schema-compliant objects at the top level of a file, this may be useful to
264
268
  define anchors or references that should not directly be read as a command.
265
269
 
@@ -229,7 +229,7 @@ commands above. You alias and run `main.py`. the `sigil` prefix is a different n
229
229
 
230
230
  ### Misc
231
231
 
232
- `load_ignore` may be used to detaching commands from the command tree for any purpose
232
+ `load: False` may be used to detaching commands from the command tree for any purpose
233
233
  (deprecation, development, etc) or for non schema-compliant objects at the top level of a file, this may be useful to
234
234
  define anchors or references that should not directly be read as a command.
235
235
 
@@ -4,22 +4,26 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "sigil-cli"
7
- version = "1.5.2"
7
+ version = "1.5.3"
8
8
  description = "Configuration driven CLI builder with subcommands and script loading"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.10"
11
11
  license = {text = "MIT"}
12
12
  authors = [{name = "Kenzo Staelens", email = "kenzostael@gmail.com"}]
13
13
  classifiers = [
14
+ "Development Status :: 5 - Production/Stable",
15
+ "License :: OSI Approved :: MIT License",
14
16
  "Programming Language :: Python :: 3",
15
17
  "Programming Language :: Python :: 3.10",
16
18
  "Programming Language :: Python :: 3.11",
17
19
  "Programming Language :: Python :: 3.12",
18
20
  "Programming Language :: Python :: 3.13",
19
21
  "Programming Language :: Python :: 3.14",
20
- "Topic :: Software Development :: User Interfaces",
21
- "License :: OSI Approved :: MIT License",
22
22
  "Operating System :: OS Independent",
23
+ 'Environment :: Console',
24
+ "Intended Audience :: Developers",
25
+ "Intended Audience :: System Administrators",
26
+ "Typing :: Typed",
23
27
  ]
24
28
  dependencies = [
25
29
  "pyyaml>=6.0",
@@ -1,9 +1,15 @@
1
1
  import argparse
2
+ from typing import Any
2
3
 
3
4
  # because setting default subommands is kind of a pain in std. argparse
4
5
 
5
6
  class LibArgParser(argparse.ArgumentParser):
6
- def set_default_subparser(self, name, args=None, positional_args=0):
7
+ def set_default_subparser(
8
+ self,
9
+ name: str,
10
+ args: Any | None =None,
11
+ positional_args: int=0
12
+ ):
7
13
  for action in self._actions:
8
14
  if not isinstance(action, argparse._SubParsersAction):
9
15
  continue
@@ -21,17 +21,67 @@ class Parser:
21
21
  cls,
22
22
  loaded_entry: dict[str, Any],
23
23
  loaded_config: dict[str, Any],
24
- entry: str
25
- ):
26
- # warning: in place mutation if you decide to make changes to loaded config
24
+ manifest_entry: str
25
+ ) -> dict[str, Any]:
26
+ """Handle duplicate yaml keys across multiple files.
27
+
28
+ :param loaded_entry: currently handled manifest entry
29
+ :type loaded_entry: dict[str, Any]
30
+ :param loaded_config: already loaded configurations
31
+ :type loaded_config: dict[str, Any]
32
+ :param manifest_entry: target entry as defined in manifest.yml
33
+ :type manifest_entry: str
34
+ :return: merged config
35
+ :rtype: dict[str, Any]
36
+ """
37
+ # note: currently this is the warning only, there's a | elsewhere
27
38
  if duplicates := (loaded_entry.keys() & loaded_config.keys()):
28
39
  for duplicate in duplicates:
29
- _logger.warning(f"{entry}[{duplicate}] already defined, ignoring")
40
+ _logger.warning(
41
+ f"{manifest_entry} [{duplicate}] already defined, ignoring"
42
+ )
43
+ valid_entries = loaded_entry | loaded_config
44
+ return valid_entries
45
+
46
+ @classmethod
47
+ def handle_name_collisions(
48
+ cls,
49
+ loaded_config: dict[str, Any],
50
+ manifest_entry: str
51
+ ) -> dict[str, Any] :
52
+ """Handle name collision where two sibling commands have
53
+ the same argparse name parameter.
54
+
55
+ :param loaded_config: deduplicated (by key) configurations
56
+ :type loaded_config: dict[str, Any]
57
+ :param manifest_entry: target entry as defined in manifest.yml
58
+ :type manifest_entry: str
59
+ :return: validated config
60
+ :rtype: dict[str, Any]
61
+ """
62
+ loaded_command_names_config = set()
63
+ valid_entries = {}
64
+ for key, item in loaded_config.items():
65
+ if (
66
+ (item.get('parent', None), item.get('name', None))
67
+ in loaded_command_names_config
68
+ ):
69
+ _logger.warning(
70
+ f"{manifest_entry} [{key}] found duplicated command "
71
+ f"[{item.get('name')}] in parent command "
72
+ f"[{item.get('parent', None)}], ignoring"
73
+ )
74
+ else:
75
+ valid_entries[key] = item
76
+ loaded_command_names_config.add(
77
+ (item.get('parent', None), item.get('name', None))
78
+ )
79
+ return valid_entries
30
80
 
31
81
  def load(
32
82
  self,
33
83
  config_root: str | Path,
34
- manifest_file='manifest.yml',
84
+ manifest_file: str = 'manifest.yml',
35
85
  ) -> dict[str, ParserConfig]:
36
86
  config_root_path = Path(config_root)
37
87
 
@@ -56,10 +106,11 @@ class Parser:
56
106
  continue
57
107
  tmp[k] = v # pesky can't del in for loop :/
58
108
  loaded_entry = tmp
59
- self.handle_duplicates(loaded_entry, loaded_config, entry)
60
109
  self.convert_args(loaded_entry)
61
- # override loaded entry duplicates by already found
62
- loaded_config = loaded_entry | loaded_config
110
+ # remove duplicates by key
111
+ loaded_config = self.handle_duplicates(loaded_entry, loaded_config, entry)
112
+ # remove sibling duplicates by parent
113
+ loaded_config = self.handle_name_collisions(loaded_config, entry)
63
114
 
64
115
  for k, v in loaded_config.items():
65
116
  try:
@@ -1,21 +1,25 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sigil-cli
3
- Version: 1.5.2
3
+ Version: 1.5.3
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
7
7
  Project-URL: Homepage, https://github.com/kenzo-staelens/sigil
8
8
  Project-URL: Repository, https://github.com/kenzo-staelens/sigil
9
9
  Project-URL: Issues, https://github.com/kenzo-staelens/sigil/issues
10
+ Classifier: Development Status :: 5 - Production/Stable
11
+ Classifier: License :: OSI Approved :: MIT License
10
12
  Classifier: Programming Language :: Python :: 3
11
13
  Classifier: Programming Language :: Python :: 3.10
12
14
  Classifier: Programming Language :: Python :: 3.11
13
15
  Classifier: Programming Language :: Python :: 3.12
14
16
  Classifier: Programming Language :: Python :: 3.13
15
17
  Classifier: Programming Language :: Python :: 3.14
16
- Classifier: Topic :: Software Development :: User Interfaces
17
- Classifier: License :: OSI Approved :: MIT License
18
18
  Classifier: Operating System :: OS Independent
19
+ Classifier: Environment :: Console
20
+ Classifier: Intended Audience :: Developers
21
+ Classifier: Intended Audience :: System Administrators
22
+ Classifier: Typing :: Typed
19
23
  Requires-Python: >=3.10
20
24
  Description-Content-Type: text/markdown
21
25
  License-File: LICENSE
@@ -259,7 +263,7 @@ commands above. You alias and run `main.py`. the `sigil` prefix is a different n
259
263
 
260
264
  ### Misc
261
265
 
262
- `load_ignore` may be used to detaching commands from the command tree for any purpose
266
+ `load: False` may be used to detaching commands from the command tree for any purpose
263
267
  (deprecation, development, etc) or for non schema-compliant objects at the top level of a file, this may be useful to
264
268
  define anchors or references that should not directly be read as a command.
265
269
 
File without changes
File without changes