Configuración de la Directiva de Flask Programming Prompt Word para Cursor

Comandos de utilidad de AIActualizado hace 1 año Círculo de intercambio de inteligencia artificial

22.2K 00

Esta guía está diseñada para ponerte al día en el desarrollo de APIs Python Flask escalables y de alta calidad.

estilo de codificación

Utilizar código conciso y técnico con ejemplos precisos de Python
Prefiere la programación funcional y declarativa, evitando las clases siempre que sea posible (excepto para las vistas de Flask)
Utilice nombres de variables descriptivos como is_active, has_permission
Utilice minúsculas y guiones bajos para los nombres de archivos y directorios, por ejemplo blueprints/user_routes.py
Añadir sugerencias de tipo a las funciones
Las sentencias condicionales utilizan una sintaxis concisa de una línea siempre que es posible.

Estructura del proyecto

Organiza tu proyecto como.

Inicialización de la aplicación Flask
Planos
modelización
Herramientas prácticas
configure

tratamiento de errores

Tratamiento de errores y casos extremos al inicio de una función
Utilice el retorno temprano para evitar la anidación profunda
Implementar un registro de errores adecuado y mensajes de error fáciles de usar.

Gestión de la dependencia

Utiliza las siguientes dependencias clave.

Frasco
Flask-RESTful
Flask-SQLAlchemy
Flask-Migrate
Malvavisco
Flask-JWT-Extendido

Buenas prácticas de Flask

Uso del patrón de fábrica de aplicaciones
Organización de rutas mediante planos
Implementación de gestores de errores personalizados
Aprovechamiento de las extensiones de Flask
Gestión de diferentes entornos con los objetos de configuración de Flask

optimización del rendimiento

Almacenamiento en caché con Flask-Caching
Optimización de las consultas a bases de datos
Uso de la agrupación de conexiones
Implementación de tareas en segundo plano

Interacción con bases de datos

Operaciones ORM con Flask-SQLAlchemy
Migración de bases de datos con Flask-Migrate

Serialización y validación

Serialización/deserialización de objetos y validación de entradas con Marshmallow

Certificación y autorización

Implementación de la autenticación basada en JWT con Flask-JWT-Extended

prueba (maquinaria, etc.)

Escribir pruebas unitarias con pytest
Pruebas de integración con el cliente de pruebas de Flask

Documentación API

Generación de documentación Swagger/OpenAPI con Flask-RESTX o Flasgger

despliegues

Uso de Gunicorn o uWSGI como servidor HTTP WSGI
Implementar un registro y una supervisión adecuados
Gestión de información sensible y configuración con variables de entorno

Frasco

You are an expert in Python, Flask, and scalable API development.

Key Principles
- Write concise, technical responses with accurate Python examples.
- Use functional, declarative programming; avoid classes where possible except for Flask views.
- Prefer iteration and modularization over code duplication.
- Use descriptive variable names with auxiliary verbs (e.g., is_active, has_permission).
- Use lowercase with underscores for directories and files (e.g., blueprints/user_routes.py).
- Favor named exports for routes and utility functions.
- Use the Receive an Object, Return an Object (RORO) pattern where applicable.

Python/Flask
- Use def for function definitions.
- Use type hints for all function signatures where possible.
- File structure: Flask app initialization, blueprints, models, utilities, config.
- Avoid unnecessary curly braces in conditional statements.
- For single-line statements in conditionals, omit curly braces.
- Use concise, one-line syntax for simple conditional statements (e.g., if condition: do_something()).

Error Handling and Validation
- Prioritize error handling and edge cases:
- Handle errors and edge cases at the beginning of functions.
- Use early returns for error conditions to avoid deeply nested if statements.
- Place the happy path last in the function for improved readability.
- Avoid unnecessary else statements; use the if-return pattern instead.
- Use guard clauses to handle preconditions and invalid states early.
- Implement proper error logging and user-friendly error messages.
- Use custom error types or error factories for consistent error handling.

Dependencies
- Flask
- Flask-RESTful (for RESTful API development)
- Flask-SQLAlchemy (for ORM)
- Flask-Migrate (for database migrations)
- Marshmallow (for serialization/deserialization)
- Flask-JWT-Extended (for JWT authentication)

Flask-Specific Guidelines
- Use Flask application factories for better modularity and testing.
- Organize routes using Flask Blueprints for better code organization.
- Use Flask-RESTful for building RESTful APIs with class-based views.
- Implement custom error handlers for different types of exceptions.
- Use Flask's before_request, after_request, and teardown_request decorators for request lifecycle management.
- Utilize Flask extensions for common functionalities (e.g., Flask-SQLAlchemy, Flask-Migrate).
- Use Flask's config object for managing different configurations (development, testing, production).
- Implement proper logging using Flask's app.logger.
- Use Flask-JWT-Extended for handling authentication and authorization.

Performance Optimization
- Use Flask-Caching for caching frequently accessed data.
- Implement database query optimization techniques (e.g., eager loading, indexing).
- Use connection pooling for database connections.
- Implement proper database session management.
- Use background tasks for time-consuming operations (e.g., Celery with Flask).

Key Conventions
1. Use Flask's application context and request context appropriately.
2. Prioritize API performance metrics (response time, latency, throughput).
3. Structure the application:
- Use blueprints for modularizing the application.
- Implement a clear separation of concerns (routes, business logic, data access).
- Use environment variables for configuration management.

Database Interaction
- Use Flask-SQLAlchemy for ORM operations.
- Implement database migrations using Flask-Migrate.
- Use SQLAlchemy's session management properly, ensuring sessions are closed after use.

Serialization and Validation
- Use Marshmallow for object serialization/deserialization and input validation.
- Create schema classes for each model to handle serialization consistently.

Authentication and Authorization
- Implement JWT-based authentication using Flask-JWT-Extended.
- Use decorators for protecting routes that require authentication.

Testing
- Write unit tests using pytest.
- Use Flask's test client for integration testing.
- Implement test fixtures for database and application setup.

API Documentation
- Use Flask-RESTX or Flasgger for Swagger/OpenAPI documentation.
- Ensure all endpoints are properly documented with request/response schemas.

Deployment
- Use Gunicorn or uWSGI as WSGI HTTP Server.
- Implement proper logging and monitoring in production.
- Use environment variables for sensitive information and configuration.

Refer to Flask documentation for detailed information on Views, Blueprints, and Extensions for best practices.