Categorías
Python

Python Entrevista Problema – análisis sintáctico de archivos CSV

 

Tabla de Contenidos

  • Por qué Al comentar su código es tan ImportantWhen la lectura de sus propios CodeWhen otros están leyendo su código
  • al leer su propio código
  • Cuando otros están leyendo su código
  • Cómo escribir comentarios en PythonPython Comentando BasicsPython Multilínea CommentsPython Al comentar accesos directos
  • Python comentando Fundamentos
  • Python multilínea comentarios
  • Python comentando accesos directos
  • Python comentando Mejor PracticesWhen escribir código para YourselfWhen escribir código para otros
  • Al escribir código para uno mismo
  • Al escribir código para otros
  • Python comentando peor PracticesAvoid: WET CommentsAvoid: maloliente CommentsAvoid: Rude Comentarios
  • Evitar: W.E.T. Comentarios
  • Evitar: maloliente Comentarios
  • Evitar: comentarios groseros
  • cómo practicar Comentando
  • Conclusión
  • al leer su propio código
  • Cuando otros están leyendo su código
  • Python Comentando Fundamentos
  • Python Multilínea Comentarios
  • Python Comentando accesos directos
  • Al escribir código para uno mismo
  • Al escribir código para otros
  • Evitar: WET Comentarios: Evitar
  • : maloliente Comentarios Evitar
  • : Rude Comentarios

Mira ahora Este tutorial tiene un vídeo relacionado curso creado por el equipo del Real Python. Mira que junto con el tutorial escrito para profundizar su comprensión: escribiendo comentarios en Python

Al escribir código en Python, es importante asegurarse de que su código puede ser fácilmente entendido por los demás . Dando a las variables nombres obvios, la definición de funciones explícitas, y la organización de su código son todas grandes maneras de hacer esto.

Otra forma impresionante y fácil de aumentar la legibilidad del código es mediante el uso de comenta !

En este tutorial, a cubrir algunos de los fundamentos de la escritura comentarios en Python. Vas a aprender cómo escribir los comentarios que están limpios y concisa, y cuando es posible que no tenga que escribir ningún comentario.

Usted también aprende:

  • Por qué es tan importante comentar su código
  • mejores prácticas para escribir comentarios en Python
  • tipos de comentarios es posible que desee evitar
  • Cómo practicar más limpio escribir comentarios

Bono

gratuito: 5 pensamientos sobre Python Maestría, un curso gratuito para los desarrolladores de Python que muestra la hoja de ruta y la mentalidad que necesita para tomar sus habilidades de Python al siguiente nivel.

Por qué Al comentar su código es tan importante

Los comentarios son una parte integral de cualquier programa. Ellos pueden venir en forma de cadenas de documentación a nivel de módulo, o incluso explicaciones en línea que ayuda a arrojar luz sobre una función compleja.

Antes de entrar en los diferentes tipos de comentarios, vamos a echar un vistazo más de cerca a qué comentar su código es tan importante.

Considere los siguientes dos escenarios en los que el programador ha decidido no comentar su código.

al leer su propio código

cliente A quiere un despliegue de última hora para su servicio web. Ya estás en un plazo muy corto, por lo que decide simplemente hacer que funcione. Todas esas cosas-documentación “extra”, al comentar adecuada, y así sucesivamente-usted añadir que más tarde.

El plazo viene, y desplegar el servicio, justo a tiempo. Uf!

De hacer una nota mental para volver y actualizar los comentarios, pero antes de poder ponerlo en su lista de tareas pendientes, su jefe se acerca con un nuevo proyecto que tiene que empezar a trabajar en forma inmediata. Dentro de unos días, usted ha olvidado por completo de que se suponía que volver atrás y comentar correctamente el código que escribió para el Cliente A.

avance rápido seis meses, y el cliente que necesita un parche construido para ese mismo servicio para cumplir con alguna nuevos requisitos. Es su trabajo para mantenerla, ya que fue el que lo construyó en el primer lugar. Se abre el editor de texto y …

Lo que hizo incluso escritura ?!

Te pasas horas de análisis a través de su código antiguo, pero que está completamente perdido en el desorden. Usted estaba en tal prisa en el momento que no nombró las variables correctamente o incluso establecen sus funciones en el flujo de control adecuado. Lo peor de todo, que no tienen ninguna observación en el guión que le diga qué es lo que!

Desarrolladores olvidar lo que su propio código hace todo el tiempo, especialmente si se escribió hace mucho tiempo o bajo mucha presión. Cuando una fecha límite se acerca rápidamente, y horas frente a la computadora han llevado a los ojos inyectados en sangre y las manos apretadas, que la presión se puede reflejar en forma de código que es más desordenado de lo habitual.

