使用pipenv安装项目时，setuptools为何生成项目及UNKNOWN.egg-info？

1. UNKNOWN.egg-info的作用与命名原因 #

• 这个目录是setuptools在未正确识别项目名称时生成的无效产物，没有实际用途，属于安装过程中的异常生成文件。
• 命名为UNKNOWN是因为setuptools无法从配置中读取到有效的项目名称，只能用默认占位符命名。它的SOURCES.txt只包含根目录的配置文件，说明它是处理根目录文件时，因项目名称识别失败而触发的错误生成结果。

2. 生成原因分析 #

出现这个问题通常是项目配置存在冲突或缺失：

• pyproject.toml和setup.py的配置不一致，比如pyproject.toml未指定项目名称，或setup.py的setup()函数缺少name参数。
• pipenv install -e .执行时，先读取pyproject.toml但配置不全，回退处理根目录文件时触发了这个错误。

3. 解决方法 #

要消除UNKNOWN.egg-info，只需确保项目配置完整且一致：

1. 统一项目名称配置
   • 在setup.py的setup()函数中明确指定项目名称：

     from setuptools import setup, find_packages
     
     setup(
         name="sampleproj",
         version="0.1.0",
         packages=find_packages(),
         # 按需添加author、description等其他配置
     )
     

   • 在pyproject.toml中同步指定项目名称（若使用setuptools作为构建后端）：

     [project]
     name = "sampleproj"
     version = "0.1.0"
     

2. 清理无效文件后重新安装
   删除已生成的UNKNOWN.egg-info和sampleproj.egg-info目录，再执行pipenv install -e .。
3. 确保构建后端配置正确
   如果pyproject.toml未指定构建后端，添加以下内容：

   [build-system]
   requires = ["setuptools>=61.0"]
   build-backend = "setuptools.build_meta"
   

内容的提问来源于stack exchange，提问作者b-jazz