rf: use runners module from datalad_core library

mih · mih · commit 7f8826d73d9d · 2024-10-30T08:41:19.000+01:00
All non-deprecated content of this module has been migrated to
`datalad_core` (and some to `datasalad`).

A deprecation warning it added to the module. All consuming code here
has been adjusted to the new imports.
diff --git a/datalad_next/annexremotes/tests/test_archivist.py b/datalad_next/annexremotes/tests/test_archivist.py
@@ -7,7 +7,7 @@
 from .. import UnsupportedRequest
 from ..archivist import ArchivistRemote
 from datalad_next.datasets import Dataset
-from datalad_next.runners import CommandError
+from datalad_core.runners import CommandError
 
 from datalad_next.tests import assert_result_count
 
diff --git a/datalad_next/constraints/git.py b/datalad_next/constraints/git.py
@@ -1,7 +1,7 @@
 """Constraints for Git-related concepts and parameters"""
 from __future__ import annotations
 
-from datalad_next.runners import (
+from datalad_core.runners import (
     CommandError,
     call_git,
     call_git_oneline,
diff --git a/datalad_next/gitremotes/datalad_annex.py b/datalad_next/gitremotes/datalad_annex.py
@@ -212,7 +212,7 @@
     LegacyGitRepo as GitRepo,
 )
 from datalad_next.exceptions import CapturedException
-from datalad_next.runners import (
+from datalad_core.runners import (
     CommandError,
     call_git,
     call_git_oneline,
diff --git a/datalad_next/iter_collections/annexworktree.py b/datalad_next/iter_collections/annexworktree.py
@@ -29,7 +29,7 @@
 
 from datalad_next.consts import on_windows
 from datalad_next.repo_utils import has_initialized_annex
-from datalad_next.runners import iter_git_subproc
+from datalad_core.runners import iter_git_subproc
 
 from .gitworktree import (
     GitWorktreeItem,
diff --git a/datalad_next/iter_collections/gitdiff.py b/datalad_next/iter_collections/gitdiff.py
@@ -25,13 +25,11 @@
 
 from datalad_next.consts import PRE_INIT_COMMIT_SHA
 from datasalad.gitpathspec import GitPathSpecs
-from datalad_next.runners import (
+from datalad_core.runners import (
     CommandError,
-    iter_git_subproc,
-)
-from datalad_next.runners import (
     call_git,
     call_git_oneline,
+    iter_git_subproc,
 )
 
 from .gittree import (
diff --git a/datalad_next/iter_collections/gitstatus.py b/datalad_next/iter_collections/gitstatus.py
@@ -12,7 +12,7 @@
 )
 
 from datalad_next.consts import PRE_INIT_COMMIT_SHA
-from datalad_next.runners import (
+from datalad_core.runners import (
     call_git_lines,
 )
 from datalad_next.repo_utils import (
diff --git a/datalad_next/iter_collections/gittree.py b/datalad_next/iter_collections/gittree.py
@@ -21,7 +21,7 @@
     itemize,
 )
 
-from datalad_next.runners import iter_git_subproc
+from datalad_core.runners import iter_git_subproc
 
 from .utils import PathBasedItem
 
diff --git a/datalad_next/iter_collections/gitworktree.py b/datalad_next/iter_collections/gitworktree.py
@@ -23,7 +23,7 @@
     itemize,
 )
 
-from datalad_next.runners import iter_git_subproc
+from datalad_core.runners import iter_git_subproc
 from datasalad.gitpathspec import GitPathSpecs
 from .utils import (
     FileSystemItem,
diff --git a/datalad_next/iter_collections/tests/test_itergitstatus.py b/datalad_next/iter_collections/tests/test_itergitstatus.py
@@ -2,7 +2,7 @@
 import pytest
 
 from datalad_next.datasets import Dataset
-from datalad_next.runners import (
+from datalad_core.runners import (
     call_git_success,
 )
 
diff --git a/datalad_next/patches/replace_sshremoteio.py b/datalad_next/patches/replace_sshremoteio.py
@@ -50,7 +50,7 @@
 
 from datalad_next.exceptions import CapturedException
 from datalad_next.patches import apply_patch
-from datalad_next.runners import CommandError
+from datalad_core.runners import CommandError
 from datalad_next.shell import (
     FixedLengthResponseGeneratorPosix,
     shell,
diff --git a/datalad_next/repo_utils/annex.py b/datalad_next/repo_utils/annex.py
@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from datalad_next.runners import call_git_success
+from datalad_core.runners import call_git_success
 
 
 def has_initialized_annex(
diff --git a/datalad_next/repo_utils/tests/test_head.py b/datalad_next/repo_utils/tests/test_head.py
@@ -1,6 +1,6 @@
 import pytest
 
-from datalad_next.runners import call_git
+from datalad_core.runners import call_git
 
 from .. import get_worktree_head
 
diff --git a/datalad_next/repo_utils/worktree.py b/datalad_next/repo_utils/worktree.py
@@ -3,7 +3,7 @@
 from pathlib import Path
 
 from datalad_next.exceptions import CapturedException
-from datalad_next.runners import (
+from datalad_core.runners import (
     CommandError,
     call_git_lines,
 )
diff --git a/datalad_next/runners/__init__.py b/datalad_next/runners/__init__.py
@@ -1,5 +1,10 @@
 """Execution of subprocesses
 
+.. deprecated:: 1.6
+   This module is deprecated. It has been partially migrated to the
+   `datalad-core library <https://pypi.org/project/datalad-core>`__. Imports
+   should be adjusted to ``datalad_core.runners``.
+
 This module provides all relevant components for subprocess execution.  The
 main work horse is :func:`~datalad_next.runners.iter_subproc`, a context
 manager that enables interaction with a subprocess in the form of an iterable
@@ -63,59 +68,95 @@
    StdOutErrCapture
 """
 
-from .iter_subproc import (
-    iter_subproc,
-)
-from .git import (
-    call_git,
-    call_git_lines,
-    call_git_oneline,
-    call_git_success,
-    iter_git_subproc,
+__all__ = [
+    'call_git',
+    'call_git_lines',
+    'call_git_oneline',
+    'call_git_success',
+    'iter_git_subproc',
+    'iter_subproc',
+    'CommandError',
+    'GitRunner',
+    'KillOutput',
+    'NoCapture',
+    'Protocol',
+    'Runner',
+    'StdErrCapture',
+    'StdOutCapture',
+    'StdOutErrCapture',
+    'STDERR_FILENO',
+    'STDOUT_FILENO',
+    'ThreadedRunner',
+    'LineSplitter',
+    'GeneratorMixIn',
+    'NoCaptureGeneratorProtocol',
+    'StdOutCaptureGeneratorProtocol',
+    'DEVNULL',
+]
+
+import warnings
+
+# TODO: REMOVE FOR V2.0
+from subprocess import (
+    DEVNULL,
 )
 
 # runners
-# TODO REMOVE FOR V2.0
-from datalad.runner import (
-    GitRunner,
-    Runner,
-)
-# TODO REMOVE FOR V2.0
-from datalad.runner.nonasyncrunner import ThreadedRunner
+# TODO: REMOVE FOR V2.0
 # protocols
-# TODO REMOVE FOR V2.0
+# TODO: REMOVE FOR V2.0
 from datalad.runner import (
+    GitRunner,
     KillOutput,
     NoCapture,
     Protocol,
-    StdOutCapture,
+    Runner,
     StdErrCapture,
+    StdOutCapture,
     StdOutErrCapture,
 )
-# TODO REMOVE FOR V2.0
-from datalad.runner.protocol import GeneratorMixIn
-# TODO REMOVE FOR V2.0
-from .protocols import (
-    NoCaptureGeneratorProtocol,
-    StdOutCaptureGeneratorProtocol,
-)
-# exceptions
-# The following import supports legacy code that uses `CommandError` from this
-# module. If you are writing new code, please use `CommandError` from
-# `datalad.support.exceptions`. We intend to remove this import in the future.
-from datalad_next.exceptions import CommandError
 
+# TODO: REMOVE FOR V2.0
 # utilities
-# TODO REMOVE FOR V2.0
+# TODO: REMOVE FOR V2.0
 from datalad.runner.nonasyncrunner import (
-    STDOUT_FILENO,
     STDERR_FILENO,
+    STDOUT_FILENO,
+    ThreadedRunner,
 )
-# TODO REMOVE FOR V2.0
+
+# TODO: REMOVE FOR V2.0
+from datalad.runner.protocol import GeneratorMixIn
+
+# TODO: REMOVE FOR V2.0
 from datalad.runner.utils import (
     LineSplitter,
 )
-# TODO REMOVE FOR V2.0
-from subprocess import (
-    DEVNULL,
+from datalad_core.runners import (
+    call_git,
+    call_git_lines,
+    call_git_oneline,
+    call_git_success,
+    iter_git_subproc,
+    iter_subproc,
+)
+
+# exceptions
+# The following import supports legacy code that uses `CommandError` from this
+# module. If you are writing new code, please use `CommandError` from
+# `datalad_core.runners`. We intend to remove this import in the future.
+from datalad_next.exceptions import CommandError
+
+# TODO: REMOVE FOR V2.0
+from .protocols import (
+    NoCaptureGeneratorProtocol,
+    StdOutCaptureGeneratorProtocol,
+)
+
+warnings.warn(
+    '`datalad_next.runners` has been partially migrated to the '
+    'datalad-core library, '
+    'check docs, and adjust imports to `datalad_core.runners`',
+    DeprecationWarning,
+    stacklevel=1,
 )
diff --git a/datalad_next/runners/git.py b/datalad_next/runners/git.py
diff --git a/datalad_next/runners/iter_subproc.py b/datalad_next/runners/iter_subproc.py
diff --git a/datalad_next/tests/fixtures.py b/datalad_next/tests/fixtures.py
diff --git a/datalad_next/url_operations/ssh.py b/datalad_next/url_operations/ssh.py
diff --git a/docs/source/index.rst b/docs/source/index.rst

Original file line number	Diff line number	Diff line change
`@@ -212,7 +212,7 @@`
`212`	`212`	`LegacyGitRepo as GitRepo,`
`213`	`213`	`)`
`214`	`214`	`from datalad_next.exceptions import CapturedException`
`215`		`-from datalad_next.runners import (`
	`215`	`+from datalad_core.runners import (`
`216`	`216`	`CommandError,`
`217`	`217`	`call_git,`
`218`	`218`	`call_git_oneline,`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`)`
`13`	`13`
`14`	`14`	`from datalad_next.consts import PRE_INIT_COMMIT_SHA`
`15`		`-from datalad_next.runners import (`
	`15`	`+from datalad_core.runners import (`
`16`	`16`	`call_git_lines,`
`17`	`17`	`)`
`18`	`18`	`from datalad_next.repo_utils import (`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`itemize,`
`22`	`22`	`)`
`23`	`23`
`24`		`-from datalad_next.runners import iter_git_subproc`
	`24`	`+from datalad_core.runners import iter_git_subproc`
`25`	`25`
`26`	`26`	`from .utils import PathBasedItem`
`27`	`27`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`itemize,`
`24`	`24`	`)`
`25`	`25`
`26`		`-from datalad_next.runners import iter_git_subproc`
	`26`	`+from datalad_core.runners import iter_git_subproc`
`27`	`27`	`from datasalad.gitpathspec import GitPathSpecs`
`28`	`28`	`from .utils import (`
`29`	`29`	`FileSystemItem,`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`import pytest`
`3`	`3`
`4`	`4`	`from datalad_next.datasets import Dataset`
`5`		`-from datalad_next.runners import (`
	`5`	`+from datalad_core.runners import (`
`6`	`6`	`call_git_success,`
`7`	`7`	`)`
`8`	`8`