Skip to content

Añade script check_spell.py #1669

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 6, 2021
Merged

Conversation

rtobar
Copy link
Collaborator

@rtobar rtobar commented Nov 30, 2021

El nuevo script check_spell.py consiste en el antiguo create_dict.py más un llamado automático a pospell. Todas las referencias al combo create_dict.py + pospell han sido eliminadas, y en su lugar ahora se llama simplemente a check_spell.py.

check_spell.py sin argumentos chequea todo el repositorio (como se usa en el worfklow de GitHub y en el Makefile). Si se entregan argumentos, se chequea sólo esos archivos (como se usa con pre-commit).

La versión anterior de este script cargaba los archivos completos antes
de agregarlos al set, lo que usa más memoria de lo requerido. Esta
operación se puede realizar más eficientemente usando generadores, con
lo cual los archivos se procesan línea a línea.

El script también innecesariamente trataba de remover el string vacío
del set resultando, lo cual se puede prevenir al momento de agregar
elementos al set.

Finalmente, el docstring todavía tenía referencias al antiguo archivo
"dict", las cuales fueron quitadas. El docstring también fue cambiado de
posición de tal manera que aparezca antes de los imports.

Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
Los usuarios que quieren realizar un chequeo ortográfico sobre los
archivos .po actualmente tienen que realizar dos pasos: invocar el sript
create_dict.py, el cual genera un archivo dict.txt (un diccionario que
contiene a todos los diccionarios dentro de dictionaries/), para luego
invocar pospell usando este diccionario generado.

Este commit toma el script create_dict.py y le agrega la funcionalidad
de invocar pospell luego de generar el diccionario dict.txt (que ahora
se genera como un archivo temporal). Con esto, el script ahora cumple la
función completa de relizar el chequeo de ortografía, por lo que su
nombre ha cambiado a check_spell.py

Si no se entregan argumentos, el script corrige todos los archivos .po
del repositorio; en caso contrario el usuario debe especificar arhivos
.po a ser chequeados.

Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
…spell.py

En el caseo del workflow de GitHub y del Makefile, el cambio es simple:
basta con sustituir la invocación a los dos scripts anteriores por el
nuevo y ya todo funciona.

En el caso de pre-commit, podemos sacar el hook que corre pospell
directamente, y en cambio declrar el paquete pospell como una
dependencia aditional del nuestro hook local que ahora corre
check_spell.py directamente.

Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
Ya no es necesario que los usuarios realizen dos pasos por separado,
sino que ahora solo necesitan correr un solo script.

Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
Copy link
Collaborator

@cacrespo cacrespo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yo lo veo super bien! Pero no me da la nafta para hacer el merge 😅
tal vez @cmaureir?

@cmaureir
Copy link
Collaborator

cmaureir commented Dec 6, 2021

Muchas gracias @rtobar 🎉

@cmaureir cmaureir merged commit f6ebc82 into python:3.10 Dec 6, 2021
cmaureir pushed a commit that referenced this pull request Dec 7, 2021
* Mejora varios aspectos del script create_dict

La versión anterior de este script cargaba los archivos completos antes
de agregarlos al set, lo que usa más memoria de lo requerido. Esta
operación se puede realizar más eficientemente usando generadores, con
lo cual los archivos se procesan línea a línea.

El script también innecesariamente trataba de remover el string vacío
del set resultando, lo cual se puede prevenir al momento de agregar
elementos al set.

Finalmente, el docstring todavía tenía referencias al antiguo archivo
"dict", las cuales fueron quitadas. El docstring también fue cambiado de
posición de tal manera que aparezca antes de los imports.


* Mueve create_dict.py -> check_spell.py

Los usuarios que quieren realizar un chequeo ortográfico sobre los
archivos .po actualmente tienen que realizar dos pasos: invocar el sript
create_dict.py, el cual genera un archivo dict.txt (un diccionario que
contiene a todos los diccionarios dentro de dictionaries/), para luego
invocar pospell usando este diccionario generado.

Este commit toma el script create_dict.py y le agrega la funcionalidad
de invocar pospell luego de generar el diccionario dict.txt (que ahora
se genera como un archivo temporal). Con esto, el script ahora cumple la
función completa de relizar el chequeo de ortografía, por lo que su
nombre ha cambiado a check_spell.py

Si no se entregan argumentos, el script corrige todos los archivos .po
del repositorio; en caso contrario el usuario debe especificar arhivos
.po a ser chequeados.


* Cambia GitHub workflows, Makefile y pre-commit hooks para usar check_spell.py

En el caseo del workflow de GitHub y del Makefile, el cambio es simple:
basta con sustituir la invocación a los dos scripts anteriores por el
nuevo y ya todo funciona.

En el caso de pre-commit, podemos sacar el hook que corre pospell
directamente, y en cambio declrar el paquete pospell como una
dependencia aditional del nuestro hook local que ahora corre
check_spell.py directamente.


* Actualiza FAQ sobre cómo hacer chequeo de ortografía

Ya no es necesario que los usuarios realizen dos pasos por separado,
sino que ahora solo necesitan correr un solo script.

Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>
@rtobar rtobar deleted the check_spell_script branch December 9, 2021 02:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants