run-script

Nesta seção, você encontra a referência de um hook declarativo do tipo run-script.

O hook declarativo run-script executa scripts Python.

Ações Disponíveis

  • trigger: Campo para definir gatilhos que informam o momento em que a execução de um script Python deve ocorrer.
    • before-input: Executa o script antes de receber os parâmetros de entrada da pessoa usuária.
      trigger: before-input
      
    • before-render: Executa o script antes do Template gerar arquivos no projeto.
      trigger: before-render
      
    • after-render: Executa o script após o Template gerar arquivos no projeto.
      trigger: after-render
      

  • script: Define o caminho do script Python que será executado.
script: path/to/script.py

Para que o run-script execute um script Python, o script precisa estar definido com:

  • Uma função com o nome run.
  • A função run deve receber como parâmetro um objeto da classe Metadata do templateframework.
  • No retorno, a função deve devolver um metadata. Pode ser o mesmo metadata recebido ou outro criado pela função.

Exemplo de função run no script Python

from templateframework.metadata import Metadata
def run(metadata: Metadata = None):
    print("Hello from script.py!")
    return metadata

No script está disponível para uso a biblioteca padrão do Python 3.8 e as bibliotecas Requests e Questionary disponíveis como dependências no STK CLI.

Exemplo de um Hook Declarativo run-script

hooks:
  - type: run-script
    trigger: before-render
    script: path/to/script.py

Leia também