Una vez que se presente el proyecto, muchos desarrolladores son simplemente demasiado cansado para volver atrás y comentar su código. Cuando es hora de volver a visitar más adelante en la línea, que pueden pasar horas tratando de analizar a través de lo que escribieron.

escribiendo comentarios sobre la marcha es una gran manera de evitar que el escenario anterior suceda. Hay que ser agradable a futuro!

Cuando otros están leyendo su código

Imagínese que usted es el único desarrollador trabajando en un pequeño proyecto Django. A entender su propio código bastante bien, por lo que no tienden a utilizar los comentarios o cualquier otro tipo de documentación, y te gusta que sea así. Comentarios toman tiempo para escribir y mantener, y que no ven el punto.

El único problema es que a finales de año su “proyecto de pequeña Django” se ha convertido en un proyecto de “20.000 líneas de código”, y su supervisor está llevando a los desarrolladores adicionales para ayudar a mantenerlo.

Los nuevos desarrolladores trabajar duro para llegar rápidamente a la velocidad, pero dentro de los primeros días de trabajo en común, que he dado cuenta de que están teniendo algunos problemas. Que utilizó algunos nombres de variables peculiares y escribió con una sintaxis muy concisa. Los nuevos empleados pasan mucho tiempo paso a paso a través de su código línea por línea, tratando de averiguar cómo funciona todo. Se tarda unos pocos días antes de que puedan ayudar a mantener ella!

uso de comentarios a lo largo de su código puede ayudar a otros desarrolladores en situaciones como ésta. Comentarios ayudar a otros desarrolladores descremada a través de su código y obtener una comprensión de cómo funciona todo muy rápidamente. Puede ayudar a asegurar una transición sin problemas por la elección de comentar su código desde el principio de un proyecto.

Cómo escribir comentarios en Python

Ahora que usted entiende por qué es tan importante comentar su código, vamos a repasar algunos conceptos básicos para que sepa cómo hacerlo correctamente.

Python Comentando Fundamentos

Los comentarios no están para los desarrolladores. Describen partes del código cuando sea necesario para facilitar la comprensión de los programadores, incluido usted mismo.

Para escribir un comentario en Python, basta con poner el símbolo de almohadilla # antes de su comentario deseada:

# This is a comment

Python ignora todo después de que el símbolo de almohadilla y hasta el final de la línea. Se puede insertar en cualquier lugar en el código, incluso en línea con otro código:

print("This will run.") # This won't run

Cuando se ejecuta el código anterior, sólo verá la salida Esto ejecutará. Todo lo demás se ignora.

Los comentarios deben ser corto, dulce, y al punto. Mientras PEP 8 aconseja mantener código a los 79 caracteres o menos por línea, se sugiere un máximo de 72 caracteres para los comentarios y las cadenas de documentación en línea. Si su comentario se aproxima o supera esta longitud, entonces usted querrá extendió a lo largo de varias líneas.

Python Multilínea Comentarios

Desafortunadamente, Python no tiene una forma de escribir comentarios de varias líneas que puedas en lenguajes como C, Java y Go:

# So you can't
just do this
in python

En el ejemplo anterior, la primera línea será ignorado por el programa, pero las otras líneas elevarán un error de sintaxis.

Por el contrario, un lenguaje como Java le permitirá difundir un comentario a lo largo de varias líneas con bastante facilidad:

/* You can easily
write multiline
comments in Java */

Todo entre / * y * / es ignorado por el programa.

Mientras que Python no tiene funcionalidad de comentarios de varias líneas nativa, puede crear comentarios multilínea en Python. Hay dos formas sencillas de hacerlo.

La primera manera es simplemente pulsando la tecla de retorno después de cada línea, la adición de un nuevo símbolo de almohadilla y continuando su comentario de allí:

def multiline_example():
# This is a pretty good example
# of how you can spread comments
# over multiple lines in Python

Cada línea que comienza con una almohadilla serán ignorados por el programa.

Otra cosa que puede hacer es el uso de líneas múltiples cadenas de envolver su comentario dentro de un conjunto de comillas triples:

"""
If I really hate pressing `enter` and
typing all those hash marks, I could
just do this instead
"""

Esto es como los comentarios de varias líneas en Java, donde todo formen parte de las comillas triples funcionará como un comentario.

