Doc: Extending Context/Runners/etc.
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 30/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Start with the existing fabric example and the Context, Config, and Runner extension points mentioned in the issue. Document the minimum implementation for each, including the Local wrapper and .invoke.yaml configuration example, then clarify task gathering, deferred execution, dynamic asynchronous commands, and completion checks for a slurm-style runner.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
I am trying to extend invoke to be able to run slurm jobs, and I am slowly figuring out what I need to extend from the example of fabric. It would be nice to have this documented somewhere for other developers. So my understanding is that a common setup is to extend:
Context: The main entity to initialize the work environment and provide a user interfaceConfig: To add your own configurations to be parsed from.invoke.yamlRunner: To define how to run a command
The issue currently is that it is not clear what is the minimum that we need to implement in each class. An example that could help illustrate is maybe a wrapper over Local that takes a "Hello world" message from Config, prints this message before each task/command, and prints a similar message at the start of the context setup.
Is there a matrix/IRC/Discord room to get some quick pointers for these?
Similarly, but more specific to the goal of the slurm wrapper:
- How can I gather the tasks before a
runcommand? Is that done automatically? - Is it possible to prepare run steps or postpone the execution of
runin a context? - In an asynchronous runner, can I dynamically add tasks/run command (dependent or independent on a previous step)
- For an asynchronous runner, where do I specify how to query if a
runis finished or not?
- Lingua principale
- Python
- Stelle
- 4.8k
- Fork
- 412
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Non abbiamo ancora controllato i file di configurazione di questo progetto. Parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di pyinvoke/invoke
-
[Security] Shell injection via Context.cd() path argument — metacharacters not escaped (CWE-78)Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
Tutte le issue di pyinvoke/invoke
Issue simili
-
documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
kristofdegrave/homeassistant-smart-charging#1413 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
nasa/earthdata-varinfo#113 ·
-
curriculum documentation quality
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
githubnext/gh-aw-workshop#3849 ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 90/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
I maintainer di solito rispondono entro 1 giorno