Выдавать предупреждение, когда в фильтрах используют None #226
Conversation
Поправить использование warinings.warn Fixes #223
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @leshchenko1979 - I've reviewed your changes and they look great!
General suggestions:
- Consider clarifying the warning message regarding the use of 'null' or 'false' to ensure it's understood they are not string literals.
- Verify the 'stacklevel' parameter in warnings to ensure it accurately points to the user's code, enhancing the debugging experience.
- Include specific version or timeline information in deprecation warnings to make them more actionable for developers.
Here's what I looked at during the review
- 🟡 General issues: 3 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Docstrings: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
| if "FILTER" in p and None in p["FILTER"].values(): | ||
| warnings.warn( | ||
| "Using None as filter value confuses Bitrix. " | ||
| "Try using an empty string, 'null' or 'false'.", | ||
| UserWarning, | ||
| stacklevel=2, | ||
| ) |
There was a problem hiding this comment.
suggestion (code_clarification): Consider refining the warning message for clarity.
The warning message suggests using 'null' or 'false' as alternatives to None, which might be interpreted as string literals rather than the intended JSON values. Clarifying this in the message could prevent confusion.
| @@ -176,6 +184,7 @@ | |||
| f"Number of results returned ({len(self.results)}) " | |||
| f"doesn't equal 'total' from the server reply ({self.total})", | |||
| RuntimeWarning, | |||
| stacklevel=4, | |||
There was a problem hiding this comment.
question (code_refinement): Verify the appropriateness of 'stacklevel=4' for the context.
Ensure that 'stacklevel=4' correctly points to the user's code in the stack trace. If the nesting level of calls has changed, this value might need adjustment.
| warnings.warn( | ||
| "list_and_get() is deprecated. It's not efficient to use it " | ||
| "now that exceeding Bitrix request rate limitations gets users " | ||
| "heavily penalised. Use 'get_all()' instead.", | ||
| DeprecationWarning, | ||
| stacklevel=2, |
There was a problem hiding this comment.
suggestion (code_clarification): Ensure the deprecation warning is clear and actionable.
The message now provides more context on why 'list_and_get()' is deprecated, which is good. However, consider adding a specific version or date when 'list_and_get()' will be removed to make the deprecation notice more actionable.
Поправить использование warinings.warn
Fixes #223