Si bien esto le da la funcionalidad de varias líneas, esto no es técnicamente un comentario. Es una cadena que no se asigna a una variable, por lo que no se le llama o se hace referencia por su programa. Aún así, ya que va a ser ignorado en tiempo de ejecución y no aparecerá en el código de bytes, puede actuar eficazmente como un comentario. (Puede echar un vistazo a este artículo para obtener una prueba de que estas cadenas no aparecen en el código de bytes.)

Sin embargo, tenga cuidado donde se colocan estas líneas múltiples “comentarios”. Dependiendo de donde se sientan en su programa, que podría convertirse en cadenas de documentación, que son piezas de la documentación que se asocian con una función o método. Si usted se desliza uno de estos chicos malos justo después de una definición de función, a continuación, lo que pretende ser un comentario llegarán a ser asociado con ese objeto.

tener cuidado donde usted utiliza éstos, y en caso de duda, sólo hay que poner una almohadilla en cada línea subsiguiente. Si está interesado en aprender más sobre las cadenas de documentación y cómo asociarlos con módulos, clases, y similares, echa un vistazo a nuestro tutorial sobre el Código Python Documentación.

Python Comentando accesos directos

Puede ser tedioso para escribir todas esas marcas de control cada vez que es necesario agregar un comentario. Entonces, ¿qué se puede hacer para acelerar las cosas un poco? Aquí hay algunos trucos que le ayudarán a cabo al comentar.

Una de las primeras cosas que usted puede hacer es utilizar múltiples cursores. Eso es exactamente lo que parece: la colocación de más de un cursor en la pantalla para realizar una tarea. Sólo tiene que mantener pulsada la tecla Ctrl o Cmd mientras Haga clic izquierdo, y debería ver las líneas parpadeantes en la pantalla:

Esto es más eficaz cuando es necesario comentar lo mismo en varios lugares.

¿Qué pasa si usted tiene una larga extensión de texto que necesita ser comentadas? Digamos que no desea una función definida para ejecutar con el fin de comprobar si hay un error. Al hacer clic en cada línea de comentario se podría llevar a cabo una gran cantidad de tiempo! En estos casos, tendrá que cambiar a los comentarios en su lugar. Sólo tiene que seleccionar el código deseado y pulse Ctrl + / en el PC, o Cmd + / Mac:

Todo se antepondrá el texto resaltado con una almohadilla e ignorado por el programa.

Si sus comentarios están volviendo demasiado difícil de manejar, o los comentarios en una secuencia de comandos que está leyendo son muy largo, entonces el editor de texto le puede dar la opción de contraerlos utilizando la pequeña flecha hacia abajo en el lado de la izquierda:

o haga clic en la flecha para ocultar los comentarios. Esto funciona mejor con los comentarios largo repartidas a lo largo de múltiples líneas o cadenas de documentación que ocupan la mayor parte del inicio de un programa.

La combinación de estos consejos hará que comentar su código de forma rápida, fácil y sin dolor!

Python Al comentar las mejores prácticas

Si bien es bueno saber cómo escribir los comentarios en Python, que es tan vital para asegurarse de que sus comentarios son legibles y fáciles de entender.

Tome un vistazo a estos consejos para ayudarle a escribir los comentarios que realmente apoyan su código.

Al escribir código para uno mismo

Usted puede hacer la vida más fácil para usted comentando su propio código correctamente. Incluso si nadie más lo verá, te verlo, y eso es suficiente razón para hacer lo correcto. Eres un desarrollador, después de todo, por lo que el código debe ser fácil para que usted entienda así.

Una forma muy útil el uso de comentarios para uno mismo es como un esquema para su código. Si no estás seguro de cómo el programa se va a salir, a continuación, puede utilizar los comentarios como una manera de hacer un seguimiento de lo que queda por hacer, o incluso como una forma de rastrear el flujo de alto nivel de su programa. Por ejemplo, use los comentarios para describir una función en pseudo-código:

from collections import defaultdict

def get_top_cities(prices):
top_cities = defaultdict(int)

# For each price range
# Get city searches in that price
# Count num times city was searched
# Take top 3 cities & add to dict

return dict(top_cities)

Estos comentarios planificar get_top_cities (). Una vez que sabe exactamente lo que quiere que su función de hacer, se puede trabajar en la traducción que de código.

uso de comentarios como este puede ayudar a mantener todo en su lugar en su cabeza. Al caminar a través de su programa, usted sabrá lo que queda por hacer a fin de tener un guión completamente funcional. Después de “traducir” los comentarios al código, recuerde que debe retirar todos aquellos comentarios que se han vuelto redundantes para que sus estancias de código fresco y limpio.

