Trilha de aprendizado · Nível 5 · Tutorial 4

Consultar a biblioteca padrão e sua documentação

Localizar recursos já disponíveis no Python e consultar a documentação oficial para usar funções adequadas à tarefa e à versão instalada.

  • Nível: Iniciante
  • Duração: 13 min
  • 6 passos
Consultar a biblioteca padrão e sua documentação

O que você vai percorrer

  1. Reconhecer de onde vem um recurso Diferencie nomes embutidos, módulos da biblioteca padrão, módulos locais e bibliotecas de terceiros antes de escolher uma solução. 1 min
  2. Encontrar uma funcionalidade na documentação oficial Use diferentes caminhos da documentação oficial para localizar um recurso da biblioteca padrão a partir do módulo ou da tarefa. 2 min
  3. Ler o que uma função faz e exige Aprenda a reconhecer assinatura, finalidade, retorno e restrições em uma entrada de referência usando math.sqrt. 2 min
  4. Conferir versão e disponibilidade Compare a versão e a plataforma do interpretador com as notas da documentação antes de usar um recurso. 2 min
  5. Adaptar um exemplo ao seu programa Consulte o contrato de statistics.mean, execute um script completo e adapte seus dados sem violar a restrição de coleção não vazia. 3 min
  6. Resolver uma tarefa com apoio da documentação Aplicar o fluxo completo de consulta à documentação oficial para escolher, verificar e usar um recurso da biblioteca padrão. 3 min

O que você vai aprender

  • Distinguir recursos embutidos, módulos da biblioteca padrão, módulos locais e bibliotecas externas.
  • Localizar uma funcionalidade pelo índice ou pela busca da documentação oficial.
  • Identificar parâmetros, retorno e restrições de uso de uma função documentada.
  • Adaptar um exemplo simples de math ou statistics ao próprio programa.
  • Conferir se o recurso consultado está disponível na versão do Python utilizada.

Antes de começar

  • Separar código em módulos e usar importações explícitas
  • Documentar funções com docstrings e tipos simples

Passo 1 de 6

Reconhecer de onde vem um recurso

Diferencie nomes embutidos, módulos da biblioteca padrão, módulos locais e bibliotecas de terceiros antes de escolher uma solução.

Quatro origens possíveis

Um recurso usado no programa pode vir de quatro lugares:

  • Embutido: já está disponível sem importação, como len.
  • Biblioteca padrão: módulo distribuído com o Python, como math e statistics; normalmente exige importação.
  • Módulo local: arquivo ou pacote criado no próprio projeto.
  • Biblioteca de terceiros: recurso produzido separadamente e que não faz parte da distribuição padrão do Python.

Os nomes embutidos e os módulos padrão são apresentados na documentação da biblioteca do Python.

Diagrama com quatro origens de recursos conectadas a um programa Python: núcleo embutido, caixa de ferramentas padrão, pasta do projeto e pacote separado.

A origem depende de como o recurso é fornecido, não apenas da forma como ele aparece no código.

Importar não revela a origem

Exemplo

Compare os casos

quantidade = len([10, 20, 30])  # nome embutido

import math                    # biblioteca padrão
raiz = math.sqrt(25)

import meu_relatorio           # pode ser um módulo local

math e meu_relatorio usam import, mas têm origens diferentes. Portanto, encontrar uma importação não permite concluir que o recurso é uma biblioteca de terceiros.

Dica

Antes de buscar algo externo

Consulte primeiro se a tarefa já é atendida por um nome embutido ou pela biblioteca padrão. Isso pode evitar uma dependência externa. Ainda assim, a disponibilidade de certos módulos pode variar conforme a versão ou a plataforma — uma verificação que será feita mais adiante neste tutorial.

Classifique pela origem

Associe cada recurso à descrição correta.

Toque em um item e depois no par correspondente.

Passo 2 de 6

Encontrar uma funcionalidade na documentação oficial

Use diferentes caminhos da documentação oficial para localizar um recurso da biblioteca padrão a partir do módulo ou da tarefa.

Reconheça a documentação oficial

Comece pelo domínio correto

A documentação oficial do Python fica no domínio docs.python.org. Nela, a seção de referência da biblioteca padrão reúne páginas sobre recursos embutidos e módulos como math e statistics.

