Add option to list config files with pip config

[deveshks]

Fixes and closes #6741

Add option to list config files per variant and whether they actually exist

$ pip config list-files
env:
global:
  /Library/Application Support/pip/pip.conf, exists: False 
site:
  /Users/devesh/pip/.env/pip.conf, exists: True 
user:
  /Users/devesh/.pip/pip.conf, exists: False 
  /Users/devesh/.config/pip/pip.conf, exists: False 

This is a preliminary output, but we need to decide on some things before we finalize something

Edit: An updated format with all values for a config file listed under it is now added:

If PIP_CONFIG_FILE is set

$ pip config debug
env_var:
  PIP_CONFIG_FILE='/Users/devesh/Desktop/pip.cfg'
  PIP_DEFAULT_TIMEOUT='60'
env:
  /Users/devesh/Desktop/pip.cfg, exists: True
    global.timeout: 60
    global.index-url: https://download.zope.org/ppix
global:
  /Library/Application Support/pip/pip.conf, exists: True
    global.timeout: 60
    freeze.timeout: 10
site:
  /Users/devesh/pip/.env/pip.conf, exists: True
    global.no-cache-dir: false
    install.no-compile: no
    install.no-warn-script-location: false

If PIP_CONFIG_FILE is not set:

$ pip config debug
env_var:
  PIP_DEFAULT_TIMEOUT='60'
env:
global:
  /Library/Application Support/pip/pip.conf, exists: True
    global.timeout: 60
    freeze.timeout: 10
site:
  /Users/devesh/pip/.env/pip.conf, exists: True
    global.no-cache-dir: false
    install.no-compile: no
    install.no-warn-script-location: false
    a.b: 1
user:
  /Users/devesh/.pip/pip.conf, exists: False
  /Users/devesh/.config/pip/pip.conf, exists: True
    global.find-links: 
    http://download.example.com
    install.find-links: 
    http://mirror1.example.com
    http://mirror2.example.com
    install.trusted-host: 
    http://mirror1.example.com
    http://mirror2.example.com

[deveshks]

To move the PR ahead, I have implemented the first suggestion provided in #6741 (comment). (Naming the command as pip config debug and following it's output.

The output now looks like:

$ pip config debug
env:
global:
  /Library/Application Support/pip/pip.conf, exists: False 
site:
  /Users/devesh/pip/.env/pip.conf, exists: True 
    install.timeout: 10 
user:
  /Users/devesh/.pip/pip.conf, exists: False 
  /Users/devesh/.config/pip/pip.conf, exists: True 
    global.timeout: 15 
    global.index-url: https://private_pypi.com/simple/ 

Hi @xavfernandez ,

The only thing missing in the output in your example which I implemented in the latest commit is PIP_INDEX_URL: https://test.pypi.org/simple/ under env: in the original example. Where do I look for this key-value pair to be shown under env?

[deveshks]

Hi @xavfernandez , @pradyunsg

Any suggestions on the next steps to do here, in order to move this PR ahead and get this approved/merged, especially w.r.t #8096 (comment) are welcome.

[pradyunsg]

I like this, although the naming of the command and functions should be updated, to more directly reflect what they're for. :)

[deveshks]

I have also gone ahead and added tests for this feature for everything except to test for system-wide configuration file which falls under global.

I think we can neither write to system-wide files which might have permissions defined in a way that the tox virtualenv cannot write to those locations, and we cannot patch those files as well since pip config commands runs inside a subprocess.

Any suggestions on if there are other ways to achieve this is welcome.

The current output for the command can be found at the PR description.

[deveshks]

Hi @pradyunsg

This should be good to go except a test for verifying set global options inside a virtualenv, which I am unsure how to do (#8096 (comment)).

Also the Travis CI has passed, but the status is stuck at Pending 😞

[deveshks]

I added a test in 84d6719 which verifies that the global configuration file is correctly identified for different platforms.

With that, I think that this PR is implementation complete, and should be ready for further reviews.

[deveshks]

Okay so the CI is green now too after rebasing to current master as well. The PR is ready for further reviews and approval/merge.

[deveshks]

Hi @xavfernandez

I think this PR is feature complete, and I would really appreciate if you could take a look at this, and provide further reviews.

[xavfernandez]

I love it 👍

Ideally, we should also help identify invalid/unknown options or environment variable, something like:

$ PIP_TOTO=titi pip config debug
env_var:
  PIP_TOTO='titi'
env:
global:
  /etc/xdg/pip/pip.conf, exists: False
  /etc/pip.conf, exists: False
site:
  /home/xafer/.virtualenvs/pip/pip.conf, exists: False
user:
  /home/xafer/.pip/pip.conf, exists: True
    global.disable-pip-version-check: 1
    global.timout: 10

PIP_TOTO is not a known configuration environment variable
global.timout is not a known configuration key (did you mean global.timeout ?)

but this can definitely happen in a followup PR :)

[deveshks]

Thanks @xavfernandez . This should be ready to merge.

Ideally, we should also help identify invalid/unknown options or environment variable, something like:

$ PIP_TOTO=titi pip config debug
env_var:
  PIP_TOTO='titi'
env:
global:
  /etc/xdg/pip/pip.conf, exists: False
  /etc/pip.conf, exists: False
site:
  /home/xafer/.virtualenvs/pip/pip.conf, exists: False
user:
  /home/xafer/.pip/pip.conf, exists: True
    global.disable-pip-version-check: 1
    global.timout: 10

PIP_TOTO is not a known configuration environment variable
global.timout is not a known configuration key (did you mean global.timeout ?)

but this can definitely happen in a followup PR :)

That's a very good idea, and I think this can definitely be handled in a separate issue/PR.

[deveshks]

Hi @pradyunsg

We should be good to merge this unless there are more reviews needed here, post this I will work on #8096 (comment)

[xavfernandez]

Thanks a lot @deveshks 👍