Dokumentation zu help()

Wenn du dir nicht sicher bist, in welchem der anderen Foren du die Frage stellen sollst, dann bist du hier im Forum für allgemeine Fragen sicher richtig.
ws
User
Beiträge: 65
Registriert: Freitag 16. Juni 2006, 13:19

Dokumentation zu help()

Beitragvon ws » Mittwoch 21. Februar 2007, 14:10

Hallo,

für ein paar Module, die ich gerade erstelle, möchte ich für andere Entwickler eine ensprechende Hilfe zur Verfügung stellen.

Was mir fehlt, ist eine Beschreibung der Arbeitsweise von help(). Ist es möglich, mit help() eine Information zu einem Objekt auszugeben? So dass ich eine Klasse in einem Modul helptest.py wie folgt anlegen kann:

Code: Alles auswählen

class HelpTest(object):
    def __init__(self, attr1, attr2):
   self.attr1 = attr1
   self.attr2 = attr2
   self.__doc__ = "Object with attr1=%(attr1)s, attr2=%(attr2)s" % self.__dict__

ht = HelpTest("Wert1", "Wert2")


und mit

Code: Alles auswählen

from helptest import *
help(ht)

den doc-String der Instanz bekomme, und nicht nur Informationen über die Klasse?

Oder gibt es andere Möglichkeiten, anderen entsprechende Informationen bereitzustellen (natürlich kann ich mit

Code: Alles auswählen

from helptest import *
print print ht.__doc__

den doc-String direkt ausgeben, aber ich frage mich, ob es da elegantere Methoden gibt.

Thanx in advance

ws
BlackJack

Beitragvon BlackJack » Mittwoch 21. Februar 2007, 17:48

`help()` fragt nur das `__doc__`-Attribut der Klasse ab.
Benutzeravatar
nkoehring
User
Beiträge: 543
Registriert: Mittwoch 7. Februar 2007, 17:37
Wohnort: naehe Halle/Saale
Kontaktdaten:

Beitragvon nkoehring » Mittwoch 21. Februar 2007, 18:44

was ist mit den """-Kommentaren (wie man sie auch immer gleich noch nennt)

also:

Code: Alles auswählen

class Foo:
    """ diese Klasse tut ihren Dienst...
    und das wollte ich hiermit dokumentieren """

    def __init__(self):
        #etc
Benutzeravatar
mq
User
Beiträge: 124
Registriert: Samstag 1. Januar 2005, 19:14

Beitragvon mq » Mittwoch 21. Februar 2007, 18:56

nkoehring hat geschrieben:was ist mit den """-Kommentaren (wie man sie auch immer gleich noch nennt)
Man nennt sie Docstrings :D
Benutzeravatar
nkoehring
User
Beiträge: 543
Registriert: Mittwoch 7. Februar 2007, 17:37
Wohnort: naehe Halle/Saale
Kontaktdaten:

Beitragvon nkoehring » Mittwoch 21. Februar 2007, 19:34

Hach... genau :D

Und das klingt doch ziemlich nach Documentation, nicht war :roll:
BlackJack

Beitragvon BlackJack » Mittwoch 21. Februar 2007, 19:54

Lies die Frage nochmal. Es geht darum das ws gerne den Docstring eines *Objekts* und nicht den von der *Klasse des Objekts* mit `help()` haben möchte.
Benutzeravatar
nkoehring
User
Beiträge: 543
Registriert: Mittwoch 7. Februar 2007, 17:37
Wohnort: naehe Halle/Saale
Kontaktdaten:

Beitragvon nkoehring » Mittwoch 21. Februar 2007, 20:04

:oops: ...naja, da hab ich wohl nicht ganz so akribisch gelesen :?

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder