-
Notifications
You must be signed in to change notification settings - Fork 163
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
Lazily initialize config drivers field #1062
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,22 @@ | ||
from __future__ import annotations | ||
|
||
from abc import ABC | ||
from typing import TYPE_CHECKING, Optional | ||
|
||
from attrs import define | ||
from attrs import define, field | ||
|
||
from griptape.mixins.serializable_mixin import SerializableMixin | ||
|
||
from .base_driver_config import BaseDriverConfig | ||
from .logging_config import LoggingConfig | ||
if TYPE_CHECKING: | ||
from .base_driver_config import BaseDriverConfig | ||
from .logging_config import LoggingConfig | ||
|
||
|
||
@define(kw_only=True) | ||
class BaseConfig(SerializableMixin, ABC): | ||
drivers: BaseDriverConfig | ||
logging: LoggingConfig | ||
_logging: Optional[LoggingConfig] = field(alias="logging") | ||
_drivers: Optional[BaseDriverConfig] = field(alias="drivers") | ||
|
||
def reset(self) -> None: | ||
self._logging = None | ||
self._drivers = None |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,42 @@ | ||
from attrs import Factory, define, field | ||
from __future__ import annotations | ||
|
||
from typing import TYPE_CHECKING, Optional | ||
|
||
from attrs import define, field | ||
|
||
from .base_config import BaseConfig | ||
from .base_driver_config import BaseDriverConfig | ||
from .logging_config import LoggingConfig | ||
from .openai_driver_config import OpenAiDriverConfig | ||
|
||
if TYPE_CHECKING: | ||
from .base_driver_config import BaseDriverConfig | ||
|
||
@define | ||
|
||
@define(kw_only=True) | ||
class _Config(BaseConfig): | ||
drivers: BaseDriverConfig = field(default=Factory(lambda: OpenAiDriverConfig()), kw_only=True) | ||
logging: LoggingConfig = field(default=Factory(lambda: LoggingConfig()), kw_only=True) | ||
_logging: Optional[LoggingConfig] = field(default=None, alias="logging") | ||
_drivers: Optional[BaseDriverConfig] = field(default=None, alias="drivers") | ||
|
||
@property | ||
def drivers(self) -> BaseDriverConfig: | ||
"""Lazily instantiates the drivers configuration to avoid client errors like missing API key.""" | ||
if self._drivers is None: | ||
self._drivers = OpenAiDriverConfig() | ||
return self._drivers | ||
|
||
@drivers.setter | ||
def drivers(self, drivers: BaseDriverConfig) -> None: | ||
self._drivers = drivers | ||
|
||
@property | ||
def logging(self) -> LoggingConfig: | ||
if self._logging is None: | ||
self._logging = LoggingConfig() | ||
return self._logging | ||
|
||
@logging.setter | ||
def logging(self, logging: LoggingConfig) -> None: | ||
self._logging = logging | ||
|
||
|
||
config = _Config() |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
import pytest | ||
|
||
from griptape.config.openai_driver_config import OpenAiDriverConfig | ||
|
||
|
||
class TestConfig: | ||
@pytest.mark.skip_mock_config() | ||
def test_init(self): | ||
from griptape.config import LoggingConfig, config | ||
|
||
assert isinstance(config.drivers, OpenAiDriverConfig) | ||
assert isinstance(config.logging, LoggingConfig) | ||
|
||
@pytest.mark.skip_mock_config() | ||
def test_lazy_init(self): | ||
from griptape.config import config | ||
|
||
assert config._drivers is None | ||
assert config._logging is None | ||
|
||
assert config.drivers is not None | ||
assert config.logging is not None | ||
|
||
assert config._drivers is not None | ||
assert config._logging is not None |
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
Oops, something went wrong.
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.
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.
Out of scope for this PR, but why do we have this base class? How would we a subclass other than
_Config
?I only bring it up, because the reset method in here feels weird.
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.
Agreed that it's probably redundant here (and maybe even adds some confusion), but I think I'd prefer to keep consistent with the pattern of having a base class for any inheritance hierarchy.
Who knows what the config classes may evolve into over time.