¿De qué se trata este artículo?
Hacer análisis de datos está acostumbrado a usar el cuaderno Jupyter, escribir algunas líneas de código, es muy conveniente obtener los resultados.
Pero en proyectos reales, PyCharm o VSCode generalmente se usan para el desarrollo. Luego, algunos amigos preguntaron, ¿existe una estructura estándar para el directorio de archivos del proyecto?
No debería haber un único estándar unificado, pero el líder de la comunidad de Python, Kenneth Reitz, propuso una estructura de directorio de proyectos de Python en 2013, que se recomienda para su referencia en proyectos futuros.
Estructura recomendada del proyecto Python
Kenneth recomienda la estructura de directorios de la siguiente manera:
samplemod-master
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.rst
├── docs
│ ├── Makefile
│ ├── conf.py
│ ├── index.rst
│ └── make.bat
├── requirements.txt
├── sample
│ ├── __init__.py
│ ├── core.py
│ └── helpers.py
├── setup.py
└── tests
├── __init__.py
├── context.py
├── test_advanced.py
└── test_basic.py
复制代码Un total de 3 carpetas, 17 archivos.
Echemos un vistazo a la primera carpeta docs, que es la documentación relacionada con el proyecto, incluidos Makefile y make.bat instalados por paquetes dependientes, configuración del proyecto conf.py, documento de introducción del proyecto index.rst, que es más detallado que README.rst Un documento, README.rst es más como una descripción general del proyecto.
La segunda carpeta, muestra, generalmente se denomina paquete en Python. Es el código central del proyecto. Por lo general, existen varios paquetes de este tipo. __init__.py es el archivo incluido en el paquete de Python. core.py y helpers.py son dos módulos principales en el paquete de muestra.
El tercer paquete, tests, es el paquete de prueba de unidad correspondiente al paquete de muestra. El nombre del módulo generalmente comienza con test y prueba cada módulo de la muestra.
¿Qué hace setup.py?
Con los tres paquetes principales anteriores, el archivo más importante es setup.py.¿Qué hace este archivo?
En pocas palabras, setup.py es un módulo de configuración relacionado con el empaquetado, generalmente combinado con herramientas de configuración.
Con setup.py, podemos instalar el paquete en el entorno global local o subirlo a PyPi, para que los desarrolladores de todo el mundo tengan la oportunidad de buscar su paquete y usar pip para instalarlo.
El código interno es relativamente estándar y fijo. Por ejemplo, el código de este proyecto es el siguiente:
from setuptools import setup, find_packages
with open('README.rst') as f:
readme = f.read()
with open('LICENSE') as f:
license = f.read()
setup(
name='sample',
version='0.1.0',
description='Sample package for Python-Guide.org',
long_description=readme,
author='Kenneth Reitz',
author_email='[email protected]',
url='https://github.com/kennethreitz/samplemod',
license=license,
packages=find_packages(exclude=('tests', 'docs'))
)
复制代码Verifique que los archivos README.rst y LICENSE se usen aquí y especifique qué paquetes distribuir.
以上就是本次分享的所有内容，想要了解更多欢迎前往公众号：Python 编程学习圈，每日干货分享