Mailman 3 June 2010 - docs

[issue8895] newline vs. newlines in io module
by Éric Araujo June 4, 2010

June 4, 2010

Éric Araujo <merwok(a)netwok.org> added the comment: Could you think of a way to improve the docs on that point? ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8895> _______________________________________

2 1

[issue8890] Modules have dangerous examples in documentation
by Henri Salo June 4, 2010

June 4, 2010

Changes by Henri Salo <henri(a)nerv.fi>: ---------- title: Module logging has dangerous examples -> Modules have dangerous examples in documentation _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8890> _______________________________________

1 0

[issue8890] Module logging has dangerous examples
by Henri Salo June 4, 2010

June 4, 2010

Henri Salo <henri(a)nerv.fi> added the comment: Please review the changes for the quality of the documentation. There probably is still more places to change. References can be made to: <http://docs.python.org/library/tempfile.html#tempfile.mkstemp> ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8890> _______________________________________

1 0

[issue8895] newline vs. newlines in io module
by Éric Araujo June 4, 2010

June 4, 2010

Changes by Éric Araujo <merwok(a)netwok.org>: Removed file: http://bugs.python.org/file17549/unnamed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8895> _______________________________________

1 0

[issue8890] Module logging has dangerous examples
by Éric Araujo June 4, 2010

June 4, 2010

Éric Araujo <merwok(a)netwok.org> added the comment: Thanks for the listing Henri. Not all of these examples have to be changed; I’ll review them in some days if you want. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8890> _______________________________________

1 0

[issue8890] Module logging has dangerous examples
by Vinay Sajip June 4, 2010

June 4, 2010

Vinay Sajip <vinay_sajip(a)yahoo.co.uk> added the comment: Other logging cases contained /tmp/ has now been removed, the missing parenthesis added and the result checked in to trunk (r81684). I'll keep the issue open for the cases which remain in the other documentation. but remove myself from the assigned-to and change the resolution to "accepted". ---------- assignee: vinay.sajip -> resolution: fixed -> accepted _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8890> _______________________________________

1 0

[issue8895] newline vs. newlines in io module
by R. David Murray June 4, 2010

June 4, 2010

R. David Murray <rdmurray(a)bitdance.com> added the comment: This is as documented: http://docs.python.org/dev/3.0/library/io.html#io.TextIOBase.newlines The keyword argument is named 'newline', the attribute is named 'newlines'. The attribute does not record what was passed to the newline argument, rather it records what newlines have been actually encountered. ---------- nosy: +r.david.murray resolution: -> invalid stage: needs patch -> committed/rejected status: open -> closed type: -> behavior _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8895> _______________________________________

2 1

[issue8895] newline vs. newlines in io module
by Éric Araujo June 4, 2010

June 4, 2010

Éric Araujo <merwok(a)netwok.org> added the comment: Thanks for the report. Could you check the docs for 3.1 and 3.x trunk (py3k) too? ---------- assignee: -> docs@python components: +Documentation -IO nosy: +docs@python, merwok stage: -> needs patch title: newline arg/attribute in the module io -> newline vs. newlines in io module _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8895> _______________________________________

1 0

[issue8890] Module logging has dangerous examples
by Henri Salo June 4, 2010

June 4, 2010

