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 individual loader import fails #97

Conversation

garlontas
Copy link
Member

@garlontas garlontas commented Nov 7, 2024

Summary by Sourcery

Bug Fixes:

  • Fix import errors for individual loaders by using try-except blocks for optional modules.

Copy link

sourcery-ai bot commented Nov 7, 2024

Reviewer's Guide by Sourcery

The PR modifies the loader imports to handle optional dependencies gracefully. Instead of importing all loaders unconditionally, XML and YAML loaders are now imported within try-except blocks to prevent import failures when their dependencies are not installed. The all list is also built dynamically based on successful imports.

Updated class diagram for loader imports

classDiagram
    class Loaders {
        +csv
        +json
        +xml
        +yaml
    }
    note for Loaders "The xml and yaml loaders are now imported conditionally."
    class ImportHandler {
        +__all__
    }
    Loaders --|> ImportHandler : dynamically builds __all__ list
    note for ImportHandler "__all__ list is built based on successful imports."
Loading

File-Level Changes

Change Details Files
Implement dynamic loader imports with graceful fallback
  • Initialize empty all list at the beginning
  • Keep CSV and JSON loaders as mandatory imports
  • Wrap XML and YAML loader imports in try-except blocks
  • Dynamically append successful imports to all list
  • Silently skip failed imports with empty except blocks
pystreamapi/loaders/__init__.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

Comment on lines 2 to 6

from pystreamapi.loaders.__csv.__csv_loader import csv
from pystreamapi.loaders.__json.__json_loader import json
from pystreamapi.loaders.__xml.__xml_loader import xml
from pystreamapi.loaders.__yaml.__yaml_loader import yaml

__all__ = [
'csv',
'json',
'xml',
'yaml'
]

__all__.append('csv')
Copy link

Choose a reason for hiding this comment

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

issue (code-quality): We've found these issues:

@garlontas
Copy link
Member Author

@sourcery-ai review

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

Copy link

sonarcloud bot commented Nov 7, 2024

@garlontas garlontas merged commit fd70cad into main Nov 7, 2024
8 checks passed
@garlontas garlontas deleted the bugfix/#93/fix-individual-import-of-loaders-failing-when-not-all-optional-deps-installed branch November 7, 2024 17:13
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.

1 participant