McSinyx
/
pip
mirror of https://github.com/pypa/pip
1
1
Fork 0
Code Issues Releases Activity

Remove show_stdout from run_command args

This commit is contained in:
Devesh Kumar Singh 2020-04-18 14:10:45 +05:30
parent 8adbc216a6
commit 94882fd1ed
5 changed files with 36 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/pip/_internal/vcs/bazaar.py
View File

@ -54,8 +54,7 @@ class Bazaar(VersionControl):
url, rev_options = self.get_url_rev_options(url) url, rev_options = self.get_url_rev_options(url)
self.run_command( self.run_command(
make_command('export', location, url, rev_options.to_args()), make_command('export', location, url, rev_options.to_args())
show_stdout=False,
) )
def fetch_new(self, dest, url, rev_options): def fetch_new(self, dest, url, rev_options):
@ -92,7 +91,7 @@ class Bazaar(VersionControl):
@classmethod @classmethod
def get_remote_url(cls, location): def get_remote_url(cls, location):
urls = cls.run_command(['info'], show_stdout=False, cwd=location) urls = cls.run_command(['info'], cwd=location)
for line in urls.splitlines(): for line in urls.splitlines():
line = line.strip() line = line.strip()
for x in ('checkout of branch: ', for x in ('checkout of branch: ',
@ -107,7 +106,7 @@ class Bazaar(VersionControl):
@classmethod @classmethod
def get_revision(cls, location): def get_revision(cls, location):
revision = cls.run_command( revision = cls.run_command(
['revno'], show_stdout=False, cwd=location, ['revno'], cwd=location,
) )
return revision.splitlines()[-1] return revision.splitlines()[-1]

19
src/pip/_internal/vcs/git.py
View File

@ -11,7 +11,7 @@ from pip._vendor.packaging.version import parse as parse_version
from pip._vendor.six.moves.urllib import parse as urllib_parse from pip._vendor.six.moves.urllib import parse as urllib_parse
from pip._vendor.six.moves.urllib import request as urllib_request from pip._vendor.six.moves.urllib import request as urllib_request
from pip._internal.exceptions import BadCommand, InstallationError from pip._internal.exceptions import BadCommand, SubProcessError
from pip._internal.utils.misc import display_path, hide_url from pip._internal.utils.misc import display_path, hide_url
from pip._internal.utils.subprocess import make_command from pip._internal.utils.subprocess import make_command
from pip._internal.utils.temp_dir import TempDirectory from pip._internal.utils.temp_dir import TempDirectory
@ -78,7 +78,7 @@ class Git(VersionControl):
def get_git_version(self): def get_git_version(self):
VERSION_PFX = 'git version ' VERSION_PFX = 'git version '
version = self.run_command(['version'], show_stdout=False) version = self.run_command(['version'])
if version.startswith(VERSION_PFX): if version.startswith(VERSION_PFX):
version = version[len(VERSION_PFX):].split()[0] version = version[len(VERSION_PFX):].split()[0]
else: else:
@ -101,7 +101,7 @@ class Git(VersionControl):
# and to suppress the message to stderr. # and to suppress the message to stderr.
args = ['symbolic-ref', '-q', 'HEAD'] args = ['symbolic-ref', '-q', 'HEAD']
output = cls.run_command( output = cls.run_command(
args, extra_ok_returncodes=(1, ), show_stdout=False, cwd=location, args, extra_ok_returncodes=(1, ), cwd=location,
) )
ref = output.strip() ref = output.strip()
@ -120,7 +120,7 @@ class Git(VersionControl):
self.unpack(temp_dir.path, url=url) self.unpack(temp_dir.path, url=url)
self.run_command( self.run_command(
['checkout-index', '-a', '-f', '--prefix', location], ['checkout-index', '-a', '-f', '--prefix', location],
show_stdout=False, cwd=temp_dir.path cwd=temp_dir.path
) )
@classmethod @classmethod
@ -135,7 +135,7 @@ class Git(VersionControl):
""" """
# Pass rev to pre-filter the list. # Pass rev to pre-filter the list.
output = cls.run_command(['show-ref', rev], cwd=dest, output = cls.run_command(['show-ref', rev], cwd=dest,
show_stdout=False, on_returncode='ignore') on_returncode='ignore')
refs = {} refs = {}
for line in output.strip().splitlines(): for line in output.strip().splitlines():
try: try:
@ -286,7 +286,7 @@ class Git(VersionControl):
# exits with return code 1 if there are no matching lines. # exits with return code 1 if there are no matching lines.
stdout = cls.run_command( stdout = cls.run_command(
['config', '--get-regexp', r'remote\..*\.url'], ['config', '--get-regexp', r'remote\..*\.url'],
extra_ok_returncodes=(1, ), show_stdout=False, cwd=location, extra_ok_returncodes=(1, ), cwd=location,
) )
remotes = stdout.splitlines() remotes = stdout.splitlines()
try: try:
@ -306,7 +306,7 @@ class Git(VersionControl):
if rev is None: if rev is None:
rev = 'HEAD' rev = 'HEAD'
current_rev = cls.run_command( current_rev = cls.run_command(
['rev-parse', rev], show_stdout=False, cwd=location, ['rev-parse', rev], cwd=location,
) )
return current_rev.strip() return current_rev.strip()
@ -319,7 +319,7 @@ class Git(VersionControl):
# find the repo root # find the repo root
git_dir = cls.run_command( git_dir = cls.run_command(
['rev-parse', '--git-dir'], ['rev-parse', '--git-dir'],
show_stdout=False, cwd=location).strip() cwd=location).strip()
if not os.path.isabs(git_dir): if not os.path.isabs(git_dir):
git_dir = os.path.join(location, git_dir) git_dir = os.path.join(location, git_dir)
repo_root = os.path.abspath(os.path.join(git_dir, '..')) repo_root = os.path.abspath(os.path.join(git_dir, '..'))
@ -378,7 +378,6 @@ class Git(VersionControl):
r = cls.run_command( r = cls.run_command(
['rev-parse', '--show-toplevel'], ['rev-parse', '--show-toplevel'],
cwd=location, cwd=location,
show_stdout=False,
on_returncode='raise', on_returncode='raise',
log_failed_cmd=False, log_failed_cmd=False,
) )
@ -386,7 +385,7 @@ class Git(VersionControl):
logger.debug("could not determine if %s is under git control " logger.debug("could not determine if %s is under git control "
"because git is not available", location) "because git is not available", location)
return None return None
except InstallationError: except SubProcessError:
return None return None
return os.path.normpath(r.rstrip('\r\n')) return os.path.normpath(r.rstrip('\r\n'))

16
src/pip/_internal/vcs/mercurial.py
View File

@ -8,7 +8,7 @@ import os
from pip._vendor.six.moves import configparser from pip._vendor.six.moves import configparser
from pip._internal.exceptions import BadCommand, InstallationError from pip._internal.exceptions import BadCommand, SubProcessError
from pip._internal.utils.misc import display_path from pip._internal.utils.misc import display_path
from pip._internal.utils.subprocess import make_command from pip._internal.utils.subprocess import make_command
from pip._internal.utils.temp_dir import TempDirectory from pip._internal.utils.temp_dir import TempDirectory
@ -47,7 +47,7 @@ class Mercurial(VersionControl):
self.unpack(temp_dir.path, url=url) self.unpack(temp_dir.path, url=url)
self.run_command( self.run_command(
['archive', location], show_stdout=False, cwd=temp_dir.path ['archive', location], cwd=temp_dir.path
) )
def fetch_new(self, dest, url, rev_options): def fetch_new(self, dest, url, rev_options):
@ -92,7 +92,7 @@ class Mercurial(VersionControl):
def get_remote_url(cls, location): def get_remote_url(cls, location):
url = cls.run_command( url = cls.run_command(
['showconfig', 'paths.default'], ['showconfig', 'paths.default'],
show_stdout=False, cwd=location).strip() cwd=location).strip()
if cls._is_local_repository(url): if cls._is_local_repository(url):
url = path_to_url(url) url = path_to_url(url)
return url.strip() return url.strip()
@ -103,8 +103,7 @@ class Mercurial(VersionControl):
Return the repository-local changeset revision number, as an integer. Return the repository-local changeset revision number, as an integer.
""" """
current_revision = cls.run_command( current_revision = cls.run_command(
['parents', '--template={rev}'], ['parents', '--template={rev}'], cwd=location).strip()
show_stdout=False, cwd=location).strip()
return current_revision return current_revision
@classmethod @classmethod
@ -115,7 +114,7 @@ class Mercurial(VersionControl):
""" """
current_rev_hash = cls.run_command( current_rev_hash = cls.run_command(
['parents', '--template={node}'], ['parents', '--template={node}'],
show_stdout=False, cwd=location).strip() cwd=location).strip()
return current_rev_hash return current_rev_hash
@classmethod @classmethod
@ -131,7 +130,7 @@ class Mercurial(VersionControl):
""" """
# find the repo root # find the repo root
repo_root = cls.run_command( repo_root = cls.run_command(
['root'], show_stdout=False, cwd=location).strip() ['root'], cwd=location).strip()
if not os.path.isabs(repo_root): if not os.path.isabs(repo_root):
repo_root = os.path.abspath(os.path.join(location, repo_root)) repo_root = os.path.abspath(os.path.join(location, repo_root))
return find_path_to_setup_from_repo_root(location, repo_root) return find_path_to_setup_from_repo_root(location, repo_root)
@ -145,7 +144,6 @@ class Mercurial(VersionControl):
r = cls.run_command( r = cls.run_command(
['root'], ['root'],
cwd=location, cwd=location,
show_stdout=False,
on_returncode='raise', on_returncode='raise',
log_failed_cmd=False, log_failed_cmd=False,
) )
@ -153,7 +151,7 @@ class Mercurial(VersionControl):
logger.debug("could not determine if %s is under hg control " logger.debug("could not determine if %s is under hg control "
"because hg is not available", location) "because hg is not available", location)
return None return None
except InstallationError: except SubProcessError:
return None return None
return os.path.normpath(r.rstrip('\r\n')) return os.path.normpath(r.rstrip('\r\n'))

9
src/pip/_internal/vcs/subversion.py
View File

@ -132,7 +132,7 @@ class Subversion(VersionControl):
@classmethod @classmethod
def _get_svn_url_rev(cls, location): def _get_svn_url_rev(cls, location):
from pip._internal.exceptions import InstallationError from pip._internal.exceptions import SubProcessError
entries_path = os.path.join(location, cls.dirname, 'entries') entries_path = os.path.join(location, cls.dirname, 'entries')
if os.path.exists(entries_path): if os.path.exists(entries_path):
@ -165,13 +165,12 @@ class Subversion(VersionControl):
# are only potentially needed for remote server requests. # are only potentially needed for remote server requests.
xml = cls.run_command( xml = cls.run_command(
['info', '--xml', location], ['info', '--xml', location],
show_stdout=False,
) )
url = _svn_info_xml_url_re.search(xml).group(1) url = _svn_info_xml_url_re.search(xml).group(1)
revs = [ revs = [
int(m.group(1)) for m in _svn_info_xml_rev_re.finditer(xml) int(m.group(1)) for m in _svn_info_xml_rev_re.finditer(xml)
] ]
except InstallationError: except SubProcessError:
url, revs = None, [] url, revs = None, []
if revs: if revs:
@ -215,7 +214,7 @@ class Subversion(VersionControl):
# svn, version 1.7.14 (r1542130) # svn, version 1.7.14 (r1542130)
# compiled Mar 28 2018, 08:49:13 on x86_64-pc-linux-gnu # compiled Mar 28 2018, 08:49:13 on x86_64-pc-linux-gnu
version_prefix = 'svn, version ' version_prefix = 'svn, version '
version = self.run_command(['--version'], show_stdout=True) version = self.run_command(['--version'])
if not version.startswith(version_prefix): if not version.startswith(version_prefix):
return () return ()
@ -298,7 +297,7 @@ class Subversion(VersionControl):
'export', self.get_remote_call_options(), 'export', self.get_remote_call_options(),
rev_options.to_args(), url, location, rev_options.to_args(), url, location,
) )
self.run_command(cmd_args, show_stdout=False) self.run_command(cmd_args)
def fetch_new(self, dest, url, rev_options): def fetch_new(self, dest, url, rev_options):
# type: (str, HiddenText, RevOptions) -> None # type: (str, HiddenText, RevOptions) -> None

