PyPI - ae-shell - Versions diffs - 0.3.13__tar.gz → 0.3.15__tar.gz - Mend

ae-shell 0.3.13tar.gz → 0.3.15tar.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 (14) hide show

{ae_shell-0.3.13 → ae_shell-0.3.15}/LICENSE.md RENAMED Viewed

@@ -1,4 +1,4 @@
-<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.project_tpls v0.3.77 -->
+<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.project_tpls v0.3.79 -->
 ### GNU GENERAL PUBLIC LICENSE
 Version 3, 29 June 2007

{ae_shell-0.3.13/ae_shell.egg-info → ae_shell-0.3.15}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ae_shell
-Version: 0.3.13
+Version: 0.3.15
 Summary: ae namespace module portion shell: shell execution and environment helpers
 Home-page: https://gitlab.com/ae-group/ae_shell
 Author: AndiEcker
@@ -23,6 +23,7 @@ Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
 Requires-Dist: ae_base
+Requires-Dist: ae_system
 Requires-Dist: ae_core
 Requires-Dist: ae_console
 Provides-Extra: dev
@@ -61,15 +62,15 @@ Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
-<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae v0.3.103 -->
-<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.namespace_root_tpls v0.3.22 -->
-# shell 0.3.13
+<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae v0.3.104 -->
+<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.namespace_root_tpls v0.3.31 -->
+# shell 0.3.15
 [![GitLab develop](https://img.shields.io/gitlab/pipeline/ae-group/ae_shell/develop?logo=python)](
     https://gitlab.com/ae-group/ae_shell)
 [![LatestPyPIrelease](
-    https://img.shields.io/gitlab/pipeline/ae-group/ae_shell/release0.3.13?logo=python)](
-    https://gitlab.com/ae-group/ae_shell/-/tree/release0.3.13)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_shell/release0.3.15?logo=python)](
+    https://gitlab.com/ae-group/ae_shell/-/tree/release0.3.15)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_shell)](
     https://pypi.org/project/ae-shell/#history)
@@ -98,8 +99,8 @@ Dynamic: summary
     https://pypi.org/project/ae-shell/#files)
-## installation
+## installation
 execute the following command to install the
 ae.shell module
@@ -120,10 +121,14 @@ following command in the root folder of this repository
 pip install --editable .[dev]
 ```
-the last command will install this module portion, along with the tools you need
-to develop and run tests or to extend the portion documentation. to contribute only to the unit tests or to the
-documentation of this portion, replace the setup extras key `dev` in the above command with `tests` or `docs`
-respectively.
+this command installs this module portion project
+along with the necessary tools to modify the source code,
+run unit tests, and build documentation. to install only
+the dependencies required for a specific task,  replace
+`dev` with one of the following:
+    * `tests`: for contributing to the unit test suite
+    * `docs`: for maintaining and building documentation
 more detailed explanations on how to contribute to this project
 [are available here](
@@ -132,7 +137,9 @@ https://gitlab.com/ae-group/ae_shell/-/blob/develop/CONTRIBUTING.rst)
 ## namespace portion documentation
-information on the features and usage of this portion are available at
+the documentation of the source code of this portion is available at
 [ReadTheDocs](
 https://ae.readthedocs.io/en/latest/_autosummary/ae.shell.html
 "ae_shell documentation").

{ae_shell-0.3.13 → ae_shell-0.3.15}/README.md RENAMED Viewed

@@ -1,12 +1,12 @@
-<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae v0.3.103 -->
-<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.namespace_root_tpls v0.3.22 -->
-# shell 0.3.13
+<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae v0.3.104 -->
+<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.namespace_root_tpls v0.3.31 -->
+# shell 0.3.15
 [![GitLab develop](https://img.shields.io/gitlab/pipeline/ae-group/ae_shell/develop?logo=python)](
     https://gitlab.com/ae-group/ae_shell)
 [![LatestPyPIrelease](
-    https://img.shields.io/gitlab/pipeline/ae-group/ae_shell/release0.3.13?logo=python)](
-    https://gitlab.com/ae-group/ae_shell/-/tree/release0.3.13)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_shell/release0.3.15?logo=python)](
+    https://gitlab.com/ae-group/ae_shell/-/tree/release0.3.15)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_shell)](
     https://pypi.org/project/ae-shell/#history)
@@ -35,8 +35,8 @@
     https://pypi.org/project/ae-shell/#files)
-## installation
+## installation
 execute the following command to install the
 ae.shell module
@@ -57,10 +57,14 @@ following command in the root folder of this repository
 pip install --editable .[dev]
 ```
-the last command will install this module portion, along with the tools you need
-to develop and run tests or to extend the portion documentation. to contribute only to the unit tests or to the
-documentation of this portion, replace the setup extras key `dev` in the above command with `tests` or `docs`
-respectively.
+this command installs this module portion project
+along with the necessary tools to modify the source code,
+run unit tests, and build documentation. to install only
+the dependencies required for a specific task,  replace
+`dev` with one of the following:
+    * `tests`: for contributing to the unit test suite
+    * `docs`: for maintaining and building documentation
 more detailed explanations on how to contribute to this project
 [are available here](
@@ -69,7 +73,9 @@ https://gitlab.com/ae-group/ae_shell/-/blob/develop/CONTRIBUTING.rst)
 ## namespace portion documentation
-information on the features and usage of this portion are available at
+the documentation of the source code of this portion is available at
 [ReadTheDocs](
 https://ae.readthedocs.io/en/latest/_autosummary/ae.shell.html
 "ae_shell documentation").

{ae_shell-0.3.13 → ae_shell-0.3.15}/ae/shell.py RENAMED Viewed

@@ -23,22 +23,24 @@ import os
 import shlex
 import subprocess
+from collections.abc import Callable, Iterable, Iterator, MutableMapping
 from contextlib import contextmanager
-from typing import Any, Callable, Iterable, Iterator, MutableMapping, Optional, Union, cast, overload
+from typing import Any, cast, overload
-from ae.base import UNSET, dummy_function, env_str, load_env_var_defaults, norm_name        # type: ignore
+from ae.base import UNSET, dummy_function, env_str, norm_name                               # type: ignore
+from ae.system import load_env_var_defaults                                                 # type: ignore
 from ae.core import main_app_instance, AppBase                                              # type: ignore
 from ae.console import MAIN_SECTION_NAME, ConsoleApp                                        # type: ignore
-__version__ = '0.3.13'
+__version__ = '0.3.15'
 STDERR_BEG_MARKER = "vvv   STDERR   vvv"                #: :paramref:`ae.shell.sh_exec.lines_output` begin stderr lines
 STDERR_END_MARKER = "^^^   STDERR   ^^^"                #: end stderr lines in :paramref:`ae.shell.sh_exec.lines_output`
-def debug_or_verbose(app_obj: Optional[ConsoleApp] = None) -> bool:
+def debug_or_verbose(app_obj: ConsoleApp | None = None) -> bool:
     """ determine if the current app runs in debug|verbose mode, while preventing early .get_option() call an app init.
     :param app_obj:             optional ConsoleApp instance (def=main_app_instance()).
@@ -85,7 +87,7 @@ def get_domain_user_var(variable_name: str, domain: str = "", user: str = "") ->
     return value
-def hint(command: str, action: Union[Callable, str], message_suffix: str = "") -> str:
+def hint(command: str, action: Callable | str, message_suffix: str = "") -> str:
     """ return hint string in debug/verbose mode, to be appended onto a shell/console output.
     :param command:             shell command.
@@ -122,7 +124,7 @@ def mask_token(text: str) -> str: ...
 def mask_token(text: list[str]) -> list[str]: ...
-def mask_token(text: Union[str, list[str]]) -> Union[str, list[str]]:
+def mask_token(text: str | list[str]) -> str | list[str]:
     """ hide most parts of any Codeberg/GitHub/GitHub URL tokens found in the specified text/-lines.
     :param text:                text, specified either as str object or as a list of str objects (lines),
@@ -152,8 +154,8 @@ def mask_token(text: Union[str, list[str]]) -> Union[str, list[str]]:
 # pylint: disable-next=too-many-arguments,too-many-positional-arguments
 def sh_exec(command_line: str, extra_args: Iterable[str] = (), console_input: str = "",
-            lines_output: Optional[list[str]] = None, app_obj: Optional[AppBase] = None, shell: bool = False,
-            env_vars: Optional[dict[str, str]] = None) -> int:
+            lines_output: list[str] | None = None, app_obj: AppBase | None = None, shell: bool = False,
+            env_vars: dict[str, str] | None = None) -> int:
     """ execute command in the current working directory of the OS console/shell.
     :param command_line:        command line string to execute on the console/shell. could contain command line args
@@ -180,7 +182,7 @@ def sh_exec(command_line: str, extra_args: Iterable[str] = (), console_input: st
     debug_out = app_obj.dpo if app_obj else dummy_function if app_obj is UNSET else print
     debug_out(f"    . executing at {os.getcwd()}: {mask_token(args)}")
-    result: Union[subprocess.CompletedProcess, subprocess.CalledProcessError]   # having: stdout/stderr/returncode
+    result: subprocess.CompletedProcess | subprocess.CalledProcessError     # having: stdout/stderr/returncode
     try:
         result = subprocess.run(args,
                                 stdout=subprocess.PIPE if ret_out else None,
@@ -210,9 +212,9 @@ def sh_exec(command_line: str, extra_args: Iterable[str] = (), console_input: st
 # pylint: disable-next=too-many-arguments,too-many-positional-arguments
 def sh_exit_if_exec_err(err_code: int, command_line: str,
-                        extra_args: Iterable[str] = (), lines_output: Optional[list[str]] = None,
-                        exit_on_err: bool = True, exit_msg: str = "", app_obj: Optional[ConsoleApp] = None,
-                        shell: bool = False, env_vars: Optional[dict[str, str]] = None) -> int:
+                        extra_args: Iterable[str] = (), lines_output: list[str] | None = None,
+                        exit_on_err: bool = True, exit_msg: str = "", app_obj: ConsoleApp | None = None,
+                        shell: bool = False, env_vars: dict[str, str] | None = None) -> int:
     """ execute command in the current working directory of the OS console/shell, dump error, and exit app if needed.
     :param err_code:            error code to pass to the console as exit code if :paramref:`.exit_on_err` is True.

{ae_shell-0.3.13 → ae_shell-0.3.15/ae_shell.egg-info}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ae_shell
-Version: 0.3.13
+Version: 0.3.15
 Summary: ae namespace module portion shell: shell execution and environment helpers
 Home-page: https://gitlab.com/ae-group/ae_shell
 Author: AndiEcker
@@ -23,6 +23,7 @@ Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
 Requires-Dist: ae_base
+Requires-Dist: ae_system
 Requires-Dist: ae_core
 Requires-Dist: ae_console
 Provides-Extra: dev
@@ -61,15 +62,15 @@ Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
-<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae v0.3.103 -->
-<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.namespace_root_tpls v0.3.22 -->
-# shell 0.3.13
+<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project ae.ae v0.3.104 -->
+<!-- THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.namespace_root_tpls v0.3.31 -->
+# shell 0.3.15
 [![GitLab develop](https://img.shields.io/gitlab/pipeline/ae-group/ae_shell/develop?logo=python)](
     https://gitlab.com/ae-group/ae_shell)
 [![LatestPyPIrelease](
-    https://img.shields.io/gitlab/pipeline/ae-group/ae_shell/release0.3.13?logo=python)](
-    https://gitlab.com/ae-group/ae_shell/-/tree/release0.3.13)
+    https://img.shields.io/gitlab/pipeline/ae-group/ae_shell/release0.3.15?logo=python)](
+    https://gitlab.com/ae-group/ae_shell/-/tree/release0.3.15)
 [![PyPIVersions](https://img.shields.io/pypi/v/ae_shell)](
     https://pypi.org/project/ae-shell/#history)
@@ -98,8 +99,8 @@ Dynamic: summary
     https://pypi.org/project/ae-shell/#files)
-## installation
+## installation
 execute the following command to install the
 ae.shell module
@@ -120,10 +121,14 @@ following command in the root folder of this repository
 pip install --editable .[dev]
 ```
-the last command will install this module portion, along with the tools you need
-to develop and run tests or to extend the portion documentation. to contribute only to the unit tests or to the
-documentation of this portion, replace the setup extras key `dev` in the above command with `tests` or `docs`
-respectively.
+this command installs this module portion project
+along with the necessary tools to modify the source code,
+run unit tests, and build documentation. to install only
+the dependencies required for a specific task,  replace
+`dev` with one of the following:
+    * `tests`: for contributing to the unit test suite
+    * `docs`: for maintaining and building documentation
 more detailed explanations on how to contribute to this project
 [are available here](
@@ -132,7 +137,9 @@ https://gitlab.com/ae-group/ae_shell/-/blob/develop/CONTRIBUTING.rst)
 ## namespace portion documentation
-information on the features and usage of this portion are available at
+the documentation of the source code of this portion is available at
 [ReadTheDocs](
 https://ae.readthedocs.io/en/latest/_autosummary/ae.shell.html
 "ae_shell documentation").

{ae_shell-0.3.13 → ae_shell-0.3.15}/ae_shell.egg-info/requires.txt RENAMED Viewed

@@ -1,4 +1,5 @@
 ae_base
+ae_system
 ae_core
 ae_console

{ae_shell-0.3.13 → ae_shell-0.3.15}/pyproject.toml RENAMED Viewed

@@ -1,4 +1,4 @@
-# THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.project_tpls v0.3.77
+# THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.project_tpls v0.3.79
 [build-system]
 requires = ["setuptools>=42", "wheel"]
 build-backend = "setuptools.build_meta"

{ae_shell-0.3.13 → ae_shell-0.3.15}/setup.py RENAMED Viewed

@@ -1,4 +1,4 @@
-# THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.project_tpls v0.3.77
+# THIS FILE IS EXCLUSIVELY MAINTAINED by the project aedev.project_tpls v0.3.79
 """ setup of ae namespace module portion shell: shell execution and environment helpers. """
 import sys
 # noinspection PyUnresolvedReferences
@@ -50,6 +50,7 @@ setup_kwargs = {
     },
     'install_requires': [
         'ae_base',
+        'ae_system',
         'ae_core',
         'ae_console',
     ],
@@ -77,7 +78,7 @@ setup_kwargs = {
     },
     'python_requires': '>=3.12',
     'url': 'https://gitlab.com/ae-group/ae_shell',
-    'version': '0.3.13',
+    'version': '0.3.15',
     'zip_safe': True,
 }

{ae_shell-0.3.13 → ae_shell-0.3.15}/ae_shell.egg-info/SOURCES.txt RENAMED Viewed

File without changes

{ae_shell-0.3.13 → ae_shell-0.3.15}/ae_shell.egg-info/dependency_links.txt RENAMED Viewed

File without changes

{ae_shell-0.3.13 → ae_shell-0.3.15}/ae_shell.egg-info/top_level.txt RENAMED Viewed

File without changes

{ae_shell-0.3.13 → ae_shell-0.3.15}/ae_shell.egg-info/zip-safe RENAMED Viewed

File without changes

{ae_shell-0.3.13 → ae_shell-0.3.15}/setup.cfg RENAMED Viewed

File without changes

{ae_shell-0.3.13 → ae_shell-0.3.15}/tests/test_shell.py RENAMED Viewed

File without changes

ae-shell 0.3.13__tar.gz → 0.3.15__tar.gz

ae-shell 0.3.13tar.gz → 0.3.15tar.gz