Most examples in documentation do not log messages and errors

[email protected] Sun, 06 Sep 2009 19:50:47 -0000
Newsgroups gmane.comp.python.twisted.bugs
Message-ID <[email protected]>
New submission from ivank <[email protected]>:

Most of the examples in the documentation don't log anywhere. This is a problem because things often go wrong, and silent failures are bad.

{{{
Projects/Twisted/doc]# for i in */examples/*.py; do echo -n $i; echo -n "\t"; grep "startLogging" $i; echo; done
conch/examples/sshsimpleclient.py
conch/examples/sshsimpleserver.py       log.startLogging(sys.stderr)

core/examples/ampclient.py
core/examples/ampserver.py
core/examples/bananabench.py
core/examples/chatserver.py
core/examples/courier.py        log.startLogging(open(LOGFILE, 'a'))

core/examples/cred.py       log.startLogging(sys.stdout)

core/examples/dbcred.py     log.startLogging(sys.stdout)

core/examples/echoclient.py
core/examples/echoclient_ssl.py
core/examples/echoclient_udp.py
core/examples/echoserv.py
core/examples/echoserv_ssl.py       log.startLogging(sys.stdout)

core/examples/echoserv_udp.py
core/examples/filewatch.py
core/examples/ftpclient.py
core/examples/ftpserver.py
core/examples/gpsfix.py     log.startLogging(logFile)

core/examples/longex2.py
core/examples/longex.py     log.startLogging(sys.stdout)

core/examples/mouse.py      log.startLogging(logFile)

core/examples/pbbenchclient.py
core/examples/pbbenchserver.py
core/examples/pbechoclient.py
core/examples/pbecho.py
core/examples/pb_exceptions.py
core/examples/pbgtk2.py
core/examples/pbinterop.py
core/examples/pbsimpleclient.py
core/examples/pbsimple.py
core/examples/postfix.py        log.startLogging(sys.stdout)

core/examples/ptyserv.py
core/examples/pyuidemo.py
core/examples/rotatinglog.py    log.startLogging(f)

core/examples/row_example.py
core/examples/row_util.py
core/examples/shaper.py
core/examples/shoutcast.py
core/examples/simpleclient.py
core/examples/simpleserv.py
core/examples/stdin.py
core/examples/stdiodemo.py
core/examples/testlogging.py        log.startLogging(sys.stdout)
# after startLogging

core/examples/wxacceptance.py       log.startLogging(sys.stdout)

core/examples/wxdemo.py     log.startLogging(sys.stdout)

mail/examples/imap4client.py        log.startLogging(sys.stdout)

mail/examples/smtpclient_tls.py         log.startLogging(sys.stdout)

names/examples/dns-service.py
names/examples/gethostbyname.py
names/examples/testdns.py
pair/examples/pairudp.py
web2/examples/demo.py
web2/examples/hello.py
web/examples/advogato.py
web/examples/dlpage.py
web/examples/fortune.rpy.py
web/examples/getpage.py
web/examples/google.py
web/examples/hello.rpy.py
web/examples/httpclient.py
web/examples/lj.rpy.py
web/examples/proxy.py
web/examples/report.rpy.py
web/examples/rootscript.py
web/examples/silly-web.py
web/examples/soap.py
web/examples/users.rpy.py
web/examples/vhost.rpy.py
web/examples/webguard.py            log.startLogging(sys.stdout)

web/examples/web.py
web/examples/xmlrpcclient.py
web/examples/xmlrpc.py
words/examples/aimbot.py
words/examples/cursesclient.py
words/examples/ircLogBot.py         log.startLogging(sys.stdout)

words/examples/jabber_client.py
words/examples/minchat.py
words/examples/msn_example.py       log.startLogging(sys.stdout)

words/examples/oscardemo.py
words/examples/pb_client.py         log.startLogging(sys.stdout)

words/examples/xmpp_client.py
}}}

----------
Type     : enhancement
Component: core
Keywords : documentation
Priority : normal
Nosy     : 
----------
http://twistedmatrix.com/trac/ticket/4008