Allow exceptions to bubble up and handle exceptions at the right level in the stack.
Each except
block must ensure that the program continues only with formally specified behavior by either:
Invalid reasons for suppressing exceptions cause:
Printing the stack trace can reveal details and sensitive data about an application such as the components in use, existing users, and other sensitive information such as keys or passwords, as described in CWE-209: Generation of Error Message Containing Sensitive Information and will not be handled in these examples.
In Python Exception
extends from BaseException
and a bare except
will catch everything.
For instance, catching a bare except
causes a user to be unable to stop a script via CTRL+C
, due to the base except
catching all exceptions. In comparison, catching except Exception
allows a KeyboardInterrupt
to be the Python interpreter itself or other parts of the code. This is due to KeyboardInterrupt
extending BaseException
and not Exception
.
Note that using except Exception
is still too broad as per CWE-755: Improper Handling of Exceptional Conditions and that a more specific exception handling is preferred.
The noncompliant01.py
code demonstrates a bare except
on a ZeroDivisionError
and must be run on the command line in order to experience the issue.
# SPDX-FileCopyrightText: OpenSSF project contributors
# SPDX-License-Identifier: MIT
""" Non-compliant Code Example """
from time import sleep
def exception_example():
"""Non-compliant Code Example using bare except"""
while True:
try:
sleep(1)
_ = 1 / 0
except:
print("Don't care")
#####################
# exploiting above code example
#####################
exception_example()
The noncompliant01.py
will continue to run when launched via terminal even when using CTRL+C
.
The process will have to be terminated or killed in order to stop it. A programming IDE will allow stopping the noncompliant01.py
as IDEs tend to kill the process rather than sending CTRL+C
.
The compliant01.py
code example can be stopped via CTRL+C
on the command line as it is catching the self created ZeroDivisionError
instead of using a bare exception.
# SPDX-FileCopyrightText: OpenSSF project contributors
# SPDX-License-Identifier: MIT
""" Compliant Code Example """
from time import sleep
def exception_example():
"""Compliant Code Example catching a specific exception"""
while True:
sleep(1)
try:
_ = 1 / 0
except ZeroDivisionError:
print("How is it now?")
#####################
# exploiting above code example
#####################
exception_example()
If recovery from an exception remains impossible, it is often best practice to wrap the checked exception in an unchecked exception and rethrow it. This approach allows the application to fail gracefully or log the error for future debugging, rather than crashing unexpectedly.
example01.py
assist in the understanding of Java’s SEI Cert exceptions SEI CERT ERR00-J 2025 by providing a use-case specfic explaination slice_cake:You got to give me plates
when re-throwing ZeroDivisionError
.
# SPDX-FileCopyrightText: OpenSSF project contributors
# SPDX-License-Identifier: MIT
"""Code Example"""
def slice_cake(cake: int, plates: int) -> float:
"""Calculates size of each slice per plate for a cake
Args:
cake (int) : Size of the cake
guests (int): Amount of guests
Returns:
(float): Size of each slice
"""
try:
return cake / plates
except ZeroDivisionError as zero_division_error:
raise ZeroDivisionError(
"slice_cake:You got to give me plates"
) from zero_division_error
#####################
# exploiting above code example
#####################
slice_cake(cake=100, plates=0)
The following two exceptions, highlighted in SEI Cert’s Oracle Coding Standard for Java, are important to understand when to attempt to handle exceptions at the right level in the stack in Python also.
Tool | Version | Checker | Description |
---|---|---|---|
Ruff | v0.4.5 | bare-except (E722) | Use lazy % formatting in logging functions |
Pylint | 3.2.7 | W0702:bare-except | No exception type(s) specified |
flake8 | 7.1.1 | E722 | do not use bare ‘except’ |
MITRE | CWE-209: Generation of Error Message Containing Sensitive Information |
SEI CERT Oracle Coding Standard for Java | ERR00-J. Do not suppress or ignore checked exceptions |
MITRE CWE Base | CWE-703, Improper Check or Handling of Exceptional Conditions |
MITRE CWE Pillar | CWE-390, Detection of Error Condition without Action |
[Python.org 2022] | python.org. (2022). Built-in Exceptions [online]. Available from: https://docs.python.org/3.9/library/exceptions.html [accessed 08 February 2023] |
[SEI CERT ERR00-J 2025] | ERR00-J. Do not suppress or ignore checked exceptions [online]. Available from: https://wiki.sei.cmu.edu/confluence/display/java/ERR00-J.+Do+not+suppress+or+ignore+checked+exceptions [Accessed Februrary 2025] |