Skip to content

fix: modernize importlib#295

Draft
JarbasAl wants to merge 1 commit intodevfrom
deprecated_importlib
Draft

fix: modernize importlib#295
JarbasAl wants to merge 1 commit intodevfrom
deprecated_importlib

Conversation

@JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Jan 5, 2025 •
edited by coderabbitai bot
Loading

remove the compat layer for old python versions, use stdlib directly

Summary by CodeRabbit

  • New Features

    • Updated plugin discovery mechanism using importlib.metadata

  • Deprecation

    • Marked normalize_lang function as deprecated, recommending use of standardize_lang_tag

  • Refactor

    • Simplified plugin loading process
    • Removed _iter_entrypoints function and integrated its functionality directly into find_plugins

@JarbasAl
fix: modernize importlib
43c1af3 
remove the compat layer for old python versions, use stdlib directly
@JarbasAl JarbasAl requested a review from goldyfruit January 5, 2025 16:34
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 5, 2025 •
edited
Loading

Walkthrough

The pull request modifies the ovos_plugin_manager/utils/__init__.py file, focusing on updating the plugin discovery mechanism. The changes replace pkg_resources with importlib.metadata for entry point handling, simplify the plugin loading process by removing the _iter_entrypoints function, and integrate its functionality directly into find_plugins. Additionally, the normalize_lang function is marked as deprecated, encouraging users to use standardize_lang_tag instead.

Changes

File Change Summary
ovos_plugin_manager/utils/__init__.py - Replaced pkg_resources with importlib.metadata for entry points
- Removed _iter_entrypoints function
- Updated find_plugins to use new entry points method
- Deprecated normalize_lang function

Suggested labels

bug, documentation

Possibly related PRs

  • fix/restore_dead_code #256: Changes involving deprecation handling in the same file, specifically related to the chop_samples parameter in the ReadWriteStream class

Poem

🐰 A plugin's journey, reimagined with care,
Metadata dancing through the coding lair,
Old imports fade, new paths unfurl,
Deprecation warnings gently swirl,
A rabbit's code, both nimble and rare! 🔧

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added fix and removed fix labels Jan 5, 2025
coderabbitai[bot]
coderabbitai bot reviewed Jan 5, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 535c7d7 and 43c1af3.

📒 Files selected for processing (1)
  • ovos_plugin_manager/utils/__init__.py (2 hunks)
🧰 Additional context used
🪛 GitHub Actions: Run UnitTests
ovos_plugin_manager/utils/__init__.py

[error] 129-129: TypeError: entry_points() got an unexpected keyword argument 'group'. The entry_points() function is being called with an unsupported parameter.

[error] AttributeError: Module does not have the attribute '_iter_entrypoints'

ovos_plugin_manager/utils/__init__.py
import warnings
import pkg_resources
from ovos_utils.log import LOG, log_deprecation, deprecated
from importlib.metadata import entry_points
Copy link
Contributor

@coderabbitai coderabbitai bot Jan 5, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue

Ensure environment compatibility for entry_points() usage
The pipeline is failing with the error “entry_points() got an unexpected keyword argument 'group'”. This commonly occurs in Python versions earlier than 3.10, where group is not a recognized parameter. Either upgrade the runtime to Python 3.10+ or provide a fallback implementation for earlier versions to maintain compatibility.

If you need a fallback approach, I can propose a backward-compatible snippet that filters entry points manually. Would you like me to open a GitHub issue to track this change?

🧰 Tools
🪛 GitHub Actions: Run UnitTests

[error] AttributeError: Module does not have the attribute '_iter_entrypoints'

@JarbasAl
Copy link
Member Author

JarbasAl commented Jan 5, 2025

apparently merging this will require python 3.10 +

@JarbasAl JarbasAl marked this pull request as draft January 29, 2026 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

+1 more reviewer

@goldyfruit goldyfruit goldyfruit approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

fix

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@JarbasAl @goldyfruit