IPython 8.4.0 Pypi GitHub Homepage
Other Docs
ParametersBackRef
get_home_dir(require_writable=False) -> str

Uses os.path.expanduser('~'), and checks for writability.

See stdlib docs for how this is determined. For Python <3.8, $HOME is first priority on ALL platforms. For Python >=3.8 on Windows, %HOME% is no longer considered.

Parameters

require_writable : bool [default: False]

if True:

guarantees the return value is a writable directory, otherwise raises HomeDirError

if False:

The path is resolved, but it is not guaranteed to exist or be writable.

Return the 'home' directory, as a unicode string.

Examples

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

IPython.paths.get_ipython_dir

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


GitHub : /IPython/utils/path.py#157
type: <class 'function'>
Commit: