Python: Move min/maxParameter methods to Function class
#18871
Conversation
This file contains 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
These seem generally useful outside of points-to, and so it might be better to add them to the `Function` class instead. I took the liberty of renaming these to say `Arguments` rather than `Parameters`, as this is more in line with the nomenclature that we're using elsewhere. (The internal points-to methods retain the old names.) I'm somewhat ambivalent about the behaviour of `getMaxParameters` on functions with `*varargs`. The hard-coded `INT_MAX` return value is somewhat awkward, but the alternative (to only have the predicate defined when a specific maximum exists) seems like it would potentially cause a lot of headaches.
There was a problem hiding this comment.
PR Overview
This PR moves the min/max parameter methods to the Function class and renames them to use “Arguments” for consistency with the rest of the codebase.
- Moved methods from a points-to context into the Function class.
- Renamed the methods to getMinArguments and getMaxArguments, and updated the corresponding change notes.
Reviewed Changes
| File | Description |
|---|---|
| python/ql/lib/change-notes/2025-02-26-add-get-min-max-parameters-to-function-class.md | Added change notes documenting the new Function class methods |
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
Tip: Copilot only keeps its highest confidence comments to reduce noise and keep you focused. Learn more
| @@ -163,6 +163,18 @@ class Function extends Function_, Scope, AstNode { | |||
| ret.getValue() = result.getNode() | |||
| ) | |||
| } | |||
|
|
|||
| /** Gets the minimum number of positional arguments that can be correctly passed to this function. */ | |||
| int getMinArguments() { | |||
There was a problem hiding this comment.
Naming: Should these be getMinPositionalArguments, something like that?
| /** Gets the maximum number of positional arguments that can be correctly passed to this function. */ | ||
| int getMaxArguments() { | ||
| if exists(this.getVararg()) | ||
| then result = 2147483647 // INT_MAX |
There was a problem hiding this comment.
Ooh this is an interesting trap. I suggest at least putting it in the QLDoc, i.e. if the function doesn't take varargs, the result is INT_MAX.
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.
These seem generally useful outside of points-to, and so it might be better to add them to the
Functionclass instead.I took the liberty of renaming these to say
Argumentsrather thanParameters, as this is more in line with the nomenclature that we're using elsewhere. (The internal points-to methods retain the old names.)I'm somewhat ambivalent about the behaviour of
getMaxParameterson functions with*varargs. The hard-codedINT_MAXreturn value is somewhat awkward, but the alternative (to only have the predicate defined when a specific maximum exists) seems like it would potentially cause a lot of headaches.