A página também oferece seletores de versão e idioma. Prefira Português do Brasil (pt-BR) quando disponível, mas algumas páginas ou partes delas podem continuar em inglês.

Mapa da navegação

Há três caminhos principais: navegar por uma área temática, abrir o índice quando você conhece o módulo ou pesquisar quando conhece apenas a tarefa.

Diagrama com três caminhos de navegação — área temática, índice de módulos e busca — convergindo para a página de uma função.

O melhor caminho depende do que você já sabe: a tarefa, a área ou o nome do módulo.

Escolha um caminho

O que você já sabe?

Use o índice de módulos quando já souber o nome, como math. Na página do módulo, procure o nome da função.

Se você conhecer apenas a necessidade, como “calcular uma raiz quadrada”, use a busca ou navegue por uma área como Módulos Numéricos e Matemáticos. Na busca do navegador, você também pode restringir os resultados com site:docs.python.org.

Dica

Confirme antes de continuar

Verifique se o resultado permanece em docs.python.org. Outros sites podem explicar o mesmo recurso, mas a documentação oficial é a referência para confirmar nomes e uso.

Da tarefa ao nome qualificado

Exemplo

Exemplo: localizar a raiz quadrada

Necessidade: calcular a raiz quadrada de um número.

Pelo índice: Referência da biblioteca → Índice de módulos → math → procurar sqrt.

Pela área: Referência da biblioteca → Módulos Numéricos e Matemáticos → math → procurar sqrt.

Pela busca: pesquisar raiz quadrada Python math site:docs.python.org.

Os caminhos levam ao nome qualificado math.sqrt. Por enquanto, basta localizar a entrada; a leitura detalhada do que ela exige será feita no próximo step.

Faça a localização

Registre seu caminho

No seu navegador, acesse a documentação oficial e localize a função para calcular uma raiz quadrada. Registre o caminho usado e o nome qualificado encontrado.

Escreva pelo menos 30 caracteres (0/30).

Passo 3 de 6

Ler o que uma função faz e exige

Aprenda a reconhecer assinatura, finalidade, retorno e restrições em uma entrada de referência usando math.sqrt.

Anatomia de uma entrada de referência

Procure as informações essenciais

Uma entrada da documentação pode distribuir as informações em diferentes partes:

  • Assinatura: mostra o nome da função e seus parâmetros.
  • Descrição: explica a finalidade e, muitas vezes, o retorno.
  • Parâmetros: indicam quais dados devem ser fornecidos.
  • Retorno: informa o que a chamada produz.
  • Restrições: delimitam quais entradas são válidas.
  • Exemplos: relacionam entradas, chamadas e resultados.

Nem toda informação aparece na assinatura. É preciso ler também o texto ao redor dela.

Mapa visual da referência

Esquema de uma entrada de documentação dividida em assinatura, descrição, entrada, saída, restrição e exemplo.

Leia a entrada como um conjunto: a assinatura apresenta a chamada, enquanto a descrição e as observações completam o contrato da função.

Interpretando math.sqrt

Da assinatura à chamada

Considere a assinatura math.sqrt(x). O nome x é o parâmetro documentado. Em math.sqrt(16), o valor 16 é o argumento associado a esse parâmetro.

A descrição informa que a função retorna a raiz quadrada de x. Para uma chamada válida neste contexto, x deve representar um número real não negativo. Um valor negativo está fora desse domínio e a documentação indica um erro ValueError — aqui basta reconhecer a restrição, sem tratar o erro.

Exemplo mínimo completo

Execute este código no seu interpretador Python:

python
import math

numero = 16
raiz = math.sqrt(numero)
print(raiz)

Exemplo

Relacionando entrada e resultado

A entrada é 16, a chamada é math.sqrt(numero) e o resultado apresentado é 4.0. A assinatura mostra que a função recebe um argumento; a descrição permite entender que o valor retornado é a raiz quadrada.

Verifique sua leitura

Escolha a interpretação válida

Leia este resumo documental: math.sqrt(x) retorna a raiz quadrada de x. Se x for negativo, a função indica um erro ValueError.

Qual opção interpreta corretamente essa informação?

Passo 4 de 6

Conferir versão e disponibilidade

Compare a versão e a plataforma do interpretador com as notas da documentação antes de usar um recurso.

