check function names for wording issues

Metadata

ID: python-inclusive/function-definition

Language: Python

Severity: Notice

Category: Code Style

Description

Ensure that some words are not used in the codebase and suggest replacement when appropriate.

Examples of replacement suggestions:

  • blacklist with denylist
  • whitelist with allowlist
  • master with primary
  • slave with secondary

Non-Compliant Code Examples

# blacklist located at the end of the string
def foo_blacklist():
    pass
# Do not use the name blacklist, even if casing is mixed
def BlaCKliSt_NaMeS():
    pass

def wHiTeLisT_NaMeS():
    pass
# blacklist at the beginning of the function name
def blacklist_names():
    pass
# wrong identifier in the function name and parameters
def blacklist_names(master, slave):
    pass

Compliant Code Examples

def foo_denylist():
    pass
https://static.datadoghq.com/static/images/logos/github_avatar.svg https://static.datadoghq.com/static/images/logos/vscode_avatar.svg jetbrains

Seamless integrations. Try Datadog Code Analysis