Allow to use @script instead of @sub and use @func instead of @xw.func #2646
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
There was a problem hiding this comment.
Pull Request Overview
This PR introduces decorator alias functionality to xlwings, allowing developers to use @script as an alternative to @sub and @func as a shorthand for @xw.func. The changes aim to provide more intuitive decorator names and reduce import verbosity.
- Added
scriptas an alias for thesubdecorator - Introduced direct import of
funcfrom xlwings on Windows platforms - Updated quickstart template to use the shorter
@funcsyntax instead of@xw.func
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| xlwings/init.py | Adds script alias for xlsub decorator and creates script = sub assignment |
| xlwings/cli.py | Updates quickstart template to import func directly and use @func instead of @xw.func |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| return inner | ||
| else: | ||
| return inner(f) | ||
|
|
There was a problem hiding this comment.
[nitpick] The alias assignment script = sub creates a duplicate reference. Consider documenting this alias relationship or using a more explicit aliasing pattern to clarify the intent for future maintainers.
Suggested change
| # Alias 'script' to 'sub' for API consistency and to support both naming conventions. |
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.
No description provided.