Skip to content

refactor(tempvc): use list comprehensions, add TEMPVC_BASE_NAME #951

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

amadaluzia
Copy link
Contributor

@amadaluzia amadaluzia commented Jul 15, 2025

Description

TEMPVC_BASE_NAME

This adds a new config variable called TEMPVC_BASE_NAME which will allow an admin to change the default temporary VC channel base name. This will allow for better customisabillity in Tux which I see as an end goal of the project. I have also added it to the example.

Guidelines

  • My code follows the style guidelines of this project (formatted with Ruff)

  • I have performed a self-review of my own code

  • I have commented my code, particularly in hard-to-understand areas

  • I have made corresponding changes to the documentation if needed

  • My changes generate no new warnings

  • I have tested this change

  • Any dependent changes have been merged and published in downstream modules

  • I have added all appropriate labels to this PR

  • I have followed all of these guidelines.

How Has This Been Tested? (if applicable)

I joined a channel after changing the value and it had the exact value I expected.

Screenshots (if applicable)

TEMPVC_BASE_NAME: "tmp: "

{67BE70DB-4F2A-46E3-9ABA-26E8B8268AE9}

TEMPVC_BASE_NAME: "new value "

{F710A719-CE0B-4999-B0AC-DF743C6BA7FD}

Summary by Sourcery

Enable customization of temporary voice channel base names by adding and using a new TEMPVC_BASE_NAME configuration option

New Features:

  • Introduce TEMPVC_BASE_NAME config variable to customize the default base name for temporary voice channels

Enhancements:

  • Update TempVc cog to use TEMPVC_BASE_NAME with a fallback to "/tmp/"

Documentation:

  • Add TEMPVC_BASE_NAME to the example settings file

Copy link
Contributor

sourcery-ai bot commented Jul 15, 2025

Reviewer's Guide

This PR adds a new configuration variable TEMPVC_BASE_NAME, integrates it into the config loader, updates the TempVc service to use this variable with a fallback, and updates the example settings file accordingly.

Class diagram for updated TempVc and Config classes

classDiagram
    class TempVc {
        - bot: Tux
        - base_vc_name: str
        + __init__(bot: Tux)
    }
    class Config {
        + TEMPVC_CATEGORY_ID: str | None
        + TEMPVC_CHANNEL_ID: str | None
        + TEMPVC_BASE_NAME: str | None
        + RECENT_GIF_AGE: int
    }
    TempVc --> Config : uses
Loading

File-Level Changes

Change Details Files
Introduce TEMPVC_BASE_NAME in configuration loader
  • Add TEMPVC_BASE_NAME attribute to config class
  • Map it to config["TEMPVC_BASE_NAME"]
tux/utils/config.py
Wire TEMPVC_BASE_NAME into TempVc cog
  • Replace hardcoded "/tmp/" base name with CONFIG.TEMPVC_BASE_NAME or default
  • Maintain fallback to "/tmp/" when variable is unset
tux/cogs/services/temp_vc.py
Update example settings with new config variable
  • Add TEMPVC_BASE_NAME entry to example YAML
config/settings.yml.example

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!

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
Contributor

@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 @amadaluzia - I've reviewed your changes - here's some feedback:

  • Use an explicit None check (e.g. CONFIG.TEMPVC_BASE_NAME if CONFIG.TEMPVC_BASE_NAME is not None else '/tmp/') instead of or so that empty strings are honored correctly.
  • Normalize the provided base VC name (e.g. trim or enforce a trailing separator) to prevent inconsistent channel names when admins supply custom values.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Use an explicit None check (e.g. CONFIG.TEMPVC_BASE_NAME if CONFIG.TEMPVC_BASE_NAME is not None else '/tmp/') instead of `or` so that empty strings are honored correctly.
- Normalize the provided base VC name (e.g. trim or enforce a trailing separator) to prevent inconsistent channel names when admins supply custom values.

## Individual Comments

### Comment 1
<location> `tux/cogs/services/temp_vc.py:11` </location>
<code_context>
     def __init__(self, bot: Tux) -> None:
         self.bot = bot
-        self.base_vc_name: str = "/tmp/"
+        self.base_vc_name: str = CONFIG.TEMPVC_BASE_NAME or "/tmp/"

     @commands.Cog.listener()
</code_context>

<issue_to_address>
Potential issue if TEMPVC_BASE_NAME is set to an empty string.

Empty strings are falsy in Python, so the fallback to "/tmp/" will trigger if TEMPVC_BASE_NAME is set to "". If you only want the fallback when TEMPVC_BASE_NAME is None, use 'CONFIG.TEMPVC_BASE_NAME if CONFIG.TEMPVC_BASE_NAME is not None else "/tmp/"'.
</issue_to_address>

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.

@amadaluzia amadaluzia changed the title feat(config): add TEMPVC_BASE_NAME config variable feat(tempvc): refactor temp vcs Jul 16, 2025
@amadaluzia amadaluzia changed the title feat(tempvc): refactor temp vcs refactor(tempvc): use list comprehensions, add TEMPVC_BASE_NAME Jul 16, 2025
@anemoijereja-eden
Copy link
Collaborator

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.

2 participants