doit 0.28 release - breaking Nikola (or not) #1655

Kwpolska · 2015-04-11T08:34:16Z

I am planning to release doit 0.28 next week.

A) it would be good if you guys make a release with the doit pinned version before I release 0.28, this way at least new installation would get the correct doit version. is it possible?

B) I managed to get a patch[1] in doit that seems to be good enough to maintain backwards compatibility (at least for Nikola). But I didnt test much... note this is not on master branch.

Another option would be to make doit detect when Nikola is using the old API and give an error message like: "doit version higher than supported version. Please downgrade to doit 0.27 with: pip install doit=0.27"

IMO the second option is safer. If you guys prefer the patch I am also ok with, but please test it a bit.
So please let me what you guys think...

[1] pydoit/doit@8666f73

Kwpolska · 2015-04-10T19:03:01Z

I’ll try to look into it. The best thing to do would be to make Nikola compatible with doit 0.28 and release quickly. There isn’t much holding us back from a release.

schettino72 · 2015-04-10T19:31:25Z

The best thing to do would be to make Nikola compatible with doit 0.28 and release quickly.

Even with that I guess we should worry about old Nikola installations..
Also a change to use doit 0.28 IMO should bump Nikola version to 7.4.0.

The main change that affects Nikola is that:

doit 0.27 DoitMain.get_commands() return Command instances
doit 0.28 DoitMain.get_cmds() returns Command classes

Now you guys won't even need to sub-class get_cmds()... another change is that Command.__init__ must take a **kwargs.

I am planning to prepare a patch for Nikola to use doit 0.28 tomorrow.

Kwpolska · 2015-04-11T08:22:40Z

Now you guys won't even need to sub-class get_cmds()...

And how would we tell doit about our custom commands?

Currently, Nikola is broken badly. You see, we instantiate all our plugins — and doit does not anymore. We can’t change that, yapsy always does that. The following problems surfaced:

the isinstance used to check for nikola help in __main__.py was broken — rewritten as is not Help
nikola help used cmd.name which was None for uninitialized doit commands — copy-pasted from new doit implementation
running a command tries to instantiate it — rewritten as a __call__ hack

Please review the patch in fb19e2d.

Kwpolska · 2015-04-11T08:25:46Z

It might be more helpful to review the entire branch instead: https://github.com/getnikola/nikola/compare/doit-0.28.0

schettino72 · 2015-04-11T10:34:24Z

nikola/utils.py:Commands is broken too. This is not used by Nikola itself. Is it for plugins?

schettino72 · 2015-04-11T10:38:59Z

nikola/plugin_categories.py

@@ -93,6 +93,10 @@ def __init__(self, *args, **kwargs):
        BasePlugin.__init__(self, *args, **kwargs)
        DoitCommand.__init__(self)

+    def __call__(self, config=None, **kwargs):


amazing hack :)

Looking at yapsy you could sub-class PluginManager.instanciateElement() to avoid this.

Kwpolska · 2015-04-11T10:39:45Z

It’s a friendly way to run things via nikola console. I’ll look into it later.

schettino72 · 2015-04-11T10:54:12Z

Now you guys won't even need to sub-class get_cmds()...

And how would we tell doit about our custom commands?

Sorry. Ignore that. You would need to pass the entry point instead of the object. Doesnt make sense for Nikola because it already load it through plugins.

schettino72 · 2015-04-15T09:20:45Z

BUMP. Any expected date for a release? no pressure 😁

Kwpolska · 2015-04-22T13:46:25Z

@schettino72 So, doit==0.28.0 is out. I don’t feel confident releasing anything right now (neither master pinned to 0.27.0 nor the new branch). As such, I made an emergency v7.3.1.1 release that only changes the doit version and nothing else.

schettino72 · 2015-04-22T14:25:08Z

Yes. it is out. I added a notice if any program tries to use the old API (I tested it with Nikola). So at least the user gets a nice error message.

pydoit/doit@0606570

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

Kwpolska · 2015-04-24T17:42:50Z

@schettino72 How can I get instances of doit-provided commands? The site.commands proxy and nikola check both require them: site.commands needs to run get_options() (instance-bound), nikola check needs to talk to nikola list with the current context.

Kwpolska · 2015-04-24T17:44:48Z

And for the record, current things that need to change:

nikola.utils.Commands needs to iterate over .get_cmds() and use v.get_options()
nikola.plugins.command.check needs to access list differently

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

Kwpolska · 2015-04-24T18:04:58Z

@schettino72 Is this really the way to go?

self._doitargs['cmds']['list'](config=self.config, **self._doitargs)

(self._doitargs = **kwargs in the __call__ hack)

If yes, Commands would need to be generated by all plugins that need it (probably only nikola console) with a crazy incantation like this…

schettino72 · 2015-04-24T20:41:39Z

@Kwpolska look at the doit help command for an example.

get the list of command class in the constructor, (and also save the other kwargs parameters)

https://github.com/pydoit/doit/blob/master/doit/cmd_help.py#L102

Just create commands instances as you wish :)

https://github.com/pydoit/doit/blob/master/doit/cmd_help.py#L154

So, if you save the parameters with some nice names, it doesnt look so much like a crazy incantation :D

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

Kwpolska · 2015-04-25T10:11:48Z

