-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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
Fix pylint errors #39397
base: main
Are you sure you want to change the base?
Fix pylint errors #39397
Conversation
API change check APIView has identified API level changes in this PR and created following API reviews. |
:param kwargs: Keyword arguments to verify for query_items_change_feed API | ||
:keyword mode: Must be one of the values in the Enum, 'ChangeFeedMode'. | ||
:param dict[str, Any] kwargs: Keyword arguments to verify for query_items_change_feed API | ||
* keyword mode: Must be one of the values in the Enum, 'ChangeFeedMode'. |
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.
nit: * instead of :
* paramtype is_start_from_beginning: bool | ||
* keyword start_time: Must be in supported types. | ||
* paramtype start_time: Union[~datetime.datetime, Literal["Now", "Beginning"]] | ||
* type kwargs: dict[str, Any] |
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.
same as above ^
@@ -2780,8 +2782,9 @@ async def __QueryFeed( # pylint: disable=too-many-branches,too-many-statements, | |||
query: Optional[Union[str, Dict[str, Any]]], | |||
options: Optional[Mapping[str, Any]] = None, | |||
partition_key_range_id: Optional[str] = None, | |||
response_hook: Optional[Callable[[Mapping[str, Any], Mapping[str, Any]], None]] = None, |
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 is being changed from a parameter to a kwarg, I want to ensure that this is intended and accurate
"""Get a sorted list of items that were changed, in the order in which they were modified. | ||
|
||
:keyword str continuation: The continuation token retrieved from previous response. It contains chang feed mode. |
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.
instead of deleting the documentation if you don't want to list out all the args and kwargs for whatever reason could you put a #pylint:disable=the pylint rule on the offending line instead. We dont want to remove documentation
Description
Pylint was causing PR build failures. This Fix will fix the pylint errors.
The majority of the errors were caused by
response_hook
parameter.response_hook
parameter was added to docstrings for number of functions, but none of them were added to the definition of the functions. This caused the docstring and the function definition to be out of sync.The main updates:
response_hook
parameter was used inside of the functions, I added the parameter to the function definition.response_hook
parameter was not used, I removed the parameter from the docstring.do-not-import-asyncio
,do-not-log-exceptions
)All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines