feat(): Add logs for pip environment when installing #8266

gutsytechster · 2020-05-19T07:26:27Z

Towards #3166

Now, when the installation is performed the logs are shown as

(pip-env) gutsytechster@prashant:~/Documents/Projects/Open-Source-Projects/pip$ pip install django
Collecting django
  Using cached Django-3.0.6-py3-none-any.whl (7.5 MB)
Requirement already satisfied: pytz in /home/gutsytechster/miniconda3/envs/pip-env/lib/python3.6/site-packages (from django) (2020.1)
Requirement already satisfied: asgiref~=3.2 in /home/gutsytechster/miniconda3/envs/pip-env/lib/python3.6/site-packages (from django) (3.2.7)
Requirement already satisfied: sqlparse>=0.2.2 in /home/gutsytechster/miniconda3/envs/pip-env/lib/python3.6/site-packages (from django) (0.3.1)
pip 20.2.dev0 from /home/gutsytechster/miniconda3/envs/pip-env/lib/python3.6/site-packages/pip (python 3.6)
Installing collected packages: django
Successfully installed django-3.0.6

Please focus on last third line. Also, I'd like to get reviews about, if it should go as logger.info or aslogger.debug.

pradyunsg · 2020-05-19T07:35:08Z

Hmm... This is too late IMO. We should log this immediately at the start of the install command, instead of just-before-installation. And, it's probably better off as a logger.debug call. :)

deveshks · 2020-05-19T08:00:41Z

src/pip/_internal/req/__init__.py

