refactor: utils #44
Open
refactor: utils #44
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…omplete` to `utils/public.py`
…omplete` to `utils/public.py`
* Start migration to uv * Setup ruff and hatch * Change pre-commit to use ruff * Format with ruff * Fix mistake * Add dev deps * Change workflows to use uv and ruff * ➕ Add colorlog and remove requirements folder and fix build * 💚 Fix sphinx build ? * 🐛 Add __version.py for version management and update import in __init__.py * ✏️ Update lib-checks.yml to run ruff on ubuntu-latest * 🐛 Update lib-checks.yml to run mypy with uv * 🔥 Delete MANIFEST.in * ✨ Enhance lib-checks.yml to include ruff formatter check * ♻️ Refactor pyproject.toml and uv.lock to use optional-dependencies for voice and speed
* chore: Update localization workflows to use 'uv' for dependency management * chore: refactor Read the Docs configuration to use uv
…tation to private module
It was used twice, and once it wasn't even necessary
Co-authored-by: Lumouille <[email protected]> Signed-off-by: Paillat <[email protected]>
Lumabots
approved these changes
Aug 4, 2025
Lumabots
reviewed
Aug 6, 2025
Icebluewolf
reviewed
Aug 6, 2025
Co-authored-by: Ice Wolfy <[email protected]> Signed-off-by: Paillat <[email protected]>
Lumabots
reviewed
Aug 6, 2025
Lumabots
reviewed
Aug 6, 2025
Lumabots
reviewed
Aug 6, 2025
Co-authored-by: Ice Wolfy <[email protected]> Co-authored-by: Lumouille <[email protected]> Signed-off-by: Paillat <[email protected]>
Co-authored-by: Lumouille <[email protected]> Signed-off-by: Paillat <[email protected]>
Co-authored-by: Lumouille <[email protected]> Signed-off-by: Paillat <[email protected]>
Signed-off-by: Paillat <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the Discord library's utils module to improve code organization and reduce maintenance burden by separating private utilities from user-facing APIs.
Key changes include:
- Splitting utils into
utils.publicfor user-facing utilities andutils.privatefor internal functions - Removing overly specific or rarely used utilities
- Consolidating overlapping utilities (like merging
time_snowflakeintogenerate_snowflake)
Reviewed Changes
Copilot reviewed 61 out of 61 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| discord/utils/public.py | New file containing user-facing utility functions |
| discord/utils/private.py | New file containing internal utility functions |
| discord/utils/init.py | New module initialization file exporting public utilities |
| discord/utils.py | Removed monolithic utils file |
| Multiple source files | Updated imports to use new utils structure |
| Documentation files | Updated to reflect removed utilities and new import patterns |
| Test files | Updated imports and removed deprecated function tests |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]> Signed-off-by: Paillat <[email protected]>
Co-authored-by: Copilot <[email protected]> Signed-off-by: Paillat <[email protected]>
Paillat-dev
force-pushed
the
refactor-utils
branch
from
b501d54 to
0df56df
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The general goal of these changes is to lower the amount of code we have to maintain across te library.
Changes include:
Separated utils function in:
utils.privatefor private utils that are to be used in the library codeutilsfor user facing utilsRemoved over specific utils
Removed overly specific public utils that wouldn't commonly be used by users and aren't hard to re implement in any project. See
CHANGELOG-V3.mdfor a comprehensive list.Removed unused (or lesser used) utils
Remove utils that were used less than once or twice in the library in favor of:
Merged overlapping utils
Merge utils with common goals or with same goal with one another, e.g. see changes to
utils.time_snowflake->utils.generate_snowflake