Modify load_feature_tables() function to allow for absolute & relative paths #58
Conversation
I was running into issues with __file__ in a Jupyter notebook. I found that the issue was happening because typically __file__ is defined in a script or module setting, but not in a notebook. Also added a unit test.
| ) | ||
| except NameError: | ||
| # If __file__ is not available (i.e. Jupyter notebook), use the current working directory | ||
| pkg_root_dir = pathlib.Path(os.getcwd()) |
There was a problem hiding this comment.
| pkg_root_dir = pathlib.Path(os.getcwd()) | |
| pkg_root_dir = pathlib.Path.cwd() |
| if p.parts[-1] == "student_success_tool" | ||
| ) | ||
| except NameError: | ||
| # If __file__ is not available (i.e. Jupyter notebook), use the current working directory |
There was a problem hiding this comment.
I'm very surprised by this! I thought __file__ refers to the path to this module, no matter the env in which it's being imported. In fact I don't believe I've ever had this issue in a Notebook.
tests/modeling/test_utils.py
Outdated
| if expect_exception: | ||
| with pytest.raises(expect_exception): | ||
| utils.load_features_table(file_path) |
There was a problem hiding this comment.
In the case of "no error", standard practice is to use from contextlib import nullcontext as does_not_raise then with pytest.raises(does_not_raise) works in the same manner as an exception. You can find a couple examples of this pattern in other unit tests.
Hi, so I'm trying to load a custom feature_table from my local directory (not for a PDP school), which is why I ran into this issue. But I also realized the Is there a way we can specify a path in our local directory? If not, how can we create that functionality? I'm not sure if this PR is really solving this specific issue, so we can either close this out or if you have an idea of how to address, you can share and I can implement.
|
|
@vishpillai123 There's probably a "well-behaved" way to handle either case: The user can pass a relative path to load files within the src code, or an absolute path to load from a file wherever it may live on disk. Does that make sense? Can you implement that logic? Potentially useful: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.is_absolute |
also adjusted unit test and added "does_not_raise()"
vishpillai123
changed the title
|
@bdewilde Made some updates based on your recommendation! Let me know what you think :). I also tested it for my school and it worked so this addresses my concerns. Previous functionality with relative path is the same. |
I was running into issues with using this function and loading a TOML file from my local directory.
changes
context
questions
None