Pipenv vs setup.py

时间:2017-11-10 16:39:15

标签: python pip setuptools pipenv

我正在尝试迁移到pipenv。我传统上将setup.pypip一起使用并pip install -e .将模块作为包安装,以便我可以从项目中的任何位置实现from myproject.xyz.abc import myClass之类的内容。

如何使用pipenv获得类似效果并摆脱setup.py

注意:我使用的是python 2.7

3 个答案:

答案 0 :(得分:18)

更新

pipenv 9.0.0已经released,应该允许您按预期使用pipenv install -e .

原始答案:

pipenv install -e是错误的,已经fixed in masterpull request)。它将在感恩节后的下一个版本中提供。

现在的临时解决方法是:

pipenv shell
pip install -e .

发布后,您应该可以pipenv install -e .运行pip,与setValue()相似。

答案 1 :(得分:11)

更新:2019年3月5日:自pip版本19.03起,您可以省略您的软件包的setup.py并使用pyproject.toml[build-system](不支持在可编辑模式下安装(在这种情况下,你仍然需要setup.py)

更新:2018年6月12日:另一个类似工具https://github.com/takluyver/flitpoetryflit背后有一个很大的未来。希望他们能合并力量,我们将拥有一体化舒适的软件包和应用程序管理,例如,生锈cargo

更新:2018年4月19日:有一个类似的工具,它可以同时处理所有包装管理,而不需要setup.py。这是https://github.com/sdispater/poetry

更新时间:2018年4月11日: Pipenv的作者在这里描述了这个问题:http://pipenv.readthedocs.io/en/latest/advanced/#pipfile-vs-setup-py

如果您在没有setup.py的软件包中运行pipenv install -e .,那么您将获得:

$ pipenv install -e .              
Directory '.' is not installable. File 'setup.py' not found.

因此,无论如何你都需要setup.py

理解应用程序和包背后的概念非常重要。此信息可能很有用https://caremad.io/posts/2013/07/setup-vs-requirement/

如果您正在构建应用程序,那么pipenv是您唯一需要的。

但是,如果你正在构建一个包,那么你必须有setup.py,以便允许pip或pipenv安装它(也许在可编辑模式下)。

pipenv作者的回答是:https://github.com/pypa/pipenv/issues/1161#issuecomment-349972287

因此,pipenv vs setup.py是一个错误的表述。他们不能互相攻击。相反,相互支持,或相互排斥。

我们可能必须找到一种方法如何使用它们,而不重复。

当你构建一个包时,你仍然可以使用pipenv,但这会导致重复的事情(setup.py和Pipfile中的要求)。我使用以下方法来解决这个问题:

import pathlib
import subprocess

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


__requires__ = ['pipenv']

packages = find_packages(exclude=['tests'])
base_dir = pathlib.Path(__file__).parent

pipenv_command = ['pipenv', 'install', '--deploy', '--system']
pipenv_command_dev = ['pipenv', 'install', '--dev', '--deploy', '--system']

class PostDevelopCommand(develop):
    """Post-installation for development mode."""
    def run(self):
        subprocess.check_call(pipenv_command_dev)
        develop.run(self)

class PostInstallCommand(install):
    """Post-installation for installation mode."""
    def run(self):
        subprocess.check_call(pipenv_command)
        install.run(self)


with open(base_dir / 'README.md', encoding='utf-8') as f:
    long_description = f.read()

setup(
    name='dll_api',
    use_scm_version = True,
    long_description='\n' + long_description,
    packages=packages,
    setup_requires=['setuptools_scm'],
    cmdclass={
        'develop': PostDevelopCommand,
        'install': PostInstallCommand,
    },
)

现在您有以下内容:

$ python setup.py install
running install
Installing dependencies from Pipfile.lock (e05404)…

注意pipenv之前应安装!

这不是解决问题的干净方法,但是,做这项工作。

答案 2 :(得分:2)

在您的情况下,pipenv代替了pip,但您仍然需要setup.py

假设目录结构如下:

dir_a/              <-- This will be your pipenv root dir and your package root dir.
    setup.py
    dir_b/
        __init__.py
        somefile.py
        otherfile.py

然后,您可以启动Python 3环境并使用以下命令安装软件包:

$> cd dir_a
$> pipenv --python 3
$> pipenv shell
$> pipenv install -e . 

您可以使用cat Pipfilepipenv graph验证该软件包是否已安装。

但是,如果软件包的根目录与pipenv根目录不同,则pipenv install -e .将失败,并显示一条神秘的错误消息:

  

错误解析要求。 -您确定它可以安装吗?

在这种情况下,您应该从pipenv根目录调用pipenv install -e并提供包根目录的路径。例如,使用以下文件结构:

dir_z/              <-- This will be your pipenv root dir.
    something.py
    empty_dir/
    dir_a/          <-- This is your package root dir.
        setup.py
        dir_b/
            __init__.py
            somefile.py
            otherfile.py

您将使用:

$> cd dir_z
$> pipenv --python 3
$> pipenv shell
$> pipenv install -e dir_a/

如另一位用户所述,在这种情况下,使用pip install -e .确实会将软件包从dir_a安装到虚拟环境中。但是,至少对我来说,它不会更新Pipfile,所以用处不大。