Skip to content

Commit

Permalink
Atualizando comandos por taskipy por motivos de Windows 🔥
Browse files Browse the repository at this point in the history
  • Loading branch information
dunossauro committed Jan 9, 2025
1 parent 8251cf1 commit fceda05
Show file tree
Hide file tree
Showing 17 changed files with 157 additions and 147 deletions.
54 changes: 27 additions & 27 deletions aulas/01.md
Original file line number Diff line number Diff line change
Expand Up @@ -440,28 +440,30 @@ Isso funcionaria para qualquer comando complicado em nossa aplicação. Simplifi
Alguns comandos que criaremos agora no início:

```toml title="pyproject.toml" linenums="37"
--8<-- "aulas/codigos/01/pyproject.toml:37:43"
--8<-- "aulas/codigos/01/pyproject.toml:37:44"
```

Os comandos definidos fazem o seguinte:

- lint: Executa duas variações da checagem:
- `ruff check --diff`: Mostra o que precisa ser alterado no código para que as boas práticas sejam seguidas
- `ruff check`: Mostra os códigos de infrações de boas práticas
- `&&`: O duplo `&` faz com que a segunda parte do comando só seja executada se a primeira não der erro. Sendo assim, enquanto o `--diff` apresentar erros, ele não executará o `check`
- `lint`: Faz a checagem de boas práticas do código python
- `pre_format`: Faz algumas correções de boas práticas automaticamente
- `format`: Executa a formatação do código em relação as convenções de estilo de código
- `run`: executa o servidor de desenvolvimento do FastAPI
- `pre_test`: executa a camada de lint antes de executar os testes
- `test`: executa os testes com pytest de forma verbosa (-vv) e adiciona nosso código como base de cobertura
- `post_test`: gera um report de cobertura após os testes

- format: Executa duas variações da formatação:
- `ruff check --fix`: Faz algumas correções de boas práticas automaticamente
- `ruff format`: Executa a formatação do código em relação as convenções de estilo de código
- run: executa o servidor de desenvolvimento do FastAPI
- pre_test: executa a camada de lint antes de executar os testes
- test: executa os testes com pytest de forma verbosa (-vv) e adiciona nosso código como base de cobertura
- post_test: gera um report de cobertura após os testes
Para executar um comando, é bem mais simples, precisando somente passar a palavra `task <comando>`.

#### Comandos com prefixo `pre` e `pos`

Para executar um comando, é bem mais simples, precisando somente passar a palavra `task <comando>`.
Todos os comandos do taskipy que apresentam prefixos como `pre_commando` ou `pos_commando` não precisam ser executados diretamente. Por exemplo, se executarmos o comando `task test` ele executará o comando `pre_test` e caso tudo ocorra bem, sem erros, ele executará o `test`, caso não aconteçam erros, o `pos_test` será executado.

Nada impede que os comandos com prefixos sejam executados diretamente, mas eles são montados para serem executados em cadeia.

??? warning "Caso precise ver o arquivo todo"
---

??? warning "Caso precise ver o arquivo de configuração por completo"

O meu está exatamente assim:

Expand All @@ -482,22 +484,20 @@ task lint

Dessa forma, veremos que cometemos algumas infrações na formatação da PEP-8. O ruff nos informará que deveríamos ter adicionado duas linhas antes de uma definição de função:

```diff
```python
fast_zero/app.py:5:1: E302 [*] Expected 2 blank lines, found 1
|
3 | app = FastAPI()
4 |
5 | @app.get('/')
| ^ E302
6 | def read_root():
7 | return {'message': 'Olá Mundo!'}
|
= help: Add missing blank line(s)

Found 1 error.
[*] 1 fixable with the `--fix` option.
--- fast_zero/app.py
+++ fast_zero/app.py
@@ -2,6 +2,7 @@

app = FastAPI()

+
@app.get('/')
def read_root():
return {'message': 'Olá Mundo!'}

