Improve type annotation for RunSQL #1090
Merged
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
The sqls to be executed do not necessarily need to be a homogeneous list or tuple containing only lists or tuples or strs. It can be a mix of everything. Signed-off-by: Zixuan James Li <[email protected]>
The 2-item tuple for `sql` can have a `dict` as the second item for parameters. This behavior is the same as using `cursor.execute` for backends except SQLite. Relevant implementation: https://github.com/django/django/blob/5f760025004bdb02f9844011033459c30347f215/django/db/migrations/operations/special.py#L119-L133 Signed-off-by: Zixuan James Li <[email protected]>
Signed-off-by: Zixuan James Li <[email protected]>
sobolevn
approved these changes
Aug 9, 2022
| @@ -21,15 +21,17 @@ class SeparateDatabaseAndState(Operation): | |||
|
|
|||
| class RunSQL(Operation): | |||
| noop: Literal[""] = ... | |||
| sql: Union[str, _ListOrTuple[str], _ListOrTuple[Tuple[str, Optional[_ListOrTuple[str]]]]] = ... | |||
| reverse_sql: Optional[Union[str, _ListOrTuple[str], _ListOrTuple[Tuple[str, Optional[_ListOrTuple[str]]]]]] = ... | |||
| sql: Union[str, _ListOrTuple[Union[str, Tuple[str, Union[Dict[str, Any], Optional[_ListOrTuple[str]]]]]]] = ... | |||
|
This causes false positive when used with a sqls: list[str] = ["SOME SQLS", "SOME SQLS"]
RunSQL(sql=sqls, reverse_sql=[])
I don't think there's a simple fix though. Ordinariy we would change |
|
Wild guess: maybe moving |
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.
I have made things!
The
sqls to be executed do not necessarily need to be a homogeneous listor tuple containing only lists or tuples or
strs. It can be a mix ofeverything acceptable for the cursor.
RunSQLiterates through the list or tupleand executes them separately.
Also, the 2-item tuple for
sqlcan have adictas the second itemfor parameters. This behavior is the same as using
cursor.executefor backends except for SQLite.A test case is added along with this change.
Relevant implementation
https://github.com/django/django/blob/5f760025004bdb02f9844011033459c30347f215/django/db/migrations/operations/special.py#L119-L133
Related issues