pyscg-0052 check and correct so that code examples cover state related issues

未关闭
#6 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
45/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
冷清
技术栈
python
领域
documentation

调研方向

Start by reviewing pyscg-0052, “Ensure Cleanup on Exceptions,” and the lock related examples in “07_concurrency.” Find examples about stateful objects and staged or temporary data that show how exceptions can cause inconsistency. Done means adding or correcting examples and explanations for avoiding or reverting state changes and controlling temporary data, while keeping the lock examples covered in “07_concurrency.”

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

描述

During restructuring we found that code examples in pyscg-0052 on "Ensure Cleanup on Exceptions" are perfect examples regarding locks in "07_concurrency" but are 'somewhat' misleading examples to "Ensure Cleanup on Exceptions".

As part of this issue find code examples that demonstrate how handling of objects that 'state-full', have staged or temporary data can lead to inconsistency issues when an unexpected exception occurs. In such a situation we should see

  • issues around 'states' avoided in the first place or 'states' reverted during an exception.
  • Temporary data controlled, highly depends on use case.
  • inconsistencies avoided or at least controlled.

Ensure that what is explained in the lock related non-compliant and compliant code examples are covered in "07_concurrency" and not just deleted.

主要语言
Python
星标
2
派生
2
平均合并
11 分钟
30 天内合并 PR
2

环境准备

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

从这里开始

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

ossf/python-secure-coding-guide 的其他 Issue

查看 ossf/python-secure-coding-guide 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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