Add support for loading from .env files
#296
Open
+153
−8
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
Kilo59
force-pushed
the
f/_/env_file_support
branch
from
d64522f
to
f541656
Compare
❌ 6 Tests Failed:
View the top 3 failed tests by shortest run timetests.agent.test_event_handler�test_parse_event_invalid_json tests.agent.test_event_handler�test_parse_event_invalid_json tests.agent.test_event_handler�test_parse_event_missing_required_field To view individual test run time comparison to the main branch, go to the Test Analytics Dashboard |
Kilo59
requested review from
joshzzheng,
Rachel-Reverie,
rreinoldsc,
TrangPham,
anthonyburdi and
JennyTee
rreinoldsc
reviewed
Jun 6, 2024
examples/agent/imgs/sidebar.png
Outdated
There was a problem hiding this comment.
should this be included in changes?
There was a problem hiding this comment.
It's part of the README update to better explain where the env variables come from.
cc @joshzzheng
rreinoldsc
reviewed
Jun 6, 2024
| import os | ||
|
|
||
| # throw error if file does not exist | ||
| initial_vars: set[str] = set(os.environ.keys()) # noqa: TID251 # we aren't actually using these vars |
There was a problem hiding this comment.
I'd like to avoid loading all the user's env vars. Can the following be used instead:
from dotenv import dotenv_values
config = dotenv_values(".env")
"returns a dict with the values parsed from the .env file."
https://pypi.org/project/python-dotenv/#load-configuration-without-altering-the-environment
There was a problem hiding this comment.
fyi doing above would mean we cannot merge system env vars + .env
There was a problem hiding this comment.
What's the concern here?
Users have to opt-in to load their environment variables in 2 different ways.
- By creating a
envfile and specifically putting the variables they want loaded into it. - By explicitly passing that file to
gx-agent --env-file
We are never directly accessing any env variable values in the agent code.
There was a problem hiding this comment.
Is the idea that we would selectively load environment variables from the env file?
That would be a departure from how .env file loading typically works.
Or are you just saying you want me to use dotenv_values() to determine which env variables were loaded (instead of doing the set difference operation)?
Edit:
I've updated the implementation.
Kilo59
force-pushed
the
f/_/env_file_support
branch
from
5c84a64
to
c8b2eaf
Compare
|
I don't understand the test failures I'm seeing. The only way I could see the changes I've added affecting these tests is if they were relying on some prior env variable state, which my |
Kilo59
commented
Jul 2, 2024
Comment on lines
+38
to
+43
| --json-log Output logs in JSON format. Defaults to False. | ||
| --log-cfg-file LOG_CFG_FILE | ||
| Path to a logging configuration json file. Supersedes --log-level and --skip-log-file. | ||
| --version Show the GX Agent version. | ||
| Path to a logging configuration file in JSON format. Supersedes --log-level and --skip-log-file. | ||
| --custom-log-tags CUSTOM_LOG_TAGS | ||
| Additional tags for logs in form of key-value pairs | ||
| --version Show the gx agent version. |
There was a problem hiding this comment.
These args aren't new but the Readme example hadn't been updated in awhile.
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.
Add an optional
gx-agent --env-fileCLI argument that allows the agent to load ENV variables from a file.https://saurabh-kumar.com/python-dotenv/
$ gx-agent --help usage: gx-agent [-h] [--env-file ENV_FILE] [--log-level LOG_LEVEL] [--skip-log-file SKIP_LOG_FILE] [--json-log] [--log-cfg-file LOG_CFG_FILE] [--custom-log-tags CUSTOM_LOG_TAGS] [--version] optional arguments: -h, --help show this help message and exit --env-file ENV_FILE Path to an environment file to load environment variables from. Defaults to None.Also, update our readme to have a more complete Quick-Start started example.