Я описываю ниже файл setup.py, который необходим, только если у вас есть пользователи с pip <1.2 (например, в Ubuntu 12.04).Если у всех есть пип 1.2 или новее, вам нужно только <code>packages=[..., 'twisted.plugins'].
. Запретив пункту написать строку "twisted" в .egg-info/top_level.txt, вы можете продолжать использовать packages=[..., 'twisted.plugins'] и иметьрабочий pip uninstall, который не удаляет все twisted/.Это включает в себя настройку / распространение дистрибутива в верхней части вашего setup.py.Вот пример setup.py:
from distutils.core import setup
# When pip installs anything from packages, py_modules, or ext_modules that
# includes a twistd plugin (which are installed to twisted/plugins/),
# setuptools/distribute writes a Package.egg-info/top_level.txt that includes
# "twisted". If you later uninstall Package with `pip uninstall Package`,
# pip <1.2 removes all of twisted/ instead of just Package's twistd plugins.
# See https://github.com/pypa/pip/issues/355 (now fixed)
#
# To work around this problem, we monkeypatch
# setuptools.command.egg_info.write_toplevel_names to not write the line
# "twisted". This fixes the behavior of `pip uninstall Package`. Note that
# even with this workaround, `pip uninstall Package` still correctly uninstalls
# Package's twistd plugins from twisted/plugins/, since pip also uses
# Package.egg-info/installed-files.txt to determine what to uninstall,
# and the paths to the plugin files are indeed listed in installed-files.txt.
try:
from setuptools.command import egg_info
egg_info.write_toplevel_names
except (ImportError, AttributeError):
pass
else:
def _top_level_package(name):
return name.split('.', 1)[0]
def _hacked_write_toplevel_names(cmd, basename, filename):
pkgs = dict.fromkeys(
[_top_level_package(k)
for k in cmd.distribution.iter_distribution_names()
if _top_level_package(k) != "twisted"
]
)
cmd.write_file("top-level names", filename, '\n'.join(pkgs) + '\n')
egg_info.write_toplevel_names = _hacked_write_toplevel_names
setup(
name='MyPackage',
version='1.0',
description="You can do anything with MyPackage, anything at all.",
url="http://example.com/",
author="John Doe",
author_email="jdoe@example.com",
packages=['mypackage', 'twisted.plugins'],
# You may want more options here, including install_requires=,
# package_data=, and classifiers=
)
# Make Twisted regenerate the dropin.cache, if possible. This is necessary
# because in a site-wide install, dropin.cache cannot be rewritten by
# normal users.
try:
from twisted.plugin import IPlugin, getPlugins
except ImportError:
pass
else:
list(getPlugins(IPlugin))
Я проверял это с pip install, pip install --user и easy_install.При любом способе установки вышеприведенные monkeypatch и pip uninstall работают нормально.
Вы можете спросить: нужно ли мне очищать monkeypatch, чтобы не испортить следующую установку?(например, pip install --no-deps MyPackage Twisted; вы не хотели бы влиять на top_level.txt Twisted.) Ответ - нет;monkeypatch не влияет на другую установку, потому что pip порождает новый python для каждой установки.
Связанный: имейте в виду, что в вашем проекте вы должны не иметьфайл twisted/plugins/__init__.py.Если вы видите это предупреждение во время установки:
package init file 'twisted/plugins/__init__.py' not found (or not a regular file)
, оно совершенно нормально, и вы должны не попытаться исправить его, добавив __init__.py.