golang/go

context: relax recommendation against putting Contexts in structs

Open

#22.602 aberto em 6 de nov. de 2017

Ver no GitHub
 (10 comments) (27 reactions) (0 assignees)Go (19.008 forks)batch import
DocumentationNeedsInvestigationhelp wanted

Métricas do repositório

Stars
 (133.883 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

This is a follow-on from discussion in #14660.

Right now the context package documentation says

Do not store Contexts inside a struct type; instead, pass a Context explicitly to each function that needs it. The Context should be the first parameter, typically named ctx: [...]

This advice seems overly restrictive. @bradfitz wrote in that issue:

While we've told people not to add contexts to structs, I think that guidance is over-aggressive. The real advice is not to store contexts. They should be passed along like parameters. But if the struct is essentially just a parameter, it's okay. I think this concern can be addressed with package-level documentation and examples.

Let's address this concern with package-level documentation.

Also see @rsc's comment at https://github.com/golang/go/issues/14660#issuecomment-200145301.

/cc @Sajmani @bradfitz @rsc

Guia do colaborador

Direção de pesquisa
A issue solicita a atualização da documentação do pacote context em Go (provavelmente em src/context/context.go) para relaxar a declaração contra o armazenamento de Contexts em structs. Leia os comentários referenciados em #14660, especialmente de bradfitz e rsc, para entender a orientação com nuances. A alteração deve explicar que armazenar um context em uma struct é aceitável quando a struct em si é efetivamente um parâmetro. Atualize a documentação no nível do pacote e possivelmente adicione um exemplo.
Pilha de tecnologia
go
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Go
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70