[issue13561] os.listdir documentation should mention surrogateescape

[STINNER Victor]

STINNER Victor  added the comment:

> I think this was added in another section of this doc. See the second 
> paragraph in 
> https://docs.python.org/3/library/os.html#file-names-command-line-arguments-and-environment-variables

Right, this section now explains encodings and the error handler.

Moreover, I recently reworked the documentation of the filesystem encoding and 
error handler:
* 
https://docs.python.org/dev/glossary.html#term-filesystem-encoding-and-error-handler
* https://docs.python.org/dev/library/os.html#python-utf-8-mode
* https://docs.python.org/dev/library/sys.html#sys.getfilesystemencoding
* etc.

I consider that it's now enough, I close the issue ;-) If someone wants to 
enhance the doc, please submit a PR. This issue is now quite old :-)

--
resolution:  -> fixed
stage: needs patch -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13561] os.listdir documentation should mention surrogateescape

[Irit Katriel]

Irit Katriel  added the comment:

I think this was added in another section of this doc. See the second paragraph 
in 
https://docs.python.org/3/library/os.html#file-names-command-line-arguments-and-environment-variables

--
nosy: +iritkatriel

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13561] os.listdir documentation should mention surrogateescape

[Éric Araujo]

Éric Araujo  added the comment:

Patch looks good, apart from a missing “the”, but I think it should be 
expanded: Right now it tells that surrogateescape is used, but IMO it would be 
more useful if it also mentioned practical implications, i.e. what Michael “The 
Beard” Foord says in the first message.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13561] os.listdir documentation should mention surrogateescape

[misdre]

misdre  added the comment:

Added a small patch to mention surrogateescape and PEP 383.

--
keywords: +patch
nosy: +misdre
Added file: http://bugs.python.org/file23998/listdir-pep383.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13561] os.listdir documentation should mention surrogateescape

[STINNER Victor]

STINNER Victor  added the comment:

Can you please write a doc patch?

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13561] os.listdir documentation should mention surrogateescape

[Éric Araujo]

Changes by Éric Araujo :


--
nosy: +eric.araujo, haypo, loewis

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13561] os.listdir documentation should mention surrogateescape

[Michael Foord]

New submission from Michael Foord :

Where os.listdir encounters undecodable bytes from the filesystem it uses the 
surrogateescape handler. As the resulting strings are invalid they can't be 
encoded without an errorhandler, and so can't be printed (for example).

This should be documented.

--
assignee: docs@python
components: Documentation
messages: 149070
nosy: docs@python, michael.foord
priority: normal
severity: normal
stage: needs patch
status: open
title: os.listdir documentation should mention surrogateescape
versions: Python 3.3

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com