New Post

Rss

Showing posts with label Assegure. Show all posts
Showing posts with label Assegure. Show all posts
Tuesday, March 20, 2012
no image

Assegure a qualidade do seu código Python – Pyflakes

Depois da dar uma pincelada na pep8 e no Pylint, chegou a hora de falarmos um pouco sobre o Pyflakes.

Resumidamente, o Pyflakes é uma ferramenta de qualidade que analisa o seu código Python atrás de erros (de sintaxe e importação, por exemplo), retornando um relatório muito objetivo com o arquivo, linha e o tipo de incoerência que ele encontrou.

Uma excelente ferramenta para você ter “plugada” ao seu editor favorito.

As comparações, acredito, serão inevitáveis. Afinal, o que o Pyflakes faz que o Pylint não faz? A resposta que você encontrará é muito simples: O Pyflakes não analisa a “beleza” do seu código. Ou seja, ele apenas verifica erros de lógica e de sintaxe, não de convenções de código.

Isso faz do Pyflakes o parceiro ideal do seu editor de código favorito. Por ser objetivo, favorece a análise e traz resultados interessantes, por exemplo, apontando variáveis criadas que nunca foram usadas, ou métodos importados que nunca foram chamados no escopo de um módulo Python.

Logo, ter as duas ferramentas à mão é uma excelente pedida para incrementar ainda mais o seu ambiente de desenvolvimento.

Vamos analisar o código de um projeto da faculdade que eu fiz, chamado Social portal for soccer players (encontra-se aberto no BitBucket):

$ pyflakes apps/notificate/views.py

A resposta é muito clara. Existem classes sendo importadas, mas que não estão sendo usadas:

apps/notificate/views.py:3: 'EmptyPage' imported but unusedapps/notificate/views.py:3: 'InvalidPage' imported but unused

O funcionamento básico do Pyflakes é esse… simples como as melhores coisas devem ser!

Se assim como eu, você tem um “tropeço” pelo vim, você não pode deixar passar esse bom pluginchamado pyflakes.vim.

Para instalá-lo, basta seguir o guia de instalação contido no arquivo README (leia diretamente doGitHub). Para que o plugin funcione corretamente, o seu vim deve ter suporte a Python (se não tiver, basta compilá-lo com o parâmetro -–enable-pythoninterp).

Uma vez instalado, quando estiver editando um código Python, basta utilizar o comando :cc para navegar entre os erros encontrados pelo plugin.

Fonte: Klaus Laube

Tecnólogo em Análise e Desenvolvimento de Sistemas pelo Centro Universitário de Jaraguá do Sul (UNERJ), Técnico em Informática com ênfase em Sistemas de Informação pelo Centro Politécnico Geraldo Werninghaus (CEPEG). Desenvolvedor Web defensor dos padrões Web. Usuário Linux, apaixonado por Python e alucinado por Django. Escreve quando pode no http://www.klauslaube.com.br.

Veja perfil e 81 post(s)

Saturday, March 3, 2012
no image

Assegure a qualidade do seu código Python – Clone Digger

Mesmo que você possa verificar a qualidade do seu código com pep8, Pylint e Pyflakes, uma das virtudes de um projeto de software é não possuir código duplicado (leia mais sobre DRY). O fato é que tanto intencionalmente como propositalmente, podemos duplicar um trecho de código e acabar prejudicando manutenções futuras (atire a primeira pedra quem nunca deu aquele CTRL+C e CTRL+V, e prometeu um refactoring depois).

Para facilitar a busca por código duplicado, podemos utilizar uma ferramenta chamada Clone Digger. Prático, rápido e muito simples. Agora ficou fácil “caçar” código duplicado em projetos Python.

Por tratar-se de uma ferramenta bem objetiva, não há muito o que falar sobre o Clone Digger. Então, vamos direto para a parte prática.

Para iniciar a análise, basta chamar o executável apontando para o diretório do seu projeto:

$ clonedigger meuprojeto/

Será gerado um arquivo chamado output.html, com um relatório detalhado (como este). Serão apresentadas informações como a quantidade de arquivos analisados, quantidade de “clones”, de linhas duplicadas e um apontamento com os trechos de código que a ferramenta concluiu como “clones” (não necessariamente iguais, mas semelhantes).

