fix(bug): prefix config environment vars to avoid conflicts

[ydm]

What I did

The configuration classes (e.g. ape_ethereum.NetworkConfig or ape_test.CoverageReportsConfig) incorrectly interpret environment variables as part of their own settings.

For example there are terminal and html fields in CoverageReportsConfig:

class CoverageReportsConfig(PluginConfig):
    terminal: Union[bool, dict] = True
    xml: Union[bool, dict] = false
    html: Union[bool, dict] = False

Now, if you try running ape with one of those (somewhat common) names set as an environment variable, it will either crash or, even worse, run with one of its settings likely augmented without the user ever intending it.

$ TERMINAL=xterm ape compile

...

pydantic_core._pydantic_core.ValidationError: 2 validation errors for CoverageReportsConfig
terminal.bool
  Input should be a valid boolean, unable to interpret input [type=bool_parsing, input_value='xterm', input_type=str]
    For further information visit https://errors.pydantic.dev/2.10/v/bool_parsing
terminal.dict[any,any]
  Input should be a valid dictionary [type=dict_type, input_value='xterm', input_type=str]
    For further information visit https://errors.pydantic.dev/2.10/v/dict_type

The reason for this behaviour is that the pydantic-settings module searches for environment variables of the same name as each setting: https://docs.pydantic.dev/latest/concepts/pydantic_settings/#environment-variable-names

I couldn't find a way to disable the environment variable settings.

To solve the problem, this patch introduces the following prefixes based on their root module:

• APE_
• APE_CACHE_
• APE_COMPILE_
• APE_CONSOLE_
• APE_ETHEREUM_
• APE_NETWORKS_
• APE_NODE_
• APE_TEST_

The following config classes are affected:

| File                                 | Class                   | Prefix                    | Test |
|--------------------------------------+-------------------------+---------------------------+------|
| src/ape/api/config.py                | ApeConfig               | APE_                      | yes  |
| src/ape/api/config.py                | DeploymentConfig        | APE_                      | NO!  |
| src/ape/api/config.py                | PluginConfig            | APE_                      | NO!  |
| src/ape_cache/config.py              | CacheConfig             | APE_CACHE_                | yes  |
| src/ape_compile/config.py            | Config                  | APE_COMPILE_              | yes  |
| src/ape_console/config.py            | ConsoleConfig           | APE_CONSOLE_              | yes  |
| src/ape_ethereum/ecosystem.py        | BaseEthereumConfig      | APE_ETHEREUM_             | yes  |
| src/ape_ethereum/ecosystem.py        | ForkedNetworkConfig     | APE_ETHEREUM_ (inherited) | yes  |
| src/ape_ethereum/ecosystem.py        | NetworkConfig           | APE_ETHEREUM_             | yes  |
| src/ape_networks/config.py           | CustomNetwork           | APE_NETWORKS_             | yes  |
| src/ape_networks/config.py           | NetworksConfig          | APE_NETWORKS_             | NO!  |
| src/ape_node/provider.py             | EthereumNetworkConfig   | APE_NODE_                 | yes  |
| src/ape_node/provider.py             | EthereumNodeConfig      | APE_NODE_                 | yes  |
| src/ape_test/config.py               | ApeTestConfig           | APE_TEST_                 | yes  |
| src/ape_test/config.py               | CoverageConfig          | APE_TEST_                 | yes  |
| src/ape_test/config.py               | CoverageReportsConfig   | APE_TEST_                 | yes  |
| src/ape_test/config.py               | EthTesterProviderConfig | APE_TEST_                 | yes  |
| src/ape_test/config.py               | GasConfig               | APE_TEST_                 | yes  |
| src/ape_test/config.py               | GasExclusion            | APE_TEST_                 | yes  |
| src/ape_test/config.py               | IsolationConfig         | APE_TEST_                 | yes  |
| tests/functional/test_config.py      | CustomConfig            | APE_API_ (inherited)      | -    |
| tests/functional/test_config.py      | CustomConfig            | APE_API_ (inherited)      | -    |
| tests/functional/test_config.py      | MyConfig                | APE_API_ (inherited)      | -    |
| tests/functional/test_config.py      | MyConfig                | APE_API_ (inherited)      | -    |
| tests/functional/test_config.py      | MyConfig                | APE_API_ (inherited)      | -    |
| tests/functional/test_config.py      | MyConfig                | APE_API_ (inherited)      | -    |
| tests/functional/test_config.py      | SubConfig               | APE_API_ (inherited)      | -    |
| tests/functional/test_config.py      | SubConfig               | APE_API_ (inherited)      | -    |
| tests/functional/test_ecosystem.py   | L2NetworkConfig         | APE_ETHEREUM_ (inherited) | -    |
| tests/functional/test_network_api.py | MyConfig                | APE_ETHEREUM_ (inherited) | -    |

Thus the previously used as an example TERMINAL environment variable now becomes APE_TEST_TERMINAL. The same applies respectively to all other settings as well.

This patch carries the risk of invalidating the settings of users who rely on environment variables based configuration (even though this seems highly unlikely), so make sure to include it in the changelog as a breaking change, should this patch get approved.

[antazoey]

This feature is not documented anywhere, so we should probably add it to the config guide.

I kind of like it under the line:

This helps keep your secrets out of Ape!

Something like:

Similarly, any config key-name can also be set with the same named environment variable (with a prefix).
For example, to set the node URL using an environment variable, do:

```shell
export APE_NODE_URL="https://node.example.com"

[antazoey]

So I tried to see if I could use APE_API_CONTRACTS_FOLDER but it didn't work.
I realize the problem was in the ApeConfg.__init__.

I had to change:

super(BaseSettings, self).__init__(*args, **kwargs)

to

super().__init__(*args, **kwargs)

At that point I can add a test:

def test_model_validate_handles_environment_variables():
    os.environ["APE_API_CONTRACTS_FOLDER"] = "contracts-env-var-test"
    cfg = ApeConfig()
    assert cfg.contracts_folder == "contracts-env-var-test"

[ydm]

OK, let me do that, will get back to you shortly.

[fubuloubu]

We had an issue planning to do this, thanks for taking it up!

Maintainer note: Breaking change for 0.9

[antazoey]

Maintainer note: Breaking change for 0.9

I am arguing against this for a couple reasons.
1, issues the user mentioned are bad enough to change now. Like a mere TERMINAL environment variable causes problems
2, the feature is un-documented; i was not aware we were supporting environment variables like TERMINAL, etc.

[fubuloubu]

Maintainer note: Breaking change for 0.9

I am arguing against this for a couple reasons. 1, issues the user mentioned are bad enough to change now. Like a mere TERMINAL environment variable causes problems 2, the feature is un-documented; i was not aware we were supporting environment variables like TERMINAL, etc.

Fair enough! Agree with releasing as a patch update

Documentation can be updated in a later PR

[ydm]

@antazoey , please check the latest version, it includes tests and docs.

[antazoey]

Amazing! Thank you so much. I think we can take it from here, just a few nits I can address and then merge.