Dokumentation und Introspection

In Python ausgefeilte Mechanismen zur Dokumentation von Funktionen und Klassen sowie zur Abfrage von Informationen.

• Docstring: Es ist Python Konvention in die erste Zeile nach Definition einer Klasse oder Funktion in einem Textstring eine Kurzbeschreibung der Klasse/Funktion zu machen. Diese Beschreibung ist mehr als ein Kommentar, sie kann zusammen mit der Klasse/Funktion zur Laufzeit abgefragt werden.

  class ThreeVec:
      "Class for 3 Vector and operations"
      def Add( self, tv ): # add two 3 vecs
          "Add two ThreeVecs"
          newvec = ThreeVec( self.x+tv.x, self.y+tv.y, self.z+tv.z)
          return newvec
  #
  

• Entsprechende Info zur Laufzeit abfragbar:
  print ThreeVec.__doc__ oder
  print ThreeVec.Add.__doc__
• oder sehr komfortabel interaktiv mit help(ThreeVec)

  Help on class ThreeVec in module ThreeVec: 
  
  class ThreeVec 
   |  Class for 3 Vector and operations
   |
   |  Methods defined here:
   |
   |  Add(self, tv)
   |
   |  Length(self)
   |
   |  SkalProd(self, tv)
   |
   |  __add__(self, tv)
   |      method for overloading the + operator
   |
   |  __cmp__(self, tv)
   |
   |  __init__(self, x=0.0, y=0.0, z=0.0)
   |
   |  __str__(self)
  ...
  

• oder Basis–Info zu Methoden: dir(ThreeVec)

  ['Add', 'Length', 'SkalProd', '__add__', '__cmp__', '__doc__', 
  '__init__', '__module__', '__str__']
  

• genauso für Objekte, Info zu Methoden und Variablen:
  v = ThreeVec(4.,5.,7.); dir(v)

  ['Add', 'Length', 'SkalProd', '__add__', '__cmp__', '__doc__', 
  '__init__', '__module__', '__str__', 'x', 'y', 'z']
  

• und schliesslich noch Abfrage von Typ über type(Object) oder direkt Object.__class__.__name__

  >>> a=5.2
  >>> b=[1,6,"abc"]
  >>> c="Hello"
  >>> type(a)
  <type 'float'>
  >>> type(b)
  <type 'list'>
  >>> type(c)
  <type 'str'>
  >>> type(v)
  <type 'instance'>
  >>> c.__class__.__name__
  'str'
  >>> b.__class__.__name__
  'list'
  >>> v.__class__.__name__
  'ThreeVec'