Directly raising exception from 'Exception' instance

未关闭
  • 哪里不对？
#321 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
半天
新手友好度
45/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
停滞
技术栈
python
领域
cloud

调研方向

Four bare raise Exception(...) sites are named: b2sdk/sync/action.py (around line 244), b2sdk/v1/download_dest.py (get_bytes_written), and two in b2sdk/v1/sync/folder.py (the except branches for NotADirectory and UnableToCreateDirectory). Read the existing exception classes in the package first, since the issue asks for a more specific built-in or custom exception but does not choose one. Done means each site raises a specific type, the existing tests in the sync and download suites still pass, and callers that catch the old generic exception are checked.

由索引模型根据 Issue 内容生成。

描述

OpenRefactory introduces fixers, that automatically fix safety, security, reliability and compliance issues. We ran OpenRefactory's Intelligent Code Repair (iCR) analysis engine on your code. We are reporting a few sample fixes that were generated.

Throwing overly broad exceptions promotes complex error handling code that is more likely to contain security vulnerabilities. It will become challenging to catch only specific types of exceptions. The best practice is to catch only exceptions which require specific handling.

Raising Exception in a function will lead to having an except Exception and the only way to differentiate between different exceptions is by comparing the exception messages. Moreover, one could forget to re-raise some exceptions which are unintentionally caught.

OpenRefactory’s Intelligent Code Repair (iCR) for Python, identified four such cases. The diffs are the following:

--- /home/nhasan/ORTest/PythonTest/b2-sdk-python/b2sdk/sync/action.py
+++ /home/nhasan/ORTest/PythonTest/b2-sdk-python/b2sdk/sync/action.py
@@ -241,6 +241,8 @@
             except OSError:
                 pass
         if not os.path.isdir(parent_dir):
+            # OpenRefactory Warning: Raising 'Exception' and 'BaseException' directly will have a negative impact on any code trying to catch these exceptions.
+            # Raise a more specific built-in exception or, create a custom one.
             raise Exception('could not create directory %s' % (parent_dir,))
 
     def do_action(self, bucket, reporter):

--- /home/nhasan/ORTest/PythonTest/b2-sdk-python/b2sdk/v1/download_dest.py
+++ /home/nhasan/ORTest/PythonTest/b2-sdk-python/b2sdk/v1/download_dest.py
@@ -175,6 +175,8 @@
 
     def get_bytes_written(self):
         if self.bytes_written is None:
+            # OpenRefactory Warning: Raising 'Exception' and 'BaseException' directly will have a negative impact on any code trying to catch these exceptions.
+            # Raise a more specific built-in exception or, create a custom one.
             raise Exception('data not written yet')
         return self.bytes_written

--- /home/nhasan/ORTest/PythonTest/b2-sdk-python/b2sdk/v1/sync/folder.py
+++ /home/nhasan/ORTest/PythonTest/b2-sdk-python/b2sdk/v1/sync/folder.py
@@ -22,6 +22,8 @@
         try:
             return func(*a, **kw)
         except exception.NotADirectory as ex:
+            # OpenRefactory Warning: Raising 'Exception' and 'BaseException' directly will have a negative impact on any code trying to catch these exceptions.
+            # Raise a more specific built-in exception or, create a custom one.
             raise Exception('%s is not a directory' % (ex.path,))
         except exception.UnableToCreateDirectory as ex:
             raise Exception('unable to create directory %s' % (ex.path,))

--- /home/nhasan/ORTest/PythonTest/b2-sdk-python/b2sdk/v1/sync/folder.py
+++ /home/nhasan/ORTest/PythonTest/b2-sdk-python/b2sdk/v1/sync/folder.py
@@ -24,6 +24,8 @@
         except exception.NotADirectory as ex:
             raise Exception('%s is not a directory' % (ex.path,))
         except exception.UnableToCreateDirectory as ex:
+            # OpenRefactory Warning: Raising 'Exception' and 'BaseException' directly will have a negative impact on any code trying to catch these exceptions.
+            # Raise a more specific built-in exception or, create a custom one.
             raise Exception('unable to create directory %s' % (ex.path,))
         except exception.EmptyDirectory as ex:
             raise exception.CommandError(

Reference: CWE-397: Declaration of Throws for Generic Exception

Reported by OpenRefactory’s Intelligent Code Repair (iCR) for Python v1.0. More info at: https://www.openrefactory.com/

主要语言
Python
星标
214
派生
68
平均合并
51 分钟
30 天内合并 PR
6

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

Backblaze/b2-sdk-python 的其他 Issue

查看 Backblaze/b2-sdk-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。