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] Rename Index class to fix plugin installation #425

Merged
merged 2 commits into from
Dec 16, 2024

Conversation

jhamon
Copy link
Collaborator

@jhamon jhamon commented Dec 16, 2024

Problem

By renaming the Index class to _Index in #418, I accidentally broke plugin installation.

Solution

Rename the class back to Index and instead alias it to _Index through import statements. We still need to alias it within the pinecone/data/__init__.py module definition to avoid collision with the Index class designed to give users a more informative error when they incorrectly import the Index class from the pinecone module.

I went ahead and also cleaned up some stuff where we were unnecessarily exposing some internal openapi details in the public interface. Users should never realistically need to construct openapi request objects.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Infrastructure change (CI configs, etc)
  • Non-code change (docs, etc)
  • None of the above: (explain here)

@jhamon jhamon marked this pull request as ready for review December 16, 2024 21:33
Copy link
Contributor

@jseldess jseldess left a comment

Choose a reason for hiding this comment

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

LGTM, though I'm not really qualified to say so :)

@@ -45,32 +37,13 @@

logger = logging.getLogger(__name__)

__all__ = [
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice thinking getting these out of here. 👍

@jhamon jhamon merged commit f01d80a into release-candidate/2025-01 Dec 16, 2024
82 of 83 checks passed
@jhamon jhamon deleted the jhamon/fix-plugin-installation branch December 16, 2024 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants