Skip to content

feat: flag bare container type hints #40

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

Closed
safwansamsudeen wants to merge 1 commit into from
Closed

feat: flag bare container type hints #40

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
17 changes: 17 additions & 0 deletions rules/security/whitelisted.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,23 @@ rules:
# Exclude 'self', 'cls', and '*' as they typically don't take hints
regex: ^(?!self$|cls$|\*$).*$
message: "The argument '$ARG' in function '$FUNC' is missing a type hint."
- id: bare-container-type-hint
languages: [python]
severity: WARNING
pattern-either:
- pattern: |
@frappe.whitelist(...)
def $FUNC(..., $ARG: list, ...): ...
- pattern: |
@frappe.whitelist(...)
def $FUNC(..., $ARG: dict, ...): ...
- pattern: |
@frappe.whitelist(...)
def $FUNC(..., $ARG: list | $X, ...): ...
- pattern: |
@frappe.whitelist(...)
def $FUNC(..., $ARG: dict | $X, ...): ...
message: "The argument '$ARG' in function '$FUNC' is missing a specific container type hint (e.g., list[str])."
- id: guest-whitelisted-method
languages: [python]
severity: WARNING
Expand Down