feat: search current working directory for config file #1464
Conversation
| # 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.
nit: i like the comment on search order "PYICEBERG_HOME, home directory, then current directory"
There was a problem hiding this comment.
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.
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.
Nice finds! That grep tool is pretty neat. I just made some corrections to these in 3ebbb8c.
There was a problem hiding this comment.
There was a problem hiding this comment.
I tried adding a test here, but I wonder if there are opportunities to clean it up.
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| "config_location, config_content, expected_result", |
There was a problem hiding this comment.
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
| ("none", None, None), | ||
| ], | ||
| ) | ||
| def test_from_multiple_configuration_files( |
There was a problem hiding this comment.
nit can we also test the order of lookup here?
There was a problem hiding this comment.
we want to test both home directory and current directory here
| ) -> None: | ||
| def create_config_file(directory: str, content: Optional[Dict[str, Any]]) -> None: | ||
| config_file_path = os.path.join(directory, ".pyiceberg.yaml") | ||
| with open(config_file_path, "w", encoding="utf-8") as file: |
There was a problem hiding this comment.
nit:
| with open(config_file_path, "w", encoding="utf-8") as file: | |
| with open(config_file_path, "w", encoding=UTF8) as file: |
Resolves #1333
Adds the current working directory to the search path for the
.pyiceberg.yamlfile.As it is now, the file is searched in the following order:
PYICEBERG_HOMEenvironment 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.