OpenQuizz
Une application de gestion des contenus pédagogiques
pip._internal.utils.subprocess Namespace Reference

Functions

def make_command (*args)
 
def format_command_args (args)
 
def reveal_command_args (args)
 
def make_subprocess_output_error (cmd_args, cwd, lines, exit_status)
 
def call_subprocess (cmd, show_stdout=False, cwd=None, on_returncode="raise", extra_ok_returncodes=None, command_desc=None, extra_environ=None, unset_environ=None, spinner=None, log_failed_cmd=True, stdout_only=False)
 
def runner_with_spinner_message (message)
 

Variables

 CommandArgs
 
 LOG_DIVIDER
 

Function Documentation

◆ call_subprocess()

def pip._internal.utils.subprocess.call_subprocess (   cmd,
  show_stdout = False,
  cwd = None,
  on_returncode = "raise",
  extra_ok_returncodes = None,
  command_desc = None,
  extra_environ = None,
  unset_environ = None,
  spinner = None,
  log_failed_cmd = True,
  stdout_only = False 
)
Args:
  show_stdout: if true, use INFO to log the subprocess's stderr and
    stdout streams.  Otherwise, use DEBUG.  Defaults to False.
  extra_ok_returncodes: an iterable of integer return codes that are
    acceptable, in addition to 0. Defaults to None, which means [].
  unset_environ: an iterable of environment variable names to unset
    prior to calling subprocess.Popen().
  log_failed_cmd: if false, failed commands are not logged, only raised.
  stdout_only: if true, return only stdout, else return both. When true,
    logging of both stdout and stderr occurs when the subprocess has
    terminated, else logging occurs as subprocess output is produced.

◆ format_command_args()

def pip._internal.utils.subprocess.format_command_args (   args)
Format command arguments for display.

◆ make_command()

def pip._internal.utils.subprocess.make_command ( args)
Create a CommandArgs object.

◆ make_subprocess_output_error()

def pip._internal.utils.subprocess.make_subprocess_output_error (   cmd_args,
  cwd,
  lines,
  exit_status 
)
Create and return the error message to use to log a subprocess error
with command output.

:param lines: A list of lines, each ending with a newline.

◆ reveal_command_args()

def pip._internal.utils.subprocess.reveal_command_args (   args)
Return the arguments in their raw, unredacted form.

◆ runner_with_spinner_message()

def pip._internal.utils.subprocess.runner_with_spinner_message (   message)
Provide a subprocess_runner that shows a spinner message.

Intended for use with for pep517's Pep517HookCaller. Thus, the runner has
an API that matches what's expected by Pep517HookCaller.subprocess_runner.

Variable Documentation

◆ CommandArgs

CommandArgs

◆ LOG_DIVIDER

LOG_DIVIDER