Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

3905 pip version check cache dir #5419

Merged
merged 10 commits into from
May 18, 2018

Conversation

tomfbiz
Copy link
Contributor

@tomfbiz tomfbiz commented May 16, 2018

Fixes #3905
Changed rules on where pip version lock file selfcheck.json is stored.

Previously, the lock file was either stored at USER_CACHE/selfcheck.json,
or for vitual enviorments it is stored at sys.prefix\pip-selfcheck.json

Now regardless of whether the user is in a virtual environment, the lock file
is stored either in selfcheck.json in the path specified in cache-dir in
pip.conf, or if none is specified it is stored atUSER_CACHE/selfcheck.json

Copy link
Member

@dstufft dstufft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two fairly minor comments, but once those are addressed this looks good to me.

separators=(",", ":")
)


class GlobalSelfCheckState(object):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd probably rename this to just SelfCheckState or similar, since it's no longer "global" vs "virtualenv".

news/3905.bugfix Outdated
@@ -0,0 +1,8 @@
Changed rules on where pip version lock file selfcheck.json is stored.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I applaud you for writing such an extensive news file entry, I think that it is probably overly descriptive compared to the level of impact the typical user is going to see. For most people this will be entirely transparent. I would suggest trimming this down to 1, maybe two sentences. For a look at our existing change log entries, check out https://github.com/pypa/pip/blob/master/NEWS.rst.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also a note about this in https://github.com/pypa/pip/blob/master/docs/development.rst#adding-a-news-entry

In order to maintain a consistent style in the NEWS.rst file, it is preferred to keep the news entry to the point, in sentence case, shorter than 80 characters and in an imperative tone -- an entry should complete the sentence "This change will ...". In rare cases, where one line is not enough, use a summary line in an imperative tone followed by a blank line separating it from a description of the feature/change in one or more paragraphs, each wrapped at 80 characters. Remember that a news entry is meant for end users and should only contain details relevant to an end user.

@dstufft
Copy link
Member

dstufft commented May 17, 2018

Looks like you have some test failures, but the code itself looks good to me. Happy to merge this once CI is green.

@pradyunsg pradyunsg added C: cache Dealing with cache and files in it T: bugfix labels May 18, 2018
@pradyunsg pradyunsg merged commit 21b97e4 into pypa:master May 18, 2018
@lock
Copy link

lock bot commented Jun 2, 2019

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot added the auto-locked Outdated issues that have been locked by automation label Jun 2, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Jun 2, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
auto-locked Outdated issues that have been locked by automation C: cache Dealing with cache and files in it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

pip version check file doesn't honor cache-dir
3 participants