Skip to content
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.

Sign up for GitHub

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

Допускать с методами tasks.* запуск только метода call(raw=True) #245

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Допускать с методами tasks.* запуск только метода call(raw=True) #245

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions fast_bitrix24/user_request.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,8 @@ class GetAllUserRequest(UserRequestAbstract):
"get_all() doesn't support parameters 'start' or 'order'",
)
@icontract.require(
lambda self: not self.st_method.startswith("tasks.elapseditem."),
"get_all() shouldn't be used with 'tasks.elapseditem.*' method group. "
lambda self: not self.st_method.startswith("tasks."),
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Consider centralizing the 'tasks.*' method group check.

The 'tasks.*' method group check is repeated in multiple places. It might be beneficial to centralize this logic in a helper function to avoid redundancy and make future updates easier.

Suggested change
lambda self: not self.st_method.startswith("tasks."),
def is_not_tasks_method(st_method: str) -> bool:
return not st_method.startswith("tasks.")
@icontract.require(
lambda self: is_not_tasks_method(self.st_method),
"get_all() shouldn't be used with 'tasks.*' method group. "
"Use call(raw=True) instead. Read more: "
)

"get_all() shouldn't be used with 'tasks.*' method group. "
"Use call(raw=True) instead. Read more: "
"https://github.com/leshchenko1979/fast_bitrix24/issues/199",
)
Expand Down Expand Up @@ -270,6 +270,12 @@ def __init__(
"get_by_ID(): 'ID_list' should be a Sequence "
"if a progress bar is to be displayed",
)
@icontract.require(
lambda self: not self.st_method.startswith("tasks."),
"get_by_ID() shouldn't be used with 'tasks.*' method group. "
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Clarify the error message for 'tasks.*' method group.

The error message could be more specific about why 'tasks.*' method group should not be used with 'get_by_ID()'. This can help users understand the limitation better.

Suggested change
"get_by_ID() shouldn't be used with 'tasks.*' method group. "
"get_by_ID() shouldn't be used with 'tasks.*' method group because it may lead to unexpected behavior. "

"Use call(raw=True) instead. Read more: "
"https://github.com/leshchenko1979/fast_bitrix24/issues/199",
)
def check_special_limitations(self):
return True

Expand Down Expand Up @@ -307,6 +313,12 @@ def __init__(self, bitrix, method: str, item_list: Union[Dict, Iterable[Dict]]):
"call(): 'ID_list' should be a Sequence "
"if a progress bar is to be displayed",
)
@icontract.require(
lambda self: not self.st_method.startswith("tasks."),
"call(raw=False) shouldn't be used with 'tasks.*' method group. "
"Use call(raw=True) instead. Read more: "
"https://github.com/leshchenko1979/fast_bitrix24/issues/199",
)
def check_special_limitations(self):
if self.st_method.endswith(GET_ALL_ENDINGS):
warnings.warn(
Expand Down
Loading