[GUI Plugin] Action Chains

[capink]

Originally Posted by Nicolas.Laurent

is there any documentation on the syntax to use for Action Chains?

Not really. The Run Python Code in intended to interact with the calibre API, which has some documentation. Besides the issue of variables we just mentioned, I don't think there anything in the action chains code could be of help to someone using this action.

[Nicolas.Laurent]

Sorry to bother you again, but I can now transfer my variable from one Run Python module to another. But my goal is to modify the value of a field (title in this case) and I can't get my variable from a Single Field Edit module.
What should I do?

[capink]

Originally Posted by Nicolas.Laurent

Sorry to bother you again, but I can now transfer my variable from one Run Python module to another. But my goal is to modify the value of a field (title in this case) and I can't get my variable from a Single Field Edit module.
What should I do?

The Single Field Edit action—like many other actions—has template option, with which you can use the code in the previous post:

Originally Posted by capink

To retrieve the variable using calibre template language:

program:
    my_retrieved_variable = globals(variable_name)

[Nicolas.Laurent]

Hello everyone

I'm back with a new problem.

I wrote this template for the Single Field Edit module, the idea being to copy author names into a dialog box and format them before assigning them to the authors field.
Everything works perfectly, except that my dialog box opens twice, and also opens when I save the code. It works, so it's not too bad, but a bit annoying.
What should I do to solve the problem?

And once again, thank you so much for this incredible plugin, which has saved me a lot of time!

Code:

python:

def evaluate(book, context):

	from PyQt5.QtWidgets import QInputDialog

	sortie = ""
	nom = ", ".join(book.authors)

	source, ok = QInputDialog.getText(None, "Modification des auteurs", "Entrez les auteurs :")

	if not ok:
	        return nom

	source = source.replace(" (Auteur)", "").replace(" & ", ", ").replace(" et ", ", ").strip()
    
	nom_transforme = []
	for auteur in source.split(", "):  
		parts = auteur.split(" ", 1)
		if len(parts) == 2:
			prenom, nom_famille = parts
			nom_transforme.append(f"{nom_famille.upper()}, {prenom.title()}")
		else:
			nom_transforme.append(auteur)

	return " & ".join(nom_transforme)

[ownedbycats]

Is there a way to do an action (chain caller) only if the previous selection modifier took anything?

[capink]

Originally Posted by Nicolas.Laurent

Hello everyone

I'm back with a new problem.

I wrote this template for the Single Field Edit module, the idea being to copy author names into a dialog box and format them before assigning them to the authors field.
Everything works perfectly, except that my dialog box opens twice, and also opens when I save the code. It works, so it's not too bad, but a bit annoying.
What should I do to solve the problem?

And once again, thank you so much for this incredible plugin, which has saved me a lot of time!

Code:

python:

def evaluate(book, context):

	from PyQt5.QtWidgets import QInputDialog

	sortie = ""
	nom = ", ".join(book.authors)

	source, ok = QInputDialog.getText(None, "Modification des auteurs", "Entrez les auteurs :")

	if not ok:
	        return nom

	source = source.replace(" (Auteur)", "").replace(" & ", ", ").replace(" et ", ", ").strip()
    
	nom_transforme = []
	for auteur in source.split(", "):  
		parts = auteur.split(" ", 1)
		if len(parts) == 2:
			prenom, nom_famille = parts
			nom_transforme.append(f"{nom_famille.upper()}, {prenom.title()}")
		else:
			nom_transforme.append(auteur)

	return " & ".join(nom_transforme)

Don't put GUI code in templates. Put it in a module and pass the result as a chain variable as discussed previously.

[capink]

Originally Posted by ownedbycats

only if the previous selection modifier took anything?

I don't understand what you mean by this.

[ownedbycats]

If the selection modifier... has anything. I can't think of word.

[capink]

If you mean Selection Modifier has resulted in books selection as opposed to none, you can test that with this condition:

program:
    list_count(from_selection('id'),',')

Datatype: number
Comparison: >
Condition value: 0

[ownedbycats]

Yes, thank you.

[ownedbycats]

Is it possible to use these in Action Chains? There's no menu option:

[capink]

No. Your best bet to re-create those with templates.

[WorldTeacher]

Hi,

i want to use action chains to make my management a bit easier. For that, I would like to have two chains:

Chain 1:
runs when books are added though "Add books > add books from folder and subfolders" and uses the plugin "count pages" to count the pages

I have the basics of this chain working, but it only counts the pages of the last book that was added, not every book added in the process

Chain 2:
runs on calibre shutdown and:
for all books added that day:
runs pluin "embed metadata"
runs plugin "epub extended metadata"
copies the books to another library

how would I create these chains?

any help is welcome, thanks in advance

[capink]

Originally Posted by WorldTeacher

Hi,

i want to use action chains to make my management a bit easier. For that, I would like to have two chains:

Chain 1:
runs when books are added though "Add books > add books from folder and subfolders" and uses the plugin "count pages" to count the pages

I have the basics of this chain working, but it only counts the pages of the last book that was added, not every book added in the process

Chain 2:
runs on calibre shutdown and:
for all books added that day:
runs pluin "embed metadata"
runs plugin "epub extended metadata"
copies the books to another library

how would I create these chains?

any help is welcome, thanks in advance

I never used "Count Pages" or "epub extended metadata", so any specific advice regarding these two plugins I will leave to people who actually use them.

But in general, plugins can be called from an action called "Calibre Actions". But there are two caveats:

• The plugin must have an action that can be associated menu item. Most plugins do.
• Any interactive dialogs that are popped up by the plugins, will have to be dealt with manually, you cannot pre-answer them.

As for the first chain, you can use the event manager, with a custom event called "Books added", which you can get from here. You can attach the chain to the event, and it will fire every times new book(s) are added. This event has an option to select all added books, which I guess was the problem you had with count pages acting on only one books.

Note: The event posted above can be added to the plugin by copy/pasting the code into the plugin's module editor: Action Chains > Manage Modules > add > copy/paste

For the second chain, you can use the event manager with the builtin event "Shutting down". All the actions should be doable with "Calibre Actions", with the two caveats mentioned above holding.

[WorldTeacher]

thanks for the help ^^

I have managed to create both chains, they work without issues.