[GUI Plugin] Action Chains

[capink]

@ownedbycats: HYG

[ownedbycats]

from calibre_plugins.action_chains.actions.base import ChainAction

class RefreshAction(ChainAction):

    name = 'Refresh GUI'

    def run(self, gui, settings, chain):
        gui.current_db().refresh()

I tried attaching this to my "switch view manager on VL tab click" chain to refresh a composite column. It gave me an error (LibraryDatabase is not callable). What did I do wrong?

[chaley]

Originally Posted by ownedbycats

from calibre_plugins.action_chains.actions.base import ChainAction

class RefreshAction(ChainAction):

    name = 'Refresh GUI'

    def run(self, gui, settings, chain):
        gui.current_db().refresh()

I tried attaching this to my "switch view manager on VL tab click" chain to refresh a composite column. It gave me an error (LibraryDatabase is not callable). What did I do wrong?

This was me leading you astray again. See this post for more detail.

[ownedbycats]

I have it working now and I posted in Action Chains scripts.

Another question:

Currently, the chain here halts the entire thing if I press 'no.' Is it possible to make it only apply to the next action in the chain?

Background:

Currently, I have two chains: "Send to Device" and "Send to Device + Add to TBR." They're identical except for a a single 'add to reading list' action. So instead of two chains, it makes sense to prompt for that one action. Putting it at the end works, but then that means I can't put my column re-sort module there.

[capink]

Originally Posted by ownedbycats

I have it working now and I posted in Action Chains scripts.

Another question:

Currently, the chain here halts the entire thing if I press 'no.' Is it possible to make it only apply to the next action in the chain?

Background:

Currently, I have two chains: "Send to Device" and "Send to Device + Add to TBR." They're identical except for a a single 'add to reading list' action. So instead of two chains, it makes sense to prompt for that one action. Putting it at the end works, but then that means I can't put my column re-sort module there.

You can use the chain variables action interactively (by checking the runtime box). It pops up a dialog where you where you set a value for the variable, you can then use the value to condition the action you want to run/skip.

Edit: A better approach is to use the Chain Variations feature which is designed for this kind of thing. It will alleviate the need to have a pop-up prompt, as it allows you to have multiple menu entries for the same chain.

[ownedbycats]

how would the variations work for this case? From what I understand, it changes the menu entry depending on...things, but whether I want to add a book to the TBR list is something I decide myself.

[capink]

Originally Posted by ownedbycats

how would the variations work for this case? From what I understand, it changes the menu entry depending on...things, but whether I want to add a book to the TBR list is something I decide myself.

By using the variant argument in a condition.

It should be as follows:

• Make sure you have the experimental mode on by adding the following tweak (requires restarting):
  

  action_chains_experimental = True

• Use the chain variation template dialog to add your two variants as follows:
  

  program:
      add_chain_variant('Send to Device','add_no');
      add_chain_variant('Send to Device + Add to TBR.','add_yes');

  The argument highlighted in blue will be passed to the chain and can be accessed later for enabling/disabling an action.
• Add the following condition to the 'add to reading list' action:
  

  Template : program: globals(_variant_argument)
  Comparison : =
  Value : add_yes

Now you should have two variants. Only one of them will pass the argument that satisfies the condition for running the 'add to reading list' action.

[ownedbycats]

I see how that works now.

For the submenu/icon arguments, should I just use an empty string if I don't want it submenued?

EDIT: Empty string works.

[ownedbycats]

Possible bug?

After restarting Calibre, the chains with variations temporarily disappear from the AC menu. They reappear after I open the config and save again. If it matters, it doesn't seem to delete keyboard shortcuts in use by them like when renaming a chain.

I restart in debug mode and I notice this error in the log:

Action Chains: Unable to create variant for chain (Send to Device)
Traceback (most recent call last):
  File "calibre_plugins.action_chains.action", line 345, in create_all_menu_actions_for_chain
  File "calibre_plugins.action_chains.action", line 355, in create_variants_menu_actions
  File "calibre_plugins.action_chains.action", line 394, in variants_from_config
AttributeError: 'ChainInterfaceAction' object has no attribute 'template_functions'

[capink]

I added a new version to the first post. Try it and see if it helps with the error above.

[ownedbycats]

That fixed it. thank you!

[ownedbycats]

New glitch noticed after updating to newest version:

On my 'view' chain, view_manager_last_view() != 'Physical Books' in conditions results in an action consistently failing. Removing it made it work again. I got this error in the evaluator:

EXCEPTION:  Interpreter: Internal error evaluating an expression: 'eval_() missing 1 required positional argument: 'locals'' - line number 2

Here's the function:

from calibre_plugins.action_chains.templates import TemplateFunction

class ViewManagerLastVIew(TemplateFunction):

    name = 'view_manager_last_view'
    arg_count = 0

    def evaluate(self, formatter, kwargs, mi, locals):
        import calibre_plugins.view_manager.config as cfg
        gui = self.plugin_action.gui
        library_config = cfg.get_library_config(gui.current_db)
        return library_config.get(cfg.KEY_LAST_VIEW, '')

Thankfully, current_virtual_library_name() works just as well (maybe better) for my purposes - but was something used in it deprecated or changed?

[capink]

Version 1.15.0 - 1 January 2022

• Update: New action: Save/Restore Format.
• Fix: Update templates before running template evaluator.
• Fix: Error at startup building chain variations.

Version 1.15.1 - 1 January 2022

• Fix: Regression with user defined templates.

[MikePatch]

This plugin is a masterpiece!

Is it possible to use in action the bulk function to "Swap title and author"?
(I didn't find a way!)

Thx
Mike

[compurandom]

I'm looking for a more selective selection.
Something like given this search and sort, select variations of:

• The first 10 items
• The 10 items after an offset
• a random 10 items
• everything except the first 10 items