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

Aperta
#6 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

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.”

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
2
Fork
2
Merge medio
11m
PR unite (30g)
2

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ossf/python-secure-coding-guide

Tutte le issue di ossf/python-secure-coding-guide

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.