Python vraag over """

[henkoegema]

Een Python program waaraan ik werk, begint met de volgende twee lijnen

#!/usr/bin/env python
"""

Wat is de functie (betekenis) van de 2e lijn.  (3x een aanhalingsteken)?

[henkoegema]

Kan het soms zijn dat het het begin van een kommentaar aanduidt, om dat ik het verder in het programma nog een keer zie staan?
Het valt me op dat wat er tussen staat alleen maar kommentaat is.

Of zie ik dit verkeerd?

[Nunslaughter]

Alles tussen triple quotes is een string, er zal dus verder in de code nog eens """ voorkomen.

Triple quotes worden voor 2 dingen gebruikt:
  1) Om makkelijk een multiregel string aan te maken:

Code: [Selecteer]

s = """regel 1
regel 2
regel 3"""
# Kan natuurlijk ook met gewone quotes
s = "regel 1"\
"regel 2"\
"regel 3"
# Of iets makkelijker
s = ("regel 1"
"regel 2"
"regel 3")

  2) als documentatie string. Dit kan zowel voor een module, class of functie zijn:

Code: [Selecteer]

# my_module.py
""" Dit is de module docstring.

Schrijf hier wat deze module doet of waarvoor ze bedoeld is."""

class Foo:
    """ Docstring voor de Foo class. Geef wat meer uitleg hier. """
    def bar(x, y):
        """ Leg even uit wat deze functie doet, en eventueel welke argumenten verwacht worden."""
        return x + y


Dit kan dan op 2 manieren gebruikt worden: automatisch generen van documentatie of via de builtin help() functie in de interpreter.

Code: [Selecteer]

help(my_module)
help(Foo)
help(Foo.bar)

[henkoegema]

Bedankt voor je uitleg.

Het is nu duidelijk.