Permite abrir la documentación del proyecto directamente en un navegador web:
$ pycheck docs
Enunciado
Cada ejercicio tiene un identificador asociado. Una vez que lo sepamos podremos realizar una serie de acciones sobre el mismo. Supongamos que vamos a trabajar con un ejercicio cuyo identificador es sum.
Para ver el enunciado del ejercicio ejecutamos lo siguiente:
$ pycheck show sum
Esto nos muestra:
Un título del ejercicio. En el encabezado del marco.
Una descripción del ejercicio: Texto Markdown.
Una lista de casos de comprobación. Los casos de comprobación están numerados # y se puede hacer referencia a ellos de manera individual.
Plantilla
Para empezar a trabajar necesitamos la plantilla del ejercicio. La podemos generar de la siguiente manera:
$ pycheck template sum
Esto generará un fichero sum.py en la carpeta de trabajo con el siguiente contenido:
# ********************
# LA SUMA MÁS SENCILLA
# ********************
def run(a: int, b: int) -> int:
result = 'tu código aquí'
return result
if __name__ == '__main__':
run(3, 4)
Nuestro código debe empezar en la línea 7.
Arranque
Existe una forma de mostrar la descripción del ejercicio y crear la plantilla, todo de una vez. Para ello usamos el siguiente comando de "arranque":
$ pycheck boot sum
Comprobación
Una vez que hayamos escrito nuestro código sobre la plantilla sum.py podemos ver si supera los casos de comprobación. Para ello hacemos:
$ pycheck check sum
Resultado erróneo:
Resultado correcto:
Es posible lanzar un único caso de comprobación. Supongamos que sólo queremos comprobar el caso número 1:
$ pycheck check -n1 sum
Esta opción es muy interesante para poder depurar nuestro código.
Ejecución
Si queremos ejecutar el ejercicio con argumentos propios, podemos hacerlo pasando dichos argumentos desde línea de comandos:
$ pycheck run sum 1 9
10
Es muy importante tener en cuenta que, en la mayoría de situaciones, los argumentos por línea de comandos deben pasarse entrecomillados:
$ pycheck run sum 1 9
$ pycheck run sum "1" "9"
$ pycheck run sum -- 1 -1 # Usar -- para números negativos
$ pycheck run sum 3.21 4.56
$ pycheck run sum hola mundo # 2 argumentos distintos
$ pycheck run sum "Hola mundo" # Un único argumento
$ pycheck run sum True
$ pycheck run sum "True"
$ pycheck run sum "[1, 2, 3]" # listas
$ pycheck run sum "{'a': 1, 'b': 2}" # diccionarios