@@ -46,7 +47,7 @@ def install_given_reqs(

    (to be called after having downloaded and unpacked the packages)
    """
-
+    logger.info(get_pip_version())


As noted in another comment by @pradyunsg , a better place for this would be somewhere in commands.install:run to show the message at the start , but you might have to experiment a bit about where to put the logger.debug message within that function.

I also saw that there was a request about adding the install location of the packages too, which I think is currently missing.

In that affect, having a custom function which gets this information along with pip version, and then writing a custom logger message might be better than directly relying on get_pip_version.

The reason on putting the logger call here was mainly due to this comment #3166 (comment)

Yeah, though I guess, I would look for other possible places as well.

deveshks · 2020-05-19T08:01:57Z

news/3166.feature

@@ -0,0 +1 @@
+Logs information about pip environemnt when installing a package.


typo environemnt -> environment

gutsytechster · 2020-05-19T11:08:21Z

Also, I am a little confused if the news entry should go as .feature or something else as this is not a bug, also not a documentation related issue.

deveshks · 2020-05-19T13:50:17Z

src/pip/_internal/req/__init__.py

@@ -46,7 +46,6 @@ def install_given_reqs(

    (to be called after having downloaded and unpacked the packages)
    """
-


Seems like that a newline was removed from this file by accident. You can re-add it so that this change doesn't show up as part of the PR.

Eh! yeah, I'll update it in subsequent commits.

gutsytechster · 2020-05-19T13:50:24Z

I am finding it difficult to get the install location beforehand. There are a number of option that user can provide to change the install location like --root, --prefix, --target etc. Is there some utility that finds out the install location.

I found decide_user_install, but this mainly tells if the package should be installed at the user site or not.

McSinyx · 2020-05-19T14:03:06Z

There's get_lib_location_guesses in the same file, which derives from the distutils' scheme (see _internal.location to see the extract of it from distutils.Distribution). IMHO the concrete location is only decided after decide_user_install, which I'm having a PR reworking on (GH-7828, edit: the mention is to let you know that the logic rework shuffled up the order in decide_user_install).

pradyunsg · 2020-05-20T07:19:28Z

It's probably better to figure out what to do for the install location logging in a follow up PR.

deveshks · 2020-05-20T07:28:01Z

src/pip/_internal/commands/install.py

@@ -249,6 +250,7 @@ def run(self, options, args):

        install_options = options.install_options or []

+        logger.debug("Using {}".format(get_pip_version()))


I think a test can be added to verify that the logger contains this string when install in called with -v, something along the lines of tests.lib.test_lib:https://github.com/pypa/pip/blob/master/tests/lib/test_lib.py#L40, maybe a smaller version of it.

gutsytechster · 2020-05-20T09:25:11Z

@McSinyx, AFAICU, the get_lib_location_guesses returns the purelib and platlib values which can be same or different based on the system's OS. And disutils_scheme gives output similar to

{'purelib': '/home/gutsytechster/miniconda3/envs/pip-env/lib/python3.8/site-packages', 'platlib': '/home/gutsytechster/miniconda3/envs/pip-env/lib/python3.8/site-packages', 'headers': '/home/gutsytechster/miniconda3/envs/pip-env/include/python3.8/UNKNOWN', 'scripts': '/home/gutsytechster/miniconda3/envs/pip-env/bin', 'data': '/home/gutsytechster/miniconda3/envs/pip-env'}

However, I still don't get how we can find the concrete location! 😐

McSinyx · 2020-05-20T09:58:11Z

@gutsytechster, IIUC these are concrete locations (purelib for pure Python, platlib for extensions). I think you can just move the assignment of lib_locations after L275.

BrownTruck · 2020-05-23T08:30:03Z

Hello!

I am an automated bot and I have noticed that this pull request is not currently able to be merged. If you are able to either merge the master branch into this pull request or rebase this pull request against master then it will be eligible for code review and hopefully merging!

news/3166.feature

xavfernandez · 2020-06-09T21:06:53Z

tests/functional/test_install.py

+
+
+def test_install_logs_pip_version_in_debug(script):
+    result = script.pip('install', '-v', 'INITools==0.2')


This test uses the network. I'd suggest to install a package from the fixture shared_data.

BrownTruck · 2020-07-06T17:45:11Z

Hello!

I am an automated bot and I have noticed that this pull request is not currently able to be merged. If you are able to either merge the master branch into this pull request or rebase this pull request against master then it will be eligible for code review and hopefully merging!

chrahunt · 2020-07-10T13:36:17Z

Thanks @gutsytechster!

deveshks reviewed May 19, 2020

View reviewed changes

gutsytechster force-pushed the add_logs_for_install branch from bf1b995 to 466eb27 Compare May 19, 2020 13:05

deveshks reviewed May 19, 2020

View reviewed changes

gutsytechster force-pushed the add_logs_for_install branch from 466eb27 to 4e87ecd Compare May 20, 2020 07:23

deveshks reviewed May 20, 2020

View reviewed changes

gutsytechster force-pushed the add_logs_for_install branch from 4e87ecd to eeff6e8 Compare May 20, 2020 08:37

BrownTruck added the needs rebase or merge PR has conflicts with current master label May 23, 2020

gutsytechster force-pushed the add_logs_for_install branch from eeff6e8 to a0d37a1 Compare May 23, 2020 08:52

pypa-bot removed the needs rebase or merge PR has conflicts with current master label May 23, 2020

pradyunsg approved these changes May 23, 2020

View reviewed changes

pradyunsg reviewed May 23, 2020

View reviewed changes

news/3166.feature Outdated Show resolved Hide resolved

xavfernandez reviewed Jun 9, 2020

View reviewed changes

BrownTruck added the needs rebase or merge PR has conflicts with current master label Jul 6, 2020

gutsytechster and others added 2 commits July 9, 2020 18:15

feat(): Add logs for pip environment when installing

0ccbad8

Update news/3166.feature

277b1e6

gutsytechster force-pushed the add_logs_for_install branch from e14fd31 to 277b1e6 Compare July 9, 2020 12:46

pypa-bot removed the needs rebase or merge PR has conflicts with current master label Jul 9, 2020

gutsytechster closed this Jul 10, 2020

gutsytechster reopened this Jul 10, 2020

test(functional/test_install): Use shared_data for installing package

f7abe1f

chrahunt approved these changes Jul 10, 2020

View reviewed changes

chrahunt merged commit 15b7afb into pypa:master Jul 10, 2020

gutsytechster deleted the add_logs_for_install branch July 22, 2020 10:15

github-actions bot locked as resolved and limited conversation to collaborators Oct 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(): Add logs for pip environment when installing #8266

feat(): Add logs for pip environment when installing #8266

gutsytechster commented May 19, 2020 •

edited

Loading

pradyunsg commented May 19, 2020

deveshks May 19, 2020

deveshks May 19, 2020

gutsytechster May 19, 2020

deveshks May 19, 2020

gutsytechster commented May 19, 2020

deveshks May 19, 2020

gutsytechster May 19, 2020

gutsytechster commented May 19, 2020 •

edited

Loading

McSinyx commented May 19, 2020 •

edited

Loading

pradyunsg commented May 20, 2020

deveshks May 20, 2020

gutsytechster commented May 20, 2020

McSinyx commented May 20, 2020

BrownTruck commented May 23, 2020

xavfernandez Jun 9, 2020

BrownTruck commented Jul 6, 2020

chrahunt commented Jul 10, 2020

		@@ -0,0 +1 @@
		Logs information about pip environemnt when installing a package.

		@@ -46,7 +46,6 @@ def install_given_reqs(

		(to be called after having downloaded and unpacked the packages)
		"""

		@@ -249,6 +250,7 @@ def run(self, options, args):

		install_options = options.install_options or []

		logger.debug("Using {}".format(get_pip_version()))



		def test_install_logs_pip_version_in_debug(script):
		result = script.pip('install', '-v', 'INITools==0.2')

feat(): Add logs for pip environment when installing #8266

feat(): Add logs for pip environment when installing #8266

Conversation

gutsytechster commented May 19, 2020 • edited Loading

pradyunsg commented May 19, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gutsytechster commented May 19, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gutsytechster commented May 19, 2020 • edited Loading

McSinyx commented May 19, 2020 • edited Loading

pradyunsg commented May 20, 2020

Choose a reason for hiding this comment

gutsytechster commented May 20, 2020

McSinyx commented May 20, 2020

BrownTruck commented May 23, 2020

Choose a reason for hiding this comment

BrownTruck commented Jul 6, 2020

chrahunt commented Jul 10, 2020

gutsytechster commented May 19, 2020 •

edited

Loading

gutsytechster commented May 19, 2020 •

edited

Loading

McSinyx commented May 19, 2020 •

edited

Loading