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

オープン
#6 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
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分
マージ済み PR(30日)
2

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ossf/python-secure-coding-guide のほかの issue

ossf/python-secure-coding-guide の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。