Descubra a versão em execução

Consulte o próprio interpretador

Execute sys.version no mesmo interpretador usado pelo seu programa. O começo do resultado informa a versão: em 3.12.4, por exemplo, 3 é a versão principal e 12 é a secundária. Os demais dados podem incluir a versão de correção e informações de compilação.

Consulta completa

Execute este script localmente:

python
import sys

print(sys.version)

Exemplo

Como ler a saída

Uma saída iniciada por 3.12.4 indica Python 3.12. Para conferir compatibilidade documental neste caso, procure a série 3.12.

Escolha a documentação correspondente

Alinhe interpretador e documentação

Em docs.python.org, confira a versão selecionada antes de ler a referência. Prefira a série principal e secundária do seu interpretador. Evite usar por engano a documentação de outra série ou a versão marcada como em desenvolvimento, pois ela pode descrever recursos que ainda não existem na sua instalação.

Comparação de versões

A correspondência deve ser feita entre a versão em execução e a mesma série da documentação.

Diagrama comparando um interpretador com páginas de documentação e destacando a correspondência entre versões iguais, enquanto uma versão de desenvolvimento aparece separada.

Use a documentação da mesma série do interpretador; versões diferentes exigem atenção às notas de disponibilidade.

Leia as notas de versão e plataforma

“Adicionado”, “alterado” e disponibilidade

Uma nota “Adicionado na versão X” informa quando o recurso passou a existir. Já “Alterado na versão X” indica uma mudança em algo que poderia existir antes — não necessariamente a criação da função. Também observe notas de disponibilidade por sistema operacional.

Exemplo

Dois tipos de limite

A documentação informa que math.isqrt foi adicionada no Python 3.8. Portanto, ela não está disponível no Python 3.7, mas pode ser usada a partir do 3.8.

Como exemplo de plataforma, winreg é um módulo da biblioteca padrão disponível no Windows. Sua presença na documentação não significa que ele esteja disponível em outros sistemas, e não é necessário executar suas funções para interpretar essa restrição.

Dica

Cheque antes de adaptar o exemplo

Confirme três pontos: sua série do Python, a nota de introdução ou alteração do recurso e uma possível restrição de plataforma.

Verifique a compatibilidade

Versão mínima

Um programa executado com Python 3.7 pode usar math.isqrt porque essa função aparece na documentação atual.

Restrição de plataforma

Todo módulo listado na biblioteca padrão está disponível em qualquer sistema operacional que execute Python.

Passo 5 de 6

Adaptar um exemplo ao seu programa

Consulte o contrato de statistics.mean, execute um script completo e adapte seus dados sem violar a restrição de coleção não vazia.

Entenda o contrato de statistics.mean

O que a função recebe e retorna

Na documentação oficial da sua versão do Python, procure statistics.mean. A função calcula a média aritmética dos valores recebidos pelo parâmetro data.

Para usá-la corretamente, identifique três pontos:

  • Parâmetro: uma coleção de dados numéricos, como uma lista.
  • Retorno: a média aritmética dos dados.
  • Restrição: a coleção não pode estar vazia.

Neste step, usaremos apenas listas numéricas não vazias e não trataremos o erro causado por uma coleção vazia.

Dos dados ao resultado

A função recebe vários valores numéricos e produz a média aritmética deles.

Diagrama com três valores numéricos entrando em um cálculo e um único valor médio saindo.

Em statistics.mean(data), data fornece os valores; o retorno é a média aritmética.

Dica

Confirme a referência usada

Antes de adaptar o exemplo, confira se a página pertence a docs.python.org e corresponde à série principal e secundária do Python que executará o script.

Leve o exemplo para um script

Script completo

Crie um arquivo Python no seu computador, copie o código e execute-o com o interpretador cuja versão você conferiu.

python
import statistics

valores = [6, 8, 10]
media = statistics.mean(valores)

print(f"Média: {media}")

Exemplo

Compare com o resultado esperado

Para [6, 8, 10], a média é (6 + 8 + 10) / 3, ou seja, 8. Portanto, a saída esperada é:

Média: 8

O script importa o módulo, mantém os dados em memória, chama a função com uma lista não vazia e apresenta o valor retornado.

Dica

Do console para o arquivo