Would fix 1 error.
```

Para corrigir isso, podemos usar o nosso comando de formatação de código:
Expand Down
5 changes: 3 additions & 2 deletions aulas/codigos/01/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ pythonpath = "."
addopts = '-p no:warnings'

[tool.taskipy.tasks]
lint = 'ruff check .; ruff check . --diff'
format = 'ruff check . --fix; ruff format .'
lint = 'ruff check'
pre_format = 'ruff check --fix'
format = 'ruff format'
run = 'fastapi dev fast_zero/app.py'
pre_test = 'task lint'
test = 'pytest -s -x --cov=fast_zero -vv'
Expand Down
5 changes: 3 additions & 2 deletions codigo_das_aulas/01/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ pythonpath = "."
addopts = '-p no:warnings'

[tool.taskipy.tasks]
lint = 'ruff check .; ruff check . --diff'
format = 'ruff check . --fix; ruff format .'
lint = 'ruff check'
pre_format = 'ruff check --fix'
format = 'ruff format'
run = 'fastapi dev fast_zero/app.py'
pre_test = 'task lint'
test = 'pytest -s -x --cov=fast_zero -vv'
Expand Down
5 changes: 3 additions & 2 deletions codigo_das_aulas/02/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ pythonpath = "."
addopts = '-p no:warnings'

[tool.taskipy.tasks]
lint = 'ruff check .; ruff check . --diff'
format = 'ruff check . --fix; ruff format .'
lint = 'ruff check'
pre_format = 'ruff check --fix'
format = 'ruff format'
run = 'fastapi dev fast_zero/app.py'
pre_test = 'task lint'
test = 'pytest -s -x --cov=fast_zero -vv'
Expand Down
5 changes: 3 additions & 2 deletions codigo_das_aulas/03/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ pythonpath = "."
addopts = '-p no:warnings'

[tool.taskipy.tasks]
lint = 'ruff check .; ruff check . --diff'
format = 'ruff check . --fix; ruff format .'
lint = 'ruff check'
pre_format = 'ruff check --fix'
format = 'ruff format'
run = 'fastapi dev fast_zero/app.py'
pre_test = 'task lint'
test = 'pytest -s -x --cov=fast_zero -vv'
Expand Down
5 changes: 3 additions & 2 deletions codigo_das_aulas/04/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,9 @@ pythonpath = "."
addopts = '-p no:warnings'

[tool.taskipy.tasks]
lint = 'ruff check .; ruff check . --diff'
format = 'ruff check . --fix; ruff format .'
lint = 'ruff check'
pre_format = 'ruff check --fix'
format = 'ruff format'
run = 'fastapi dev fast_zero/app.py'
pre_test = 'task lint'
test = 'pytest -s -x --cov=fast_zero -vv'
Expand Down
5 changes: 3 additions & 2 deletions codigo_das_aulas/05/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ pythonpath = "."
addopts = '-p no:warnings'

[tool.taskipy.tasks]
lint = 'ruff check .; ruff check . --diff'
format = 'ruff check . --fix; ruff format .'
lint = 'ruff check'
pre_format = 'ruff check --fix'
format = 'ruff format'
run = 'fastapi dev fast_zero/app.py'
pre_test = 'task lint'
test = 'pytest -s -x --cov=fast_zero -vv'
Expand Down
5 changes: 3 additions & 2 deletions codigo_das_aulas/06/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ pythonpath = "."
addopts = '-p no:warnings'

[tool.taskipy.tasks]
lint = 'ruff check .; ruff check . --diff'
format = 'ruff check . --fix; ruff format .'
lint = 'ruff check'
pre_format = 'ruff check --fix'
format = 'ruff format'
run = 'fastapi dev fast_zero/app.py'
pre_test = 'task lint'
test = 'pytest -s -x --cov=fast_zero -vv'
Expand Down
5 changes: 3 additions & 2 deletions codigo_das_aulas/07/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ pythonpath = "."
addopts = '-p no:warnings'

[tool.taskipy.tasks]
lint = 'ruff check .; ruff check . --diff'
format = 'ruff check . --fix; ruff format .'
lint = 'ruff check'
pre_format = 'ruff check --fix'
format = 'ruff format'
run = 'fastapi dev fast_zero/app.py'
pre_test = 'task lint'
test = 'pytest -s -x --cov=fast_zero -vv'
Expand Down
5 changes: 3 additions & 2 deletions codigo_das_aulas/08/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,9 @@ pythonpath = "."
addopts = '-p no:warnings'

[tool.taskipy.tasks]
lint = 'ruff check .; ruff check . --diff'
format = 'ruff check . --fix; ruff format .'
lint = 'ruff check'
pre_format = 'ruff check --fix'
format = 'ruff format'
run = 'fastapi dev fast_zero/app.py'
pre_test = 'task lint'
test = 'pytest -s -x --cov=fast_zero -vv'
Expand Down
5 changes: 3 additions & 2 deletions codigo_das_aulas/09/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,9 @@ pythonpath = "."
addopts = '-p no:warnings'

[tool.taskipy.tasks]
lint = 'ruff check .; ruff check . --diff'
format = 'ruff check . --fix; ruff format .'
lint = 'ruff check'
pre_format = 'ruff check --fix'
format = 'ruff format'
run = 'fastapi dev fast_zero/app.py'
pre_test = 'task lint'
test = 'pytest -s -x --cov=fast_zero -vv'
Expand Down
5 changes: 3 additions & 2 deletions codigo_das_aulas/10/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ pythonpath = "."
addopts = '-p no:warnings'

[tool.taskipy.tasks]
lint = 'ruff check .; ruff check . --diff'
format = 'ruff check . --fix; ruff format .'
lint = 'ruff check'
pre_format = 'ruff check --fix'
format = 'ruff format'
run = 'fastapi dev fast_zero/app.py'
pre_test = 'task lint'
test = 'pytest -s -x --cov=fast_zero -vv'
Expand Down
5 changes: 3 additions & 2 deletions codigo_das_aulas/11/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,9 @@ pythonpath = "."
addopts = '-p no:warnings'

[tool.taskipy.tasks]
lint = 'ruff check .; ruff check . --diff'
format = 'ruff check . --fix; ruff format .'
lint = 'ruff check'
pre_format = 'ruff check --fix'
format = 'ruff format'
run = 'fastapi dev fast_zero/app.py'
pre_test = 'task lint'
test = 'pytest -s -x --cov=fast_zero -vv'
Expand Down
5 changes: 3 additions & 2 deletions codigo_das_aulas/12/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ pythonpath = "."
addopts = '-p no:warnings'

[tool.taskipy.tasks]
lint = 'ruff check .; ruff check . --diff'
format = 'ruff check . --fix; ruff format .'
lint = 'ruff check'
pre_format = 'ruff check --fix'
format = 'ruff format'
run = 'fastapi dev fast_zero/app.py'
pre_test = 'task lint'
test = 'pytest -s -x --cov=fast_zero -vv'
Expand Down
7 changes: 3 additions & 4 deletions slides/brutos/aula_01.md
Original file line number Diff line number Diff line change
Expand Up @@ -440,12 +440,11 @@ Alguns comandos fazem mais sentido quando compostos. Queremos fazer mais, com me

```toml
[tool.taskipy.tasks]
lint = 'ruff check . && ruff check . --diff'
format = 'ruff check . --fix && ruff format .'
lint = 'ruff check'
pre_format = 'ruff check --fix'
format = 'ruff format'
```

> O `&&` está sendo usado por compatibilidade com o windows, se você estiver no GNU/Linux ou MacOS. Você pode colocar `;` para unir comandos
---

## Cadeia de comandos com taskipy
Expand Down
178 changes: 88 additions & 90 deletions slides/html/aula_01.html

Large diffs are not rendered by default.

Binary file modified slides/pdf/aula_01.pdf
Binary file not shown.

0 comments on commit fceda05

Please sign in to comment.