-
Notifications
You must be signed in to change notification settings - Fork 1.8k
minor: enforce lint rule clippy::needless_pass_by_value to datafusion-functions #18768
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
Conversation
…-functions Signed-off-by: StandingMan <jmtangcs@gmail.com>
Signed-off-by: StandingMan <jmtangcs@gmail.com>
| pub fn digest_utf8_array_impl<'a, StringArrType>( | ||
| self, | ||
| input_value: StringArrType, | ||
| input_value: &StringArrType, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change seems odd; input_value should already be a reference I believe?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, StringArrType is just a trait. input_value isn’t automatically a reference—we need to explicitly borrow it when required.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But if we look at StringArrayType it is implemented for references:
https://docs.rs/arrow/latest/arrow/array/trait.StringArrayType.html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You mean to keep the function definition like this:
pub fn digest_utf8_array_impl<'a, StringArrType>(
self,
input_value: StringArrType,
) -> ArrayRef
where
StringArrType: StringArrayType<'a>,
{ ... }
and then call it like this:
self.digest_utf8_array_impl::<&GenericStringArray<T>>(&v)
…but the Rust compiler still complains and doesn’t accept it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My point is this might be a false positive by clippy because if we look here for example:
datafusion/datafusion/functions/src/crypto/basic.rs
Lines 260 to 263 in f1ecacc
| DataType::Binary | DataType::LargeBinary => { | |
| let v = value.as_binary::<T>(); | |
| self.digest_binary_array_impl::<&GenericBinaryArray<T>>(v) | |
| } |
v is already of type &GenericBinaryArray<T>; it is already a reference 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, but Clippy warns that input_value is not consumed in the function body, suggesting we take a reference instead. Therefore, the parameter of digest_utf8_array_impl needs to be a double reference (&&).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess we'll just go along with this; for reference: #18839 (comment)
Signed-off-by: StandingMan <jmtangcs@gmail.com>
Signed-off-by: StandingMan <jmtangcs@gmail.com>
| pub fn digest_utf8_array_impl<'a, StringArrType>( | ||
| self, | ||
| input_value: StringArrType, | ||
| input_value: &StringArrType, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But if we look at StringArrayType it is implemented for references:
https://docs.rs/arrow/latest/arrow/array/trait.StringArrayType.html
Signed-off-by: StandingMan <jmtangcs@gmail.com>
|
Thanks @Jefffrey for taking the time to review this PR! |
…-functions (apache#18768) ## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes apache#123` indicates that this PR will close issue apache#123. --> - Closes apache#18758. ## Rationale for this change <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> - enforce lint rule `clippy::needless_pass_by_value` to `datafusion-functions`. ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. --> ## Are these changes tested? <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 2. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. --> --------- Signed-off-by: StandingMan <jmtangcs@gmail.com>
## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123. --> N/A ## Rationale for this change <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> Whilst reviewing some recent PRs (#18839 & #18768) I noticed we have quite a few inner implementation functions that are public for some reason, which give the false impression these are meant to be public APIs (and thus any changes to their signature needs to be restricted). Went through and limited the functions to private where possible to try reduce our public API footprint. ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. --> Change inner functions in functions & nested-functions crates to be private, away from public. - There are still some that are left public such as some regex ones, because they are used directly in benches ## Are these changes tested? <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 2. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> Compiler itself. ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> Yes, quite a few functions are now private, but I don't think they were meant to be public in the first place. <!-- If there are any breaking changes to public APIs, please add the `api change` label. -->
Which issue does this PR close?
clippy::needless_pass_by_valuetodatafusion-functions#18758.Rationale for this change
clippy::needless_pass_by_valuetodatafusion-functions.What changes are included in this PR?
Are these changes tested?
Are there any user-facing changes?