CODEWITHSUNDEEP
pythoncross-platformhome-directory
Nathan Osman
Nathan Osman

Reputation: 73165

What is a cross-platform way to get the home directory?

I need to get the location of the home directory of the current logged-on user. Currently, I've been using the following on Linux:

os.getenv("HOME")

However, this does not work on Windows. What is the correct cross-platform way to do this ?

Upvotes: 1241

Views: 703557

Answers (5)

Dan
Dan

Reputation: 23657

On Python 3.5+ you can use pathlib.Path.home():

from pathlib import Path
home = Path.home()

# example usage:
with open(home / ".ssh" / "known_hosts") as f:
    lines = f.readlines()

to get a pathlib.PosixPath object. Use str() to convert to a string if necessary.

On older Python versions, you can use os.path.expanduser.

from os.path import expanduser
home = expanduser("~")

Upvotes: 2143

Charlie Parker
Charlie Parker

Reputation: 5201

This can be done using pathlib, which is part of the standard library, and treats paths as objects with methods, instead of strings.

from pathlib import Path

home: str = str(Path('~').expanduser())

Upvotes: 5

Tammi
Tammi

Reputation: 459

This doesn't really qualify for the question (it being tagged as cross-platform), but perhaps this could be useful for someone.

How to get the home directory for effective user (Linux specific).

Let's imagine that you are writing an installer script or some other solution that requires you to perform certain actions under certain local users. You would most likely accomplish this in your installer script by changing the effective user, but os.path.expanduser("~") will still return /root.

The argument needs to have the desired user name:

os.path.expanduser(f"~{USERNAME}/")

Note that the above works fine without changing EUID, but if the scenario previously described would apply, the example below shows how this could be used:

import os
import pwd
import grp

class Identity():

    def __init__(self, user: str, group: str = None):
        self.uid = pwd.getpwnam(user).pw_uid
        if not group:
            self.gid = pwd.getpwnam(user).pw_gid
        else:
            self.gid = grp.getgrnam(group).gr_gid

    def __enter__(self):
        self.original_uid = os.getuid()
        self.original_gid = os.getgid()
        os.setegid(self.uid)
        os.seteuid(self.gid)

    def __exit__(self, type, value, traceback):
        os.seteuid(self.original_uid)
        os.setegid(self.original_gid)

if __name__ == '__main__':

    with Identity("hedy", "lamarr"):
        homedir = os.path.expanduser(f"~{pwd.getpwuid(os.geteuid())[0]}/")
        with open(os.path.join(homedir, "install.log"), "w") as file:
            file.write("Your home directory contents have been altered")

Upvotes: -2

Jaeyoon Jeong
Jaeyoon Jeong

Reputation: 709

I found that pathlib module also supports this.

from pathlib import Path
>>> Path.home()
WindowsPath('C:/Users/XXX')

Upvotes: 42

Cow
Cow

Reputation: 3040

I know this is an old thread, but I recently needed this for a large scale project (Python 3.8). It had to work on any mainstream OS, so therefore I went with the solution @Max wrote in the comments.

Code:

import os
print(os.path.expanduser("~"))

Output Windows:

PS C:\Python> & C:/Python38/python.exe c:/Python/test.py
C:\Users\mXXXXX

Output Linux (Ubuntu):

rxxx@xx:/mnt/c/Python$ python3 test.py
/home/rxxx

I also tested it on Python 2.7.17 and that works too.

Upvotes: 26

Related Questions