fix: raise clear error when required SSH connection params are None#8
Open
prabindersinghh wants to merge 1 commit intoouterbounds:mainfrom
Open
Conversation
This file contains hidden or 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
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.
Summary
Add validation for required SSH connection parameters — previously
crashed with confusing TypeError if any were None.
Context / Motivation
If a user forgets to set ssh_key_file, username, or address via
@slurm(...) or environment variables, the code crashed with:
TypeError: argument should be str or an os.PathLike object, not NoneTypeThis gives no indication of what went wrong or how to fix it.
Changes Made
__init__before first parameter useSlurmExceptionwith clear message for each missing paramor the METAFLOW_SLURM_SSH_KEY_FILE environment variable."
Testing
Manually verified: instantiating SlurmClient with None values now
raises SlurmException with correct message instead of TypeError.