且构网

分享程序员开发的那些事...
且构网 - 分享程序员编程开发的那些事

setuptools:从 zip 中删除 lib/python3.5/site-packages 前缀

更新时间:2022-10-21 18:13:14

这似乎提供了我正在寻找的行为.但是,如果有更优雅的解决方案,例如通过将某些参数传递给 setup(),我会很高兴听到这个消息.

from setuptools import setup, find_packages从 setuptools.command.install 导入安装类自定义安装(安装):"""确保模块位于 zip 文件的根目录."""def initialize_options(self):super().initialize_options()self.prefix = ''self.install_lib = ''设置(cmdclass={'install': CustomInstall},name='my_package',版本='1.0.0',作者='我的名字',author_email='my-email@example.com',包=find_packages('.'),data_files=[('my_package', ['README.md'])],zip_safe=真,)

I'm trying to create a package that should be distributed as a zip file, containing only the package itself. Unfortunately, at least when run from a virtualenv, the zip contains lengthy subdirectories. This is the file structure of the project:

.
├── my_package
│   └── __init__.py
├── README.md
└── setup.py

setup.py contains:

from setuptools import setup, find_packages

setup(
    name='my_package',
    version='1.0.0',
    author='my name',
    author_email='my-email@example.com',
    packages=find_packages('.'),
    data_files=[('my_package', ['README.md'])],
    zip_safe=True,
)

When I run python setup.py bdist_dumb --format zip --relative, I get the following output:

running bdist_dumb
running build
running build_py
creating build
creating build/lib
creating build/lib/my_package
copying my_package/__init__.py -> build/lib/my_package
installing to build/bdist.linux-x86_64/dumb
running install
running install_lib
creating build/bdist.linux-x86_64
creating build/bdist.linux-x86_64/dumb
creating build/bdist.linux-x86_64/dumb/home
creating build/bdist.linux-x86_64/dumb/home/sybren
creating build/bdist.linux-x86_64/dumb/home/sybren/.virtualenvs
creating build/bdist.linux-x86_64/dumb/home/sybren/.virtualenvs/packaging-test
creating build/bdist.linux-x86_64/dumb/home/sybren/.virtualenvs/packaging-test/lib
creating build/bdist.linux-x86_64/dumb/home/sybren/.virtualenvs/packaging-test/lib/python3.5
creating build/bdist.linux-x86_64/dumb/home/sybren/.virtualenvs/packaging-test/lib/python3.5/site-packages
creating build/bdist.linux-x86_64/dumb/home/sybren/.virtualenvs/packaging-test/lib/python3.5/site-packages/my_package
copying build/lib/my_package/__init__.py -> build/bdist.linux-x86_64/dumb/home/sybren/.virtualenvs/packaging-test/lib/python3.5/site-packages/my_package
byte-compiling build/bdist.linux-x86_64/dumb/home/sybren/.virtualenvs/packaging-test/lib/python3.5/site-packages/my_package/__init__.py to __init__.cpython-35.pyc
running install_data
creating build/bdist.linux-x86_64/dumb/home/sybren/.virtualenvs/packaging-test/my_package
copying README.md -> build/bdist.linux-x86_64/dumb/home/sybren/.virtualenvs/packaging-test/my_package
running install_egg_info
running egg_info
creating my_package.egg-info
writing my_package.egg-info/PKG-INFO
writing dependency_links to my_package.egg-info/dependency_links.txt
writing top-level names to my_package.egg-info/top_level.txt
writing manifest file 'my_package.egg-info/SOURCES.txt'
reading manifest file 'my_package.egg-info/SOURCES.txt'
writing manifest file 'my_package.egg-info/SOURCES.txt'
Copying my_package.egg-info to build/bdist.linux-x86_64/dumb/home/sybren/.virtualenvs/packaging-test/lib/python3.5/site-packages/my_package-1.0.0-py3.5.egg-info
running install_scripts
creating /home/sybren/workspace/packaging-test/dist
creating '/home/sybren/workspace/packaging-test/dist/my_package-1.0.0.linux-x86_64.zip' and adding '.' to it
adding 'lib/python3.5/site-packages/my_package/__init__.py'
adding 'lib/python3.5/site-packages/my_package/__pycache__/__init__.cpython-35.pyc'
adding 'lib/python3.5/site-packages/my_package-1.0.0-py3.5.egg-info/dependency_links.txt'
adding 'lib/python3.5/site-packages/my_package-1.0.0-py3.5.egg-info/PKG-INFO'
adding 'lib/python3.5/site-packages/my_package-1.0.0-py3.5.egg-info/top_level.txt'
adding 'lib/python3.5/site-packages/my_package-1.0.0-py3.5.egg-info/SOURCES.txt'
adding 'lib/python3.5/site-packages/my_package-1.0.0-py3.5.egg-info/zip-safe'
adding 'my_package/README.md'
removing 'build/bdist.linux-x86_64/dumb' (and everything under it)

As you can see, it puts the package in lib/python3.5/site-packages, which I don't want. I just want the package to contain my_package/*.

If we can prevent my_package*.egg-info/* from being packed, even better, but my primary question is about getting rid of the lib/python3.5/site-packages prefix.

This seems to provide the behaviour I'm looking for. However, if there is a more elegant solution, for example by passing certain parameters to setup(), I'd be happy to hear about that.

from setuptools import setup, find_packages
from setuptools.command.install import install


class CustomInstall(install):
    """Ensures the module is placed at the root of the zip file."""

    def initialize_options(self):
        super().initialize_options()
        self.prefix = ''
        self.install_lib = ''

setup(
    cmdclass={'install': CustomInstall},
    name='my_package',
    version='1.0.0',
    author='my name',
    author_email='my-email@example.com',
    packages=find_packages('.'),
    data_files=[('my_package', ['README.md'])],
    zip_safe=True,
)