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

♻️ refactor client structure #413

Merged
merged 2 commits into from
Nov 1, 2024
Merged

♻️ refactor client structure #413

merged 2 commits into from
Nov 1, 2024

Conversation

mraniki
Copy link
Owner

@mraniki mraniki commented Nov 1, 2024

Summary by Sourcery

Refactor the client structure by relocating the ParserClient import to a new module and update the development dependencies by removing black from pyproject.toml.

Enhancements:

  • Refactor client structure by moving ParserClient import to a new module _client.

Build:

  • Remove black from the development dependencies in pyproject.toml.

Copy link

sourcery-ai bot commented Nov 1, 2024

Reviewer's Guide by Sourcery

This PR refactors the client structure by renaming the module containing the ParserClient class and removes the black dependency from the project's development dependencies.

Updated class diagram for ParserClient usage

classDiagram
    class ParserClient {
    }

    class BasicHandler {
        ParserClient
    }

    class StandardHandler {
        ParserClient
    }

    BasicHandler --> ParserClient
    StandardHandler --> ParserClient

    note for ParserClient "ParserClient module moved to _client"
Loading

File-Level Changes

Change Details Files
Renamed the module containing the ParserClient class
  • Changed import statement from '.handler' to '._client' for ParserClient class
  • Module renamed to indicate it's an internal implementation detail
findmyorder/handler/basic.py
findmyorder/handler/standard.py
Removed black formatter from development dependencies
  • Removed black dependency from pyproject.toml
pyproject.toml

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.

Hey @mraniki - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codecov bot commented Nov 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (a0f1824) to head (7c3a701).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #413   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         6           
  Lines          142       142           
=========================================
  Hits           142       142           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mraniki mraniki merged commit 24240d4 into main Nov 1, 2024
11 checks passed
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