added origin_len, docstrings and tests

[kaliv0]

Summary by Sourcery

Add the 'origin_len' method to the AliasDict class, update documentation with new examples, and include tests for the new functionality. Enhance code readability by adding docstrings to all methods. Update the project version to 1.1.0.

New Features:

• Introduce the 'origin_len' method to return the length of the original dictionary without aliases.

Enhancements:

• Add docstrings to all methods in the AliasDict class to improve code readability and understanding.

Documentation:

• Update README.md to include documentation and examples for the new 'origin_len' method.

Tests:

• Add a new test to verify that the 'origin_len' method correctly excludes aliases from the count.

Chores:

• Bump the project version from 1.0.0 to 1.1.0 in pyproject.toml to reflect new changes.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR enhances the AliasDict class by adding docstrings to all methods, introducing a new origin_len() method to get the length of the original dictionary without aliases, and reorganizing the len() implementation. The version has been bumped to 1.1.0 to reflect these additions.

Updated class diagram for AliasDict

classDiagram
    class AliasDict {
        +AliasDict(dict_)
        +add_alias(key, *aliases)
        +remove_alias(*aliases)
        +clear_aliases()
        +aliases()
        +aliased_keys()
        +origin_keys()
        +keys()
        +values()
        +items()
        +origin_len()
        +__len__()
        +__missing__(key)
        +__iter__()
        +__repr__()
    }
    note for AliasDict "Added origin_len method and docstrings for all methods"

Loading

File-Level Changes

Change	Details	Files
Added docstrings to all methods in the AliasDict class	Added descriptive docstrings to add_alias(), remove_alias(), and clear_aliases() methods Added docstrings to all dictionary view methods (keys(), values(), items(), etc.) Added docstrings to alias-specific methods (aliases(), aliased_keys(), origin_keys())	aldict/alias_dict.py
Implemented new origin_len() method and reorganized length-related functionality	Added new origin_len() method to get dictionary length excluding aliases Moved len() implementation to be grouped with other special methods Added test case for origin_len() method	aldict/alias_dict.py tests/test_alias_dict.py
Updated documentation and version	Added documentation for origin_len() method with usage example Bumped version from 1.0.0 to 1.1.0	README.md 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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

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

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}