Como fazer benchmark de código Python com pytest-benchmark
Everett Pompeii
O que é Benchmarking?
Benchmarking é a prática de testar o desempenho do seu código para ver quão rápido (latência) ou quanto (throughput) trabalho ele pode executar. Este passo frequentemente negligenciado no desenvolvimento de software é crucial para criar e manter um código rápido e performático. O benchmarking fornece as métricas necessárias para que os desenvolvedores compreendam o desempenho do seu código sob várias cargas de trabalho e condições. Pelas mesmas razões que você escreve testes unitários e de integração para evitar regressões de funcionalidades, você deve escrever benchmarks para evitar regressões de desempenho. Bugs de desempenho são bugs!
Escreva FizzBuzz em Python
Para escrevermos testes de desempenho, precisamos de algum código-fonte para testar. Para começar, vamos escrever um programa muito simples, FizzBuzz.
As regras para o FizzBuzz são as seguintes:
Escreva um programa que imprima os inteiros de
1
a100
(inclusive):
- Para múltiplos de três, imprima
Fizz
- Para múltiplos de cinco, imprima
Buzz
- Para múltiplos de três e cinco, imprima
FizzBuzz
- Para todos os outros, imprima o número
Existem muitas maneiras de escrever o FizzBuzz. Então vamos seguir com o meu favorito:
- Itere de
1
a100
, usando um intervalo de101
. - Para cada número, calcule o módulo (resto após divisão) para ambos
3
e5
. - Se o resto for
0
, então o número é um múltiplo do fator dado.- Se o resto for
0
para15
, então imprimaFizzBuzz
. - Se o resto for
0
para3
, então imprimaFizz
. - Se o resto for
0
para5
, então imprimaBuzz
.
- Se o resto for
- Caso contrário, apenas imprima o número.
Siga Passo a Passo
Para seguir este tutorial passo a passo, você precisará instalar Python e instalar o pipenv
.
🐰 O código-fonte deste post está disponível no GitHub.
Crie um arquivo Python chamado game.py
,
e defina seu conteúdo com a implementação FizzBuzz acima.
Em seguida, execute python game.py
.
A saída deve ser similar a:
🐰 Boom! Você está detonando na entrevista de programação!
Antes de prosseguir, é importante discutir as diferenças entre micro-benchmarking e macro-benchmarking.
Micro-Benchmarking vs Macro-Benchmarking
Existem duas categorias importantes de benchmarks de software: micro-benchmarks e macro-benchmarks.
Os micro-benchmarks operam em um nível semelhante aos testes unitários.
Por exemplo, um benchmark para uma função que determina Fizz
, Buzz
, ou FizzBuzz
para um número individual seria um micro-benchmark.
Os macro-benchmarks operam em um nível semelhante aos testes de integração.
Por exemplo, um benchmark para uma função que executa o jogo inteiro de FizzBuzz, de 1
a 100
, seria um macro-benchmark.
Em geral, é melhor testar no menor nível de abstração possível. No caso dos benchmarks, isso os torna mais fáceis de manter, e ajuda a reduzir a quantidade de ruído nas medições. No entanto, assim como ter alguns testes de ponta a ponta pode ser muito útil para verificar se todo o sistema se junta conforme esperado, ter macro-benchmarks pode ser muito útil para garantir que os caminhos críticos através do seu software permaneçam com bom desempenho.
Benchmarking em Python
As duas opções populares para benchmarking em Python são: pytest-benchmark e airspeed velocity (asv)
pytest-benchmark
é uma ferramenta de benchmarking poderosa integrada ao popular framework de testes pytest
.
Ela permite que os desenvolvedores meçam e comparem o desempenho de seu código executando benchmarks junto com seus testes de unidade.
Os usuários podem facilmente comparar seus resultados de benchmark localmente e exportá-los em vários formatos, como JSON.
airspeed velocity (asv)
é outra ferramenta de benchmarking avançada no ecossistema Python.
Um dos principais benefícios do asv
é sua capacidade de gerar relatórios HTML detalhados e interativos,
o que facilita a visualização das tendências de desempenho e a identificação de regressões.
Além disso, o asv
suporta Benchmarking Contínuo Relativo nativamente.
Ambos são suportados pelo Bencher.
Então por que escolher pytest-benchmark
?
pytest-benchmark
integra-se perfeitamente com pytest
,
que é o padrão de fato para testes unitários no ecossistema Python.
Recomendo usar pytest-benchmark
para medir a latência do seu código,
especialmente se você já estiver utilizando pytest
.
Ou seja, pytest-benchmark
é ótimo para medir o tempo de relógio de parede.
Refatorar FizzBuzz
Para testar nossa aplicação FizzBuzz, precisamos desacoplar nossa lógica da execução principal do programa. Os ambientes de benchmarking não conseguem avaliar a execução principal. Para fazer isso, precisamos fazer algumas mudanças.
Vamos refatorar nossa lógica do FizzBuzz em um par de funções:
play_game
: Recebe um número inteiron
, chamafizz_buzz
com esse número, e seshould_print
forTrue
, imprime o resultado.fizz_buzz
: Recebe um número inteiron
e executa a lógica deFizz
,Buzz
,FizzBuzz
ou número, retornando o resultado como uma string.
Então, atualize a execução principal para ficar assim:
A execução principal do nosso programa itera através dos números de 1
a 100
inclusive e chama play_game
para cada número, com should_print
definido como True
.
Avaliando FizzBuzz
Para avaliar nosso código, precisamos criar uma função de teste que execute nosso benchmark.
No final do game.py
, adicione o seguinte código:
- Crie uma função chamada
test_game
que receba um fixturebenchmark
dopytest-benchmark
. - Crie uma função
run_game
que itere de1
a100
inclusivamente.- Para cada número, chame
play_game
, comshould_print
definido comoFalse
.
- Para cada número, chame
- Passe a função
run_game
para o executorbenchmark
.
Agora precisamos configurar nosso projeto para executar nossos benchmarks.
Crie um novo ambiente virtual com pipenv
:
Instale pytest-benchmark
dentro desse novo ambiente pipenv
:
Agora estamos prontos para avaliar nosso código, execute pytest game.py
:
🐰 Vamos agitar o som! Temos nossas primeiras métricas de benchmark!
Finalmente, podemos descansar nossas cabeças cansadas de desenvolvedor… Brincadeira, nossos usuários querem um novo recurso!
Escreva FizzBuzzFibonacci em Python
Nossos Indicadores-Chave de Desempenho (KPIs) estão em queda, então nosso Gerente de Produto (PM) quer que adicionemos um novo recurso. Após muitas sessões de brainstorming e várias entrevistas com usuários, foi decidido que o bom e velho FizzBuzz não é suficiente. Hoje em dia, as crianças querem um novo jogo, o FizzBuzzFibonacci.
As regras para FizzBuzzFibonacci são as seguintes:
Escreva um programa que imprime os números inteiros de
1
a100
(inclusive):
- Para múltiplos de três, imprima
Fizz
- Para múltiplos de cinco, imprima
Buzz
- Para múltiplos de ambos três e cinco, imprima
FizzBuzz
- Para números que fazem parte da sequência de Fibonacci, apenas imprima
Fibonacci
- Para todos os outros, imprima o número
A Sequência de Fibonacci é uma série na qual cada número é a soma dos dois números precedentes.
Por exemplo, começando com 0
e 1
o próximo número na sequência de Fibonacci seria 1
.
Seguido por: 2
, 3
, 5
, 8
e assim por diante.
Números que fazem parte da Sequência de Fibonacci são conhecidos como números de Fibonacci. Então, teremos que escrever uma função que detecte números de Fibonacci.
Existem muitas maneiras de escrever a sequência de Fibonacci e, da mesma forma, muitas maneiras de detectar um número de Fibonacci. Então, vamos com a minha favorita:
- Crie uma função chamada
is_fibonacci_number
que recebe um inteiro e retorna um valor booleano. - Itere para todos os números de
0
até o nosso númeron
inclusive. - Inicialize nossa sequência de Fibonacci começando com
0
e1
como os númerosanterior
eatual
, respectivamente. - Itere enquanto o número
atual
for menor que a iteração correntei
. - Some os números
anterior
eatual
para obter o númeronext_value
. - Atualize o número
anterior
para o númeroatual
. - Atualize o número
atual
para o númeronext_value
. - Uma vez que
atual
for maior ou igual ao número dadon
, o loop será encerrado. - Verifique se o número
atual
é igual ao número dadon
e se for, retorneTrue
. - Caso contrário, retorne
False
.
Agora precisamos atualizar nossa função fizz_buzz
:
- Renomeie a função
fizz_buzz
parafizz_buzz_fibonacci
para torná-la mais descritiva. - Chame nossa função auxiliar
is_fibonacci_number
. - Se o resultado de
is_fibonacci_number
forTrue
, então retorneFibonacci
. - Se o resultado de
is_fibonacci_number
forFalse
, então execute a mesma lógica deFizz
,Buzz
,FizzBuzz
ou número retornando o resultado.
Como renomeamos fizz_buzz
para fizz_buzz_fibonacci
, também precisamos atualizar nossa função play_game
:
Tanto nossa execução principal quanto a função test_game
podem permanecer exatamente como estão.
Benchmarking FizzBuzzFibonacci
Agora podemos executar novamente nosso benchmark:
Voltando ao nosso histórico do terminal,
podemos fazer uma comparação visual entre o desempenho de nossos jogos FizzBuzz e FizzBuzzFibonacci: 10.8307 us
vs 735.5682 us
.
Seus números serão um pouco diferentes dos meus.
No entanto, a diferença entre os dois jogos provavelmente estará na faixa de 50x.
Isso me parece bom! Especialmente por adicionar uma funcionalidade com um nome tão sofisticado como Fibonacci ao nosso jogo.
As crianças vão adorar!
Expandir FizzBuzzFibonacci em Python
Nosso jogo é um sucesso! As crianças realmente adoram jogar FizzBuzzFibonacci. Tanto que a notícia chegou aos executivos de que eles querem uma sequência. Mas este é o mundo moderno, precisamos de Receita Recorrente Anual (ARR) e não de compras únicas! A nova visão para o nosso jogo é que ele seja indefinido, não mais vivendo entre o limite de 1
e 100
(mesmo que seja inclusivo). Não, estamos indo para novas fronteiras!
As regras para o Open World FizzBuzzFibonacci são as seguintes:
Escreva um programa que aceite qualquer número inteiro positivo e imprima:
- Para múltiplos de três, imprima
Fizz
- Para múltiplos de cinco, imprima
Buzz
- Para múltiplos de ambos três e cinco, imprima
FizzBuzz
- Para números que fazem parte da sequência de Fibonacci, apenas imprima
Fibonacci
- Para todos os outros, imprima o número
Para que nosso jogo funcione para qualquer número, precisaremos aceitar um argumento de linha de comando. Atualize a execução principal para se parecer com isto:
- Importe o pacote
sys
. - Recolha todos os argumentos (
args
) passados para o nosso jogo a partir da linha de comando. - Obtenha o primeiro argumento passado para o nosso jogo e verifique se é um dígito.
- Se for, analise o primeiro argumento como um inteiro,
i
. - Jogue nosso jogo com o novo inteiro
i
analisado.
- Se for, analise o primeiro argumento como um inteiro,
- Se a análise falhar ou nenhum argumento for passado, padrão para solicitar uma entrada válida.
Agora podemos jogar nosso jogo com qualquer número! Execute python game.py
seguido por um número inteiro para jogar nosso jogo:
E se omitirmos ou fornecermos um número inválido:
Uau, isso foi um teste completo! CI aprova. Nossos chefes estão encantados. Vamos lançar! 🚀
O Fim
🐰 … o fim da sua carreira talvez?
Brincadeira! Tudo está pegando fogo! 🔥
Bem, a princípio, tudo parecia estar indo bem. Então, às 02:07 da madrugada de sábado, meu pager disparou:
📟 Seu jogo está pegando fogo! 🔥
Após sair da cama às pressas, tentei descobrir o que estava acontecendo. Eu tentei pesquisar nos logs, mas era difícil porque tudo continuava travando. Finalmente, encontrei o problema. As crianças! Elas adoravam tanto nosso jogo que jogavam até chegar a um milhão! Num lampejo de brilhantismo, adicionei dois novos benchmarks:
- Um microbenchmark
test_game_100
para jogar o jogo com o número cem (100
) - Um microbenchmark
test_game_1_000_000
para jogar o jogo com o número um milhão (1_000_000
)
Quando executei, obtive o seguinte resultado:
Espere por isso… espere por isso…
O quê! 15.8470 us
x 1.000
deveria ser 15.847.0 us
e não 571.684.6334 us
🤯
Mesmo que eu tenha acertado minha função de sequência de Fibonacci, devo ter algum bug de desempenho em algum lugar.
Corrigir FizzBuzzFibonacci em Python
Vamos dar outra olhada na função is_fibonacci_number
:
Agora que estou pensando em desempenho, percebo que tenho um loop desnecessário e extra.
Podemos eliminar completamente o loop for i in range(n + 1):
e
apenas comparar o valor current
com o número fornecido (n
) 🤦
- Atualize a nossa função
is_fibonacci_number
. - Inicialize a sequência de Fibonacci começando com
0
e1
como os númerosprevious
ecurrent
respectivamente. - Itere enquanto o número
current
for menor que o número dadon
. - Adicione os números
previous
ecurrent
para obter o númeronext_value
. - Atualize o número
previous
para o númerocurrent
. - Atualize o número
current
para o númeronext_value
. - Quando
current
for maior ou igual ao número dadon
, sairemos do loop. - Verifique se o número
current
é igual ao número dadon
e retorne esse resultado.
Agora vamos executar esses benchmarks novamente e ver como nos saímos:
Uau! Nosso benchmark test_game
está de volta a algo próximo do original FizzBuzz.
Gostaria de lembrar exatamente qual era essa pontuação. Já faz três semanas.
Meu histórico do terminal não vai tão longe.
E o pytest-benchmark
só armazena seus resultados quando pedimos.
Mas acho que está perto!
O benchmark test_game_100
caiu quase 50x para 322.0815 ns
.
E o benchmark test_game_1_000_000
caiu mais de 500.000x! De 571.684.633,4 ns
para 753.1445 ns
!
🐰 Pelo menos pegamos esse bug de desempenho antes que chegasse à produção… ah, certo. Deixa pra lá…
Detecte Regressões de Desempenho em CI
Os executivos não ficaram felizes com a enxurrada de críticas negativas que nosso jogo recebeu devido ao meu pequeno bug de desempenho. Eles me disseram para não deixar isso acontecer de novo, e quando perguntei como, eles simplesmente me disseram para não fazê-lo novamente. Como eu deveria gerenciar isso‽
Felizmente, encontrei esta incrível ferramenta open source chamada Bencher. Existe um nível gratuito super generoso, então posso apenas usar Bencher Cloud para meus projetos pessoais. E no trabalho, onde tudo precisa estar em nossa nuvem privada, comecei a usar Bencher Auto-Hospedado.
Bencher tem adaptadores integrados, por isso é fácil de integrar ao CI. Após seguir o guia Rápido Início, consegui executar meus benchmarks e rastreá-los com o Bencher.
Usando este incrível dispositivo de viagem no tempo que um simpático coelho me deu, consegui voltar ao passado e reviver o que teria acontecido se estivéssemos usando o Bencher desde o início. Você pode ver onde fizemos pela primeira vez o push da implementação bugada de FizzBuzzFibonacci. Imediatamente recebi falhas no CI como um comentário na minha solicitação de pull. No mesmo dia, corrigi o bug de desempenho, eliminando aquele loop extra e desnecessário. Sem incêndios. Apenas usuários felizes.
Bencher: Benchmarking Contínuo
Bencher é um conjunto de ferramentas de benchmarking contínuas. Já teve algum impacto de regressão de desempenho nos seus usuários? Bencher poderia ter prevenido isso. Bencher permite que você detecte e previna regressões de desempenho antes que cheguem à produção.
- Execute: Execute seus benchmarks localmente ou no CI usando suas ferramentas de benchmarking favoritas. O CLI
bencher
simplesmente envolve seu harness de benchmark existente e armazena seus resultados. - Rastreie: Acompanhe os resultados de seus benchmarks ao longo do tempo. Monitore, consulte e faça gráficos dos resultados usando o console web do Bencher baseado na branch de origem, testbed e medida.
- Capture: Capture regressões de desempenho no CI. Bencher usa análises personalizáveis e de última geração para detectar regressões de desempenho antes que elas cheguem à produção.
Pelos mesmos motivos que os testes de unidade são executados no CI para prevenir regressões de funcionalidades, benchmarks deveriam ser executados no CI com o Bencher para prevenir regressões de desempenho. Bugs de desempenho são bugs!
Comece a capturar regressões de desempenho no CI — experimente o Bencher Cloud gratuitamente.