refactor: move legacy APIs to a separate module #5381
Merged
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
Signed-off-by: Frost Ming <me@frostming.com>
|
There was a problem hiding this comment.
Pull Request Overview
This PR refactors deprecated APIs by moving them to a dedicated bentoml.legacy module, allowing the new service type to be exported in the top-level namespace without conflicts.
- Legacy API classes and functions now inherit from bentoml.legacy.Runnable in multiple framework integrations.
- Top-level lazy loading and attribute access (in init.py) are updated to handle legacy references and emit deprecation warnings.
- Documentation snippets and SDK factory imports have been updated accordingly.
Reviewed Changes
Copilot reviewed 57 out of 57 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/bentoml/_internal/frameworks/* | Updated get_runnable functions and associated runnable classes to reference bentoml.legacy.Runnable. |
| src/bentoml/init.py | Modified lazy loading and getattr to delegate legacy API attributes and warn users of deprecation. |
| docs/README.md | Revised documentation snippet to align with the new public API changes. |
| src/_bentoml_sdk/service/factory.py | Adjusted Runner import to use bentoml.legacy.Runner. |
| src/_bentoml_impl/frameworks/* | Updated legacy-related get_runnable and runnable classes to use bentoml.legacy.Runnable. |
Comments suppressed due to low confidence (2)
src/bentoml/init.py:301
- Ensure that the bentoml.legacy module defines all to support this dynamic attribute lookup; otherwise, accessing legacy APIs via the top-level module may raise an AttributeError.
elif name in legacy.__all__:
docs/README.md:216
- [nitpick] Verify that updating the documentation from 'bentoml.Service' to 'bentoml.Bento' correctly reflects the new intended public API and aligns with the overall legacy refactoring.
.. autoclass:: bentoml.Bento
aarnphm
approved these changes
Jun 8, 2025
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.
Signed-off-by: Frost Ming me@frostming.com
What does this PR address?
We plan to export the new service type in the top-level namespace, which conflict with the legacy service with the same name. Therefore, as a preliminary step, this PR moves all deprecated APIs to a new module
bentoml.legacywhile keeping the references inbentomlfor a while.Any references to
bentoml.<legacy_api>will emit a deprecation warning to let users migrate ASAP.