dvc-utils 0.0.3__tar.gz → 0.0.4__tar.gz

{dvc-utils-0.0.3 → dvc-utils-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dvc-utils
-Version: 0.0.3
+Version: 0.0.4
 Summary: CLI for diffing DVC files at two commits (or one commit vs. current worktree), optionally passing both through another command first
 Home-page: https://github.com/runsascoded/dvc-utils
 Author: Ryan Williams
@@ -29,6 +29,7 @@ pip install dvc-utils
 ```
 
 ## Usage <a id="usage"></a>
+<!-- `bmdf -- dvc-utils --help` -->
 ```bash
 dvc-utils --help
 # Usage: dvc-utils [OPTIONS] COMMAND [ARGS]...
@@ -42,6 +43,7 @@ dvc-utils --help
 ```
 
 ### `dvc-utils diff` <a id="dvc-utils-diff"></a>
+<!-- `bmdf -- dvc-utils diff --help` -->
 ```bash
 dvc-utils diff --help
 # Usage: dvc-utils diff [OPTIONS] [cmd...] <path>
@@ -59,11 +61,15 @@ dvc-utils diff --help
 #   optional) at HEAD (last committed value) vs. the current worktree content.
 #
 # Options:
-#   -r, --refspec TEXT  <commit 1>..<commit 2> (compare two commits) or <commit>
-#                       (compare <commit> to the worktree)
-#   -S, --no-shell      Don't pass `shell=True` to Python `subprocess`es
-#   -v, --verbose       Log intermediate commands to stderr
-#   --help              Show this message and exit.
+#   -c, --color              Colorize the output
+#   -r, --refspec TEXT       <commit 1>..<commit 2> (compare two commits) or
+#                            <commit> (compare <commit> to the worktree)
+#   -S, --no-shell           Don't pass `shell=True` to Python `subprocess`es
+#   -U, --unified INTEGER    Number of lines of context to show (passes through
+#                            to `diff`)
+#   -v, --verbose            Log intermediate commands to stderr
+#   -w, --ignore-whitespace  Ignore whitespace differences (pass `-w` to `diff`)
+#   --help                   Show this message and exit.
 ```
 
 ## Examples <a id="examples"></a>

{dvc-utils-0.0.3 → dvc-utils-0.0.4}/README.md

@@ -18,6 +18,7 @@ pip install dvc-utils
 ```
 
 ## Usage <a id="usage"></a>
+<!-- `bmdf -- dvc-utils --help` -->
 ```bash
 dvc-utils --help
 # Usage: dvc-utils [OPTIONS] COMMAND [ARGS]...
@@ -31,6 +32,7 @@ dvc-utils --help
 ```
 
 ### `dvc-utils diff` <a id="dvc-utils-diff"></a>
+<!-- `bmdf -- dvc-utils diff --help` -->
 ```bash
 dvc-utils diff --help
 # Usage: dvc-utils diff [OPTIONS] [cmd...] <path>
@@ -48,11 +50,15 @@ dvc-utils diff --help
 #   optional) at HEAD (last committed value) vs. the current worktree content.
 #
 # Options:
-#   -r, --refspec TEXT  <commit 1>..<commit 2> (compare two commits) or <commit>
-#                       (compare <commit> to the worktree)
-#   -S, --no-shell      Don't pass `shell=True` to Python `subprocess`es
-#   -v, --verbose       Log intermediate commands to stderr
-#   --help              Show this message and exit.
+#   -c, --color              Colorize the output
+#   -r, --refspec TEXT       <commit 1>..<commit 2> (compare two commits) or
+#                            <commit> (compare <commit> to the worktree)
+#   -S, --no-shell           Don't pass `shell=True` to Python `subprocess`es
+#   -U, --unified INTEGER    Number of lines of context to show (passes through
+#                            to `diff`)
+#   -v, --verbose            Log intermediate commands to stderr
+#   -w, --ignore-whitespace  Ignore whitespace differences (pass `-w` to `diff`)
+#   --help                   Show this message and exit.
 ```
 
 ## Examples <a id="examples"></a>

{dvc-utils-0.0.3 → dvc-utils-0.0.4}/dvc_utils/main.py

@@ -72,13 +72,29 @@ def dvc_cache_path(ref: str, dvc_path: Optional[str] = None, log: bool = False)
     return join(dvc_cache_dir(log=log), 'files', 'md5', dirname, basename)
 
 
-def diff_cmds(cmd1: str, cmd2: str, verbose: bool = False, **kwargs):
+def diff_cmds(
+    cmd1: str,
+    cmd2: str,
+    verbose: bool = False,
+    color: bool = False,
+    unified: int | None = None,
+    ignore_whitespace: bool = False,
+    **kwargs,
+):
     """Run two commands and diff their output.
 
     Adapted from https://stackoverflow.com/a/28840955"""
     with named_pipes(n=2) as pipes:
         (pipe1, pipe2) = pipes
-        diff = Popen(['diff'] + pipes)
+        diff_cmd = [
+            'diff',
+            *(['-w'] if ignore_whitespace else []),
+            *(['-U', str(unified)] if unified is not None else []),
+            *(['--color=always'] if color else []),
+            pipe1,
+            pipe2,
+        ]
+        diff = Popen(diff_cmd)
         processes = []
         for path, cmd in ((pipe1, cmd1), (pipe2, cmd2)):
             with open(path, 'wb', 0) as pipe:
@@ -90,11 +106,22 @@ def diff_cmds(cmd1: str, cmd2: str, verbose: bool = False, **kwargs):
 
 
 @cli.command('diff', short_help='Diff a DVC-tracked file at two commits (or one commit vs. current worktree), optionally passing both through another command first')
+@option('-c', '--color', is_flag=True, help='Colorize the output')
 @option('-r', '--refspec', default='HEAD', help='<commit 1>..<commit 2> (compare two commits) or <commit> (compare <commit> to the worktree)')
 @option('-S', '--no-shell', is_flag=True, help="Don't pass `shell=True` to Python `subprocess`es")
+@option('-U', '--unified', type=int, help='Number of lines of context to show (passes through to `diff`)')
 @option('-v', '--verbose', is_flag=True, help="Log intermediate commands to stderr")
+@option('-w', '--ignore-whitespace', is_flag=True, help="Ignore whitespace differences (pass `-w` to `diff`)")
 @argument('args', metavar='[cmd...] <path>', nargs=-1)
-def dvc_utils_diff(refspec, no_shell, verbose, args):
+def dvc_utils_diff(
+    color: bool,
+    refspec: str | None,
+    no_shell: bool,
+    unified: int | None,
+    verbose: bool,
+    ignore_whitespace: bool,
+    args: Tuple[str, ...],
+):
     """Diff a file at two commits (or one commit vs. current worktree), optionally passing both through `cmd` first
 
     Examples:
@@ -139,7 +166,15 @@ def dvc_utils_diff(refspec, no_shell, verbose, args):
         shell_kwargs = dict(shell=shell) if shell else {}
         before_cmd = args(before_path)
         after_cmd = args(after_path)
-        diff_cmds(before_cmd, after_cmd, verbose=verbose, **shell_kwargs)
+        diff_cmds(
+            before_cmd,
+            after_cmd,
+            verbose=verbose,
+            color=color,
+            unified=unified,
+            ignore_whitespace=ignore_whitespace,
+            **shell_kwargs,
+        )
     else:
         process.run('diff', before_path, after_path, log=log)
 

{dvc-utils-0.0.3 → dvc-utils-0.0.4}/dvc_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dvc-utils
-Version: 0.0.3
+Version: 0.0.4
 Summary: CLI for diffing DVC files at two commits (or one commit vs. current worktree), optionally passing both through another command first
 Home-page: https://github.com/runsascoded/dvc-utils
 Author: Ryan Williams
@@ -29,6 +29,7 @@ pip install dvc-utils
 ```
 
 ## Usage <a id="usage"></a>
+<!-- `bmdf -- dvc-utils --help` -->
 ```bash
 dvc-utils --help
 # Usage: dvc-utils [OPTIONS] COMMAND [ARGS]...
@@ -42,6 +43,7 @@ dvc-utils --help
 ```
 
 ### `dvc-utils diff` <a id="dvc-utils-diff"></a>
+<!-- `bmdf -- dvc-utils diff --help` -->
 ```bash
 dvc-utils diff --help
 # Usage: dvc-utils diff [OPTIONS] [cmd...] <path>
@@ -59,11 +61,15 @@ dvc-utils diff --help
 #   optional) at HEAD (last committed value) vs. the current worktree content.
 #
 # Options:
-#   -r, --refspec TEXT  <commit 1>..<commit 2> (compare two commits) or <commit>
-#                       (compare <commit> to the worktree)
-#   -S, --no-shell      Don't pass `shell=True` to Python `subprocess`es
-#   -v, --verbose       Log intermediate commands to stderr
-#   --help              Show this message and exit.
+#   -c, --color              Colorize the output
+#   -r, --refspec TEXT       <commit 1>..<commit 2> (compare two commits) or
+#                            <commit> (compare <commit> to the worktree)
+#   -S, --no-shell           Don't pass `shell=True` to Python `subprocess`es
+#   -U, --unified INTEGER    Number of lines of context to show (passes through
+#                            to `diff`)
+#   -v, --verbose            Log intermediate commands to stderr
+#   -w, --ignore-whitespace  Ignore whitespace differences (pass `-w` to `diff`)
+#   --help                   Show this message and exit.
 ```
 
 ## Examples <a id="examples"></a>

{dvc-utils-0.0.3 → dvc-utils-0.0.4}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup
 
 setup(
     name='dvc-utils',
-    version="0.0.3",
+    version="0.0.4",
     description="CLI for diffing DVC files at two commits (or one commit vs. current worktree), optionally passing both through another command first",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",