Estndar de Codificacin Lenguaje Python

Propsito
Version

Encabezado del
Programa

Formato del
encabezado

Gua para codificar programas en Python

2.7.8
Comenzar con ttulo de institucin educativa, nombre del estudiante,
profesor(es), nombre del programa. Pueden usarse maysculas y
minsculas siempre y cuando sea consistente y respetando reglas
ortogrficas
Ejemplo:
''' (3 comillas simples)
Comentario ms largo en una lnea en Python
'''
# Comentario en linea
Todo deber estar encerrado entre comentarios (no abrir y cerrar por
cada rengln). Respetando la sangra excepto para la institucin (o
empresa) y curso que debern estar centrados:

Instituto Tecnolgico Superior de Zapopan

CMMI
Desarrollador: Juan Prez
Nombre del Profesor: Leon Ramos Corchado
Nombre del Programa: Ejemplo 1

Contenido del
programa

Instrucciones de
uso:

Ejemplo de uso

Descripcin del programa en comentarios.

Se describe como es usado el programa. Suministra los datos de
entrada y sus lmites.

(paso a paso del programa)

El programa recibe como entrada un nmero entero que corresponde a
la
cantidad de nmeros que componen la lista ligada, esta cantidad no
deber
exceder de 19.
El programa no valida si los datos introducidos son de otro tipo del
especificado, por lo que se deber esta consciente de ello.

Estndar de Codificacin Lenguaje Python

Identificadores

Ejemplo de
identificadores

Comentarios

Se considera como identificador a los nombres de variables (arreglos, matrices,

apuntadores), funciones, as como cualquier tipo de dato definido por el usuario.
Debern tener un nombre significativo para que por su simple lectura, pueda
conocerse su funcin.
Un identificador consiste en una letra seguida (posiblemente) de una o ms
letras o dgitos con subrayados aislados. Se pueden usar letras maysculas y
minsculas, las que no son tomadas como diferenciadores de identificadores son
el mismo identificador.
Se recomienda, para una mejor legibilidad usar minsculas para las palabras
reservadas y maysculas para los dems identificadores.
Variable1 = 1
Texto1 = "texto"

Deber documentarse el cdigo de tal forma que sea inteligible por el lector

Deber explicar tanto el propsito como el comportamiento del cdigo

No comentar cada variable, pues esta deber ser auto descriptiva

No se debern incluir lneas en blanco entre comentarios.

La longitud de los comentarios no excedern el ancho de la pantalla (80

caracteres)
No abuse de los comentarios, solo considere aquellos relevantes
Cada comentario no deber iniciar en la lnea de una instruccin de cdigo,
sino anterior a ella.

Comentarios
correctos

''' (3 comillas simples)

Comentario ms largo en una lnea en Python
'''
# Comentario en lnea
Numero1= 2

Comentarios
incorrectos

''' (3 comillas simples)

Comentario ms largo en una lnea en Python
'''
Numero= 1
# Comentario en lnea

Espacios en
blanco

Sangra

Cada begin y end deber estar alineado uno con el otro y deber asignrsele

Entre cada bloque de encabezado, variables, mdulos y programa principal

deber separarse con una lnea en blanco para mejorar legibilidad

un rengln para cada uno.

Estndar de Codificacin Lenguaje Python

Ejemplo de uso
de sangrado

if verdadero:
print "Verdadero"
else:
print "Falso"

Asignaciones

A= 3
B=c
Palabra= hola

Estructuras de
Control

El condicional: if / else
# Si 1 es igual a 2
if 1 == 2:
# Este bloque no se ejecuta porque 1 no es nunca igual a 2
print '1 == 2'
else:
# Este cdigo si se ejecuta
print '1 != 2'
El ciclo for ... in
for miElemento in ( 1, 2, 3, 4, 5 ):
print miElemento
El ciclo while
i=0
while i < 10:
i=i+1
print i

Estndar de Codificacin Lenguaje Python

Declaracion de
variables

Declaracin de variables Globales y Locales.

Identificar variables Globales (Maysculas) y variables Locales

(Minsculas).

Sentencias

No debern existir sentencias que rebasen el ancho de la pantalla

(80 caracteres), en su caso descompnganse en ms simples

Definicin de
constantes

No existen constantes.

Asignacin
Mdulos

En cualquier parte del cdigo se puede declarar un identificador.

Trabajaremos con mdulos