Se a documentação mostrar um exemplo do console interativo, não copie os marcadores >>> nem as linhas que apenas representam a saída. No script, mantenha somente as instruções Python. Você pode alterar os dados e os nomes das variáveis, desde que continue fornecendo uma coleção numérica não vazia à função.

Adapte e verifique no seu computador

Sua adaptação

Execute primeiro o script como apresentado. Depois, substitua a lista por [12, 15, 18] e execute novamente.

A média matemática desses valores é 15. Como todos os valores são inteiros e a média é exata, a saída literal esperada neste caso é:

Média: 15

Compare essa previsão com o que apareceu no seu terminal.

Registre o resultado observado

Qual foi a saída observada depois da alteração? Compare-a com o resultado esperado e explique por que a lista usada respeita a restrição documentada de statistics.mean.

Escreva pelo menos 60 caracteres (0/60).

Passo 6 de 6

Resolver uma tarefa com apoio da documentação

Aplicar o fluxo completo de consulta à documentação oficial para escolher, verificar e usar um recurso da biblioteca padrão.

O fluxo completo de consulta

Da necessidade ao resultado

Ao resolver uma tarefa com a biblioteca padrão, siga este fluxo:

  1. Defina a tarefa em termos claros.
  2. Localize um recurso na documentação oficial.
  3. Leia o contrato: finalidade, parâmetros, retorno e restrições.
  4. Confira a disponibilidade na série do Python que você usa.
  5. Experimente com dados pequenos e compare o resultado esperado com o observado.

A escolha do recurso deve ser justificada pela documentação, e não apenas pelo fato de uma chamada parecer funcionar.

Mapa do processo

Fluxo visual em cinco etapas: definir a tarefa, consultar a documentação, ler o contrato, conferir a versão e experimentar o código.

A consulta termina com uma comparação entre o resultado esperado e o observado.

Aplicação final no seu computador

Escolha e justifique o recurso

Um terreno quadrado tem área de 81 m². O comprimento de cada lado é o número real não negativo que, multiplicado por ele mesmo, resulta em 81.

Sem partir do nome de uma função, use a documentação oficial em docs.python.org para localizar um recurso já explorado neste tutorial que calcule esse valor. Depois, execute sua solução no próprio computador.

Para registrar sua versão, execute import sys e print(sys.version) no mesmo interpretador. Em sua resposta, inclua:

  • a versão principal e secundária do Python usado;
  • a série correspondente da documentação consultada;
  • o nome qualificado do recurso escolhido;
  • sua finalidade, seu parâmetro, seu retorno e uma restrição relevante;
  • o script completo que você executou;
  • o resultado matemático esperado;
  • a saída observada literalmente;
  • uma comparação entre o esperado e o observado.

Escreva pelo menos 200 caracteres (0/200).

Checklist para futuras consultas

Resumo

Antes de usar um recurso documentado

Reutilize este processo sempre que procurar uma funcionalidade já disponível no Python.

  • Descreva primeiro a tarefa que precisa resolver.
  • Procure o recurso na documentação oficial e confirme sua origem.
  • Leia finalidade, parâmetros, retorno, restrições e exemplos.
  • Alinhe a série da documentação à versão principal e secundária do seu interpretador.
  • Adapte um exemplo pequeno, execute-o e compare o resultado esperado com o observado.

Tutorial concluído

Parabéns! Você concluiu: Consultar a biblioteca padrão e sua documentação

Agora você sabe localizar um recurso padrão, interpretar seu contrato, conferir sua disponibilidade e adaptá-lo ao próprio programa.

100 XP

Baixe o Aplicativo agora para ter acesso a + de 5000 cursos gratuitos, exercícios, certificado e muito conteúdo sem pagar nada!

  • Cursos online 100% gratuitos do início ao fim

    Milhares de cursos online em vídeo, ebooks e áudiobooks.

  • Mais de 60 mil exercícios gratuitos

    Para testar seus conhecimentos no decorrer dos cursos online

  • Certificado Digital gratuito válido em todo o Brasil

    Gerado diretamente na galeria de fotos do seu celular e enviado ao seu e-mail

Aplicativo Cursa na tela de ebook, na tela de curso em vídeo e na tela de exercícios do curso, mais o certificado de conclusão de curso