I’m more of a singleton fan, but okay. I’m leaving the spaghetti in check and rewriting the Command thing.

Everything should be fine now.

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

Kwpolska · 2015-04-25T10:45:39Z

Needs review. @schettino72 @ralsina?

schettino72 · 2015-04-25T11:57:11Z

nikola/utils.py

+        self._main = main
+        self._config = config
+        self._doitargs = doitargs
+        for k, v in self._main.get_cmds().items():


You should use the cmds provided on doitargs, so please don't use DoitMain.get_cmds() .

Note that cmds is a PluginDict [1], not a plain dict. You should get its items using cmds.todict(). Or if you need just one value, cmds.get_plugin().

Plugins are lazy-loaded... for core commands plugins are not used so you get the command class without problems. But for plugins the dict value will only contain the entry point.

[1] https://github.com/pydoit/doit/blob/master/doit/plugin.py#L53

fixed in b9f081e

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

Kwpolska · 2015-04-26T07:16:07Z

Merging — I hope nothing will break.

doit 0.28 release - breaking Nikola (or not)

Kwpolska added BLOCKER breaks backwards compatibility labels Apr 10, 2015

Kwpolska added this to the v7.3.2 milestone Apr 10, 2015

Kwpolska self-assigned this Apr 10, 2015

schettino72 reviewed Apr 11, 2015
View reviewed changes

This was referenced Apr 22, 2015

[requires.io] dependency update on master branch #1662

Closed

Support for EarlyTasks. #1632

Closed

Kwpolska added 6 commits April 24, 2015 19:25

compatibility with doit v0.28.0

c64db75

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

remove unnecessary _name

2f4f10b

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

leftover import

2a0c481

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

[TEMPORARY] use doit from git

9cc68d7

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

fix nikola help <command> (copy new doit impl)

88678db

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

use doit==0.28.0 from pypi

6e2776b

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

Kwpolska force-pushed the doit-0.28.0 branch from 6eb3702 to 6e2776b Compare April 24, 2015 17:26

Kwpolska added 2 commits April 24, 2015 20:02

[TEMPORARY] disable Commands

299680b

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

fix nikola check (hacky!)

9a9d7c2

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

fix site.commands (works in console only)

8cb66c2

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

fix issue with unicode arguments to __main__

a73ed63

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

schettino72 reviewed Apr 25, 2015
View reviewed changes

use PluginDicts correctly

b9f081e

Signed-off-by: Chris Warrick <kwpolska@gmail.com>

Kwpolska added a commit that referenced this pull request Apr 26, 2015

Merge pull request #1655 from getnikola/doit-0.28.0

0b93441

doit 0.28 release - breaking Nikola (or not)

Kwpolska merged commit 0b93441 into master Apr 26, 2015

Kwpolska mentioned this pull request Apr 26, 2015

[requires.io] dependency update on master branch #1670

Closed

Kwpolska deleted the doit-0.28.0 branch April 26, 2015 08:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doit 0.28 release - breaking Nikola (or not) #1655

doit 0.28 release - breaking Nikola (or not) #1655

Kwpolska commented Apr 11, 2015

Kwpolska commented Apr 10, 2015

schettino72 commented Apr 10, 2015

Kwpolska commented Apr 11, 2015

Kwpolska commented Apr 11, 2015

schettino72 commented Apr 11, 2015

schettino72 Apr 11, 2015

Kwpolska commented Apr 11, 2015

schettino72 commented Apr 11, 2015

schettino72 commented Apr 15, 2015

Kwpolska commented Apr 22, 2015

schettino72 commented Apr 22, 2015

Kwpolska commented Apr 24, 2015

Kwpolska commented Apr 24, 2015

Kwpolska commented Apr 24, 2015

schettino72 commented Apr 24, 2015

Kwpolska commented Apr 25, 2015

Kwpolska commented Apr 25, 2015

schettino72 Apr 25, 2015

schettino72 Apr 25, 2015

Kwpolska Apr 25, 2015

Kwpolska commented Apr 26, 2015

doit 0.28 release - breaking Nikola (or not) #1655

doit 0.28 release - breaking Nikola (or not) #1655

Conversation

Kwpolska commented Apr 11, 2015

Kwpolska commented Apr 10, 2015

schettino72 commented Apr 10, 2015

Kwpolska commented Apr 11, 2015

Kwpolska commented Apr 11, 2015

schettino72 commented Apr 11, 2015

schettino72 Apr 11, 2015

Choose a reason for hiding this comment

Kwpolska commented Apr 11, 2015

schettino72 commented Apr 11, 2015

schettino72 commented Apr 15, 2015

Kwpolska commented Apr 22, 2015

schettino72 commented Apr 22, 2015

Kwpolska commented Apr 24, 2015

Kwpolska commented Apr 24, 2015

Kwpolska commented Apr 24, 2015

schettino72 commented Apr 24, 2015

Kwpolska commented Apr 25, 2015

Kwpolska commented Apr 25, 2015

schettino72 Apr 25, 2015

Choose a reason for hiding this comment

schettino72 Apr 25, 2015

Choose a reason for hiding this comment

Kwpolska Apr 25, 2015

Choose a reason for hiding this comment

Kwpolska commented Apr 26, 2015