Update helper_func.py

[senseiubot]

Summary by Sourcery

New Features:

• Implement a function to verify if a user is a member of a specified group.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a new helper function, subsgroup, and reorders the existing subschannel and subsgroup functions. The subschannel function was also modified to use the FORCE_SUB_CHANNEL constant.

Flow diagram for subscription verification process

flowchart TD
    Start[Start] --> IsAdmin{Is User Admin?}
    IsAdmin -->|Yes| Grant[Grant Access]
    IsAdmin -->|No| CheckForceGroup{Force Sub Group?}

    CheckForceGroup -->|Yes| CheckGroupMember{Check Group Membership}
    CheckForceGroup -->|No| CheckForceChannel{Force Sub Channel?}

    CheckGroupMember -->|Member| CheckForceChannel
    CheckGroupMember -->|Not Member| Deny[Deny Access]

    CheckForceChannel -->|Yes| CheckChannelMember{Check Channel Membership}
    CheckForceChannel -->|No| Grant

    CheckChannelMember -->|Member| Grant
    CheckChannelMember -->|Not Member| Deny

    Grant --> End[End]
    Deny --> End

Loading

File-Level Changes

Change	Details	Files
Added a new helper function subsgroup.	Added a new function subsgroup that checks if a user is a member of a group.	helper_func.py
Reordered the subschannel and subsgroup functions.	Moved the subschannel function below the new subsgroup function. Moved the old subsgroup function to the end of the file.	helper_func.py
Modified the subschannel function to use the FORCE_SUB_CHANNEL constant.	The subschannel function now uses the FORCE_SUB_CHANNEL constant to determine the channel to check for membership.	helper_func.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. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

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.

[what-the-diff]

PR Summary

• Introduction of new function for subgroup membership verification
  A new function named subsgroup has been added. The purpose of this function is to check whether a user is part of a specified subgroup.

• New function to check membership in a certain channel
  An additional function, subschannel, has been created to verify if a user is a member of a particular channel.

• Function outputs
  Both of the new functions return a 'True' value if the user is either an 'admin' or a member of the required group/channel. Otherwise, it gives a 'False' output. This development is aimed to facilitate better user management by easily identifying users' membership status.

[sourcery-ai]

Hey @senseiubot - I've reviewed your changes - here's some feedback:

Overall Comments:

• There appears to be duplicate implementations of both subschannel() and subsgroup() functions. Consider removing the duplicates and potentially refactoring the common logic into a single helper function that takes the chat_id as a parameter.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟡 Complexity: 1 issue found
• 🟢 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.}

[sourcery-ai]

issue (complexity): Consider consolidating the duplicate functions subschannel() and subsgroup() into a single function.

The duplicate functions subschannel() and subsgroup() can be consolidated into a single function that handles both cases. This reduces complexity while maintaining all functionality:

async def check_subscription(filter, client, update, force_sub_setting, chat_id):
    if not force_sub_setting:
        return True
    user_id = update.from_user.id
    if user_id in ADMINS:
        return True
    try:
        member = await client.get_chat_member(chat_id=chat_id, user_id=user_id)
    except UserNotParticipant:
        return False

    return member.status in [ChatMemberStatus.OWNER, ChatMemberStatus.ADMINISTRATOR, ChatMemberStatus.MEMBER]

# Usage with filters:
subschannel = filters.create(lambda _, c, u: check_subscription(_, c, u, FORCE_SUB_CHANNEL, FORCE_SUB_CHANNEL))
subsgroup = filters.create(lambda _, c, u: check_subscription(_, c, u, FORCE_SUB_GROUP, FORCE_SUB_GROUP))

This approach:

• Eliminates code duplication
• Makes future maintenance easier
• Keeps the same filter interface
• Maintains all existing functionality