Kommentarzeile vom Skript im oberen Fensterberich anzeigen

[feldmaus]

Hallöchen Leute,

In meinem Skript habe ich im oberen Teil(Kopf) Kommentare
stehen(Author, Version ...).

Dieses Skript ist eine grafische Anwendung.

In dem Title dieser Anwendung wollte ich die Versionsnummer erscheinen
lassen, die ich in dem Kopf Bereich meines Skriptes als Kommentar
nieder gschrieben habe.

Hier der Kopf meines Skriptes:

Code: Alles auswählen

#!/usr/bin/env python
##################################################
# Gnuradio Python Flow Graph
# Title: AM Receiver - Diplomarebeit
# Author: Markus Feldmann
# Description: AM Receiver
# Version: 2009-02-26-03
##################################################

Wie realisiere ich das?
Vielleicht fallen euch ja auch gute Allternativen ein ?

Ich würde ungerne 2 Versionsnummern pflegen.

Grüße Markus

[cofi]

Wenn das nicht direkt im Kommentarblock erscheinen muss, dann wäre

Code: Alles auswählen

_version = "2009-02-26-03"

das Mittel deiner Wahl. Ich sehe jedenfalls keinen Grund, warum die Version direkt im Kommentar stehen sollte, denn jeder der den Code liesst, der wird auch diese Zeile lesen

[BlackJack]

Die Namen `__version__` und `__author__` sind für solche Informationen nicht ganz unüblich. `__date__` und `__revision__` habe ich auch schon gesehen und verwendet.

[feldmaus]

Danke für eure Antworten, gibt es noch mehr solcher nützlichen Variablen?

Und wo finde ich auf der Seite,
http://docs.python.org/library/index.html
was zu diesen doc Strings ?

Grüße Markus

[BlackJack]

Das sind nur Konventionen, ich weiss nicht ob die in der Python-Dokumentation beschrieben werden. Aber auch Module in der Standardbibliothek enthalten diese Attribute teilweise. In `pydoc` findet man zum Beispiel `__author__`, `__date__`, `__version__`, und `__credits__`. Die werden auch alle von `pydoc` berücksichtigt.

Epydoc kennt `__credits__` nicht, dafür aber zum Beispiel `__copyright__` und `__license__`. Siehe 5.4 Module metadata variables in der Epydoc-Dokumentation.

[cofi]

An Docstrings ist nicht viel besonderes. Es ist der erste in einem Block vorkommende (am besten direkt nach dem Beginn des Blocks) nicht zugewiesene String und man kann auf ihn per namespace.__doc__ zugreifen.

Der Punkt warum ich dir hier von Docstrings abraten würde ist aber, dass sie dafür schlichtweg nicht gemacht wurden und ein Leser etwas nützliches finden will, wenn er sich das anschaut - speziell in einer (i)python-Sitzung. Im Klartext: Der Leser will eine Beschreibung was das Modul macht, wenn er sich dessen Docstring anschaut und nicht wer das geschrieben hat und andrer Kram.

Zu den Variablen: Du musst ja keine besonderen nehmen, aber du solltest darauf achten, dass sie eben als "privat" behandelt werden, d.h. min ein Unterstrich am Anfang.