packaging needs {pre,post}-{install,remove} hooks

[vsajip]

BPO	12416
Nosy	@vsajip, @ncoghlan, @tarekziade, @merwok

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/merwok'
closed_at = <Date 2014-03-13.03:32:30.239>
created_at = <Date 2011-06-26.23:50:46.574>
labels = ['type-feature', 'library']
title = 'packaging needs {pre,post}-{install,remove} hooks'
updated_at = <Date 2014-03-13.03:32:30.238>
user = 'https://github.com/vsajip'

bugs.python.org fields:

activity = <Date 2014-03-13.03:32:30.238>
actor = 'eric.araujo'
assignee = 'eric.araujo'
closed = True
closed_date = <Date 2014-03-13.03:32:30.239>
closer = 'eric.araujo'
components = ['Library (Lib)', 'Distutils2']
creation = <Date 2011-06-26.23:50:46.574>
creator = 'vinay.sajip'
dependencies = []
files = []
hgrepos = []
issue_num = 12416
keywords = []
message_count = 8.0
messages = ['139230', '139274', '139295', '139296', '139298', '139302', '145019', '145952']
nosy_count = 5.0
nosy_names = ['vinay.sajip', 'ncoghlan', 'tarek', 'eric.araujo', 'alexis']
pr_nums = []
priority = 'normal'
resolution = 'out of date'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue12416'
versions = ['3rd party', 'Python 3.3']

[vsajip]

In general it is possible for an installation to make certain system changes other than the record of files written during an installation (for example, under Windows, there may be distribution-specific Windows registry updates).

There seems to be no hook that's called when a distribution is removed, which would allow distribution-specific cleanup code to be called (e.g. to undo Windows registry changes).

Such a hook should be provided.

[merwok]

I have no objection, but you may want to ask on the fellowship ML first.

Should the hooks be run before the removal or just after? (Debian for example has both, which makes four hooks: preinst, postinst, prerm, postrm). Our setup_hooks (used with pysetup commands) are run right after the setup.cfg file is parsed, before any operation is started.

Regarding implementation: The hook should be defined in the global section of setup.cfg; upon installation, packaging would write this info into the dist-info directory (say in an UNINSTALLHOOKS file), which would be read when preparing an uninstallation.

[tarekziade]

Sounds good. Also, we should make the assumption that this hook might be deactivated or might fail. So it should not break the uninstallation in this case (a warning seem fine)

[merwok]

Definitely, hooks do not stop operation. I’ll double-check that. We may want an option to turn hooks failures into fatal errors.

[tarekziade]

We need to make it crystal clear in the doc: developers need to understand this behavior.

Also, for a fatal error, I am -1 for activating this for an uninstall hook because we want to uninstall wathever happens in the hooks, +1 for others (as long as it's coupled with a --force option)

It can be a specific exception the hook can raise to stop the process

[merwok]

The setup.cfg spec says only this:

The callables are executed in the order they’re found in the file; if
one of them cannot be found, tools should not stop, but for example
produce a warning and continue with the next line.

packaging/commandhooks does not say anything. I’ll open a bug to add docs and tests about that, and a feature request for the new option to turn warnings into fatal errors.

[merwok]

Editing title to reflect the scope of the needed feature.

[merwok]

I’ve opened bpo-13225 about the error handling.