running egg_info in build command

[kloczek]

I just realised that many build problem of my rpm/Solaris IPS packages are caused by lack of generated <module>.egg-info metadata. Typical package build procedure which I'm using is sequence of the commands:

• "setup.py build"
• "setup.py install --root </install/prefix>"
• "pytest with PYTHONPATH pointing to sitearch and sitelib inside </install/prefix>

Issue is that I just realised that some modules during build are generating <module>.egg-info metadata directory and some are not and so far I was not able to find what is causing that difference.

Example: two modules lz4 https://github.com/python-lz4/python-lz4/ and botocore https://github.com/boto/botocore/
botocore:

+ /usr/bin/python3 setup.py build '--executable=/usr/bin/python3 -s'
running build
running build_py
creating build
creating build/lib
creating build/lib/botocore

<copy files to build/lib/botocore>

running egg_info
creating botocore.egg-info
writing botocore.egg-info/PKG-INFO
writing dependency_links to botocore.egg-info/dependency_links.txt
writing requirements to botocore.egg-info/requires.txt
writing top-level names to botocore.egg-info/top_level.txt
writing manifest file 'botocore.egg-info/SOURCES.txt'
reading manifest file 'botocore.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
warning: no files found matching 'botocore/vendored/requests/cacert.pem'
no previously-included directories found matching 'docs/build'
adding license file 'LICENSE.txt'
adding license file 'NOTICE'
writing manifest file 'botocore.egg-info/SOURCES.txt'
copying botocore/cacert.pem -> build/lib/botocore

<copy or create some data files>

The same with lz4:

+ /usr/bin/python3 setup.py build '--executable=/usr/bin/python3 -s'
running build
running build_py
creating build
creating build/lib.linux-x86_64-3.8
creating build/lib.linux-x86_64-3.8/lz4
copying lz4/__init__.py -> build/lib.linux-x86_64-3.8/lz4
copying lz4/version.py -> build/lib.linux-x86_64-3.8/lz4
creating build/lib.linux-x86_64-3.8/lz4/block
copying lz4/block/__init__.py -> build/lib.linux-x86_64-3.8/lz4/block
creating build/lib.linux-x86_64-3.8/lz4/frame
copying lz4/frame/__init__.py -> build/lib.linux-x86_64-3.8/lz4/frame
creating build/lib.linux-x86_64-3.8/lz4/stream
copying lz4/stream/__init__.py -> build/lib.linux-x86_64-3.8/lz4/stream
running build_ext
building 'lz4._version' extension
creating build/temp.linux-x86_64-3.8
creating build/temp.linux-x86_64-3.8/lz4

<compile and link loadable DSO>

copying build/lib.linux-x86_64-3.8/lz4/_version.cpython-38-x86_64-linux-gnu.so -> lz4
copying build/lib.linux-x86_64-3.8/lz4/block/_block.cpython-38-x86_64-linux-gnu.so -> lz4/block
copying build/lib.linux-x86_64-3.8/lz4/frame/_frame.cpython-38-x86_64-linux-gnu.so -> lz4/frame
copying build/lib.linux-x86_64-3.8/lz4/stream/_stream.cpython-38-x86_64-linux-gnu.so -> lz4/stream

Someone can help and point what is causing that in case of lz4 setuptools egg_info command is not executed?

[kloczek]

No one knows why sometimes egg_info os executed by build and what triggers that??

[kloczek]

I've spend a little time to check actual setuptools code and looks like egg_info is called as part of the build when include_package_data=true.
IMO there is no any connection to generate module metadata only in such condition and egg_info should be always part of the `build.
Here is the patch:

--- a/setuptools/command/build_py.py~   2021-07-19 01:30:57.000000000 +0100
+++ b/setuptools/command/build_py.py    2021-08-29 17:25:09.264491327 +0100
@@ -68,6 +68,8 @@
         if attr == 'data_files':
             self.data_files = self._get_data_files()
             return self.data_files
+        self.run_command('egg_info')
+        ei_cmd = self.get_finalized_command('egg_info')
         return orig.build_py.__getattr__(self, attr)

     def build_module(self, module, module_file, package):
@@ -136,8 +138,6 @@
             # Locate package source directory
             src_dirs[assert_relative(self.get_package_dir(package))] = package

-        self.run_command('egg_info')
-        ei_cmd = self.get_finalized_command('egg_info')
         for path in ei_cmd.filelist.files:
             d, f = os.path.split(assert_relative(path))
             prev = None

[kloczek]

That patch is wrong :/
To be honest I'm not sure how it should be done.

[webknjaz]

FWIW setup.py install is finally deprecated. For more details, explore:

• install_requires is not executed with custom install command #456
• Deprecate setup_requires, setup.py install, and easy_install command. #2824
• https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html

[kloczek]

FWIW setup.py install is finally deprecated. For more details, explore:

This has nothinig to do with setuptools install.