Command hooks #112

embray · 2014-12-11T20:04:11Z

Add support for pre- and post-command hooks that can be provided by setup_package modules (along with the other get_ functions they can provide.

The hooks should be variables in the setup_package module with names like pre_<command_name>_hook. For example to implement a pre-build_ext hook there should be a pre_build_ext_hook defined in setup_package.

Every setup_package module can provide hooks, though their run order should not be relied in. In other words, there is no way currently to ensure that hooks defined for the same command are run in a specific order. One can also define a post_<command_name>_hook.

This also adds an optional srcdir option to register_commands so that it can be passed through to the find_packages call that register_commands now makes.

The pre_<command_name>_hook variable may either be a callable, or a string specifying the import path for some callable defined elsewhere. The callable must take a single argument, which is the Command object for the command being hooked. This provides access to all the command's options.

If this is implemented there should probably also be an update to the developer docs to mention this feature. There might be some existing code that can make use of this feature as well, but I haven't looked in-depth yet. I kept this separate from #110 for now, but once that PR is merged I will rebase this on top of it.

embray · 2014-12-11T20:14:59Z

Rebased on #110 .

embray · 2014-12-11T20:58:08Z

@astrofrog Does this look good for you for astropy/astropy#3166 ? I think it would mostly suffice to change the preprocess_sources for the erfa package now to pre_build_py_hook(cmd). Would you like to try that out, or shall I?

astrofrog · 2014-12-11T21:56:07Z

@embray - thanks for your work on this - this is awesome! I will try it out in astropy/astropy#3166 now :)

embray · 2014-12-15T18:29:23Z

Rebased to include ee59f09, so this should still work with astropy.

astrofrog · 2014-12-15T18:43:45Z

astropy_helpers/setup_helpers.py

@embray: traceback isn't defined

embray · 2014-12-15T19:15:30Z

Thanks for catching those.

astrofrog · 2014-12-15T20:41:41Z

@embray - one more issue, I currently get the following traceback:

Traceback (most recent call last):
  File "setup.py", line 112, in <module>
    **package_info
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/distutils/core.py", line 148, in setup
    dist.run_commands()
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/distutils/dist.py", line 955, in run_commands
    self.run_command(cmd)
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/distutils/dist.py", line 974, in run_command
    cmd_obj.run()
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/distutils/command/build.py", line 126, in run
    self.run_command(cmd_name)
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/distutils/cmd.py", line 313, in run_command
    self.distribution.run_command(command)
  File "/opt/local/Library/Frameworks/Python.framework/Versions/3.4/lib/python3.4/distutils/dist.py", line 974, in run_command
    cmd_obj.run()
  File "/Users/tom/Dropbox/Code/development/Astropy/astropy/astropy_helpers/astropy_helpers/commands/build_ext.py", line 168, in run
    invalidate_caches()
NameError: name 'invalidate_caches' is not defined

Pyflakes also is warning me about a missing import for shutil on line 80.

astrofrog · 2014-12-15T21:15:57Z

(it also looks like Travis is failing)

embray · 2014-12-15T21:17:46Z

The failures on travis are due solely to the SSL thing.

astrofrog · 2014-12-15T21:25:09Z

Ok, see #113 for a fix for the SSL

embray · 2014-12-15T21:33:02Z

Should be really, truly fixed by 336997d. And this time I tested building astropy itself too ;)

Just goes to show the wealth of open holes in the test suite for this package.

embray · 2014-12-15T21:33:37Z

I might actually consider adding a test_can_build_astropy after all...

astrofrog · 2014-12-16T00:10:40Z

@embray - if this and astropy/astropy#3166 pass, can I go ahead and merge this PR tomorrow morning, or did you want to do more work on it?

embray · 2014-12-16T15:33:40Z

Just adding a changelog entry, then I'll merge.

…d_packages and loop over all the setup_package modules twice in order to pick up pre-/post-command hooks.

