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

Aberta
#6 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
45/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Pouca atividade
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

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

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Python
Estrelas
2
Forks
2
Merge médio
11min
PRs com merge (30d)
2

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de ossf/python-secure-coding-guide

Todas as issues de ossf/python-secure-coding-guide

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.