Unclear that you need to reanalyze between setting a property and getting it back
Mantenedores costumam responder em até 2 dias
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 1/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 78/100
- Tipo de issue
- Documentação
- Clareza
- Claramente especificada
- Status de atividade
- Ativa
- Stack de tecnologia
- python
- Domínio
- documentation
Direção de pesquisa
Comece por docs/dev/concepts.md e docs/guide/index.md e, em seguida, revise o exemplo citado na issue #2295 para ver o que ainda está confuso. Esclareça como as leituras de propriedades se comportam após uma escrita e antes da execução da análise, especialmente em scripts Python, e explique quando chamar bv.update_analysis_and_wait() ou current_function.reanalyze(). O trabalho estará concluído quando os leitores conseguirem entender por que uma leitura pode retornar o valor antigo e como obter o valor atualizado.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Is this a general concept that needs to be documented or a specific API?
Large set of API properties/functions
What concept or API needs more documentation?
In many cases, if you set a property and then read it back, you get the old value; the new value only shows up after running analysis.
For example, if I run this as a single console command:
>>> print(current_function.type); current_function.type = 'int(void *)'; print(current_function.type)
I get the same type twice:
void(int32_t arg1, char** arg2) __noreturn
void(int32_t arg1, char** arg2) __noreturn
After running the command, the UI automatically reanalyzes, so if I then run:
>>> print(current_function.type)
I get the new one:
int32_t(void* arg1)
This is apparently by design, and it is documented, but the documentation is very vague.
docs/dev/concepts.md says:
This is a convenience the UI does for you just like if you were to change a type or create a function, you almost always want the analysis to be updated. However, in scripts you run yourself as plugins or via the "Run Script" command, you may not get the same results mid-execution until after the entire script is finished running.
This says you "want the analysis to be updated" and "may not get the same results", but it doesn't say how the results differ. I would have expected that updating the analysis would be necessary for the change to propagate to other parts of the binary, perhaps necessary for it to appear in the decompilation; I wouldn't have expected it to be necessary merely to read the thing I just wrote.
Likewise, docs/guide/index.md says:
When you run commands in the scripting console, the UI will automatically update analysis. This is because quite often when you make a change in the console you expect it to be immediately reflected in the UI. The same is not true when running a script where you must trigger
bv.update_analysis_and_wait()orcurrent_function.reanalyze()to experience the same behavior.
This makes it sound like skipping reanalysis only prevents changes from appearing "in the UI".
I don't know if there is other documentation I'm missing, but if not, this should be clarified.
Is this documentation related to a specific API?
Affects all, but especially Python where these properties are getters and setters (affecting user expectations).
Are there any known examples of people using this API/concept?
#2295 is an example of someone getting confused by this.
- Linguagem predominante
- C++
- Estrelas
- 1.3k
- Forks
- 304
- Merge médio
- 2d 20h
- PRs com merge (30d)
- 10
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de Vector35/binaryninja-api
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 84/100
Vector35/binaryninja-api#8715 ·
Mantenedores costumam responder em até 2 dias
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Vector35/binaryninja-api#8714 ·
Mantenedores costumam responder em até 2 dias
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
Vector35/binaryninja-api#8713 ·
Mantenedores costumam responder em até 2 dias
-
Component: Python API
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
Vector35/binaryninja-api#8649 ·
Mantenedores costumam responder em até 2 dias
-
Hexagon lifting issuesAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Vector35/binaryninja-api#8621 · 1 comentário ·
Mantenedores costumam responder em até 2 dias
Todas as issues de Vector35/binaryninja-api
Issues semelhantes
-
Bug Core VIF
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 80/100
ESPresense/ESPresense#2680 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 Menos de uma hora Facilidade para iniciantes 75/100
stew675/llama-cpp-rdna-boosts#348 ·
Mantenedores costumam responder em até 1 dia
-
Documentation: Add comprehensive newcomer onboarding guide, project structure, and local usage to READMETalvez já em andamento @Ash-Blanc assumiu hoje. Abertaarea/other status/bot-triaged status/need-triage
Dificuldade 2/5 Meio dia Facilidade para iniciantes 85/100
-
bug
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
Mantenedores costumam responder em até 1 dia