-
Notifications
You must be signed in to change notification settings - Fork 194
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: search current working directory for config file #1464
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR! Added a few nit comments
# Look into the home directory | ||
if pyiceberg_home_config := _load_yaml(os.path.expanduser("~")): | ||
return pyiceberg_home_config | ||
# Directories to search for the configuration file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: i like the comment on search order "PYICEBERG_HOME, home directory, then current directory"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a new line to show this in 2bd6913, is this what you are looking for? I just added back this comment underneath.
mkdocs/docs/configuration.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there are a couple other places where pyiceberg.yaml is referenced in the docs
https://grep.app/search?q=pyiceberg.yaml&filter[repo][0]=apache/iceberg-python&filter[path][0]=mkdocs/docs/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice finds! That grep tool is pretty neat. I just made some corrections to these in 3ebbb8c.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried adding a test here, but I wonder if there are opportunities to clean it up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR! I added some nit comments on testing
tests/utils/test_config.py
Outdated
|
||
|
||
@pytest.mark.parametrize( | ||
"config_location, config_content, expected_result", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: config_content and expected_result are always the same, we can use one of them, write to the file and verify that it reads back the same
There's another test that looks to do something similar to this newer test. Are both needed? iceberg-python/tests/utils/test_config.py Lines 58 to 65 in 0e5086c
|
Resolves #1333
Adds the current working directory to the search path for the
.pyiceberg.yaml
file.As it is now, the file is searched in the following order:
PYICEBERG_HOME
environment variableI'm unsure if people would like to have 2 and 3 swapped. In either case, users can still override this with the environment variable.