Type safety: resource methods unpack dict | list HTTP responses with **
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 65/100
- Tipo de issue
- Refatoração
- Clareza
- Claramente especificada
- Status de atividade
- Ativa
- Stack de tecnologia
- python
- Domínio
- backend-api-design, tooling
Direção de pesquisa
Observe os métodos de recurso em modelos como Agent, Contact e Conversation. Eles chamam self._http.get e desempacotam a resposta com Model(**response). Substitua-os por Model.model_validate(response). Verifique também os dois arquivos de teste mencionados para o estreitamento de tipo. Execute ty check . para verificar se os diagnósticos foram resolvidos.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Context
This follows #11 (ty as a dev dependency) and #12 (builtins.list annotations), as part of re-enabling ty in CI. Once #12 is in, ty check . reports 42 diagnostics. 40 of them come from the issue below, and I'd like your preference on the fix before opening a PR.
Problem
HTTPClient / AsyncHTTPClient methods return dict[str, Any] | list[Any], which is accurate: _unwrap_response returns a list or a single object depending on the endpoint. Single-object resource methods then unpack the result without checking which one it is:
response = self._http.get(f"/api/v1/accounts/{account_id}/agents/{agent_id}")
return Agent(**response) # ty: argument after ** must be a mapping, found `dict[str, Any] | list[Any]`
This return Model(**response) pattern appears 40 times across 9 models (Agent, Contact, Conversation, Inbox, Team, Message, Profile, ContactCreateResponse, ConversationToggleStatusResponse). It isn't a bug today, since those endpoints do return objects. But the types don't show that, and if a list ever came back, the user would get a bare TypeError. List methods already narrow with isinstance(response, list) and aren't affected.
Options
Model.model_validate(response)(my preference)- One-line change at each of the 40 sites, and
_httpstays untouched. - pydantic already validates the input at runtime, and
model_validateacceptsAny, so the type checker is satisfied. - It behaves the same as today for dict responses, because these models use no aliases or custom config. An unexpected list would raise a pydantic
ValidationErrorinstead of aTypeError.
- One-line change at each of the 40 sites, and
- Split the HTTP methods by response shape, e.g.
get_object() -> dict[str, Any]andget_list() -> list[Any], which check the shape and raise aChatwootAPIErrorotherwise.- This gives the most precise types.
- But it redesigns the internal HTTP API in both clients and touches every call site, including the list ones.
cast(dict[str, Any], response)at each site.- This silences the checker without any runtime check, so I'd rather avoid it.
Also in scope
Two small narrowing fixes in tests:
tests/smoke/test_smoke.py:240:contact.nameisstr | None.tests/unit/test_inbox_agent_bot.py:59: subscripting a possibly-Noneresult.
Once this and #11/#12 are merged, a small follow-up PR would re-enable the ty job in CI.
Note on overlap
#5, #8 and #9 touch some of the same resource files (#8 specifically changes response handling). Happy to rebase onto whichever lands first. Just let me know if one of them should go in before this.
Which option would you prefer?
- Linguagem predominante
- Python
- Estrelas
- 8
- Forks
- 5
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de chatwoot/chatwoot-sdk-python
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 35/100
Todas as issues de chatwoot/chatwoot-sdk-python
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 73/100
Netcracker/qubership-ai-packages#266 ·
Mantenedores costumam responder em até 1 dia
-
PROCESSED_DATA_FOLDER: strip whitespace and treat empty as unsetTalvez já em andamento @TorecLuik assumiu hoje. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
NL-BioImaging/BIOMERO.importer#63 ·
Mantenedores costumam responder em até 1 dia
-
MLX training-complete chat/merge suggestions omit --backend mlxTalvez já em andamento @vaputa assumiu hoje. Abertaneeds-triage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
MakazhanAlpamys/Soup#2913 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
area:security effort:S priority:P3 status:needs-triage type:chore
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
randomparity/kdive#3657 ·
Mantenedores costumam responder em até 1 dia
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
aws/mcp-proxy-for-aws#476 ·
Mantenedores costumam responder em até 1 dia