Henri Salo <henri(a)nerv.fi> added the comment: We should review all of these: install/index.rst: python setup.py build --build-base=/tmp/pybuild/foo-1.0 install/index.rst: python setup.py install --install-base=/tmp install/index.rst:would install pure modules to :file:`{/tmp/python/lib}` in the first case, and install/index.rst:to :file:`{/tmp/lib}` in the second case. (For the second case, you probably install/index.rst:want to supply an installation base of :file:`/tmp/python`.) library/pipes.rst: >>> f=t.open('/tmp/1', 'w') library/pipes.rst: >>> open('/tmp/1').read() library/mailcap.rst: >>> mailcap.findmatch(d, 'video/mpeg', filename='/tmp/tmp1223') library/mailcap.rst: ('xmpeg /tmp/tmp1223', {'view': 'xmpeg %s'}) library/logging.rst: LOG_FILENAME = '/tmp/logging_rotatingfile_example.out' library/logging.rst: /tmp/logging_rotatingfile_example.out library/logging.rst: /tmp/logging_rotatingfile_example.out.1 library/logging.rst: /tmp/logging_rotatingfile_example.out.2 library/logging.rst: /tmp/logging_rotatingfile_example.out.3 library/logging.rst: /tmp/logging_rotatingfile_example.out.4 library/logging.rst: /tmp/logging_rotatingfile_example.out.5 library/logging.rst:The most current file is always :file:`/tmp/logging_rotatingfile_example.out`, library/logging.rst: filename='/tmp/myapp.log', library/logging.rst:which results in output (written to ``/tmp/myapp.log``) which should look library/atexit.rst: _count = int(open("/tmp/counter").read()) library/atexit.rst: open("/tmp/counter", "w").write("%d" % _count) library/imghdr.rst: >>> imghdr.what('/tmp/bass.gif') library/tempfile.rst: '/var/folders/5q/5qTPn6xq2RaWqk+1Ytw3-U+++TI/-Tmp-/tmpG7V1Y0' library/tempfile.rst: * On all other platforms, the directories :file:`/tmp`, :file:`/var/tmp`, and library/tempfile.rst: :file:`/usr/tmp`, in that order. library/posixfile.rst: file = posixfile.open('/tmp/test', 'w') library/cgi.rst: cgitb.enable(display=0, logdir="/tmp") library/optparse.rst: prog -v --report /tmp/report.txt foo bar library/optparse.rst:takes one argument, ``"/tmp/report.txt"`` is an option argument. ``"foo"`` and library/rexec.rst: :file:`/tmp` or uploading it to the :file:`/incoming` directory of your public library/rexec.rst::file:`/tmp` to be written, we can subclass the :class:`RExec` class:: library/rexec.rst: # check filename : must begin with /tmp/ library/rexec.rst: if file[:5]!='/tmp/': library/rexec.rst: raise IOError("can't write outside /tmp") library/rexec.rst:called :file:`/tmp/foo/../bar`. To fix this, the :meth:`r_open` method would library/rexec.rst:have to simplify the filename to :file:`/tmp/bar`, which would require splitting library/compiler.rst::file:`/tmp/doublelib.py`. :: library/compiler.rst: >>> mod = compiler.parseFile("/tmp/doublelib.py") library/zipimport.rst:subdirectory. For example, the path :file:`/tmp/example.zip/lib/` would only library/zipimport.rst: $ unzip -l /tmp/example.zip library/zipimport.rst: Archive: /tmp/example.zip library/zipimport.rst: >>> sys.path.insert(0, '/tmp/example.zip') # Add .zip file to front of path library/zipimport.rst: '/tmp/example.zip/jwzthreading.py' library/trace.rst: # make a report, placing output in /tmp library/trace.rst: r.write_results(show_missing=True, coverdir="/tmp") library/nntplib.rst: >>> f = open('/tmp/article') library/bsddb.rst: >>> db = bsddb.btopen('/tmp/spam.db', 'c') library/sqlite3.rst::file:`/tmp/example` file:: library/sqlite3.rst: conn = sqlite3.connect('/tmp/example') tutorial/inputoutput.rst: >>> f = open('/tmp/workfile', 'w') tutorial/inputoutput.rst: <open file '/tmp/workfile', mode 'w' at 80a0960> tutorial/inputoutput.rst: >>> f = open('/tmp/workfile', 'r+') tutorial/inputoutput.rst: >>> with open('/tmp/workfile', 'r') as f: whatsnew/2.3.rst: amk@nyman:~/src/python$ unzip -l /tmp/example.zip whatsnew/2.3.rst: Archive: /tmp/example.zip whatsnew/2.3.rst: >>> sys.path.insert(0, '/tmp/example.zip') # Add .zip file to front of path whatsnew/2.3.rst: '/tmp/example.zip/jwzthreading.py' whatsnew/2.3.rst:subdirectory; for example, the path :file:`/tmp/example.zip/lib/` would only whatsnew/2.3.rst: >>> os.stat("/tmp").st_mtime whatsnew/2.3.rst: >>> os.stat("/tmp").st_mtime whatsnew/2.0.rst: output = UTF8_streamwriter( open( '/tmp/output', 'wb') ) whatsnew/2.0.rst: input = UTF8_streamreader( open( '/tmp/output', 'rb') ) whatsnew/2.6.rst: shutil.copytree('Doc/library', '/tmp/library', whatsnew/2.6.rst: # to the /tmp directory. whatsnew/2.6.rst: z.extract('Python/sysmodule.c', '/tmp') whatsnew/2.6.rst: plistlib.writePlist(data_struct, '/tmp/customizations.plist') whatsnew/2.6.rst: new_struct = plistlib.readPlist('/tmp/customizations.plist') whatsnew/2.7.rst: -> ./python.exe argparse-example.py -v -o /tmp/output -C 4 file1 file2 whatsnew/2.7.rst: {'output': '/tmp/output', whatsnew/2.4.rst: sts = subprocess.call(['dpkg', '-i', '/tmp/new-package.deb']) whatsnew/2.4.rst: sts = subprocess.call('dpkg -i /tmp/new-package.deb', shell=True) whatsnew/2.5.rst: dest = mailbox.mbox('/tmp/mbox') whatsnew/2.5.rst::file:`/tmp/example` file:: whatsnew/2.5.rst: conn = sqlite3.connect('/tmp/example') I can't change the status of resolution. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8890> _______________________________________

1 0

[issue8890] Module logging has dangerous examples
by Henri Salo June 4, 2010

June 4, 2010

Henri Salo <henri(a)nerv.fi> added the comment: Please note that there is other similar examples as well. Even on the same page. ---------- status: closed -> open _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8890> _______________________________________

1 0