Documentar os 11 raspadores no README e expor todos eles na API pública - #42
Draft
bdcdo wants to merge 2 commits into
Draft
Documentar os 11 raspadores no README e expor todos eles na API pública#42bdcdo wants to merge 2 commits into
bdcdo wants to merge 2 commits into
Conversation
A lista de fontes na abertura do README citava apenas 7 raspadores, omitindo CFM, SaudeLegis, ANS e ANVISA. Seis raspadores também não tinham nenhuma seção de uso: Presidência, Câmara, Senado, IPEA, CAPES e CFM apareciam só como uma linha na tabela de fontes. - Lista de abertura agora cobre os 11 raspadores, agrupados por tema (legislação, saúde, pesquisa acadêmica, imprensa). - Tabela de fontes separada entre raspadores HTTP e raspadores com navegador, com o nome do parâmetro de busca de cada fonte — que varia entre `pesquisa`, `texto`, `termo` e `assunto`. - Novas seções de uso para Presidência, Câmara, Senado, IPEA, CAPES e CFM, com filtros extras (`ano`, `tipo_materia`, `uf`, `revogada`, `numero`) e colunas retornadas. - Colunas retornadas documentadas também para SaudeLegis e NYT. - Índice dos notebooks de exemplo em `notebooks/`. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X6nwdnXab21r12wbRT2VuQ
Dois pontos em que a superfície pública ficou para trás dos raspadores
que o pacote realmente tem:
- `raspe.scrapers.__all__` listava apenas `ScraperFolha`, então
`from raspe.scrapers import ScraperCFM` só funcionava importando o
submódulo direto. Agora as 12 classes são reexportadas, incluindo as
baseadas em Playwright — importá-las não exige o extra `browser`,
porque o Playwright já era carregado sob demanda.
- `scraper_manager.scraper()` mapeava 5 fontes, e `scraper("CFM")`
levantava `ValueError` mesmo com `raspe.cfm()` existindo. Adicionados
CFM, FOLHA, NYT, SAUDELEGIS, ANS e ANVISA, fechando as 11 fontes.
O retorno passou de `BaseScraper` para `AbstractScraper`, que é o
ancestral comum dos raspadores HTTP e dos Playwright, e a mensagem de
erro agora enumera as fontes válidas.
Testes: cobertura por fonte em `scraper()`, repasse de kwargs e um teste
que trava o mapping contra `raspe.__all__`, para o mapping não voltar a
ficar defasado quando um raspador novo entrar.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01X6nwdnXab21r12wbRT2VuQ
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivação
O pacote tem 11 raspadores, mas nem a documentação nem a superfície pública refletiam isso.
No README:
pesquisa,texto,termo,assunto) e isso não estava documentado em lugar nenhum — só era descobrível lendo o código de cada scraper.No código:
raspe.scrapers.__all__listava apenasScraperFolha, entãofrom raspe.scrapers import ScraperCFMsó funcionava importando o submódulo direto.scraper_manager.scraper()mapeava 5 fontes das 11.scraper("CFM")levantavaValueErrormesmo comraspe.cfm()existindo e funcionando.Mudanças
Documentação (
README.md)paginas=e busca por lista de termos (colunatermo_busca).ano,tipo_materia,uf,revogada,numero) e colunas retornadas.scraper_manager.scraper(), para escolher a fonte por nome.notebooks/.Todos os 11 raspadores passam a ter seção própria com exemplo executável.
Exports (
src/)raspe.scrapersreexporta as 12 classes de raspador (as 11 fontes + a baseScraperDatalegis). Importá-las não exige o extrabrowser: o Playwright já era carregado sob demanda, dentro de_import_playwright(), e não no import do módulo.scraper_manager.scraper()cobre as 11 fontes — adicionadosCFM,FOLHA,NYT,SAUDELEGIS,ANS,ANVISA. O retorno passou deBaseScraperparaAbstractScraper, que é o ancestral comum dos raspadores HTTP e dos baseados em Playwright, e a mensagem de erro passa a enumerar as fontes válidas.Testes
tests/test_scraper_manager.pyfoi de 6 para 16 casos: cobertura por fonte, repasse de kwargs (api_key,headless), mensagem de erro, e um teste que trava o mapping contraraspe.__all__— para o mapping não voltar a ficar defasado quando um raspador novo entrar.Hooks
isort,pylinteflake8passam nos arquivos alterados;mypyepyrightrodados à mão (os hooks apontam para um.venv/que não existe neste ambiente) reportam zero erros.Os nomes de parâmetros, filtros e colunas documentados no README foram extraídos de
_set_query_base()e_parse_page()de cada scraper.🤖 Generated with Claude Code
https://claude.ai/code/session_01X6nwdnXab21r12wbRT2VuQ