DHI / DHI/python-package-development
Add section on inappropriate intimacy between classes
- Linguagem predominante
- Jupyter Notebook
- Estrelas
- 8
- Forks
- 1
- Merge médio
- 4min
- PRs com merge (30d)
- 1
Descrição
Classes should interact through public APIs, not by reaching into each other's private attributes.
**Example from MIKE IO plotting refactor:**
Before (inappropriate intimacy):
```python
# Plotter reaches into geometry internals for subsetting
values = values[self.da.geometry.top_elements]
geometry = self.da.geometry.geometry2d
# Plotter uses private attribute to check for time axis
if self.da._has_time_axis:
return self.da.values[0]
```
After (using public API):
```python
# Use sel/isel for subsetting
da = da.sel(layers="top")
geometry = da.geometry
# Use public dims property
da = self.da.isel(time=0) if "time" in self.da.dims else self.da
```
**Key principles:**
- Never access private attributes (prefixed with `_`) of another class
- Use public methods like `sel`, `isel`, and public properties like `dims`
- If you need to access private state, that's a signal the class is missing a public API
- Plotters should plot, not subset — keep data manipulation in the data layer
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Direção de pesquisa
Comece localizando a seção da documentação do curso que aborda design de classes ou plotagem, pois a issue não nomeia um arquivo nem um ponto de entrada. Adicione nela a explicação fornecida e os exemplos de MIKE IO, preservando as orientações sobre APIs públicas e manipulação de dados; considera-se concluído quando a nova seção estiver publicada no material apropriado do curso.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 48/100