`open_fs("$HOME")` does not work

[tfeldmann]

I think os.expandvars needs to be called before abspath in the opener.

Example:

from fs import open_fs
>>> open_fs("~")
OSFS('/Users/tf')

>>> open_fs("$HOME")
...[snip]...
fs.errors.CreateFailed: root path '/Users/tf/Desktop/Users/tf' does not exist

I found the same unintuitive behavior on windows (open_fs("%USERPROFILE%")).
The user profile path is appended to the current working dir.

[lurch]

You could argue that calling os.expandvars is the job of user-code, rather than pyfilesystem-code? 🤷 Because it's entirely possible to have a directory named $HOME:

$ cd /tmp
$ mkdir \$HOME
$ cd \$HOME
$ pwd
/tmp/$HOME

[tfeldmann]

I see, but that's what the expand_vars option is for, isn't it? Wouldn't it be nicer if
OSFS("$HOME") and open_fs("osfs://$HOME") had the same result?

[lurch]

Wouldn't it be nicer if OSFS("$HOME") and open_fs("osfs://$HOME") had the same result?

Oh! I hadn't realised that expand_vars defaults to True https://github.com/PyFilesystem/pyfilesystem2/blob/master/fs/osfs.py#L97

If https://github.com/PyFilesystem/pyfilesystem2/blob/master/fs/osfs.py#L125 does both os.path.expandvars and os.path.expanduser, then perhaps it makes sense for https://github.com/PyFilesystem/pyfilesystem2/blob/master/fs/opener/osfs.py#L38 to also use both, rather than only doing os.path.expanduser ?
OTOH, given that there's (currently) no option to control the expand_vars behaviour for osfs:// URLs, perhaps this would be a backwards-incompatible change? 🤷

(On a side-note, I wonder if it even makes sense for https://github.com/PyFilesystem/pyfilesystem2/blob/master/fs/opener/osfs.py#L38 to be calling os.path.expanduser, given that the OSFS init-method always calls it too?)

[lurch]

Side-note 2: I've not played with FS-URLs and the fs-opener stuff, but why does https://github.com/PyFilesystem/pyfilesystem2/blob/master/fs/opener/osfs.py#L38 unconditionally do join(cwd, ... ? Shouldn't it only try to prepend the cwd to the FS-URL path, if the FS-URL path is relative rather than absolute? 🤷

[tfeldmann]

Yes I wondered about that, too. Maybe expand_vars could be a parameter of fs.open_fs? That way one could pass an FTP password via an env variable.

[althonos]

Yes, we could probably provide expand_vars as an fs.open_fs parameter, which would however default to False for backward compatibility!

[edgarrmondragon]

@althonos Instead of making expand_vars a parameter of fs.open_fs which is not specific to OSFS, wdyt of making the expand_vars a URL param that gets passed to OSFS in

pyfilesystem2/fs/opener/osfs.py

Line 40 in 59f6e4d

osfs = OSFS(path, create=create)

in a similar manner to FTPFS

pyfilesystem2/fs/opener/ftpfs.py

Lines 43 to 51 in 59f6e4d

	ftp_fs = FTPFS(
	ftp_host,
	port=ftp_port,
	user=parse_result.username,
	passwd=parse_result.password,
	proxy=parse_result.params.get("proxy"),
	timeout=int(parse_result.params.get("timeout", "10")),
	tls=bool(parse_result.protocol == "ftps"),
	)

So, something like

+          expand_vars = parse_result.params.get("expand_vars", "true").lower() == "true"
-          osfs = OSFS(path, create=create)
+          osfs = OSFS(path, create=create, expand_vars=expand_vars)