Rez pip fails to install ipdb, pymediainfo with the default config

[jtomori]

Hello,
I wanted to leave it here so that it's easier to find a rez config value which fixes the issues associated with installing some packages with pip.

Installing ipdb with Rez 2.111.3 on Windows 10 fails:

>rez pip --python-version 3.7 --install --release ipdb
...
14:37:42 INFO     Installed [ipdb-0.13.9] [REDACTED]\rez_packages\ipdb\0.13.9\package.py (efd4e36916ac78079627ffb5d538ffd557f55068)
14:37:42 ERROR    Unknown source file in ipython-7.34.0.dist-info\RECORD! '..\..\share\man\man1\ipython.1.gz'

To resolve, try:

1. Manually install the pip package using 'pip install --target'
   to a temporary location.
2. See where '..\..\share\man\man1\ipython.1.gz'
   actually got installed to by pip, RELATIVE to --target location
3. Create a new rule to 'pip_install_remaps' configuration like:

    {
        "record_path": r"{pardir}{sep}{pardir}{sep}share{sep}man{sep}man1{sep}ipython.1.gz",
        "pip_install": r"<RELATIVE path pip installed to in 2.>",
        "rez_install": r"<DESTINATION sub-path in rez package>",
    }

4. Try rez-pip install again.

If path remapping is not enough, consider submitting a new issue
via https://github.com/AcademySoftwareFoundation/rez/issues/new

Traceback (most recent call last):
  File "[REDACTED]\lib\runpy.py", line 196, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "[REDACTED]\lib\runpy.py", line 86, in _run_code
    exec(code, run_globals)
  File "[REDACTED]\Scripts\rez\rez.exe\__main__.py", line 7, in <module>
  File "[REDACTED]\lib\site-packages\rez\cli\_entry_points.py", line 69, in run_rez
    return run()
  File "[REDACTED]\lib\site-packages\rez\cli\_main.py", line 191, in run
    returncode = run_cmd()
  File "[REDACTED]\lib\site-packages\rez\cli\_main.py", line 183, in run_cmd
    return func(opts, opts.parser, extra_arg_groups)
  File "[REDACTED]\lib\site-packages\rez\cli\pip.py", line 67, in command
    pip_install_package(
  File "[REDACTED]\lib\site-packages\rez\pip.py", line 366, in pip_install_package
    src_dst_lut = _get_distribution_files_mapping(distribution, targetpath)
  File "[REDACTED]\lib\site-packages\rez\pip.py", line 565, in _get_distribution_files_mapping
    rel_src, rel_dest = get_mapping(rel_src_orig)
  File "[REDACTED]\lib\site-packages\rez\pip.py", line 548, in get_mapping
    raise IOError(
OSError: [Errno 89] Don't know what to do with relative path in ipython-7.34.0.dist-info\RECORD, see above error message for: '..\\..\\share\\man\\man1\\ipython.1.gz'

And similarly installing pymediainfo:

>rez pip --python-version 3.7 --install --release pymediainfo
...
14:38:01 INFO     Installed [importlib_metadata-5.1.0] [REDACTED]\rez_packages\importlib_metadata\5.1.0\package.py (1ea170f09dad84a21d7e5918bcf56066e867f747)
14:38:01 ERROR    Unknown source file in pymediainfo-6.0.1.dist-info\RECORD! '..\..\docs\License.html'

To resolve, try:

1. Manually install the pip package using 'pip install --target'
   to a temporary location.
2. See where '..\..\docs\License.html'
   actually got installed to by pip, RELATIVE to --target location
3. Create a new rule to 'pip_install_remaps' configuration like:

    {
        "record_path": r"{pardir}{sep}{pardir}{sep}docs{sep}License.html",
        "pip_install": r"<RELATIVE path pip installed to in 2.>",
        "rez_install": r"<DESTINATION sub-path in rez package>",
    }

4. Try rez-pip install again.

If path remapping is not enough, consider submitting a new issue
via https://github.com/AcademySoftwareFoundation/rez/issues/new

Traceback (most recent call last):
  File "[REDACTED]\lib\runpy.py", line 196, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "[REDACTED]\lib\runpy.py", line 86, in _run_code
    exec(code, run_globals)
  File "[REDACTED]\Scripts\rez\rez.exe\__main__.py", line 7, in <module>
  File "[REDACTED]\lib\site-packages\rez\cli\_entry_points.py", line 69, in run_rez
    return run()
  File "[REDACTED]\lib\site-packages\rez\cli\_main.py", line 191, in run
    returncode = run_cmd()
  File "[REDACTED]\lib\site-packages\rez\cli\_main.py", line 183, in run_cmd
    return func(opts, opts.parser, extra_arg_groups)
  File "[REDACTED]\lib\site-packages\rez\cli\pip.py", line 67, in command
    pip_install_package(
  File "[REDACTED]\lib\site-packages\rez\pip.py", line 366, in pip_install_package
    src_dst_lut = _get_distribution_files_mapping(distribution, targetpath)
  File "[REDACTED]\lib\site-packages\rez\pip.py", line 565, in _get_distribution_files_mapping
    rel_src, rel_dest = get_mapping(rel_src_orig)
  File "[REDACTED]\lib\site-packages\rez\pip.py", line 548, in get_mapping
    raise IOError(
OSError: [Errno 89] Don't know what to do with relative path in pymediainfo-6.0.1.dist-info\RECORD, see above error message for: '..\\..\\docs\\License.html'

The solution is to set the pip_install_remaps variable in your rezconfig to the following:

pip_install_remaps = [
    # Typical bin copy behaviour
    # Path in record          | pip installed to    | copy to rez destination
    # ------------------------|---------------------|--------------------------
    # ../../bin/*             | bin/*               | bin/*
    {
        "record_path": r"^{p}{s}{p}{s}(bin{s}.*)",
        "pip_install": r"\1",
        "rez_install": r"\1",
    },
    # Fix for #821
    # Path in record          | pip installed to    | copy to rez destination
    # ------------------------|---------------------|--------------------------
    # ../../lib/python/*      | *                   | python/*
    {
        "record_path": r"^{p}{s}{p}{s}lib{s}python{s}(.*)",
        "pip_install": r"\1",
        "rez_install": r"python{s}\1",
    },
    # Fix for ipython
    # Path in record          | pip installed to    | copy to rez destination
    # ------------------------|---------------------|--------------------------
    # ../../share/*           | share/*             | share/*
    {
        "record_path": r"^{p}{s}{p}{s}(share{s}.*)",
        "pip_install": r"\1",
        "rez_install": r"\1",
    },
    # Fix for pymediainfo
    # Path in record          | pip installed to    | copy to rez destination
    # ------------------------|---------------------|--------------------------
    # ../../docs/*            | docs/*              | docs/*
    {
        "record_path": r"^{p}{s}{p}{s}(docs{s}.*)",
        "pip_install": r"\1",
        "rez_install": r"\1",
    }
]

[hughetop]

I ran into the same thing with networkx. I'm surprised you didn't run into #1409 on windows, but it looks like your regexes are structured in a better way than I did them.