pandas
Meta: Dokumentationsrichtlinien
Suche…
Bemerkungen
Dieser Meta-Post ähnelt der Python-Version http://stackoverflow.com/documentation/python/394/meta-documentation-guidelines#t=201607240058406359521 .
Bitte machen Sie Änderungsvorschläge und kommentieren Sie diese (anstelle der richtigen Kommentare), damit wir diese Vorschläge ausarbeiten können.
Anzeigen von Codeausschnitten und Ausgaben
Zwei beliebte Optionen sind zu verwenden:
ipython-notation:
In [11]: df = pd.DataFrame([[1, 2], [3, 4]])
In [12]: df
Out[12]:
0 1
0 1 2
1 3 4
Alternativ (dies ist in der Python-Dokumentation populär) und knapper:
df.columns # Out: RangeIndex(start=0, stop=2, step=1)
df[0]
# Out:
# 0 1
# 1 3
# Name: 0, dtype: int64
for col in df:
print(col)
# prints:
# 0
# 1
Im Allgemeinen ist dies für kleinere Beispiele besser.
Hinweis: Die Unterscheidung zwischen Ausgabe und Druck. ipython macht dies deutlich (die Ausdrucke werden vor der Ausgabe der Ausgabe ausgeführt)
In [21]: [print(col) for col in df]
0
1
Out[21]: [None, None]
Stil
Verwenden Sie die Pandabibliothek als pd
, dies kann davon ausgegangen werden (der Import muss nicht in jedem Beispiel sein)
import pandas as pd
- Einzug mit 4 Stellen
- Kwargs sollten keine Leerzeichen
f(a=1)
- Begrenzung auf 80 Zeichen (die gesamte Zeile, die in das gerenderte Code-Snippet passt, sollte stark bevorzugt werden)
Unterstützung für Pandas-Versionen
Die meisten Beispiele funktionieren für mehrere Versionen. Wenn Sie eine "neue" Funktion verwenden, sollten Sie erwähnen, wann diese eingeführt wurde.
Beispiel: sort_values
.
Anweisungen ausdrucken
In den meisten Fällen sollte das Drucken vermieden werden, da dies eine Ablenkung sein kann (Out sollte bevorzugt werden).
Das ist:
a
# Out: 1
ist immer besser als
print(a)
# prints: 1
Unterstütze lieber Python 2 und 3:
print(x) # yes! (works same in python 2 and 3)
print x # no! (python 2 only)
print(x, y) # no! (works differently in python 2 and 3)