44
src/pip/_internal/vcs/versioncontrol.py
View File

@ -39,7 +39,7 @@ from pip._internal.utils.urls import get_url_scheme
if MYPY_CHECK_RUNNING: if MYPY_CHECK_RUNNING:
from typing import ( from typing import (
Dict, Iterable, Iterator, List, Optional, Text, Tuple, Dict, Iterable, Iterator, List, Optional, Text, Tuple,
Type, Union Type, Union, Mapping, Any
) )
from pip._internal.utils.misc import HiddenText from pip._internal.utils.misc import HiddenText
from pip._internal.utils.subprocess import CommandArgs from pip._internal.utils.subprocess import CommandArgs
@ -83,17 +83,15 @@ def make_vcs_requirement_url(repo_url, rev, project_name, subdir=None):
def call_subprocess( def call_subprocess(
cmd, # type: Union[List[str], CommandArgs] cmd, # type: Union[List[str], CommandArgs]
show_stdout=False, # type: bool
cwd=None, # type: Optional[str] cwd=None, # type: Optional[str]
on_returncode='raise', # type: str on_returncode='raise', # type: str
extra_environ=None, # type: Optional[Mapping[str, Any]]
extra_ok_returncodes=None, # type: Optional[Iterable[int]] extra_ok_returncodes=None, # type: Optional[Iterable[int]]
log_failed_cmd=True # type: Optional[bool] log_failed_cmd=True # type: Optional[bool]
): ):
# type: (...) -> Text # type: (...) -> Text
""" """
Args: 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 extra_ok_returncodes: an iterable of integer return codes that are
acceptable, in addition to 0. Defaults to None, which means []. acceptable, in addition to 0. Defaults to None, which means [].
log_failed_cmd: if false, failed commands are not logged, log_failed_cmd: if false, failed commands are not logged,
@ -101,33 +99,16 @@ def call_subprocess(
""" """
if extra_ok_returncodes is None: if extra_ok_returncodes is None:
extra_ok_returncodes = [] extra_ok_returncodes = []
# Most places in pip use show_stdout=False.
# What this means is-- # log the subprocess output at DEBUG level.
# log_subprocess = subprocess_logger.debug
# - We log this output of stdout and stderr at DEBUG level
# as it is received. env = os.environ.copy()
# - If DEBUG logging isn't enabled (e.g. if --verbose logging wasn't if extra_environ:
# requested), then we show a spinner so the user can still see the env.update(extra_environ)
# subprocess is in progress.
# - If the subprocess exits with an error, we log the output to stderr
# at ERROR level if it hasn't already been displayed to the console
# (e.g. if --verbose logging wasn't enabled). This way we don't log
# the output to the console twice.
#
# If show_stdout=True, then the above is still done, but with DEBUG
# replaced by INFO.
if show_stdout:
# Then log the subprocess output at INFO level.
log_subprocess = subprocess_logger.info
used_level = logging.INFO
else:
# Then log the subprocess output using DEBUG. This also ensures
# it will be logged to the log file (aka user_log), if enabled.
log_subprocess = subprocess_logger.debug
used_level = logging.DEBUG
# Whether the subprocess will be visible in the console. # Whether the subprocess will be visible in the console.
showing_subprocess = subprocess_logger.getEffectiveLevel() <= used_level showing_subprocess = True
command_desc = format_command_args(cmd) command_desc = format_command_args(cmd)
try: try:
@ -786,9 +767,9 @@ class VersionControl(object):
def run_command( def run_command(
cls, cls,
cmd, # type: Union[List[str], CommandArgs] cmd, # type: Union[List[str], CommandArgs]
show_stdout=True, # type: bool
cwd=None, # type: Optional[str] cwd=None, # type: Optional[str]
on_returncode='raise', # type: str on_returncode='raise', # type: str
extra_environ=None, # type: Optional[Mapping[str, Any]]
extra_ok_returncodes=None, # type: Optional[Iterable[int]] extra_ok_returncodes=None, # type: Optional[Iterable[int]]
log_failed_cmd=True # type: bool log_failed_cmd=True # type: bool
): ):
@ -800,8 +781,9 @@ class VersionControl(object):
""" """
cmd = make_command(cls.name, *cmd) cmd = make_command(cls.name, *cmd)
try: try:
return call_subprocess(cmd, show_stdout, cwd, return call_subprocess(cmd, cwd,
on_returncode=on_returncode, on_returncode=on_returncode,
extra_environ=extra_environ,
extra_ok_returncodes=extra_ok_returncodes, extra_ok_returncodes=extra_ok_returncodes,
log_failed_cmd=log_failed_cmd) log_failed_cmd=log_failed_cmd)
except OSError as e: except OSError as e: