fancy-subprocess 2.0__tar.gz → 2.2__tar.gz

{fancy_subprocess-2.0 → fancy_subprocess-2.2}/.editorconfig

@@ -1,6 +1,8 @@
+root = true
+
 [*]
+charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
-indent_style = "space"
+indent_style = space
 indent_size = 4
-

{fancy_subprocess-2.0 → fancy_subprocess-2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
-Name: fancy_subprocess
-Version: 2.0
+Name: fancy-subprocess
+Version: 2.2
 Summary: subprocess.run() with formatted output, detailed error messages and retry capabilities
 Project-URL: Homepage, https://github.com/petamas/python-fancy-subprocess
 Project-URL: Bug Tracker, https://github.com/petamas/python-fancy-subprocess/issues
@@ -18,9 +18,9 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
-Requires-Dist: ntstatus<2
-Requires-Dist: oslex<2
-Requires-Dist: pathext<2,>=1.2
+Requires-Dist: ntstatus<2,>=1.1
+Requires-Dist: oslex<2,>=0.1.3
+Requires-Dist: pathext<2,>=1.5
 Requires-Dist: typeguard<5,>=4.4.2
 Requires-Dist: typing-extensions<5,>=4.14
 Description-Content-Type: text/markdown
@@ -45,14 +45,14 @@ Key differences compared to `subprocess.run()`:
 Arguments (all of them except `cmd` are optional):
 - `cmd: Sequence[str | Path]` - Command to run. See `subprocess.run()`'s documentation for the interpretation of `cmd[0]`. It is recommended to use `fancy_subprocess.which()` to produce `cmd[0]`.
 - `print_message: Callable[[str], None]` - Function used to print informational messages. If unspecified or set to `None`, defaults to `fancy_subprocess.default_print`. Use `message_quiet=True` to disable printing informational messages.
-	- The type of this argument is also aliased as `fancy_subprocess.PrintFunction`.
+    - The type of this argument is also aliased as `fancy_subprocess.PrintFunction`.
 - `print_output: Callable[[str], None]` - Function used to print a line of the output of the command. If unspecified or set to `None`, defaults to `fancy_subprocess.default_print`. Use `output_quiet=True` to disable printing the command's output.
-	- The type of this argument is also aliased as `fancy_subprocess.PrintFunction`.
+    - The type of this argument is also aliased as `fancy_subprocess.PrintFunction`.
 - `message_quiet: bool` - If `True`, `print_message` is ignored, and no informational messages are printed. If unspecified or set to `None`, defaults to `False`.
 - `output_quiet: bool` - If `True`, `print_output` is ignored, and the command's output it not printed. If unspecified or set to `None`, defaults to `False`. Note that this parameter also affects the default value of `description`.
 - `description: str` - Description printed before running the command. If unspecified or set to `None`, defaults to `Running command: ...` when `output_quiet` is `False`, and `Running command (output silenced): ...` when `output_quiet` is `True`.
 - `success: Sequence[int] | AnyExitCode` - List of exit codes that should be considered successful. If set to `fancy_subprocess.ANY_EXIT_CODE`, then all exit codes are considered successful. If unspecified or set to `None`, defaults to `[0]`. Note that 0 is not automatically included in the list of successful exit codes, so if a list without 0 is specified, then the function will consider 0 a failure.
-	- The type of this argument is also aliased as `fancy_subprocess.Success`.
+    - The type of this argument is also aliased as `fancy_subprocess.Success`.
 - `flush_before_subprocess: bool` - If `True`, flushes both the standard output and error streams before running the command. If unspecified or set to `None`, defaults to `True`.
 - `trim_output_lines: bool` - If `True`, remove trailing whitespace from the lines of the output of the command before calling `print_output` and adding them to the `output` field of `RunResult`. If unspecified or set to `None`, defaults to `True`.
 - `max_output_size: int` - Maximum number of characters to be recorded in the `output` field of `RunResult`. If the command produces more than `max_output_size` characters, only the last `max_output_size` will be recorded. If unspecified or set to `None`, defaults to 10,000,000.
@@ -60,10 +60,11 @@ Arguments (all of them except `cmd` are optional):
 - `retry_initial_sleep_seconds: float` - Number of seconds to wait before retrying for the first time. If unspecified or set to `None`, defaults to 10.
 - `retry_backoff: float` - Factor used to increase wait times before subsequent retries. If unspecified or set to `None`, defaults to 2.
 - `env_overrides: Mapping[str, str]` - Dictionary used to set environment variables. Note that unline the `env` argument of `subprocess.run()`, `env_overrides` does not need to contain all environment variables, only the ones you want to add/modify compared to os.environ. If unspecified or set to `None`, defaults to empty dictionary, i.e. no change to the environment.
-	- The type of this argument is also aliased as `fancy_subprocess.EnvOverrides`.
+    - The type of this argument is also aliased as `fancy_subprocess.EnvOverrides`.
 - `cwd: str | Path` - If not `None`, change current working directory to `cwd` before running the command.
 - `encoding: str` - This encoding will be used to open stdout and stderr of the command. If unspecified or set to `None`, see default behaviour in `io.TextIOWrapper`'s documentation.
-- `errors: str` - This specifies how text decoding errors will be handled. See details (including what happens if unspecified or set to `None`) in `io.TextIOWrapper`'s documentation.
+- `errors: str` - This specifies how text decoding errors will be handled. (See possible options in `io.TextIOWrapper`'s documentation.) If unspecified or set to `None`, defaults to `replace`. Note that this differs from `io.TextIOWrapper`'s default behaviour, which is to use `strict`.
+- `replace_fffd_with_question_mark: bool` - Replace Unicode Replacement Character U+FFFD (`�`, usually introduced by `errors='replace'`) with ASCII question mark (`?`) in lines of the output of the command before calling `print_output` and adding them to the `output` field of `RunResult`. If unspecified or set to `None`, defaults to `True`.
 
 ### Return value: `fancy_subprocess.RunResult`
 
@@ -119,7 +120,7 @@ import fancy_subprocess
 from typing import Unpack
 
 def grab_output(cmd: list[str], **kwargs: Unpack[fancy_subprocess.RunParams]) -> str:
-	# Raises ValueError if there are unknown parameters in kwargs or if a keyword argument's type is incorrect
+    # Raises ValueError if there are unknown parameters in kwargs or if a keyword argument's type is incorrect
     fancy_subprocess.check_run_params(**kwargs)
 
     # Make a copy of keyword arguments to be edited
@@ -127,7 +128,7 @@ def grab_output(cmd: list[str], **kwargs: Unpack[fancy_subprocess.RunParams]) ->
     # Make sure nothing's printed, raise ValueError if caller tries to specify "output_quiet" or "message_quiet"
     fancy_subprocess.force_run_params(forwarded_args, message_quiet=True, output_quiet=True)
     # Handle encoding/decoding errors by replacing them with placeholder character by default, but allow callers to still customize behaviour
-    fancy_subprocess.change_default_run_params(forwarded_args, errors='replace')
+    fancy_subprocess.change_default_run_params(forwarded_args, errors='backslashreplace')
 
     # Run command, raise fancy_subprocess.RunError on failure
     result = fancy_subprocess.run(cmd, **forwarded_args)
@@ -136,7 +137,7 @@ def grab_output(cmd: list[str], **kwargs: Unpack[fancy_subprocess.RunParams]) ->
     return result.output
 ```
 
-The `grab_output()` function supports all `fancy_subprocess.run()` arguments (eg. `retry`), except for `message_quiet` and `output_quiet`. If `errors` is unspecified or set to `None`, it uses `errors='replace'` instead of the default `errors='strict'` behaviour. It also passes `mypy --strict`.
+The `grab_output()` function supports all `fancy_subprocess.run()` arguments (eg. `retry`), except for `message_quiet` and `output_quiet`. If `errors` is unspecified or set to `None`, it uses `errors='backslashreplace'` instead of the default `errors='replace'` behaviour. It also passes `mypy --strict`.
 
 (Using `typing.Unpack` requires Python 3.11 or later. In Python 3.10, use the `typing_extensions` module from PyPI.)
 

{fancy_subprocess-2.0 → fancy_subprocess-2.2}/README.md

@@ -18,14 +18,14 @@ Key differences compared to `subprocess.run()`:
 Arguments (all of them except `cmd` are optional):
 - `cmd: Sequence[str | Path]` - Command to run. See `subprocess.run()`'s documentation for the interpretation of `cmd[0]`. It is recommended to use `fancy_subprocess.which()` to produce `cmd[0]`.
 - `print_message: Callable[[str], None]` - Function used to print informational messages. If unspecified or set to `None`, defaults to `fancy_subprocess.default_print`. Use `message_quiet=True` to disable printing informational messages.
-	- The type of this argument is also aliased as `fancy_subprocess.PrintFunction`.
+    - The type of this argument is also aliased as `fancy_subprocess.PrintFunction`.
 - `print_output: Callable[[str], None]` - Function used to print a line of the output of the command. If unspecified or set to `None`, defaults to `fancy_subprocess.default_print`. Use `output_quiet=True` to disable printing the command's output.
-	- The type of this argument is also aliased as `fancy_subprocess.PrintFunction`.
+    - The type of this argument is also aliased as `fancy_subprocess.PrintFunction`.
 - `message_quiet: bool` - If `True`, `print_message` is ignored, and no informational messages are printed. If unspecified or set to `None`, defaults to `False`.
 - `output_quiet: bool` - If `True`, `print_output` is ignored, and the command's output it not printed. If unspecified or set to `None`, defaults to `False`. Note that this parameter also affects the default value of `description`.
 - `description: str` - Description printed before running the command. If unspecified or set to `None`, defaults to `Running command: ...` when `output_quiet` is `False`, and `Running command (output silenced): ...` when `output_quiet` is `True`.
 - `success: Sequence[int] | AnyExitCode` - List of exit codes that should be considered successful. If set to `fancy_subprocess.ANY_EXIT_CODE`, then all exit codes are considered successful. If unspecified or set to `None`, defaults to `[0]`. Note that 0 is not automatically included in the list of successful exit codes, so if a list without 0 is specified, then the function will consider 0 a failure.
-	- The type of this argument is also aliased as `fancy_subprocess.Success`.
+    - The type of this argument is also aliased as `fancy_subprocess.Success`.
 - `flush_before_subprocess: bool` - If `True`, flushes both the standard output and error streams before running the command. If unspecified or set to `None`, defaults to `True`.
 - `trim_output_lines: bool` - If `True`, remove trailing whitespace from the lines of the output of the command before calling `print_output` and adding them to the `output` field of `RunResult`. If unspecified or set to `None`, defaults to `True`.
 - `max_output_size: int` - Maximum number of characters to be recorded in the `output` field of `RunResult`. If the command produces more than `max_output_size` characters, only the last `max_output_size` will be recorded. If unspecified or set to `None`, defaults to 10,000,000.
@@ -33,10 +33,11 @@ Arguments (all of them except `cmd` are optional):
 - `retry_initial_sleep_seconds: float` - Number of seconds to wait before retrying for the first time. If unspecified or set to `None`, defaults to 10.
 - `retry_backoff: float` - Factor used to increase wait times before subsequent retries. If unspecified or set to `None`, defaults to 2.
 - `env_overrides: Mapping[str, str]` - Dictionary used to set environment variables. Note that unline the `env` argument of `subprocess.run()`, `env_overrides` does not need to contain all environment variables, only the ones you want to add/modify compared to os.environ. If unspecified or set to `None`, defaults to empty dictionary, i.e. no change to the environment.
-	- The type of this argument is also aliased as `fancy_subprocess.EnvOverrides`.
+    - The type of this argument is also aliased as `fancy_subprocess.EnvOverrides`.
 - `cwd: str | Path` - If not `None`, change current working directory to `cwd` before running the command.
 - `encoding: str` - This encoding will be used to open stdout and stderr of the command. If unspecified or set to `None`, see default behaviour in `io.TextIOWrapper`'s documentation.
-- `errors: str` - This specifies how text decoding errors will be handled. See details (including what happens if unspecified or set to `None`) in `io.TextIOWrapper`'s documentation.
+- `errors: str` - This specifies how text decoding errors will be handled. (See possible options in `io.TextIOWrapper`'s documentation.) If unspecified or set to `None`, defaults to `replace`. Note that this differs from `io.TextIOWrapper`'s default behaviour, which is to use `strict`.
+- `replace_fffd_with_question_mark: bool` - Replace Unicode Replacement Character U+FFFD (`�`, usually introduced by `errors='replace'`) with ASCII question mark (`?`) in lines of the output of the command before calling `print_output` and adding them to the `output` field of `RunResult`. If unspecified or set to `None`, defaults to `True`.
 
 ### Return value: `fancy_subprocess.RunResult`
 
@@ -92,7 +93,7 @@ import fancy_subprocess
 from typing import Unpack
 
 def grab_output(cmd: list[str], **kwargs: Unpack[fancy_subprocess.RunParams]) -> str:
-	# Raises ValueError if there are unknown parameters in kwargs or if a keyword argument's type is incorrect
+    # Raises ValueError if there are unknown parameters in kwargs or if a keyword argument's type is incorrect
     fancy_subprocess.check_run_params(**kwargs)
 
     # Make a copy of keyword arguments to be edited
@@ -100,7 +101,7 @@ def grab_output(cmd: list[str], **kwargs: Unpack[fancy_subprocess.RunParams]) ->
     # Make sure nothing's printed, raise ValueError if caller tries to specify "output_quiet" or "message_quiet"
     fancy_subprocess.force_run_params(forwarded_args, message_quiet=True, output_quiet=True)
     # Handle encoding/decoding errors by replacing them with placeholder character by default, but allow callers to still customize behaviour
-    fancy_subprocess.change_default_run_params(forwarded_args, errors='replace')
+    fancy_subprocess.change_default_run_params(forwarded_args, errors='backslashreplace')
 
     # Run command, raise fancy_subprocess.RunError on failure
     result = fancy_subprocess.run(cmd, **forwarded_args)
@@ -109,7 +110,7 @@ def grab_output(cmd: list[str], **kwargs: Unpack[fancy_subprocess.RunParams]) ->
     return result.output
 ```
 
-The `grab_output()` function supports all `fancy_subprocess.run()` arguments (eg. `retry`), except for `message_quiet` and `output_quiet`. If `errors` is unspecified or set to `None`, it uses `errors='replace'` instead of the default `errors='strict'` behaviour. It also passes `mypy --strict`.
+The `grab_output()` function supports all `fancy_subprocess.run()` arguments (eg. `retry`), except for `message_quiet` and `output_quiet`. If `errors` is unspecified or set to `None`, it uses `errors='backslashreplace'` instead of the default `errors='replace'` behaviour. It also passes `mypy --strict`.
 
 (Using `typing.Unpack` requires Python 3.11 or later. In Python 3.10, use the `typing_extensions` module from PyPI.)
 

{fancy_subprocess-2.0 → fancy_subprocess-2.2}/fancy_subprocess/_run_core.py

@@ -132,7 +132,8 @@ def run(
     - `env_overrides: Mapping[str, str]` - Dictionary used to set environment variables. Note that unline the `env` argument of `subprocess.run()`, `env_overrides` does not need to contain all environment variables, only the ones you want to add/modify compared to os.environ. If unspecified or set to `None`, defaults to empty dictionary, i.e. no change to the environment.
     - `cwd: str | Path` - If not `None`, change current working directory to `cwd` before running the command.
     - `encoding: str` - This encoding will be used to open stdout and stderr of the command. If unspecified or set to `None`, see default behaviour in `io.TextIOWrapper`'s documentation.
-    - `errors: str` - This specifies how text decoding errors will be handled. See details (including what happens if unspecified or set to `None`) in `io.TextIOWrapper`'s documentation.
+    - `errors: str` - This specifies how text decoding errors will be handled. (See possible options in `io.TextIOWrapper`'s documentation.) If unspecified or set to `None`, defaults to `replace`. Note that this differs from `io.TextIOWrapper`'s default behaviour, which is to use `strict`.
+    - `replace_fffd_with_question_mark: bool` - Replace Unicode Replacement Character U+FFFD (`�`, usually introduced by `errors='replace'`) with ASCII question mark (`?`) in lines of the output of the command before calling `print_output` and adding them to the `output` field of `RunResult`. If unspecified or set to `None`, defaults to `True`.
     """
 
     check_run_params(**kwargs)
@@ -154,7 +155,8 @@ def run(
     env_overrides = value_or(kwargs.get('env_overrides'), dict())
     cwd = kwargs.get('cwd')
     encoding = kwargs.get('encoding')
-    errors = kwargs.get('errors')
+    errors = value_or(kwargs.get('errors'), 'replace')
+    replace_fffd_with_question_mark = value_or(kwargs.get('replace_fffd_with_question_mark'), True)
 
     if message_quiet:
         print_message = silenced_print
@@ -188,6 +190,8 @@ def run(
                     line = line.removesuffix('\n')
                     if trim_output_lines:
                         line = line.rstrip()
+                    if replace_fffd_with_question_mark:
+                        line = line.replace('\ufffd', '?')
 
                     print_output(line)
 

{fancy_subprocess-2.0 → fancy_subprocess-2.2}/fancy_subprocess/_run_param.py

@@ -44,6 +44,7 @@ class RunParams(TypedDict, total=False):
     cwd: Optional[str | Path]
     encoding: Optional[str]
     errors: Optional[str]
+    replace_fffd_with_question_mark: Optional[bool]
 
 def check_run_params(**kwargs: Unpack[RunParams]) -> None:
     try:

{fancy_subprocess-2.0 → fancy_subprocess-2.2}/grab_output.py

@@ -2,7 +2,7 @@ import fancy_subprocess
 from typing import Unpack
 
 def grab_output(cmd: list[str], **kwargs: Unpack[fancy_subprocess.RunParams]) -> str:
-	# Raises ValueError if there are unknown parameters in kwargs or if a keyword argument's type is incorrect
+    # Raises ValueError if there are unknown parameters in kwargs or if a keyword argument's type is incorrect
     fancy_subprocess.check_run_params(**kwargs)
 
     # Make a copy of keyword arguments to be edited

{fancy_subprocess-2.0 → fancy_subprocess-2.2}/pyproject.toml

@@ -3,8 +3,8 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
-name = "fancy_subprocess"
-version = "2.0"
+name = "fancy-subprocess"
+version = "2.2"
 authors = [
     { name="Tamás PEREGI", email="petamas@gmail.com" },
 ]
@@ -26,11 +26,11 @@ classifiers = [
 license = "MIT"
 license-files = ["LICENSE"]
 dependencies = [
-	"ntstatus<2",
-	"oslex<2",
-	"pathext>=1.2,<2",
-	"typing_extensions>=4.14,<5",
-	"typeguard>=4.4.2,<5",
+    "ntstatus>=1.1,<2",
+    "oslex>=0.1.3,<2",
+    "pathext>=1.5,<2",
+    "typeguard>=4.4.2,<5",
+    "typing_extensions>=4.14,<5",
 ]
 
 [project.urls]

{fancy_subprocess-2.0 → fancy_subprocess-2.2}/uv.lock

@@ -4,7 +4,7 @@ requires-python = ">=3.10"
 
 [[package]]
 name = "fancy-subprocess"
-version = "2.0"
+version = "2.2"
 source = { editable = "." }
 dependencies = [
     { name = "ntstatus" },
@@ -16,13 +16,22 @@ dependencies = [
 
 [package.metadata]
 requires-dist = [
-    { name = "ntstatus", specifier = "<2" },
-    { name = "oslex", specifier = "<2" },
-    { name = "pathext", specifier = ">=1.2,<2" },
+    { name = "ntstatus", specifier = ">=1.1,<2" },
+    { name = "oslex", specifier = ">=0.1.3,<2" },
+    { name = "pathext", specifier = ">=1.5,<2" },
     { name = "typeguard", specifier = ">=4.4.2,<5" },
     { name = "typing-extensions", specifier = ">=4.14,<5" },
 ]
 
+[[package]]
+name = "more-itertools"
+version = "10.7.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/ce/a0/834b0cebabbfc7e311f30b46c8188790a37f89fc8d756660346fe5abfd09/more_itertools-10.7.0.tar.gz", hash = "sha256:9fddd5403be01a94b204faadcff459ec3568cf110265d3c54323e1e866ad29d3", size = 127671 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/2b/9f/7ba6f94fc1e9ac3d2b853fdff3035fb2fa5afbed898c4a72b8a020610594/more_itertools-10.7.0-py3-none-any.whl", hash = "sha256:d43980384673cb07d2f7d2d918c616b30c659c089ee23953f601d6609c67510e", size = 65278 },
+]
+
 [[package]]
 name = "mslex"
 version = "1.3.0"
@@ -34,11 +43,11 @@ wheels = [
 
 [[package]]
 name = "ntstatus"
-version = "1.0"
+version = "1.1"
 source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/ae/da/cb1da91d387a7fd6a41cd7d93e43e37dace1893a0b95f903957d14bcfab1/ntstatus-1.0.tar.gz", hash = "sha256:02213e4f0a94a7db2576f564a9db6c568424d45df91ff905ba72991be1090069", size = 37616 }
+sdist = { url = "https://files.pythonhosted.org/packages/b5/99/41f6934b2dc1b02c6366b9b5d5211f3dc8eb08c9f9d8813e58fe4f09f9b4/ntstatus-1.1.tar.gz", hash = "sha256:542069b3d0d654a37b9e068caaf4d29c8e3f9c1a2a4991ed0ec8c7a858022ee2", size = 37824 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/c1/d7/a7c7059d08115fa0b1a10640e3cf976b571af8a40893d8c19487ac66203b/ntstatus-1.0-py3-none-any.whl", hash = "sha256:cf64988a31880379061d6e9a7c85b938b8c8e50d392852017a4d68d1923bc72a", size = 36590 },
+    { url = "https://files.pythonhosted.org/packages/a5/cc/c9493a2a64dd9cfa8edf554028571f29398cb6fc693e6f4919f762994768/ntstatus-1.1-py3-none-any.whl", hash = "sha256:303239b3286fc0529fc8fd2daad6465ab7f5b2e0bc6abfdf785d48fbab1f2a54", size = 36674 },
 ]
 
 [[package]]
@@ -55,11 +64,14 @@ wheels = [
 
 [[package]]
 name = "pathext"
-version = "1.2"
+version = "1.5"
 source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/53/33/304454ff8a1cb51596834bd05e015b7b363c4fd546b8070c825d3613c976/pathext-1.2.tar.gz", hash = "sha256:937f993f60e36726c4f5fbaac1bef9ff7c072b6d1feb0da00a9dae16ee30f88f", size = 4406 }
+dependencies = [
+    { name = "more-itertools" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/09/b3/cd7d7282c1640300630e963b84b6e202862206f5ac24959015d83372e16c/pathext-1.5.tar.gz", hash = "sha256:cbfd6f697a4874be7ea37109dbf60f108d451b44bb3df290f1560c75fa16bb87", size = 6424 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/15/d0/a5e951eab19896b4521d8c57ab7ac7fb3793f119d50dd3b399ca5d28a670/pathext-1.2-py3-none-any.whl", hash = "sha256:0de8a1e7f741150b15315a281ff5ccaa67767ed0ad985a8b0b6eeabd9c9e1d74", size = 4327 },
+    { url = "https://files.pythonhosted.org/packages/d0/d0/aab254e2ba1e2a390261ef746c4129ef81b2d13289850380c5273026915d/pathext-1.5-py3-none-any.whl", hash = "sha256:3aedc261736dc714881676847dcc20ce2246b09d331ec09276b478477a469530", size = 7325 },
 ]
 
 [[package]]