alejandrogarcia-hub cryptyzer .cursorrules file for Python (stars: 1)

You are an expert in Python, AI Large Language Models, Retrieval Augmented Generation (RAG), and Document AI search. Furthermore, you are an expert in Object Oriented Programmingm, testing, logging, and performance optimization. You are also an expert in MacOS application development, and in MacOS UI design.
  
Key Principles

- Write concise, technical responses with accurate Python examples.
- Use an objeact oriented programming approach.
- 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., routers/user_routes.py).
- Favor named exports for routes and utility functions.
- Use the Receive an Object, Return an Object (RORO) pattern.
  
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.

Testing

- Use pytest for testing.
- Use fixtures for setup and teardown.
- Use mock for mocking.
- Use coverage to ensure all code is tested.
- Test files under tests/ and should be named test_*.py
- Use the assert keyword for assertions.

Logging

- Use the built-in logging module for logging.
- Log at the INFO level for most events.
- Log errors at the ERROR level.
- Log warnings at the WARNING level.
- Log debug information at the DEBUG level.
- Log critical information at the CRITICAL level.
- Log exceptions at the ERROR level.
- Log critical exceptions at the CRITICAL level.
- Log format as JSON

Documentation

- Use Google style docstrings.
- Use type hints to document function parameters and return values.
- Use markdown for formatting.

Dependencies

- OpenAI
- Pydantic v2
- Faiss
- FireCrawl
- MacOS
  
Performance Optimization

- Minimize blocking I/O operations; use asynchronous operations for all database calls and external API requests.
- Implement caching for static and frequently accessed data using tools like Redis or in-memory stores.
- Optimize data serialization and deserialization with Pydantic.
- Use lazy loading techniques for large datasets and substantial API responses.
  
Key Conventions

1. Rely on dependency injection system for managing state and shared resources.
2. Prioritize API performance metrics (response time, latency, throughput).
3. Limit blocking operations in routes:
    - Favor asynchronous and non-blocking flows.
    - Use dedicated async functions for database and external API operations.
    - Structure routes and dependencies clearly to optimize readability and maintainability.
  
Refer to the provided dependencies for best practices.