Particularmente, a ferramenta me ajuda bastante a determinar se certos trechos de código não poderiam ser herdados por uma classe pai, ou algumas rotinas costumeiras não poderiam ser encapsuladas em funções.

Até a próxima…

Fonte: Klaus Laube

Tecnólogo em Análise e Desenvolvimento de Sistemas pelo Centro Universitário de Jaraguá do Sul (UNERJ), Técnico em Informática com ênfase em Sistemas de Informação pelo Centro Politécnico Geraldo Werninghaus (CEPEG). Desenvolvedor Web defensor dos padrões Web. Usuário Linux, apaixonado por Python e alucinado por Django. Escreve quando pode no http://www.klauslaube.com.br.

Veja perfil e 78 post(s)

Thursday, September 1, 2011
no image

Assegure a qualidade do seu código Python – pep8

Convenções de código! Já tive a oportunidade de escrever sobre elas no Profissionais TI. Benção ou maldição? Há quem goste, há quem ache uma perda de tempo…

Acredito muito que a organização e a qualidade do código são benéficas para qualquer projeto, principalmente para aqueles que possuem alta rotatividade de profissionais. Padrões de projetos, padrões estruturais e de escrita facilitam a “assimilação” do que já foi produzido, facilita a manutenção e “orienta” as novas produções.

Se você tem problemas em decorar convenções e boas práticas, não desanime! O Python possui algumas ferramentas “bacanudas” que vão te auxiliar a deixar o software mais próximo do “estado da arte”, seja garantindo as convenções de código, seja avaliando a qualidade do mesmo.

As “PEPs“ (Python Enhancement Proposal) são documentos que geralmente abordam alguma nova funcionalidade da linguagem, propósitos, procedimentos ou ambiente. Em suma, são “guidelines” que te orientam num melhor uso da linguagem e suas funcionalidades, bem como podem ajudar em questões como arquitetura, ambiente ou processos de sua aplicação.

Para saber mais sobre PEPs, acesse a PEP 1 que é justamente um documento explicando o que são e o que fazem as Python Enhancement Proposals.

O pep8 é uma ferramenta simples (e muito eficaz) que analisa o seu código Python segundo as convenções de código descritas na PEP 8.

Vamos analisar o código do Django Brasil (você não sabia? O site é open source!), mais especificamente o arquivo models.py da app blog:

$ pep8 src/djangobrasil/apps/blog/models.py src/djangobrasil/apps/blog/models.py:42:65: W291 trailing whitespacesrc/djangobrasil/apps/blog/models.py:62:1: E302 expected 2 blank lines, found 1src/djangobrasil/apps/blog/models.py:105:80: E501 line too long (89 characters)

Como podemos ver, a ferramenta nos mostra a linha e coluna onde o problema foi encontrado, apresentando uma breve descrição da incoerência que estamos cometendo em relação às recomendações da PEP 8.

Para obter uma resposta mais “verbose“, podemos passar alguns parâmetros para o pep8:

$ pep8 src/djangobrasil/apps/blog/models.py --show-source --show-pep8 (...)src/djangobrasil/apps/blog/models.py:105:80: E501 line too long (89 characters) return '/weblog/%s/%s/' % (self.pub_date.strftime('%Y/%m/%d').lower(), self.slug) ^ Limit all lines to a maximum of 79 characters.  There are still many devices around that are limited to 80 character lines; plus, limiting windows to 80 characters makes it possible to have several windows side-by-side. The default wrapping on such devices looks ugly. Therefore, please limit all lines to a maximum of 79 characters. For flowing long blocks of text (docstrings or comments), limiting the length to 72 characters is recommended.

Viu só?! Dessa forma podemos aprender sobre a PEP 8 enquanto “ferimos” as convenções de código em nossos projetos :P

Para finalizar, podemos contar as ocorrências de problemas com a PEP 8 em determinada região do projeto:

$ pep8 src/djangobrasil/apps/blog/ --statistics -qq --filename=*.py 1 E225 missing whitespace around operator7 E302 expected 2 blank lines, found 11 E303 too many blank lines (2)11 E501 line too long (89 characters)4 W291 trailing whitespace2 W391 blank line at end of file

Nenhum problema muito grave de convenções de código na app blog do DjangoBrasil ;)

Confira: pep8 – Python style guide checker.

Nos próximos posts, vamos dar uma pincelada no pylint, pyflakes e clone digger.

Fonte: Klaus Laube