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

added clear_aliases() and more test cases #1

Merged
merged 3 commits into from
Dec 15, 2024
Merged

added clear_aliases() and more test cases #1

merged 3 commits into from
Dec 15, 2024

Conversation

kaliv0
Copy link
Owner

@kaliv0 kaliv0 commented Dec 14, 2024

Summary by Sourcery

Add the clear_aliases() method to AliasDict and enhance test coverage with new test cases for alias handling and dictionary operations.

New Features:

  • Introduce the clear_aliases() method to remove all aliases from the AliasDict.

Tests:

  • Add test cases for the new clear_aliases() method to ensure it functions correctly.
  • Enhance existing test cases to verify that dictionary length does not include aliases and that popitem() behaves as expected.
  • Add test cases for setdefault() and update() methods to ensure they handle aliases correctly.

Copy link

sourcery-ai bot commented Dec 14, 2024

Reviewer's Guide by Sourcery

This PR adds a new clear_aliases() method to the AliasDict class and enhances test coverage with additional test cases. The changes focus on improving the dictionary's functionality and ensuring proper behavior of alias-related operations.

Class diagram for AliasDict with clear_aliases method

classDiagram
    class AliasDict {
        +remove_alias(*aliases)
        +clear_aliases()
        +aliases()
    }
    note for AliasDict "Added clear_aliases method to clear all aliases."
Loading

File-Level Changes

Change Details Files
Added new clear_aliases() method to remove all aliases while preserving original keys
  • Implemented clear_aliases() method that clears the internal _alias_dict
  • Added test case to verify clear_aliases() removes all aliases while keeping original items
aldict/alias_dict.py
tests/test_alias_dict.py
Enhanced test coverage for existing dictionary operations
  • Added test for dictionary length to verify aliases aren't counted
  • Added test for popitem() method behavior
  • Added test for clear() method
  • Added test for setdefault() with aliases
  • Added test for update() method's effect on aliases
  • Improved test_eq() by using a shared dictionary for initialization
  • Renamed test_pop to test_pop_alias_doesnt_remove_key for clarity
tests/test_alias_dict.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.

Hey @kaliv0 - 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: 1 issue found
  • 🟢 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.

@kaliv0 kaliv0 merged commit 960b7e3 into main Dec 15, 2024
6 checks passed
@kaliv0 kaliv0 deleted the enhance branch December 15, 2024 10:48
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