# -*- coding: utf-8 -*-
# ---
# jupyter:
#   jupytext:
#     text_representation:
#       extension: .sh
#       format_name: light
#       format_version: '1.5'
#       jupytext_version: 1.14.4
#   kernelspec:
#     display_name: Bash
#     language: bash
#     name: bash
# ---

# + [markdown] slideshow={"slide_type": "slide"}
# # Diseño de software para cómputo científico
#
# ----
#
# ## Unidad 6: Estilo de código (*flake8* + *black*)
#
# Se pasa más tiempo leyendo código que escribiéndolo. Entonces:
#  - **Readability counts** (PEP 20)

# + [markdown] slideshow={"slide_type": "slide"}
# ![Screenshot%20from%202021-09-06%2018-47-34.png](attachment:Screenshot%20from%202021-09-06%2018-47-34.png)
#
#
# [Flake8](https://github.com/PyCQA/flake8) es un herramienta que sirve para **chequear** el estilo de código Python.
# Esta diseñada sobre otras herramientas y se puede extender su funcionalidad con diversos plugins.
#

# + [markdown] slideshow={"slide_type": "fragment"}
# Para correr en la terminal tenemos estas opciones:
# ```
# flake8
# flake8 file.py
# flake8 /path/to/folder/
# ```

# + [markdown] slideshow={"slide_type": "slide"}
# ## Ejemplo con flake8

# + slideshow={"slide_type": "-"}
flake8 codes/style_example.py

# + [markdown] slideshow={"slide_type": "fragment"}
# El estilo que revisa no es exactamente PEP8. Hay [varios plugins](https://github.com/DmytroLitvinov/awesome-flake8-extensions) que se agregan para estilos especializados.
#
# Por ejemplo:
#    - flake8-isort  (verifica el orden de los imports)
#    - flake8-black  (menciona los cambios que haría black)
#    - pep8-naming   (verifica los nombres de variables, funciones, clases, etc.)
#    - flake8-builtins (prohibe el uso de funciones de python como nombres de variables)

# + slideshow={"slide_type": "fragment"}
pip install flake8-isort pep8-naming flake8-black
# -

flake8 codes/style_example.py

# + [markdown] slideshow={"slide_type": "slide"}
# ![black.png](attachment:black.png)
#
# Es un **formateador** (*linter*) de codigo para apegarse al estándar PEP8. *Ojo que sobreescribe los archivos!*
#
# Revisa que el AST sea igual antes y despues de formatear. Funciona con poca (o nula) configuración y te ahorra tener que pensar.
#
# Tiene opciones para evitar formatear secciones de código:
#    - No formatea bloques que empiecen con **# fmt: off** y terminen con **# fmt: on**.
#    - No formatea líneas que terminen con **# fmt: skip**.
# -

pip install black

black codes/style_example.py -l 80

StarcoderdataJupyterScriptsDedupFiltered