Python Eficaz

CAPÍTULO 7
Colaboração
O Python tem recursos especialmente criados para implementar APIs bem
definidas, com limites de interface muito claros. A comunidade do Python
estabeleceu boas práticas para maximizar a facilidade de manutenção do código
à medida que envelhece. Existem ferramentas nativas que permitem aos
membros de grandes equipes o trabalho em conjunto mesmo em ambientes
bastante heterogêneos.
Colaborar com outras pessoas em projetos de Python requer certa dose de
atenção na maneira de escrever o código. Mesmo se estiver trabalhando sozinho,
existe sempre a possibilidade de você incluir em seu projeto algum trecho de
código escrito por outra pessoa, presente na biblioteca-padrão ou em algum
pacote externo de código aberto. É importante entender os mecanismos que
tornam tão fácil colaborar com outros programadores de Python.
Item 49: Escreva docstrings para toda e qualquer
função, classe e módulo
Para o Python, a documentação é extremamente importante devido à natureza
dinâmica da linguagem. O Python permite incluir documentação diretamente a
blocos de código. Ao contrário de muitas outras linguagens, a documentação
presente no código-fonte de um programa pode ser acessada diretamente
enquanto o programa está rodando.
Por exemplo, podemos documentar uma função simplesmente incluindo uma
docstring imediatamente após o comando def.
def palindrome(word):
"""Return True if the given word is a palindrome."""
return word == word[::-1]
Podemos obter a docstring diretamente de dentro do próprio programa acessando
o atributo especial __doc__, presente em qualquer função.
www.full-ebook.com