pythonwindowsunixpathcross-platform

Using absolute unix paths in windows with python


I'm creating an application that stores blob files into the hard drive, but this script must run in both Linux and Windows, the issue is that I want to give it an absolute path from the filesystem root and not one relative to the project files. This is because I'm using git and don't want to deal with excluding all these files from syncing.

So I would like to have something like this:

path = '/var/lib/blob_files/'
file = open(path+'myfile.blob', 'w')

and get a file in Unix at:

/var/lib/blob_files/myfile.blob

and in Windows at:

C:\var\lib\blob_files\myfile.blob

It could also be relative to the user home folder (/home/user in Unix and C:\Users\User in Windows) but I guess the problem is very similar.

How can I achieve this? Is there any library or function that can help me transparently to convert this path without having to ask in what platform is the script running all the time?

Of my two options, absolute from root or relative from home folder, which one do you recommend to use?


Solution

  • Use os.path.abspath(), and also os.path.expanduser() for files relative to the user's home directory:

    print os.path.abspath("/var/lib/blob_files/myfile.blob")
    >>> C:\var\lib\blob_files\myfile.blob
    
    print os.path.abspath(os.path.expanduser("~/blob_files/myfile.blob"))
    >>> C:\Users\jerry\blob_files\myfile.blob
    

    These will "do the right thing" for both Windows and POSIX paths.

    expanduser() won't change the path if it doesn't have a ~ in it, so you can safely use it with all paths. Thus, you can easily write a wrapper function:

    import os
    def fixpath(path):
        return os.path.abspath(os.path.expanduser(path))
    

    Note that the drive letter used will be the drive specified by the current working directory of the Python process, usually the directory your script is in (if launching from Windows Explorer, and assuming your script doesn't change it). If you want to force it to always be C: you can do something like this:

    import os
    def fixpath(path):
        path = os.path.normpath(os.path.expanduser(path))
        if path.startswith("\\"): return "C:" + path
        return path