cleaner: remove RECORD and modify INSTALLER

[cho-m]

EDIT: Updated contents to match latest commit

According to Python specification, we should remove RECORD file
to prevent changes to installed formula files via other tools, e.g. pip.
This also improves chances of generating an all bottle as it avoids
diff due to checksums of HOMEBREW_PREFIX present files. Also modify
INSTALLER file to indicate that brew is managing the Python package.

• Have you followed the guidelines in our Contributing document?
• Have you checked to ensure there aren't other open Pull Requests for the same change?
• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your changes? Here's an example.
• Have you successfully run brew style with your changes locally?
• Have you successfully run brew typecheck with your changes locally?
• Have you successfully run brew tests with your changes locally?

---

❯ brew bottle --json --only-json-tab asciidoc
==> Determining asciidoc bottle rebuild...
==> Bottling asciidoc--10.2.0.arm64_sonoma.bottle.7.tar.gz...
./asciidoc--10.2.0.arm64_sonoma.bottle.7.tar.gz
  bottle do
    rebuild 7
    sha256 cellar: :any_skip_relocation, arm64_sonoma: "397fc8b36e3079d3f387c91a9df61d0314f34c26f98c4dcebf44b13a0498d648"
  end

❯ brew fetch -q asciidoc
SHA256: 215cdd544ce3046f58f868347c476c8fa83b3391b2a700e6ddd1f9b65b0e9c4f

❯ diffoscope $(brew --cache -q asciidoc) asciidoc--10.2.0.arm64_sonoma.bottle.7.tar.gz
--- /Users/cho-m/Library/Caches/Homebrew/downloads/0dc87f8a307fb752c8a06de20d603793dcd2d4a2aab76dcbf6085012327a2507--asciidoc--10.2.0.arm64_sonoma.bottle.6.tar.gz
+++ asciidoc--10.2.0.arm64_sonoma.bottle.7.tar.gz
│   --- 0dc87f8a307fb752c8a06de20d603793dcd2d4a2aab76dcbf6085012327a2507--asciidoc--10.2.0.arm64_sonoma.bottle.6.tar
├── +++ asciidoc--10.2.0.arm64_sonoma.bottle.7.tar
│ ├── file list
│ │ @@ -142,15 +142,14 @@
│ │  -rw-r--r--   0        0        0    11241 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc/resources/themes/flask/flask.css
│ │  drwxr-xr-x   0        0        0        0 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc/resources/themes/volnitsky/
│ │  -rw-r--r--   0        0        0     8043 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc/resources/themes/volnitsky/volnitsky.css
│ │  -rw-r--r--   0        0        0     1954 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc/resources/xhtml11-quirks.conf
│ │  -rw-r--r--   0        0        0    23017 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc/resources/xhtml11.conf
│ │  -rw-r--r--   0        0        0     5810 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc/utils.py
│ │  drwxr-xr-x   0        0        0        0 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc-10.2.0.dist-info/
│ │ --rw-r--r--   0        0        0        4 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc-10.2.0.dist-info/INSTALLER
│ │ +-rw-r--r--   0        0        0        5 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc-10.2.0.dist-info/INSTALLER
│ │  -rw-r--r--   0        0        0     3103 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc-10.2.0.dist-info/METADATA
│ │ --rw-r--r--   0        0        0    11135 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc-10.2.0.dist-info/RECORD
│ │  -rw-r--r--   0        0        0        0 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc-10.2.0.dist-info/REQUESTED
│ │  -rw-r--r--   0        0        0       92 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc-10.2.0.dist-info/WHEEL
│ │  -rw-r--r--   0        0        0       74 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc-10.2.0.dist-info/entry_points.txt
│ │  -rw-r--r--   0        0        0        9 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc-10.2.0.dist-info/top_level.txt
│ │  -rw-r--r--   0        0        0      361 2022-05-22 17:07:31.000000 asciidoc/10.2.0/libexec/pyvenv.cfg
│ ├── asciidoc/10.2.0/libexec/lib/python3.12/site-packages/asciidoc-10.2.0.dist-info/INSTALLER
│ │ @@ -1 +1 @@
│ │ -pip
│ │ +brew

❯

[Bo98]

To minimize potential impact, we specifically restrict the replacement to match relative path of common directory structure, e.g. ../../../bin/<script>, and the expected CSV entries. The regex can be modified/expanded if RECORD format changes or if we find additional files that need similar modification.

I guess the concern is relocation can happen in literally any text file, including any .py file. So there's not really any filename regex that covers that.

There are most drastic measures: https://salsa.debian.org/python-team/tools/dh-python/-/commit/b369c028b398f8893b7fd94f2a0cb67e34e26ad0. In the end, interfacing Homebrew-provided Python packages with pip isn't really supported - you should manage them via brew instead. Looking into it more actually, it's probably actually what we want:

If the RECORD file is missing, tools that rely on .dist-info must not attempt to uninstall or upgrade the package. (This restriction does not apply to tools that rely on other sources of information, such as system package managers in Linux distros.)

And perhaps replace INSTALLER:

For example, if a tool is asked to uninstall a project but finds no RECORD file, it may suggest that the tool named in INSTALLER may be able to do the uninstallation.

See https://packaging.python.org/en/latest/specifications/recording-installed-packages/#intentionally-preventing-changes-to-installed-packages

[cho-m]

I'll go ahead and just delete RECORD given there is official documentation allowing it.

Changing INSTALLER does make message more useful:

ERROR: Cannot uninstall numpy 1.26.4, RECORD file not found. You might be able to recover from this via: 'pip install --force-reinstall --no-deps numpy==1.26.4'.

ERROR: Cannot uninstall numpy 1.26.4, RECORD file not found. Hint: The package was installed by brew.

[Bo98]

Thanks!

[MikeMcQuaid]

Thanks again @cho-m!