add os.fspath()

[ethanfurman]

BPO	27186
Nosy	@brettcannon, @ethanfurman, @vadmium, @serhiy-storchaka, @JelleZijlstra, @buchuki, @erikjanss
Files	issue27186-fsencode.buchuki.patch issue27186.patch: patch to add os.fspath and PyOS_FsPath issue27186-DirEntry-fspath.patch: adds fspath support to os.DirEntry issue27186-pathlib.buchuki.patch issue27186-glossary.buchuki.patch: path-like glossary entry issue27186-DirEntry-fspath.patch: patch to add fspath support to os.DirEntry issue27186-os_path_t.patch: patch for the path_t converter in os

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/brettcannon'
closed_at = <Date 2016-06-24.19:28:56.707>
created_at = <Date 2016-06-02.18:22:21.760>
labels = ['type-feature']
title = 'add os.fspath()'
updated_at = <Date 2018-08-13.23:04:39.687>
user = 'https://github.com/ethanfurman'

bugs.python.org fields:

activity = <Date 2018-08-13.23:04:39.687>
actor = 'erikjanss'
assignee = 'brett.cannon'
closed = True
closed_date = <Date 2016-06-24.19:28:56.707>
closer = 'brett.cannon'
components = []
creation = <Date 2016-06-02.18:22:21.760>
creator = 'ethan.furman'
dependencies = []
files = ['43124', '43125', '43128', '43133', '43155', '43205', '43215']
hgrepos = []
issue_num = 27186
keywords = ['patch']
message_count = 45.0
messages = ['266971', '266979', '266982', '266984', '267004', '267105', '267127', '267285', '267293', '267295', '267299', '267301', '267306', '267316', '267322', '267327', '267328', '267336', '267348', '267429', '267465', '268060', '268062', '268070', '268146', '268158', '268329', '268393', '268394', '268399', '268414', '268415', '268433', '268457', '268628', '269204', '269205', '269207', '269208', '269209', '269795', '269800', '323225', '323228', '323495']
nosy_count = 8.0
nosy_names = ['brett.cannon', 'ethan.furman', 'python-dev', 'martin.panter', 'serhiy.storchaka', 'JelleZijlstra', 'buchuki', 'erikjanss']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue27186'
versions = ['Python 3.6']

[python-dev]

New changeset 59a52a9dd0dc by Ethan Furman in branch 'default':
bpo-27186 -- initial docs, tests, and python version of os.fspath
https://hg.python.org/cpython/rev/59a52a9dd0dc

[buchuki]

Make os.fsencode and os.fsdecode able to accept a PathLike by calling into fspath. Additionally adds test for PathLike objects.

[buchuki]

Test __fspath__ returning bytes as well.

[JelleZijlstra]

This patch adds the C implementation (copied from the PEP).

Some notes:

• I added a new .h file in Include/ because there didn't seem to be an obvious existing place to put it.
• There was some uncertainty about whether we should Py_INCREF the string or bytes returned when a string/bytes is passed in. Running test -l and -L works with the Py_INCREF in and we're adding a new reference to the module, so I think this is correct.

[buchuki]

This patch adds fspath protocol and constructor initialization to pathlib.Path.

[ethanfurman]

Note: My schedule changed -- I won't be at the sprints today, but tomorrow. I'll finish reviewing these patches and commit this afternoon if no one beats me to it.

[buchuki]

Adding a glossary entry for path-like. The references are all correct except:

:class:`os.PathLike` doesn't link to anything because PathLike hasn't been added to the os module yet. Similarly, :meth:`__fspath__` does not link to anything, although I think this is acceptable.

[ethanfurman]

Dusty: The pathlib tests looks like it's only testing the PurePath implementation; while this /should/ be sufficient, please add tests for the other classes as well.

[python-dev]

New changeset 780cbe18082e by Ethan Furman in branch 'default':
bpo-27186: add C version of os.fspath(); patch by Jelle Zijlstra
https://hg.python.org/cpython/rev/780cbe18082e

[ethanfurman]

New changeset 00991aa5fdb5 by Ethan Furman in branch 'default':
bpo-27182: update fsencode and fsdecode for os.path(); patch by Dusty Phillips
https://hg.python.org/cpython/rev/00991aa5fdb5

(had wrong issue # in commit)

[ethanfurman]

Jelle: the DirEntry patch looks good so far, but it needs a test for a bytes path.

[JelleZijlstra]

Thanks for reviewing. This patch adds tests with a bytes DirEntry.

[python-dev]

New changeset e672cf63d08a by Ethan Furman in branch 'default':
bpo-27186: add PathLike ABC
https://hg.python.org/cpython/rev/e672cf63d08a

[python-dev]

New changeset 76b2ddaee6bd by Ethan Furman in branch 'default':
bpo-27186: fix fsencode/fsdecode and update tests; patch by Jelle Zijlstra
https://hg.python.org/cpython/rev/76b2ddaee6bd