Você já usou as configurações color e linewidth da função plot. Os próximos exemplos apresentam outras funções e parâmetros. Não é preciso memorizar todos os nomes e sua ordem: o PyneIDE mostra a ajuda correspondente ao lado do código.

Neste capítulo, vamos usar o arquivo first_chart.py já criado. Não é preciso executar o programa agora.

Passe o mouse sobre o nome da função

  1. Abra o arquivo first_chart.py pelo grupo Scripts do painel Pyne.
  2. Encontre a chamada plot(close, "Close", ...) dentro de main().
  3. Passe o ponteiro sobre o nome plot, no começo da linha, e aguarde um instante.

A ajuda que aparece mostra a lista de parâmetros e a descrição da função. Se o conteúdo for extenso, passe o mouse sobre a ajuda e role dentro dela. Para fechá-la, pressione Esc.

A ajuda do PyneIDE está aberta sobre a chamada de plot de first_chart.py; a lista de parâmetros mostra que o valor padrão de linewidth é 1.
A ajuda exibida sobre o nome plot também mostra o tipo e o valor padrão dos parâmetros.

Como ler a lista de parâmetros?

A ajuda pode listar mais configurações do que usamos no exemplo. Basta encontrar aquelas de que você precisa no momento.

No caso de plot, por exemplo:

  • series é o valor a desenhar. No nosso programa, esse lugar é ocupado por close.
  • title é o nome do desenho. O segundo argumento da chamada, "Close", define esse nome.
  • linewidth é a espessura da linha. O = 1 na lista de parâmetros indica seu valor padrão; no exemplo, linewidth=2 substitui esse valor.

Um parâmetro é o nome de um dado ou de uma configuração que a função espera receber. O argumento é o valor passado na chamada. Portanto, linewidth é um parâmetro; 2, fornecido na chamada linewidth=2, é um argumento.

Se aparecer um tipo ao lado do nome, ele dá uma indicação do valor esperado. Por exemplo, int significa número inteiro. Você encontrará anotações de tipo nos próximos capítulos; não precisa aprender a lista inteira agora.

A descrição da ajuda aparece em inglês. O livro também explica em português o significado dos parâmetros usados nos exemplos. Ao conhecer uma função nova, vale ler a descrição primeiro e depois procurar a configuração que deseja alterar.

Recurso adicional: ir para a definição

Se quiser ver onde a função foi escrita, mantenha pressionada a tecla Command no macOS ou Ctrl no Windows e Linux e clique no nome plot. O editor abre a definição correspondente. Você também pode clicar com o botão direito no nome e escolher Go to Definition.

No arquivo aberto, abaixo da linha def plot(...), você encontra a descrição e a implementação da função. Esse já é o código da biblioteca instalada: para o exercício, basta lê-lo, sem modificá-lo. Volte ao seu programa clicando na aba first_chart.py.

O PyneIDE navegou até a linha def plot no arquivo plot.py da biblioteca; abaixo, aparece a descrição dos parâmetros.
Ir para a definição abre o código-fonte de plot na biblioteca. Seu programa continua em uma aba separada.

Você não precisa conhecer o funcionamento interno da biblioteca para acompanhar os exemplos do livro. Esse recurso é útil quando quiser estudar uma função com mais profundidade.

Tente por conta própria

Abra a ajuda de plot e procure o parâmetro linewidth. Qual é seu valor padrão? Depois, confira sua chamada: ela usa esse mesmo valor?

Solução do exercício

O valor padrão é 1. O programa first_chart.py usa linewidth=2, por isso definimos a espessura como 2. Se você omitir esse argumento da chamada, a função usará o valor padrão 1.