Unclear that you need to reanalyze between setting a property and getting it back
Los mantenedores suelen responder en 2 días
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 78/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Empieza con docs/dev/concepts.md y docs/guide/index.md; después, revisa el ejemplo citado en el issue #2295 para ver qué sigue siendo confuso. Aclara cómo se comporta la lectura de propiedades después de una escritura y antes de que se ejecute el análisis, especialmente en los scripts de Python, y explica cuándo llamar a bv.update_analysis_and_wait() o current_function.reanalyze(). El trabajo estará terminado cuando los lectores puedan entender por qué una lectura puede devolver el valor anterior y cómo obtener el actualizado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- C++
- Estrellas
- 1.3k
- Forks
- 304
- Merge medio
- 2 d 20 h
- PR fusionados (30 d)
- 10
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de Vector35/binaryninja-api
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 84/100
Vector35/binaryninja-api#8715 ·
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Vector35/binaryninja-api#8714 ·
Los mantenedores suelen responder en 2 días
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
Vector35/binaryninja-api#8713 ·
Los mantenedores suelen responder en 2 días
-
Component: Python API
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Vector35/binaryninja-api#8649 ·
Los mantenedores suelen responder en 2 días
-
Hexagon lifting issuesAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Vector35/binaryninja-api#8621 · 1 comentario ·
Los mantenedores suelen responder en 2 días
Todos los issues de Vector35/binaryninja-api
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 80/100
ESPresense/ESPresense#2680 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 Menos de una hora Aptitud para principiantes 75/100
stew675/llama-cpp-rdna-boosts#348 ·
Los mantenedores suelen responder en 1 día
-
Documentation: Add comprehensive newcomer onboarding guide, project structure, and local usage to READMEPosiblemente ocupada @Ash-Blanc la tomó hoy. Abiertoarea/other status/bot-triaged status/need-triage
Dificultad 2/5 Medio día Aptitud para principiantes 85/100
-
bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día