Cómo organizar las carpetas de tus proyectos

Clase 3 de 21 • Curso Profesional de Python

Alfonso Morán

student•

📁Un módulo es cualquier archivo de Python. Generalmente, contiene código que puedes reutilizar.

🗄 Un paquete es un conjunto de módulos. Siempre posee el archivo __init__.py. Una ejemplo de organizar los archivos de 🐍Python es de la siguiente manera.

Kenyi Julberht Hancco Quispe

student•

Buen resumen!

Cesar Hernández Ramírez

student•

Nice bro

ALDO MATUS MARTINEZ

student•

:snake: __init __.py When a new object is made, it is initialized by calling the init method on the object.

__init__

is pronounced “dunder init”: dunder is short for “double-underscore”.

Reinaldo Mendoza

student•

Muy buen dato, para tener en cuenta al referirnos a los archivos

Javier Suárez Meerhoff

student•

gracias!

Daniel Alejandro Franco Meneses

student•

Si están usando WSL o una terminal Unix, pueden instalar con sudo apt-get install tree para ver un árbol de sus carpetas. Luego puedo ingresar a la carpeta de mi proyecto y ejecutar el comando tree.

Se vería algo así:

Yo pongo tree -I venv para ignorar la carpeta venv que esta llena de cosas. Si no lo pongo verás todos los directorios de tu proyecto.

Alexander Sánchez

student•

Interesante. muchas gracias. En OS X, con homebrew se puede instalar así:

brew install tree

Mauricio Gonzalez Falcon

student•

Gracias por el aporte, instalado ya!

Gabriel Salvador

student•

El diccionario define a un módulo como cualquier archivo de python con código que se pueda reutilizar... que se pueda reutilizar.

Reinaldo Mendoza

student•

Bien simple esa deficinion

José Jesús Enciso Mayo

student•

Y luego te quedas como el jurado en ese episodio, ya que en varios cursos te dicen la.importancia de nunca copiar código o reutilizarlo tanto xD

Oscar Eduardo Chaparro Blancas

student•

Si haz seguido la rama de cursos sugerida y ya pasaste por el curso de git/github, así como las entregas anteriores de Facundo, sin querer haz aprobado un curso que va tras bambalinas, que es el orden sugerido para el manejo de tus proyectos. Personalmente me ha servido mucho porque he aplicado esa metodología para ordenar los cursos del reto de DataAcademy y muchos mas, aún fuera de uso de python, como los cursos de SQL y esto hace que como profesionista, tenga una costumbre funcional y un orden general en mis proyectos. Esta clase deja ver la maravilla que es Platzi como plataforma de educación en la que los cursos se entrelazan en temas que quizá no son tan relevantes o no forman parte del foco del proyecto, pero que dan un plus a nuestro trabajo y a nuestro estilo profesional. Enhorabuena!

Jesús Enrique Morocoima Marcano

student•

Es verdad 100% de Acuerdo con usted compañero

Miguel Angel Velazquez Romero

student•

Que yo sepa la carpeta venv (que en realidad es un entorno virtual) por lo regular va en el .gitignore y en vez de la carpeta va un requirements.txt, donde la persona que descargue el proyecto puede hacer su propio entorno virtual (ya que aveces no es compatible con otros equipos), con su propia versión de Python, las dependencias necesarias e incluso sus propias versiones de las dependencias.

Rogelio Enrique Carrera

student•

Faltaría requirements.txt pero si, está es la estructura más usada.

José Anderson Ramírez Ponte

student•

ambos paradigmas llevan al mismo resultado?

Emmanuel Corral Marco

student•

How to organize your proyect folders

To make this thema more simple Facundo introduces two concepts:

modules: A module is any python file, usually this is reusable in other python files, for example a function created to reuse.
packages: A package is a folder that contain many modules. In this folder, always there is _init.py, it's necessary to the package.

package:
 - module_1
 - module_2
 - module_3
 - module_n
 all modules are relationized to the __init__

Example of directory project:

README
.gitignore
venve
package:
- init.py
- module_1.py
- module_2.py
README: an explanation over our proyect, normally use a .md format.
.gitignore: file to ignore other files at the time to run.
venve: this is the folder with the envioment variables.

Frameworks: Set of rules to the app run. They have them folders..

María Jimena Rodríguez Contreras

student•

gracias

Carlos Esteban Lara Gil

student•

0.1 ¿Cómo organizar las carpetas de tus proyectos?

Glosario

Módulo

Un módulo es cualquier archivo que termine con la extensión .py.

Generalmente un módulo tiene archivos que se pueden reutilizar

Paquete

Un paquete es un conjunto de módulos. init.py es el archivo que se usa para inicializar un paquete. Esto denota que una carpeta es un paquete.

Así se vería la carpeta de un proyecto (Explicado con indentación):

Proyecto:
    README.md
    .gitignore
    venv
    proyecto:
        __init__.py
        nave.py
        destino.py
        plataforma.py
        lanzamiento.py
        test.py
        validación.py

R E A D M E . m d: Explica como funciona el proyecto, github y gitlab lo toman para explicarle a otros desarrolladores como trabajar con él
.gi t i g n o re: Es un archivo que se usa para ignorar todos los archivos que no queremos que se suban a un repositorio remoto
ve n v todos los módulos que se usan para trabajar en el proyecto
El paquete del proyecto: *Componentes del proyecto

Iván Mauricio Jaimes Niño

student•

Módulo en Python

Un módulo puede contener:

Funciones
Clases
Variables
Código ejecutable
Atributos asociados con el módulos

El nombre del módulo es el nombre del archivo (sin la extensión .py).

Por ejemplo, en el siguiente diagrama la función printer y la clase Shape están definidas en el módulo utils.

Paquete en Python

Un paquete en Python es un directorio que contiene uno o más módulos de Python.

El archivo opcional "init.py" puede contener código que se ejecuta cuando un módulo se importa del paquete (inicialización). Según la documentación:

Los archivos init.py son necesarios para que Python trate los directorios que contienen el archivo como paquetes. Esto evita que los directorios con un nombre común, como una cadena, oculten involuntariamente módulos válidos que aparecen más adelante en la ruta de búsqueda del módulo. En el caso más simple, init.py puede ser simplemente un archivo vacío, pero también puede ejecutar el código de inicialización del paquete o establecer la variable all, que se describe más adelante. (https://docs.python.org/3/tutorial/modules.html#packages)

Alfonso Morán

student•

Qué es lo que debe contener el archivo init.py? es un archivo vacío?

Luis Lira

student•

Sí, es un archivo vacío que sirve para que Python reconozca lo módulos.

Alfonso Morán

student•

Gracias! 😄

Gabriel Missael Barco

student•

Cómo organizar las carpetas de tus proyectos

Es importante comprender dos conceptos:

Módulo: Es cualquier archivo de Python. Generalmente, contiene código que puedes reutilizar 😃.
Paquete: Un paquete es una carpeta que contiene un conjunto de módulos. Siempre posee el archivo __init__.py. Estos módulos están relacionados.

Un orden común de proyectos:

- exploracion_espacial_proyecto.
    - README
    - .gitignore
    - venv
    - exploración espacial
        - `__init__.py`
        - nave.py
        - destino.py
        - tests.py

Sin embargo, en cada proyecto puede ser diferente dependiendo de lo que se esté haciendo, ya que, por ejemplo, podrías usar algún *framework.*🤯

Juan Carlos Ortiz Romero

student•

una explicación sobre nuestro proyecto, normalmente usamos un formato .md. .gitignore: archivo para ignorar otros archivos en el momento de ejecutar. venve: esta es la carpeta con las variables de entorno. Frameworks: Conjunto de reglas para la ejecución de la aplicación. Las tienen carpetas.

Daniel Choxin

student•

gracias

Edkar Chachati

student•

Como Organizar las Carpetas de tus Proyectos

Las carpetas se organizan por Paquetes y Módulos, estos últimos son cualquier archivo de Python. Generalmente, contiene código que puedes reutilizar

Un Paquete es una carpeta que contiene módulos. Siempre posee el archivo init.py

María Jimena Rodríguez Contreras

student•

gracias

Miguel Angel Reyes Moreno

student•

Cómo organizar las carpetas de tus proyectos

Módulo

Un módulo es cualquier archivo de Python (o sea que termina con .py). Generalmente, contiene código que puedes reutilizar.

Paquete

Una carpeta que contiene módulos. Siempre posee el archivo __init__.py. (Se lee dunder init doy py).

Paquetes
Módulo	Módulo
Módulo	Módulo
Módulo	Módulo

exploracion_espacial
`nave.py`	`destino.py`
`plataforma.py`	`lanzamiento.py`
`tests.py`	`validacion.py`

Estructura de proyecto:

README -> Explica cómo funciona el proyecto
.gitignore -> Cosas que no se subirán al repo
venv -> entorno virtual de Python
exploracion_espacial -> Paquete, dentro de él, los módulos
- __init__.py
- nave.py
- destino.py
- plataforma.py
- lanzamiento.py
- tests.py
- validacion.py

Esta regla no está tallada en piedra. Depende del proyecto y el Framework que uses.

Jesús Velázquez Jiménez

student•

Package Set of modules that work together. Contain a file init.py **Module **Any code that we can reuse.

Henry Mendiburu Díaz

student•

La carpeta exploracion_espacil_proyecto tendría que guardarse en alguna ruta especial de la PC ? Cuando se quiera importar se tendría que llamar considerando la ruta completa donde está guardada?

Carlos Castillo

student•

la ruta tu la puedes definir según como tu manejes tu sistema de carpetas personal. Para importar archivos y usarlos en código si tienes que escribir la dirección completa aunque es importante que los archivos que uses los tengas en la misma carpeta o en una carpeta hija donde tengas tu proyecto para poder ingresar la dirección como "./resources/archivo.csv"

Sandra Milena Rojas Herrán

student•

Mientras podemos tener tests para python y cuando terminen el curso, pueden ir a:

TAU Pytest

Es super explicativo y te ayuda a mejorar tus skills en inglés.

Andrés Felipe Lopez gomez

student•

Muchas gracias

Max Castillo

student•

Módulos

Un módulo es un archivo de Python cuyos objetos (funciones, clases, excepciones, etc.) pueden ser accedidos desde otro archivo. Se trata simplemente de una forma de organizar grandes códigos.

Paquetes