Para mejorar la legibilidad y el mantenimiento del programa, debemos diseñar una buena estructura de directorios para el software, que es tan importante como el estilo de codificación estándar. No existe un estándar estricto para la especificación de directorios del software, siempre que sea claro y legible, suponiendo que su software se llame QQ, entonces la estructura de directorios recomendada es
QQ/
|-- core/
| |-- core.py
|
|-- api/
| |-- api.py
|
|-- db/
| |-- db_handle.py
|
|-- lib/
| |-- common.py
|
|-- conf/
| |-- settings.py
|
|-- run.py
|-- setup.py
|-- requirements.txt
|-- READMEHagamos una explicación:
• core/ : almacenar código relacionado con la lógica empresarial
• api/ : almacenar archivos de interfaz, la interfaz se utiliza principalmente para proporcionar operaciones de datos para la lógica empresarial.
• db/ : almacena los archivos relacionados con la base de datos de operaciones, principalmente utilizados para interactuar con la base de datos,
• lib/ : almacena módulos personalizados usados comúnmente en programas
• conf/ : almacenar archivos de configuración
• run.py : el archivo de inicio del programa, generalmente ubicado en el directorio raíz del proyecto, porque la carpeta donde se encuentra el archivo en ejecución se usará como la primera ruta de sys.path por defecto durante el tiempo de ejecución, lo que ahorra la necesidad de tratar con variables de entorno Un paso de
• setup.py : secuencia de comandos para la instalación, implementación y empaquetado.
• requirements.txt : almacene la lista de paquetes externos de Python de los que depende el software.
• LÉAME : documentación del proyecto.
El formato de README es generalmente el siguiente:
1. Posicionamiento del software y funciones básicas del software;
2. El método de ejecución del código: entorno de instalación, comando de inicio, etc.;
3. Breves instrucciones de uso;
4. Descripción de la estructura del directorio del código, puntos más detallados pueden explicar los principios básicos del software;
5. Descripción de las preguntas más frecuentes.
En general, use setup.py para administrar problemas de empaquetado, instalación e implementación de código . La forma estándar de escritura de la industria es usar la popular herramienta de empaquetado Python setuptools para administrar estas cosas. Este método se usa ampliamente en proyectos de código abierto. Un proyecto debe tener una herramienta de instalación e implementación, que pueda instalar el entorno de manera rápida y fácil en un nueva máquina El código se implementa y el programa se ejecuta.
El archivo requirements.txt existe para facilitar a los desarrolladores el mantenimiento de las dependencias del software . Necesitamos agregar la información de las bibliotecas dependientes en el proceso de desarrollo a este archivo para evitar que falten paquetes de software al instalar dependencias en setup.py, y también es conveniente que los usuarios especifiquen a qué paquetes de Python hace referencia el proyecto. El formato de este archivo es que cada línea contiene una descripción de las dependencias del paquete, generalmente en el formato de matraz> = 0.10. El requisito es que pip pueda reconocer este formato, de modo que simplemente pueda pasar los requisitos de pip install-r . TXT