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

Ouverte
#6 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
45/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Calme
Stack technique
python
Domaine
documentation

Piste de recherche

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

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Python
Étoiles
2
Forks
2
Merge moyen
11 min
PR mergées (30 j)
2

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de ossf/python-secure-coding-guide

Toutes les issues de ossf/python-secure-coding-guide

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.