Join GitHub today
Simplify loader functionality #92
I looked into issue #91
From there I looked at the loader code. It seems the loader's use of sys.path may be causing the user's issue. Although I haven't worked with invoke that much, I don't see a tempting use case for needing to load a
If you know a good use case for finding tasks on
Since the loader is a very simple class, with only three methods that really only call eacho ther sequentially, I thought this could be refactored out. You don't really need a class for this.
I added the code to the
I haven't reimplemented tests yet as they need to be redesigned to accommodate for the api change.
I thought maybe you'd like to review the changes, and if you like the design please say so and I will add commits adding tests for this.
First, I haven't compared them yet but the parent directory searching likely duplicates #87 (which precedes this ticket by a few weeks.)
Secondly and more importantly, task module loading is a complicated topic with varied use cases - any change is likely to ruin somebody's day somewhere. This was true for Fabric 1.x (Invoke's predecessor) and while I'm trying to find less-error-prone solutions in Invoke, clearly it's always a clusterfsck :(
I say that to explain why I'm likely to kick this PR around some before merging or rejecting it.
Third, re: loading from sys.path, IIRC it was put in place for a few reasons, though none of them are super straightforward:
tl;dr we need to jot down as many use cases as we can & find the solution best combining 'meets most/all use cases' & 'is least surprising'. So far in Invoke, I've had success breaking things down & exposing both lower level features & high level ones combining the former for maximum usability.
Loading isn't an issue for pure-library use cases, so that may mean we expose more loading-related CLI flags and/or document the default behavior more thoroughly.
This was referenced
Nov 3, 2013
referenced this pull request
Apr 14, 2014
Took another gander at this & #87; thoughts:
Anyway - I'm going to (finally) take your PR into a branch, add my own changes on top re: these thoughts, and merge it. End result should be your recursive loader + retaining use of a Loader class + probably shoving the sys.path code into a subclass.
Bah, except I forgot the whole thing where one may want
Still, we can perform the sys.path tweak while still telling
@Ivoz I don't think so, the distinction here is subtle but important - there's a set of paths to be searched when we import the tasks module itself; and there's also the paths to search when anything in that tasks module calls
It's actually nice that they're separate because it makes the distinction clearer & lets us implement things exactly how we want.
I've now got the code set up in a manner I am happy with, and it still at its core uses your discovery algorithm :) will be merging it momentarily...
All done. If interested you can see the actual diff here: pyinvoke:0bcf45a...pyinvoke:f75f3d3 (scroll down.)
I did not end up writing a second subclass that preserved the old behavior, but it'll now be very easy to do so (and to add a CLI flag for selecting which subclass to use, I guess) should anybody care at some point.