Maybe flatten out exception tree
还没有人认领这个 Issue。
评估
调研方向
首先审查当前的异常层次结构以及拟议的 exceptions.general、exceptions.http、exceptions.opening、exceptions.kv_store 和 exceptions.acl 模块。然后检查生成器及其冲突处理机制。完成的标准是:就层次结构和名称达成一致,在不意外改变父级关系的情况下实现扁平化,并添加冲突防护。
由索引模型根据 Issue 内容生成。
描述
This is a ticket for discussion and design, responding to Paul's comment about nested exceptions being awkward to reach for.
--
I spread all the errors out on the table and had a look. We can get a pretty nice result by dividing exceptions across 5 modules, while still saving ourselves from utterly changing the shape of the world (fighting the WIT forevermore). No more subpackages under exceptions, just 5 files:
-
exceptions.general:- All from types.error. I don't see a point in having a common superclass for these at all; there's no semantic, and it doesn't really help catchers narrow down what threw it, as many things throw these.
- Move
HttpInvalid,HttpUser, andHttpIncompletetoexceptions.http, though. - It's unfortunate
GenericErrorexists, as it sound a lot likeUnexpectedFastlyError.UnexpectedFastlyErrorshould become private, as it indicates a bug in our code if it's thrown. People definitely shouldn't be catching it. CatchExceptionorFastlyExceptionif you want a catch-all. - Rename
GenericErrortoOtherErrorto get a little closer to its meaning. "Generic" suggests to me a superset of the other errors, while "Other" unambiguously indicates it's not one of those errors.
-
exceptions.http:ErrorWithDetailwith a better name, likeHttpError.- All the
send-error-detailexceptionserror-with-detailcarries (not currently generated). Map anyErrorWithDetailthat has (optional) details directly onto these, subclassingHttpError. - All the
trailer-errors. RenameErrortoOtherError.
-
exceptions.opening:- All
open-errorerrors. This is actually a pretty semantically cohesive category.
- All
-
exceptions.kv_store:- All
kv-errorerrors. - There's another
GenericErrorthere. Rename it toOtherError.
- All
-
exceptions.acl:- All the
acl-errors. RenameGenericErrortoOtherError.
- All the
Open questions
- Are we going to cause trouble for ourselves by changing the parentage of some errors, like making
error'sHttpInvalidsuperclassexceptions.http.HttpError(or perhaps some other common ancestor)? I rather think so. The common-ancestor approach sounds good. Theerrorsuperclass is worthless, but theerror-with-detailone may have meaning.
Name collisions (if we were to flatten everything into 1 module):
- Error (x2), but we can probably remove the types.error.Error common superclass to make that go away.
- GenericError (x4)
- LimitExceeded (x2)
- TooManyRequests (x2)
- Unsupported (x2)
Paths not taken
We could deduplicate and have, say, ACL stuff and non-ACL stuff throw the same TooManyRequests error, but we'd be losing potentially important info for the catcher. So that's a bad idea. (Also, it could get messy if the 2 TooManyRequests errors later diverge in shape, which might happen if WIT grows subtyping.)
Thus, we must rename exceptions or divide up into modules.
If we flatten and rename, we get into trouble in the future when somebody introduces another InternalError and we never prefixed the KV one into KvStoreInternalError. I'm against preemptively prefixing the heck out of everything, because it gets wordy and this isn't Java. And does one really need to say HttpTrailerError? There are unlikely to be other kinds of trailer errors. But if we don't prefix universally, it becomes awkward to program against because you constantly have to look aside to see what we named things. So let's keep the names short and just make a better __repr__ instead if needed to clarify tracebacks.
Prerequisites
We'd need to add alarm bells about collisions in the generator so we don't accidentally template duplicate names into one module.
- 主要语言
- Python
- 星标
- 5
- 派生
- 1
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
fastly/compute-sdk-python 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 75/100
fastly/compute-sdk-python#116 ·
-
难度 4/5 3-5 天 新手友好度 35/100
fastly/compute-sdk-python#98 ·
-
难度 5/5 一周以上 新手友好度 35/100
fastly/compute-sdk-python#74 ·
-
难度 5/5 一周以上 新手友好度 35/100
fastly/compute-sdk-python#61 ·
-
fastly/compute-sdk-python#60 · 已指派 1 人 ·
查看 fastly/compute-sdk-python 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 75/100
xinnan-tech/xiaozhi-fde-talk#263 ·
-
rules
难度 1/5 1 小时以内 新手友好度 90/100
-
难度 2/5 1-3 小时 新手友好度 70/100
huggingface/Repo2RLEnv#163 · 1 条评论 ·
-
难度 1/5 1 小时以内 新手友好度 95/100
huggingface/sentence-transformers#4074 ·
-
comp/dashboard invalid P3
难度 2/5 1-3 小时 新手友好度 70/100
NousResearch/hermes-agent#121143 ·