docs: ext: consoletest: Check pip install for correct invocation

Signed-off-by: John Andersen <johnandersenpdx@gmail.com>

Author: pdxjohnny

.ci/dffml-install.sh

@@ -7,7 +7,7 @@ if [ "x${DFFML_RELEASE}" == "xmaster" ]; then
   pip install -e .
   dffml service dev install
 elif [ "x${DFFML_RELEASE}" == "xlatest" ]; then
-  pip install dffml[all]
+  pip install --use-feature=2020-resolver dffml[all]
 else
-  pip install "dffml[all]==${DFFML_RELEASE}"
+  pip install --use-feature=2020-resolver "dffml[all]==${DFFML_RELEASE}"
 fi

docs/_ext/consoletest.py

@@ -552,11 +552,36 @@ async def run(self, ctx):
         await super().run(ctx)
 
 
+class PipNotRunAsModule(Exception):
+    """
+    Raised when a pip install command was not prefixed with python -m to run pip
+    as a module. Pip sometimes complains when this is not done.
+    """
+
+
+class PipMissingUseFeature2020Resolver(Exception):
+    """
+    Raised when a pip install command isn't upgrading pip and doesn't have
+    --use-feature=2020-resolver
+    """
+
+
 class PipInstallCommand(ConsoleCommand):
     def __init__(self, cmd: List[str]):
         super().__init__(cmd)
         self.directories: List[str] = []
         self.fix_dffml_packages()