…tate dict for the package cache rather than a normal global variable, so that it can be easily reset at the end of test runs--this was causing some tests to fail depending on the order in which they were run.

…his test restores its previous cwd.

setup_package modules (along with the other get_ functions they can provide. The hooks should be variables in the setup_package module with names like pre_<command_name>_hook. For example to implement a pre-build_ext hook there should be a pre_build_ext_hook defined in setup_package. Every setup_package module can provide hooks, though their run order should not be relied in. In other words, there is no way currently to ensure that hooks defined for the same command are run in a specific order. One can also define a post_<command_name>_hook. This also adds an optional srcdir option to register_commands so that it can be passed through to the find_packages call that register_commands now makes.

astrofrog · 2014-12-16T15:40:36Z

Ok, 👍

embray · 2014-12-16T15:42:15Z

Rebased once more and added changelog entry. Good to go.

Command hooks

embray force-pushed the command-hooks branch from 480d416 to f4aa400 Compare December 11, 2014 20:14

eteq mentioned this pull request Dec 11, 2014

Expose erfa constants from erfam.h and use them in Time astropy/astropy#3137

Merged

embray force-pushed the command-hooks branch from f4aa400 to 91faa7e Compare December 15, 2014 18:29

astrofrog reviewed Dec 15, 2014
View reviewed changes

astropy_helpers/setup_helpers.py

Copy link

Member

astrofrog Dec 15, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@embray: traceback isn't defined

embray force-pushed the command-hooks branch from 91bcea6 to 6833443 Compare December 15, 2014 21:25

embray added the enhancement label Dec 16, 2014

embray added this to the v1.0 milestone Dec 16, 2014

embray added 6 commits December 16, 2014 10:39

Add new find_packages that caches its results--we'll need to do a fin…

407c80c

…d_packages and loop over all the setup_package modules twice in order to pick up pre-/post-command hooks.

add cython_version.py to .gitignore

0487ac1

Update the reworked find_packages to use the setup_helper's _module_s…

2c726c3

…tate dict for the package cache rather than a normal global variable, so that it can be easily reset at the end of test runs--this was causing some tests to fail depending on the order in which they were run.

Probably not necessary, but just to be on the safe side ensure that t…

a4445f8

…his test restores its previous cwd.

Add missing imports

5378cfa

Added changelog entry [ci skip]

54a7285

embray force-pushed the command-hooks branch from 6833443 to 54a7285 Compare December 16, 2014 15:41

embray added a commit that referenced this pull request Dec 16, 2014

Merge pull request #112 from embray/command-hooks

36db545

Command hooks

embray merged commit 36db545 into astropy:master Dec 16, 2014

embray deleted the command-hooks branch December 16, 2014 15:42

embray mentioned this pull request Dec 16, 2014

update setup_helpers and a corresponding setup.py change astropy/astropy#3206

Merged

Uh oh!

Command hooks #112

Command hooks #112

Uh oh!

Conversation

embray commented Dec 11, 2014

Uh oh!

embray commented Dec 11, 2014

Uh oh!

embray commented Dec 11, 2014

Uh oh!

astrofrog commented Dec 11, 2014

Uh oh!

embray commented Dec 15, 2014

Uh oh!

astrofrog Dec 15, 2014

Choose a reason for hiding this comment

Uh oh!

embray commented Dec 15, 2014

Uh oh!

astrofrog commented Dec 15, 2014

Uh oh!

astrofrog commented Dec 15, 2014

Uh oh!

embray commented Dec 15, 2014

Uh oh!

astrofrog commented Dec 15, 2014

Uh oh!

embray commented Dec 15, 2014

Uh oh!

embray commented Dec 15, 2014

Uh oh!

astrofrog commented Dec 16, 2014

Uh oh!

embray commented Dec 16, 2014

Uh oh!

astrofrog commented Dec 16, 2014

Uh oh!

embray commented Dec 16, 2014

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants