Modify load_feature_tables() function to be also used in a Notebook setting #58
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
bdewilde
reviewed
Jan 25, 2025
| ) | ||
| 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.
Suggested change
| 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.
| if toml_content: | ||
| toml_file = tmpdir.join("features_table.toml") | ||
| toml_file.write(toml_content) | ||
|
|
Comment on lines
+136
to
+138
| 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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.changes
context
__file__is not defined".questions
None