También puede utilizar los comentarios como parte del proceso de depuración. Comentario el código antiguo y ver cómo afecta a su salida. Si está de acuerdo con el cambio, entonces no deje el código comentado en su programa, ya que disminuye la legibilidad. Eliminarlo y versión de uso de control si es necesario traerlo de vuelta.

Finalmente, use los comentarios para definir partes difíciles de su propio código. Si pones un proyecto hacia abajo y volver a ella más meses o años más tarde, pasará mucho tiempo tratando de reencontrarse con lo que ha escrito. En caso de que olvide lo que su propio código no, hacer un favor futuro y marcar hacia abajo de manera que será más fácil para volver a la velocidad más adelante.

Al escribir código para otros

la gente le gusta descremada y saltar hacia atrás y adelante a través de texto y de lectura de códigos no es diferente. La única vez que es probable que lee a través de código línea por línea es cuando no está trabajando y usted tiene que averiguar lo que está pasando.

En la mayoría de los otros casos, se va a tomar un rápido vistazo a las variables y las definiciones de funciones con el fin de obtener la esencia. Tener comentarios para explicar lo que está sucediendo en la llanura Inglés realmente puede ayudar a un desarrollador en esta posición.

sea agradable a sus compañeros desarrolladores y uso de comentarios para ayudarles a hojear a través de su código. Los comentarios en línea deben utilizarse con moderación para aclarar bits de código que no son evidentes por sí mismos. (Por supuesto, su primera prioridad debe ser hacer su stand código por sí mismo, pero los comentarios en línea puede ser útil en este sentido.)

Si usted tiene un método o una función complicada cuyo nombre no es fácilmente comprensible, es posible que desee para incluir un breve comentario después de la línea de definición de arrojar alguna luz:

def complicated_function(s):
# This function does something complicated

Esto puede ayudar a otros desarrolladores que están Skimming su código de tener una idea de lo que hace la función.

Para cualquier función pública, tendrá que incluir una cadena de documentación asociada, si esto es complicado o no:

def sparsity_ratio(x: np.array) -> float:
"""Return a float

Percentage of values in array that are zero or NaN
"""

Esta cadena se convertirá en el atributo .__ doc__ de su función y será oficialmente asociada con ese método específico. Las directrices docstring PEP 257 le ayudará a estructurar su cadena de documentación. Estos son un conjunto de convenciones que los desarrolladores utilizan generalmente cuando la estructuración de las cadenas de documentación.

Las directrices PEP 257 tienen convenios para cadenas de documentación de varias líneas también. Estas cadenas de documentación aparecen a la derecha en la parte superior de un archivo e incluyen una descripción de alto nivel de todo el guión y lo que tiene que hacer:

# -*- coding: utf-8 -*-
"""A module-level docstring

Notice the comment above the docstring specifying the encoding.
Docstrings do appear in the bytecode, so you can access this through
the ``__doc__`` attribute. This is also what you'll see if you call
help() on a module or any other Python object.
"""

Una cadena de documentación de nivel de módulo como éste contendrá toda la información pertinente o necesidad de saber para el desarrollador de leerlo. Al escribir uno, se recomienda hacer una lista de todas las clases, excepciones y funciones, así como un resumen de una línea para cada uno.

Python Al comentar peores prácticas

Al igual que existen normas para escribir comentarios Python, hay algunos tipos de comentarios que no conducen a Pythonic código. Éstos son sólo unos pocos.

Evitar: W.E.T. Comentarios

Sus comentarios debe ser D.R.Y. El acrónimo de la máxima de la programación “No te repitas”. Esto significa que el código debe tener poca o ninguna redundancia. No es necesario comentar un trozo de código que explica suficientemente en sí, como éste:

return a # Returns a

Podemos ver claramente que una se devuelve, así que no hay necesidad de indicar explícitamente esto en un comentario. Esto hace que los comentarios W.E.T., lo que significa que “escribió todo dos veces.” (O, para la más cínica allí, “la pérdida de tiempo de todos.”)

W.E.T. los comentarios pueden ser un simple error, especialmente si se ha utilizado comentarios para planificar su código antes de escribirlo. Pero una vez que tienes el código que se ejecuta bien, asegúrese de volver atrás y comentarios Retire los que se han vuelto innecesarias.

Evitar: Malolientes Comentarios

Los comentarios pueden ser un signo de “olor de código”, que es todo lo que indica que puede haber un problema más profundo con su código. Código huele intentar enmascarar los problemas subyacentes de un programa, y ​​los comentarios son una manera de tratar de ocultar esos problemas. Los comentarios deben apoyar su código, no tratar de explicarlo. Si el código está mal escrito, ninguna cantidad de comentar se va a arreglar.