+        # Ensure that we are running pip using it's module invocation
+        if self.cmd[:2] != ["python", "-m"]:
+            raise PipNotRunAsModule(cmd)
+        # Ensure command have --use-feature=2020-resolver
+        # If we are installing pip then we may or may not be upgrading from
+        # a version that has it, so don't raise an excption
+        if (
+            not (self.cmd.count("pip") == 2 and "-U" in self.cmd)
+            and "--use-feature=2020-resolver" not in self.cmd
+        ):
+            raise PipMissingUseFeature2020Resolver(cmd)
 
     def fix_dffml_packages(self):
         """
@@ -590,19 +615,7 @@ def fix_dffml_packages(self):
                     self.cmd.insert(i, "-e")
                 self.directories.append(directory)
 
-    async def pip_has_use_feature(self, ctx):
-        with tempfile.TemporaryFile() as stdout:
-            with contextlib.redirect_stdout(stdout):
-                await run_commands([["python", "-m", "pip", "-h"]], ctx)
-                stdout.seek(0)
-                return "--use-feature" in stdout.read().decode()
-
     async def run(self, ctx):
-        # Add --use-feature=2020-resolver to pip if it has it
-        if await self.pip_has_use_feature(ctx):
-            self.cmd.insert(
-                self.cmd.index("install") + 1, "--use-feature=2020-resolver"
-            )
 
         await super().run(ctx)
 

docs/examples/integration.rst

@@ -103,16 +103,16 @@ Make sure to update ``pip`` in case it's old, and install ``setuptools`` and
 .. code-block:: console
     :test:
 
-    $ python3 -m venv .venv
+    $ python -m venv .venv
     $ . .venv/bin/activate
-    $ pip install -U pip setuptools wheel
+    $ python -m pip install -U pip setuptools wheel
 
 Download the Python client libraries for MySQL.
 
 .. code-block:: console
     :test:
 
-    $ pip install -U \
+    $ python -m pip install --use-feature=2020-resolver -U \
         https://dev.mysql.com/get/Downloads/Connector-Python/mysql-connector-python-8.0.21.tar.gz
 
 Start MariaDB (functionally very similar to MySQL which its a fork of).
@@ -152,7 +152,7 @@ MariaDB/MySQL with DFFML.
 .. code-block:: console
     :test:
 
-    $ pip install -U dffml-source-mysql
+    $ python -m pip install --use-feature=2020-resolver -U dffml-source-mysql
 
 To get our dummy data, we'll be using the GitHub v4 API to search for "todo".
 The search should return repos implementing a TODO app.
@@ -278,7 +278,7 @@ configs than ``json``.
 .. code-block:: console
     :test:
 
-    $ pip install -U dffml-feature-git dffml-config-yaml
+    $ python -m pip install --use-feature=2020-resolver -U dffml-feature-git dffml-config-yaml
 
 The git operations / features rely on ``tokei``. We need to download and install
 it first.
@@ -408,7 +408,7 @@ another separate Python package from DFFML which we can install via ``pip``.
 .. code-block:: console
     :test:
 
-    $ pip install -U dffml-model-tensorflow
+    $ python -m pip install --use-feature=2020-resolver -U dffml-model-tensorflow
 
 The model is a generic wrapper around Tensorflow's DNN estimator. We can use it
 to train on our dataset.

docs/installation.rst

@@ -20,7 +20,7 @@ First make sure you have the latest versions of ``pip``, ``setuptools``, and
         .. code-block:: console
             :test:
 
-            $ python3 -m pip install -U pip setuptools wheel
+            $ python -m pip install -U pip setuptools wheel
 
     .. group-tab:: Windows
 
@@ -43,13 +43,13 @@ package.
         .. code-block:: console
             :test:
 
-            $ python3 -m pip install -U dffml
+            $ python -m pip install --use-feature=2020-resolver -U dffml
 
     .. group-tab:: Windows
 
         .. code-block:: console
 
-            (.venv) C:\Users\username> python -m pip install -U dffml
+            (.venv) C:\Users\username> python -m pip install --use-feature=2020-resolver -U dffml
 
 If you want to install all of the machine learning model plugins that are
 maintained as a part of the core repository, you can append ``[models]``.
@@ -60,13 +60,13 @@ maintained as a part of the core repository, you can append ``[models]``.
 
         .. code-block:: console
 
-            $ python3 -m pip install -U dffml[models]
+            $ python -m pip install --use-feature=2020-resolver -U dffml[models]
 
     .. group-tab:: Windows
 
         .. code-block:: console
 
-            (.venv) C:\Users\username> python -m pip install -U dffml[models]
+            (.venv) C:\Users\username> python -m pip install --use-feature=2020-resolver -U dffml[models]
 
 If you want to install all of the machine learning model plugins and all the
 data sources and DataFlow operations that are maintained as a part of the core
@@ -78,13 +78,13 @@ repository, you can append ``[all]``.
 
         .. code-block:: console
 
-            $ python3 -m pip install -U dffml[all]
+            $ python -m pip install --use-feature=2020-resolver -U dffml[all]
 
     .. group-tab:: Windows
 
         .. code-block:: console
 
-            (.venv) C:\Users\username> python -m pip install -U dffml[all]
+            (.venv) C:\Users\username> python -m pip install --use-feature=2020-resolver -U dffml[all]
 
 If you want to stay on the bleeding edge of bug fixes, etc. You can install from
 the master branch.
@@ -96,13 +96,13 @@ the master branch.
         .. code-block:: console
             :test:
 
-            $ python3 -m pip install -U "https://github.com/intel/dffml/archive/master.zip#egg=dffml"
+            $ python -m pip install --use-feature=2020-resolver -U "https://github.com/intel/dffml/archive/master.zip#egg=dffml"
 
     .. group-tab:: Windows
 
         .. code-block:: console
 
-            (.venv) C:\Users\username> python -m pip install -U "https://github.com/intel/dffml/archive/master.zip#egg=dffml"
+            (.venv) C:\Users\username> python -m pip install --use-feature=2020-resolver -U "https://github.com/intel/dffml/archive/master.zip#egg=dffml"
 
 You can also install the bleeding edge version of any plugin. To get the
 subdirectory you should use, take the package name on PyPi and remove ``dffml-``
@@ -115,14 +115,14 @@ and replace ``-`` with ``/``.
         .. code-block:: console
             :test:
 
-            $ python3 -m pip install -U "https://github.com/intel/dffml/archive/master.zip#egg=dffml" \
+            $ python -m pip install --use-feature=2020-resolver -U "https://github.com/intel/dffml/archive/master.zip#egg=dffml" \
                 "https://github.com/intel/dffml/archive/master.zip#egg=dffml-feature-git&subdirectory=feature/git"
 
     .. group-tab:: Windows
 
         .. code-block:: console
 
-            (.venv) C:\Users\username> python -m pip install -U "https://github.com/intel/dffml/archive/master.zip#egg=dffml" ^
+            (.venv) C:\Users\username> python -m pip install --use-feature=2020-resolver -U "https://github.com/intel/dffml/archive/master.zip#egg=dffml" ^
                 "https://github.com/intel/dffml/archive/master.zip#egg=dffml-feature-git&subdirectory=feature/git"
 
 There's an online IDE based on Theia (similar to VS Code) called GitPod that

docs/tutorials/models/iris.rst

@@ -12,7 +12,7 @@ the ``dffml-model-tensorflow`` plugin.
 .. code-block:: console
     :test:
 
-    $ python -m pip install dffml-model-tensorflow
+    $ python -m pip install --use-feature=2020-resolver dffml-model-tensorflow
 
 Iris Dataset
 ------------

docs/tutorials/models/package.rst

@@ -59,7 +59,7 @@ package.
 
 .. code-block:: console
 
-    $ pip install -e .
+    $ python -m pip install --use-feature=2020-resolver -e .
 
 Testing
 -------
@@ -215,7 +215,7 @@ And remember that any time we modify the **setup.py**, we have to re-install.
 .. code-block:: console
     :test:
 
-    $ pip install -e .
+    $ python -m pip install --use-feature=2020-resolver -e .
 
 Command Line Usage
 ------------------

docs/tutorials/models/slr.rst

@@ -266,7 +266,7 @@ information on the HTTP service.
 .. code-block:: console
     :test:
 
-    $ pip install -U dffml-service-http
+    $ python -m pip install --use-feature=2020-resolver -U dffml-service-http
 
 We start the HTTP service and tell it that we want to make our model accessable
 via the HTTP :ref:`plugin_service_http_api_model` API.

docs/tutorials/sources/complex.rst

@@ -80,7 +80,7 @@ The following command installs your new source.
 
 .. code-block:: console
 
-    $ python -m pip install -e .
+    $ python -m pip install --use-feature=2020-resolver -e .
 
 Write the tests
 ---------------

docs/tutorials/sources/file.rst

@@ -206,7 +206,7 @@ To install your new source run
 .. code-block:: console
     :test:
 
-    $ python -m pip install -e .
+    $ python -m pip install --use-feature=2020-resolver -e .
 
 CLI Usage
 ---------

tests/docs/test_consoletest.py

@@ -120,8 +120,11 @@ class TestPipInstallCommand(unittest.TestCase):
     def test_fix_dffml_packages(self):
         command = consoletest.PipInstallCommand(
             [
+                "python",
+                "-m",
                 "pip",
                 "install",
+                "--use-feature=2020-resolver",
                 "-U",
                 "dffml",
                 "-e",
@@ -130,12 +133,14 @@ def test_fix_dffml_packages(self):
                 "aiohttp",
             ]
         )
-        command.fix_dffml_packages()
         self.assertListEqual(
             command.cmd,
             [
+                "python",
+                "-m",
                 "pip",
                 "install",
+                "--use-feature=2020-resolver",
                 "-U",
                 "-e",
                 os.path.abspath(ROOT_DIR),