Skip to content
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

fix: api_keys_required #1277

Merged
merged 9 commits into from
Dec 30, 2024
Merged

fix: api_keys_required #1277

merged 9 commits into from
Dec 30, 2024

Conversation

Wendong-Fan
Copy link
Member

@Wendong-Fan Wendong-Fan commented Dec 4, 2024

Description

Describe your changes in detail.

Motivation and Context

close #1273

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds core functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Example (update in the folder of example)

Implemented Tasks

  • Subtask 1
  • Subtask 2
  • Subtask 3

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • I have read the CONTRIBUTION guide. (required)
  • My change requires a change to the documentation.
  • I have updated the tests accordingly. (required for a bug fix or a new feature)
  • I have updated the documentation accordingly.

@Wendong-Fan Wendong-Fan added the bug Something isn't working label Dec 4, 2024
@Wendong-Fan Wendong-Fan added this to the Sprint 18 milestone Dec 4, 2024
@Wendong-Fan Wendong-Fan requested a review from koch3092 December 4, 2024 14:50
@Wendong-Fan Wendong-Fan self-assigned this Dec 4, 2024
@Wendong-Fan Wendong-Fan marked this pull request as ready for review December 4, 2024 14:50
Copy link
Collaborator

@koch3092 koch3092 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Wendong-Fan .
If a class depends on multiple tokens at the same time, it seems that only one api_key can be verified.

camel/utils/commons.py Show resolved Hide resolved
@Wendong-Fan Wendong-Fan marked this pull request as draft December 4, 2024 18:34
Copy link
Collaborator

@koch3092 koch3092 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Wendong-Fan , left some comments below

camel/utils/test.py Outdated Show resolved Hide resolved
camel/models/anthropic_model.py Outdated Show resolved Hide resolved
@koch3092
Copy link
Collaborator

A situation that currently does not meet expectations:

class ExampleClass:
    def __init__(self, messages: List[str], key_1: str = None, api_key_2: str = None):
        self._key1 = key_1 or os.environ.get("API_KEY_1")
        self._key2 = api_key_2 or os.environ.get("API_KEY_2")
        self.messages = messages

    @api_keys_required(
        [
            ("key_1", 'API_KEY_1'),
            ("api_key_2", 'API_KEY_2'),
        ]
    )
    def run(self):
        print("API keys validated!")


if __name__ == "__main__":
    # Example with API_KEY_1 provided in arguments
    obj = ExampleClass(messages=["xx"], key_1="API", api_key_2="dfadf")
    obj.run()
    
"""
Traceback (most recent call last):
  File "path\to\camel\camel\utils\test.py", line 53, in <module>
    obj.run()
  File "path\to\camel\camel\utils\commons.py", line 307, in wrapper
    raise ValueError(
ValueError: Missing required API keys: API_KEY_1, API_KEY_2
"""

@AveryYay AveryYay requested a review from pointearth December 23, 2024 17:09
@Wendong-Fan Wendong-Fan requested a review from koch3092 December 28, 2024 18:34
@Wendong-Fan Wendong-Fan marked this pull request as ready for review December 28, 2024 18:34
Copy link
Collaborator

@koch3092 koch3092 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@Wendong-Fan Wendong-Fan merged commit 487ed43 into master Dec 30, 2024
4 of 6 checks passed
@Wendong-Fan Wendong-Fan deleted the api_required_fix branch December 30, 2024 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

[BUG] api_keys_required() is not compatible with the method of directly setting api_key
2 participants