Skip to content

bpo-36264: Updates documentation for change to expanduser on Windows #12294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zooba merged 2 commits into from
Mar 12, 2019
Merged

bpo-36264: Updates documentation for change to expanduser on Windows #12294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
463bafb
bpo-36264: Updates documentation for change to expanduser on Windows
zooba Mar 12, 2019
4636f9a
Also add to API Changes section
zooba Mar 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions Doc/library/os.path.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,17 +172,20 @@ the :mod:`glob` module.)
password directory through the built-in module :mod:`pwd`. An initial ``~user``
is looked up directly in the password directory.

On Windows, :envvar:`HOME` and :envvar:`USERPROFILE` will be used if set,
otherwise a combination of :envvar:`HOMEPATH` and :envvar:`HOMEDRIVE` will be
used. An initial ``~user`` is handled by stripping the last directory component
from the created user path derived above.
On Windows, :envvar:`USERPROFILE` will be used if set, otherwise a combination
of :envvar:`HOMEPATH` and :envvar:`HOMEDRIVE` will be used. An initial
``~user`` is handled by stripping the last directory component from the created
user path derived above.

If the expansion fails or if the path does not begin with a tilde, the path is
returned unchanged.

.. versionchanged:: 3.6
Accepts a :term:`path-like object`.

.. versionchanged:: 3.8
No longer uses :envvar:`HOME` on Windows.

.. index::
single: $ (dollar); environment variables expansion
single: % (percent); environment variables expansion (Windows)
Expand Down
8 changes: 8 additions & 0 deletions Doc/whatsnew/3.8.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,10 @@ now return ``False`` instead of raising :exc:`ValueError` or its subclasses
characters or bytes unrepresentable at the OS level.
(Contributed by Serhiy Storchaka in :issue:`33721`.)

:func:`~os.path.expanduser` on Windows now prefers the :envvar:`USERPROFILE`
environment variable and does not use :envvar:`HOME`, which is not normally set
for regular user accounts.


ncurses
-------
Expand Down Expand Up @@ -672,6 +676,10 @@ Changes in the Python API
:exc:`dbm.gnu.error` or :exc:`dbm.ndbm.error`) instead of :exc:`KeyError`.
(Contributed by Xiang Zhang in :issue:`33106`.)

* :func:`~os.path.expanduser` on Windows now prefers the :envvar:`USERPROFILE`
environment variable and does not use :envvar:`HOME`, which is not normally
set for regular user accounts.


CPython bytecode changes
------------------------
Expand Down