[new check] wheel contains compiled objects/libraries with debug symbols

[jameslamb]

What should be checked?

Given a built distribution contain compiled code in the following languages:

• C
• C++
• Fortran
• Rust

pydistcheck should attempt to detect debug symbols in that compiled code and report on it.

See the links in the Notes section for some more information on how this could work. Significant additional research is definitely needed to accomplish this in a way that's portable, fast, and correct.

What should the name of this check be?

using-debug-symbols

Will this check introduce any additional configuration?

no

Details on additional configuration required.

No response

Distribution type

• source (e.g. .tar.gz)
• built(e.g. .whl)

Notes

Some references:

• ENH:Distutils Remove debugging symbols by default numpy/numpy#16110
• Excessive size of wheel packages psycopg/psycopg#142
• Strip debug symbols of wheels pypa/cibuildwheel#331
• Add linker flags to strip debug symbols during wheel building scikit-image/scikit-image#6109
• https://github.com/messense/auditwheel-symbols
• https://medium.com/@holdengrissett/linux-101-understanding-the-insides-of-your-program-2be2480ba366
• https://stackoverflow.com/questions/7219845/difference-between-nm-and-objdump
• https://github.com/vadimcn/vscode-lldb/wiki/How-can-I-tell-if-a-binary-was-compiled-with-debug-symbols%3F
• https://bloomberg.github.io/memray/native_mode.html#adding-debugging-information-to-your-native-extension
• https://dwarfstd.org/
• https://docs.rs/mach_object/latest/mach_object/
• https://www.internalpointers.com/post/journey-across-static-dynamic-libraries
• http://blog.darlinghq.org/2018/07/mach-o-linking-and-loading-tricks.html
• https://lowlevelbits.org/parsing-mach-o-files/