Pep257. verificador de estilo doutring python
Baixe Agora

Pep257. Classificação e resumo

Pep257. Tag

estilo Pitão docstring Verificador de estilo

Pep257. Descrição

O PEP275 é uma ferramenta de análise estática para verificar a conformidade com o Python Pep 257: http://www.python.org/dev/peps/pep-0257/.O framework para verificar o estilo do DOEPRING é flexível, e as verificações personalizadas podem ser facilmente adicionadas, Por exemplo, para cobrir as convenções do Docstring numpy: https://github.com/numpy/numpy/blob/master/doc/howto_document.rst.txt.adding New Chews é descrito em DocString de Pep257.py File.Installationuse Pip ou Easy_Install: Pip Install Pep257Alternativamente, você pode usar o arquivo de origem PEP257.py diretamente - é auto-suficiente.PEP257 é testado com Python 2.4, 2.5, 2.6, 2.7, 3.1, 3.2.example $ PEP257 - Helpusage: Pep257 Opções : -h, --help Mostrar esta mensagem de ajuda e saída -e --Explain show Explicação de cada erro -r, --range show error start..end positions -q, --quele citar linhas erradas $ PEP257 *. pydocopt.py:0:0: Pep257 módulos deve ter docstrings.docopt.py:14:4: Pep257 classe doutring deve ter 1 linha em branco ao redor deles.Docopt.py:27:0: Pep257 As aulas exportadas devem ter Docstrings.Docopt.py:43:4: Pep257 Definições exportadas deve ter docstrings .... $ Pep257 * .py --explaindocopt.py:1:0: Os módulos Pep257 devem ter os módulos DOCSTRINGS.PEP257 devem ter docstrings. Todos os módulos devem normalmente ter docstrings.docopt.py:14:4: Pep257 classe DOCSTRING deve ter 1 linha em branco ao redor deles.PEP257 classe doubling deve ter 1 linha em branco ao redor deles. Insira uma linha em branco antes e depois de todos os docstrings (uma linha ou multi-line) que documente uma classe - geralmente falando, os métodos da classe são separados uns dos outros por uma única linha em branco, e o DOCSTRING precisa ser compensado a partir do primeiro método por uma linha em branco; Para a simetria, coloque uma linha em branco entre o cabeçalho de classe e o docstring .... $ Pep257 - Cotate * .pyDocopt.py: 1: 0: Os módulos Pep257 devem ter docstrings. Import Sys Import Re # Python 3 Compatibilidade Tente: Basestring Exceto NameError: Docopt.py: 14: 4: Pep257 Classe Docstring deve ter 1 linha em branco ao redor deles. "" "Erro na construção de mensagem de uso." "" Docopt.py:27:0: As aulas exportadas Pep257 devem ter docstrings. Padrão de classe (objeto): Docopt.py: 43: 4: Pep257 As definições exportadas devem ter docstrings. def flat (auto): ... Python apipep257 A API Python é útil quando você deseja incluir o PEP 257 verificações em seu teste-suite. >>> Import Pep257 >>> Pep257.Check_files () um teste de estilo pytest pode ficar assim: Importar Pep257Test_PEP257 (): Errões = Pep257.Check_files ( ) assert Len (erros) == Homepage de 0produto

Pep257. Software Relacionado