ensure exception inherit a base exception

Docs > Code Analysis > Static Analysis Rules > ensure exception inherit a base exception

This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

Metadata

ID: python-best-practices/exception-inherit

Language: Python

Severity: Warning

Category: Best Practices

Description

New Exception must inherit the base Exception. Always use another exception as parent or use at least the Exception base class.

Learn More

Python Documentation: User-defined Exceptions

Non-Compliant Code Examples

class CustomException:
    """An Invalid exception class."""

Compliant Code Examples

class CustomException(Exception):
    """An Invalid exception class."""

How to use this rule

1
2
rulesets:
  - python-best-practices     # Rules to enforce Python best practices.

Create a static-analysis.datadog.yml with the content above at the root of your repository
Use our free IDE Plugins or add Code Analysis scans to your CI pipelines
Get feedback on your code

For more information, please read the Code Analysis documentation

VS Code Extension

Identify code vulnerabilities directly in your
VS Code editor

JetBrains Plugin

Identify code vulnerabilities directly in
JetBrains products