Changeset 217

Timestamp:

06/30/2010 06:00:43 PM (13 years ago)

Author:

marcus

Message:

Work on doctest and some preparation for sphinx (see #17).

Todo: adopt numpy docstring style and the pre-processor (see
​http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines and
​http://svn.scipy.org/svn/numpy/trunk/doc/example.py and
​http://projects.scipy.org/numpy/browser/trunk/doc/sphinxext/numpydoc.py
and ​http://sphinx.pocoo.org/ext/autodoc.html#docstring-preprocessing).

• Diese und die folgenden Zeilen werden ignoriert --

M src/SeismicHandler/commands/echo.py

File:

• SHX/trunk/src/SeismicHandler/commands/echo.py (modified) (3 diffs)

SHX/trunk/src/SeismicHandler/commands/echo.py

@@ -21 +21 @@
 class echo(BaseCommand):
     """
-    command ECHO <text1>[;<text2>[;...;<textN>]]
+    A command for printing text on several output channels. Valid only for
+    script parsing, since python offers this function out-of-the-box.
+
+    Basic usage in scripting language
+    ---------------------------------
+
+    ECHO <text1>[;<text2>[;...;<textN>]]
 
     Writes text to echo channel (set by ECHO_CH command).  Default output
@@ -27 +33 @@
     displayed, separated by blanks.
 
-    parameters:
+    Parameters
+    ----------
 
-    <text1>, <text2>, ..., <textN>  ---  parameter type: string
-       Text to be written to echo channel, parameters are separated by
+    text1, text2 : string
+       Text(s) to be written to echo channel, parameters are separated by
        blanks.
 
-    qualifiers:
+    Qualifiers
+    ----------
 
-    /NO_LF
+    NO_LF
        Writes no line feed at the of the line.  Next ECHO command
        overwrites this one.
 
-    /NO_CRLF
+    NO_CRLF
        Writes no line feed and no carriage return at the end of the
        line.  Next ECHO text is appended to this one.
 
-    Examples:
+    Examples
+    --------
 
-       ECHO THIS IS A TEST           ! writes string "THIS IS A TEST" to
-                                     ! the currently selected ECHO-file
+    ``ECHO THIS IS A TEST`` :
+        Writes string "THIS IS A TEST" to the currently selected echo channel.
 
-       ECHO DISTANCE ^DISTANCE(2)    ! writes string "DISTANCE " and value
-                                     ! of distance information of second trace
-                                     ! on display to the currently selected
-                                     ! ECHO-file
+    ``ECHO DISTANCE ^DISTANCE(2)`` :
+        Writes string "DISTANCE " and value of distance information of second
+        trace on display to the currently selected echo channel.
+
+    >>> import sys                       # In order to have some test routine,
+    >>> from StringIO import StringIO    # we need to fetch the output channel.
+    >>> newout = StringIO()
+    >>> oldout, Settings.echo_channel = Settings.echo_channel, newout
+    >>> _ = echo("foo", "bar", NO_CRLF=True) # no line feed
+    >>> newout.getvalue()
+    'foo bar'
+    >>> _ = echo("qux")
+    >>> newout.getvalue()[:-1] # skip the line break
+    'foo bar qux'
+    >>> Settings.echo_channel = oldout   # restore output channel
     """
 
@@ -71 +91 @@
 
 if __name__ == "__main__":
-    echo("test 2", "laal", NO_CRLF=True)
+    import doctest
+    doctest.testmod(exclude_empty=True)