Skip to content

Commit 3e98aad

Browse files
net0wellclaude
andcommitted
docs: README com trilhas
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 8c694ac commit 3e98aad

1 file changed

Lines changed: 37 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Biblioteca .NET 10 para executar Python de forma tipada, encadeável e observáv
44
com contrato de entrada/saída, trilhas (**Pipelines**), execução assíncrona com RabbitMQ, agendamento
55
cron e painel Vue opcional.
66

7-
> Projeto em desenvolvimento. Esta versão entrega o **Core Runner** (execução síncrona de Stages) e o
8-
> SDK Python **`psrunner`**.
7+
> Projeto em desenvolvimento. Esta versão entrega o **Core Runner** (execução síncrona de Stages e de
8+
> trilhas) e o SDK Python **`psrunner`**.
99
1010
## Como funciona
1111

@@ -56,6 +56,39 @@ double[] termos = result.GetOutput<double[]>("termos"); // [1, 2, 4, 8]
5656
Stages também podem ser definidos em C# (`AddStage("chave", s => s.Script(...).Input(...).Output(...))`)
5757
e testados localmente com pytest pelo `psrunner.testing.run_stage`, sem .NET.
5858

59+
## Trilhas (pipelines)
60+
61+
Uma trilha encadeia Stages em ordem. Cada entrada de um passo recebe a entrada da trilha
62+
(`$pipeline.campo`), a saída de qualquer passo anterior (`$steps.passo.campo`) ou um valor fixo
63+
(`{"const": ...}`). Sem ligação explícita, vale o campo de mesmo nome do passo anterior. A trilha
64+
declara as próprias saídas. Tipos e ligações são validados ao carregar o catálogo.
65+
66+
```jsonc
67+
// pipelines/calculo-progressao.pipeline.json
68+
{
69+
"key": "calculo-progressao", "version": 1, "name": "Cálculo de progressão",
70+
"inputs": [ { "name": "a1", "type": "number" }, { "name": "razao", "type": "number" },
71+
{ "name": "n", "type": "integer" }, { "name": "coeficientes", "type": "list", "itemType": "number" } ],
72+
"steps": [
73+
{ "key": "termos", "stage": "progressao-termos@1" },
74+
{ "key": "polinomio", "stage": "polinomio-avaliar@1",
75+
"bindings": { "coeficientes": "$pipeline.coeficientes", "x": "$steps.termos.termos" } },
76+
{ "key": "estatisticas", "stage": "estatisticas@1", "bindings": { "valores": "$steps.polinomio.valores" } }
77+
],
78+
"outputs": [ { "name": "soma", "source": "$steps.estatisticas.soma" } ]
79+
}
80+
```
81+
82+
```csharp
83+
await using var result = await runner.RunPipelineAsync("calculo-progressao",
84+
new { a1 = 1, razao = 2, n = 4, coeficientes = new[] { 1.0, 0.0, 1.0 } });
85+
double soma = result.GetOutput<double>("soma");
86+
double[] termos = result.GetStepOutput<double[]>("termos", "termos"); // depuração
87+
```
88+
89+
A mesma trilha pode ser definida em C# com `AddPipeline("chave", p => p.Input(...).Step(...).Output(...))`.
90+
Se um passo falhar, os seguintes ficam como `Skipped` e a execução termina `Failed`.
91+
5992
## Requisitos
6093

6194
- .NET 10 SDK
@@ -68,8 +101,8 @@ e testados localmente com pytest pelo `psrunner.testing.run_stage`, sem .NET.
68101
| `src/PythonScriptRunner.Abstractions` | contratos públicos (tipos de campo, `StageDefinition`, `RunResult`, `PsrFile`, interfaces) |
69102
| `src/PythonScriptRunner.Core` | catálogos (código e pasta), validação, ambientes uv, executor de processos, runner |
70103
| `python/psrunner` | SDK Python (`@stage`, `Context`, `File`, `StageError`, `psrunner.testing`, CLI) |
71-
| `schemas` | JSON Schema do `stage.json` |
72-
| `tests` | testes .NET (unitários e de integração com Python real) |
104+
| `schemas` | JSON Schemas do `stage.json` e do `*.pipeline.json` |
105+
| `tests` | testes .NET (unitários e de integração com Python real) e fixtures de trilha |
73106

74107
## Desenvolvimento
75108

0 commit comments

Comments
 (0)