Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Add section on inappropriate intimacy between classes

Aperta
#35 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
48/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia individuando la sezione della documentazione del corso che tratta la progettazione delle classi o il plotting, poiché l’issue non indica alcun file o punto di ingresso. Aggiungi lì la spiegazione fornita e gli esempi di MIKE IO, mantenendo le indicazioni sulle API pubbliche e sulla manipolazione dei dati; il lavoro sarà considerato completato quando la nuova sezione sarà pubblicata nel materiale del corso appropriato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Classes should interact through public APIs, not by reaching into each other's private attributes.

Example from MIKE IO plotting refactor:

Before (inappropriate intimacy):

# 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):

# 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
Lingua principale
Jupyter Notebook
Stelle
8
Fork
1
Merge medio
4m
PR unite (30g)
1

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di DHI/python-package-development

Tutte le issue di DHI/python-package-development

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.