Add `pip cache dir`

[hugovk]

Short version

Add a cross-platform way to find out the uv cache directory (like pip has) for use on GitHub Actions.

Long version

If we want to cache things installed by uv pip install on GitHub Actions, we need to do something like this:

- uses: actions/cache@v4
  if: startsWith(runner.os, 'Linux')
  with:
    path: ~/.cache/uv
    key: ${{ runner.os }}-uv-${{ hashFiles('**/requirements.txt') }}
    restore-keys: |
      ${{ runner.os }}-uv-

- uses: actions/cache@v4
  if: startsWith(runner.os, 'macOS')
  with:
    path: ~/Library/Caches/uv
    key: ${{ runner.os }}-uv-${{ hashFiles('**/requirements.txt') }}
    restore-keys: |
      ${{ runner.os }}-uv-

- uses: actions/cache@v4
  if: startsWith(runner.os, 'Windows')
  with:
    path: ~\AppData\Local\uv\Cache
    key: ${{ runner.os }}-uv-${{ hashFiles('**/requirements.txt') }}
    restore-keys: |
      ${{ runner.os }}-uv-

Adapted from https://github.com/actions/cache/blob/main/examples.md#multiple-oss-in-a-workflow

Or:

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
        include:
        - os: ubuntu-latest
          path: ~/.cache/uv
        - os: macos-latest
          path: ~/Library/Caches/uv
        - os: windows-latest
          path: ~\AppData\Local\uv\Cache
    steps:
    - uses: actions/cache@v4
      with:
        path: ${{ matrix.path }}
        key: ${{ runner.os }}-uv-${{ hashFiles('**/requirements.txt') }}
        restore-keys: |
         ${{ runner.os }}-uv-

Adapted from https://github.com/actions/cache/blob/main/examples.md#multiple-oss-in-a-workflow-with-a-matrix

Or we may be able to choose a common directory using the --cache-dir flag or UV_CACHE_DIR environment variable.

Originally we had to do the same thing with pip (hence the examples at actions/cache).

But then pip 20.1 added a pip cache dir command (pypa/pip#7350 / pypa/pip#8095):

❯ pip cache dir
/Users/hugo/Library/Caches/pip

If we add uv pip cache dir, we would similarly be able to simplify the config:

- name: Get uv cache dir
  id: uv-cache
  run: |
    echo "dir=$(uv cache dir)" >> $GITHUB_OUTPUT

- name: pip cache
  uses: actions/cache@v4
  with:
    path: ${{ steps.pip-cache.outputs.dir }}
    key: ${{ runner.os }}-uv-${{ hashFiles('**/requirements.txt') }}
    restore-keys: |
      ${{ runner.os }}-uv-

Adapted from https://github.com/actions/cache/blob/main/examples.md#using-pip-to-get-cache-location

[charliermarsh]

Yeah we should add this, it's trivial.

[charliermarsh]

As part of this, I'll probably move uv clean to uv cache clean, so we can centralize the cache commands.

[hugovk]

Out of scope for this issue, could be useful to add some other pip cache subcommands:

❯ pip cache --help

Usage:
  pip3 cache dir
  pip3 cache info
  pip3 cache list [<pattern>] [--format=[human, abspath]]
  pip3 cache remove <pattern>
  pip3 cache purge


Description:
  Inspect and manage pip's wheel cache.

  Subcommands:

  - dir: Show the cache directory.
  - info: Show information about the cache.
  - list: List filenames of packages stored in the cache.
  - remove: Remove one or more package from the cache.
  - purge: Remove all items from the cache.

  ``<pattern>`` can be a glob expression or a package name.

Cache Options:
  --format <list_format>      Select the output format among: human (default) or abspath

Especially pip cache info, because we will end up with large pip and uv caches on some systems:

❯ pip cache info
Package index page cache location (pip v23.3+): /Users/hugo/Library/Caches/pip/http-v2
Package index page cache location (older pips): /Users/hugo/Library/Caches/pip/http
Package index page cache size: 187.6 MB
Number of HTTP files: 870
Locally built wheels location: /Users/hugo/Library/Caches/pip/wheels
Locally built wheels size: 5.9 MB
Number of locally built wheels: 10

Shall I open a new issue for pip cache info?

[charliermarsh]

Yeah feel free to create a separate issue for pip cache info. That looks useful. (I don't think we'd attempt to mimic the exact same output (in terms of format, etc.), but we could report the same information.)

[hugovk]

Thanks, I created #1655 and sneaked pip cache list in there too.

[akx]

Ah, heh, related 😁 actions/setup-python#818