Tomemos este ejemplo sencillo:

# A dictionary of families who live in each city
mydict = {
"Midtown": ["Powell", "Brantley", "Young"],
"Norcross": ["Montgomery"],
"Ackworth": []
}

def a(dict):
# For each city
for p in dict:
# If there are no families in the city
if not mydict[p]:
# Say that there are no families
print("None.")

Este código es bastante rebelde. Hay un comentario antes de cada línea de explicar lo que hace el código. Este script se podría haber hecho más sencillo mediante la asignación de nombres obvios a las variables, funciones y colecciones, así:

families_by_city = {
"Midtown": ["Powell", "Brantley", "Young"],
"Norcross": ["Montgomery"],
"Ackworth": [],
}

def no_families(cities):
for city in cities:
if not families_by_city[city]:
print(f"No families in {city}.")

Mediante el uso de las convenciones de nombres obvios, hemos sido capaces de eliminar todos los comentarios innecesarios y reducir la longitud del código, así!

Sus comentarios rara vez deben ser más largo que el código que soportan. Si está gastando demasiado tiempo para explicar lo que hizo, entonces usted necesita para volver atrás y refactorizar para que su código sea más clara y concisa.

Evitar: Rude Comentarios

Esto es algo que es probable subir cuando se trabaja en un equipo de desarrollo. Cuando varias personas están trabajando en el mismo código, otros van a estar entrando y revisar lo que has escrito y hacer cambios. De vez en cuando, se puedan encontrar a alguien que se atrevió a escribir un comentario como éste:

# Put this here to fix Ryan's stupid-a** mistake

Honestamente, es sólo una idea buena que no hace esto. No está bien si es el código de su amigo, y que está seguro de que no se sientan ofendidos por ella. Nunca se sabe lo que podría conseguir enviado a la producción, y cómo se va a ver si lo dejamos sin querer que el comentario allí, y un cliente descubrió que en el camino? Usted es un profesional, y que incluyen palabras vulgares en sus comentarios no es la manera de demostrar que.

cómo practicar Comentando

La forma más sencilla de empezar a escribir los comentarios más Pythonic es sólo para hacerlo!

Comience a escribir comentarios para sí mismo en su propio código. Que sea un punto para incluir comentarios simples de ahora en adelante, cuando sea necesario. Añadir un poco de claridad a funciones complejas, y poner una cadena de documentación en la parte superior de todas las secuencias de comandos.

Otra buena manera de practicar es volver atrás y revisar viejo código que has escrito. Ver donde cualquier cosa que no tenga sentido, y limpiar el código. Si todavía necesita un poco de apoyo adicional, añadir un comentario rápido para ayudar a aclarar el propósito del código.

Esta es una idea especialmente buena si su código está arriba en GitHub y la gente se bifurcan tu repositorio. Ayudarles a empezar guiándolos a través de lo que ya has hecho.

También puede devolver a la comunidad comentando el código de otras personas. Si ha descargado algo de GitHub y tenía problemas para tamizar a través de ella, añadir comentarios a medida que llegan a entender lo que hace cada pieza de código.

“sesión” su comentario con sus iniciales y la fecha, y luego enviar los cambios como una solicitud de extracción. Si se combinan los cambios, usted podría estar ayudando a decenas si no cientos de desarrolladores como usted obtener una ventaja sobre su próximo proyecto.

Conclusión

Aprender a comentar también es una herramienta valiosa. No sólo va a aprender a escribir con más claridad y concisión en general, sino que obtendrá sin duda una comprensión más profunda de Python también.

Saber comentarios escritura en Python puede hacer la vida más fácil para todos los desarrolladores, incluido usted mismo! Pueden ayudar a otros desarrolladores de ponerse al día en lo que hace el código, y ayudarle a obtener la re-conocen código antiguo de su cuenta. Por

notar cuando se está utilizando para tratar los comentarios y apoyar código mal escrito, usted será capaz de volver atrás y modificar el código para ser más robusto. Al comentar código escrito previamente, ya sea propio o de otro desarrollador, es una gran manera de practicar la escritura de comentarios limpias en Python.

A medida que aprenda más acerca de la documentación de su código, se puede considerar de pasar al siguiente nivel de documentación. Echa un vistazo a nuestro tutorial sobre el Código Python Documentación para dar el siguiente paso.

Mira ahora Este tutorial tiene un vídeo relacionado curso creado por el equipo del Real Python. Mira que junto con el tutorial escrito para profundizar su comprensión: escribiendo comentarios en Python

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *