Add audeer.script_dir()

[hagenw]

Very often, I add the following to the top of a script:

CURRENT_DIR = os.path.dirname(os.path.realpath(__file__))

and I need to google it every time.

To make it easier to remember, this pull request proposes to add audeer.script_dir() which can be used instead.
When called in an interactive session, it returns the directory the user is located in.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.0%. Comparing base (b24d6c7) to head (66fc3c5).

Additional details and impacted files

Files	Coverage Δ
audeer/__init__.py	100.0% <100.0%> (ø)
audeer/core/io.py	100.0% <100.0%> (ø)

[frankenjoe]

Haha, just this morning I had the very same idea that such a function would be a good extension to audeer :)

[hagenw]

Hehe, great, I still wonder why I hadn't the idea earlier than today.

[frankenjoe]

I wonder if the name current_dir() could be misleading. A user might expect it returns the current working directory. So maybe we should rename to script_dir()?

[hagenw]

I found current_dir() a nice fit, as the variable name in the script was always CURRENT_DIR. But you are right, inside a script it might be misleading as it returns the script dir. On the other hand, in an interactive session it returns the current working directory.
So, it is actually a mixture of script_dir() and current_working_dir(). A correct term might be caller_dir(), but I doubt that this name is a good choice.

[frankenjoe]

On the other hand, in an interactive session it returns the current working directory.

You have already documented the behavior when no script file exists, e.g. in an interactive session. So I think it is ok to still call it script_dir() or maybe current_script_dir() to align it with current_working_dir().

[hagenw]

I changed the name to audeer.script_dir() and extended the tests to check that a change in current working directory, does not affect audeer.script_dir() when called in a file.