Vamos lá: Conhecendo o `simples`¶

Criando o pacote¶

Um pacote corresponde a um conjunto de módulos, no simples temos dois módulos, o módulo de tests e o módulo de simples, para saber mais sobre módulos e pacotes, você pode ver o seguinte tutorial em português no devfuria.

Estrutura¶

setup.py corresponde ao arquivo que permite a instalação do seu pacote, a pasta tests conterá os módulos que servirão para realizar testes em seu programa, docs onde ficará a documentação do seu programa, e por fim a pasta simples que conterá os módulos da sua biblioteca, a seguir temos uma estrutura bastante comum, com umas pequenas variações dependendo do tutorial:

simples/
    ├── setup.py
    |── simples/
    |── tests/
    └── docs/

Alguns tutoriais você pode encontrar em python-packaging, uoftcoders.

Utilizando Docstrings¶

No Python, as Docstrings correspondem a um conjunto de comentários entre """ """ realizados no início de um módulo, função, classe ou método.

A seguir, temos alguns tutoriais que ensinam o uso de Docstrings:

Exemplos¶

No pacote simples é usado o padrão do numpy.

Função soma inteiros usando o docstring do numpy:

def soma_inteiros(x: int, y: int)-> int:
    """Realiza a soma entre dois inteiros.

    Parameters
    ----------
    x : int
        número inteiro.
    y : int
        número inteiro

    Returns
    -------
    int
        o resultado da soma de x + y
    """
    return x + y

Criando testes¶

A estrutura do simples de forma mais básica com a pasta tests:

simples/
    ├── setup.py
    └──simples/
    |      |── __init__.py
    |      └── soma.py
    └──tests/
          |── __init__.py
          └── test_soma.py

Os testes criados para a biblioteca simples foi utilizando o pytest. Um dos exemplos testa se a soma é igual a 8:

def test_soma_inteiros():
    assert soma_inteiros(5, 3) == 8, "Resultado deve ser 8"

Para saber mais sobre testes no python, você pode acessar alguns dos seguintes materiais:

Vamos lá: Conhecendo o simples¶