HTTPX [Python] | Biblioteca Python robusta y de alto rendimiento

Al crear solicitudes HTTP, hay muchas variables potenciales que puedes personalizar. Si eres un desarrollador que desea tener más control sobre las solicitudes que realiza, ¡sigue leyendo!

¿Qué es HTTPX?

HTTPX es una potente biblioteca de Python diseñada para realizar solicitudes HTTP con una velocidad y eficiencia excepcionales. Está dirigida a desarrolladores que priorizan el rendimiento y el control específico sobre sus canales de comunicación.

Características clave de HTTPX

HTTPX destaca como una potente biblioteca de Python diseñada para realizar solicitudes HTTP con énfasis en la velocidad y la eficiencia. Se convierte en un activo útil para diversas tareas de desarrollo web debido a estas características clave:

1. Rendimiento rápido:

• Asíncrono: HTTPX prospera en operaciones asíncronas (compatible con asyncio). Esto le permite manejar numerosas solicitudes HTTP simultáneamente, lo que aumenta el rendimiento para aplicaciones web y API de alto tráfico.
• Agrupación de conexiones: Administra eficientemente las conexiones a los servidores, eliminando la necesidad de establecer nuevas conexiones para cada solicitud. Esto reduce la sobrecarga y mejora los tiempos de respuesta.

2. Manejo eficiente de datos:

• Transmisión: Para grandes conjuntos de datos o flujos de datos en tiempo real, HTTPX ofrece capacidades de transmisión excepcionales. Puedes procesar los datos en fragmentos a medida que llegan, evitando la necesidad de descargar toda la respuesta a la vez. Esto es particularmente beneficioso para aplicaciones en tiempo real y descargas de archivos grandes.
• Descompresión automática: HTTPX maneja automáticamente las respuestas comprimidas (como Gzip), lo que simplifica el manejo de datos y reduce la sobrecarga de procesamiento.

3. Control granular para flujos de trabajo complejos:

Personalización de solicitudes: HTTPX proporciona un control preciso sobre los parámetros de la solicitud. Puedes definir varios aspectos como:

• Encabezados para el intercambio de información específica con el servidor.
• Contenido del cuerpo para enviar estructuras de datos complejas.
• Tiempos de espera para evitar que las aplicaciones se bloqueen en servidores que no responden.
• Métodos de autenticación para una comunicación segura.
• Otras opciones avanzadas para un comportamiento de solicitud personalizado.

4. Características de comunicación robustas:

• Reintentos y tiempos de espera: Configura reintentos para solicitudes fallidas para manejar los problemas temporales de la red con elegancia. Establece tiempos de espera para evitar que las aplicaciones se bloqueen en servidores que no responden.
• Interceptores y ganchos: Implementa lógica personalizada para modificar el comportamiento de la solicitud o interceptar las respuestas para un control avanzado sobre la comunicación.

5. Integración y ecosistema:

• Integración perfecta: HTTPX se integra bien con otras bibliotecas populares de desarrollo web de Python. Esto lo convierte en una herramienta versátil para crear aplicaciones web con diversas funcionalidades.

Escenarios de casos de uso del mundo real de HTTPX

1. Creación de API de alto tráfico:

• Escalado para el éxito: Cuando tu API necesita manejar una gran cantidad de solicitudes simultáneas de manera eficiente, la naturaleza asíncrona y la agrupación de conexiones de HTTPX vienen al rescate. Garantiza que tu API siga respondiendo y ofrezca resultados rápidos incluso bajo una carga pesada.
• Arquitectura de microservicios: En arquitecturas de microservicios donde las API se comunican entre sí con frecuencia, la velocidad de HTTPX se vuelve crucial. Minimiza la sobrecarga de comunicación, lo que lleva a un sistema general más receptivo y de mejor rendimiento.

2. Aplicaciones en tiempo real:

• Minimizar la latencia: Para aplicaciones en tiempo real como aplicaciones de chat, tickers de acciones o actualizaciones deportivas en vivo, minimizar la latencia (retraso) es fundamental. La naturaleza asíncrona de HTTPX y el manejo eficiente de datos (incluida la transmisión) garantizan que los datos en tiempo real fluyan sin problemas con un retraso mínimo.
• Soporte de WebSocket (con integración): Si bien HTTPX no maneja WebSockets directamente, se integra bien con bibliotecas como WebSockets que permiten la comunicación bidireccional en tiempo real entre clientes y servidores. Este enfoque combinado proporciona una solución potente para crear aplicaciones en tiempo real en Python.

3. Tareas con uso intensivo de datos:

• Descargas de archivos grandes: Al descargar archivos grandes (por ejemplo, archivos multimedia, copias de seguridad), las capacidades de transmisión de HTTPX resultan invaluables. Puedes procesar los datos en fragmentos a medida que llegan, lo que reduce el uso de memoria y mejora el rendimiento de la descarga en comparación con las bibliotecas que descargan todo el archivo a la vez.
• Fuentes de datos en tiempo real: El procesamiento de fuentes de datos en tiempo real de sensores, plataformas de redes sociales o mercados financieros a menudo implica grandes volúmenes de datos. El soporte de transmisión de HTTPX permite el procesamiento eficiente de flujos de datos entrantes, lo que permite análisis e información en tiempo real.

4. Aplicaciones de rendimiento crítico:

• Optimización del rendimiento: Para aplicaciones donde la velocidad es una prioridad máxima, HTTPX ofrece un rendimiento excepcional. Su naturaleza asíncrona, la agrupación de conexiones y el manejo eficiente de datos lo hacen ideal para tareas como el web scraping, las pruebas de API o las herramientas de monitoreo del rendimiento.
• Pruebas de carga y evaluación comparativa del rendimiento: HTTPX puede ser una herramienta valiosa en escenarios de pruebas de carga donde necesitas simular grandes volúmenes de tráfico para evaluar el rendimiento de una aplicación. Su eficiencia te permite enviar numerosas solicitudes rápidamente y analizar los resultados para detectar cuellos de botella en el rendimiento.

Ejemplos de código HTTPX

1. Solicitud GET básica con manejo de respuesta:

import httpx

async def fetch_data(url):
  async with httpx.AsyncClient() as client:
    response = await client.get(url)
    if response.status_code == 200:
      data = await response.text()  # Read entire response as text
      print(f"Data from {url}: {data[:100]}...")  # Truncate for brevity
    else:
      print(f"Error: {response.status_code}")

asyncio.run(fetch_data("https://www.example.com"))

Este ejemplo de código define una función asíncrona fetch_data que toma una URL. Luego usa httpx.AsyncClient para realizar una solicitud GET. La respuesta se procesa más tarde en función del código de estado, donde, si tiene éxito, se imprime un fragmento de datos.

2. Manejo de grandes transferencias de datos con transmisión:

import httpx

async def download_file(url, filename):
  async with httpx.AsyncClient() as client:
    response = await client.get(url, stream=True)
    if response.status_code == 200:
      async with open(filename, 'wb') as f:
        async for chunk in response.aiter_content(chunk_size=1024):
          await f.write(chunk)
      print(f"File downloaded: {filename}")

asyncio.run(download_file("https://large-file.com/data.zip", "data.zip"))

Este ejemplo de código demuestra la descarga de un archivo grande mediante transmisión. El argumento stream=True permite procesar fragmentos de datos de 1024 bytes, y el método aiter_content permite iterar sobre el contenido de la respuesta en fragmentos manejables que luego se escriben en el archivo.

3.  Personalización de solicitudes con encabezados, tiempos de espera y autenticación:

import httpx

async def make_authenticated_request(url, token):
  headers = {'Authorization': f'Bearer {token}'}
  timeout = httpx.Timeout(timeout=5, connect=2)  # Set timeouts for request and connection

  async with httpx.AsyncClient() as client:
    try:
      response = await client.get(url, headers=headers, timeout=timeout)
      response.raise_for_status()  # Raise exception for non-200 status codes
      # Process successful response
    except httpx.HTTPStatusError as e:
      print(f"Error: {e}")

asyncio.run(make_authenticated_request("https://api.example.com/data", "your_access_token"))

El ejemplo de código anterior demuestra la configuración de encabezados personalizados (para la autorización) y los tiempos de espera para una solicitud. También utiliza raise_for_status para generar una excepción para los códigos de respuesta no exitosos.

4. Características avanzadas: reintentos e interceptores:

from httpx import retries

async def fetch_data_with_retries(url):
  async with httpx.AsyncClient(retries=retries.Retry(total=3, backoff_factor=1)) as client:
    response = await client.get(url)
    # Process response

async def logging_interceptor(request, response):
  print(f"Request: {request.method} {request.url}")
  print(f"Response: {response.status_code}")

async def main():
  async with httpx.AsyncClient(interceptors=[logging_interceptor]) as client:
    await fetch_data_with_retries("https://unreliable-api.com/data")

asyncio.run(main())

Este ejemplo de código demuestra dos características avanzadas:

• Reintentos: El argumento retries configura los reintentos automáticos para las solicitudes fallidas con hasta 3 intentos y una estrategia de retroceso.
• Interceptores: Se agrega una función logging_interceptro personalizada utilizando el argumento interceptors, que registra información sobre la solicitud y la respuesta durante el proceso de comunicación.

Apidog: herramienta óptima de desarrollo de API para el desarrollo de aplicaciones/API HTTPX

La biblioteca HTTPX de Python puede ser difícil de entender al principio. Escrito en lenguaje de programación Python, puede resultar confuso para los principiantes a pesar de su naturaleza intuitiva. Para los desarrolladores más nuevos, considera usar Apidog.

Generación de código de cliente Python con Apidog

Apidog puede acelerar los procesos de desarrollo de API o aplicaciones de cualquier persona con la ayuda de su práctica función de generación de código. Con unos pocos clics de un botón, puedes tener código listo para usar para tus aplicaciones: ¡todo lo que necesitas hacer es copiarlo y pegarlo en tu IDE de trabajo!

En primer lugar, localiza este botón </> que se encuentra en la esquina superior derecha de la pantalla cuando intentas crear una nueva solicitud. Luego, selecciona Generate Client Code.

Puedes observar que Apidog también admite la generación de código para una variedad de otros lenguajes de código. Sin embargo, como estamos intentando importar código de cliente Python, selecciona Python. Copia y pega el código en tu IDE para comenzar a completar tu aplicación.

Creación de API con Apidog

Con Apidog, puedes crear API por ti mismo. Puedes crear tu API basándote en el diseño que pretendes para tu aplicación.

Comienza presionando el botón New API, como se muestra en la imagen de arriba.

A continuación, puedes seleccionar muchas de las características de la API. En esta página, puedes:

• Establecer el método HTTP (GET, POST, PUT o DELETE)
• Establecer la URL de la API (o el punto final de la API) para la interacción cliente-servidor
• Incluir uno o varios parámetros para pasarlos en la URL de la API
• Proporcionar una descripción de la funcionalidad que pretende proporcionar la API. Aquí, también puedes describir el límite de velocidad que planeas implementar en tu API.

Cuantos más detalles puedas proporcionar a la etapa de diseño, más descriptiva será la documentación de tu API, como se muestra en la siguiente sección de este artículo. También puedes advertir a los desarrolladores en la descripción que estás utilizando la biblioteca Python HTTPX para crear esta API.

Para proporcionar algo de ayuda en la creación de API en caso de que esta sea la primera vez que creas una, puedes considerar leer estos artículos.

Una vez que hayas finalizado todas las necesidades básicas para realizar una solicitud, puedes intentar realizar una solicitud haciendo clic en Send. A continuación, deberías recibir una respuesta en la parte inferior de la ventana de Apidog, como se muestra en la imagen de arriba.

La interfaz de usuario simple e intuitiva permite a los usuarios ver fácilmente la respuesta obtenida de la solicitud. También es importante comprender la estructura de la respuesta, ya que necesitas hacer coincidir el código tanto en el lado del cliente como en el del servidor.

Genera documentación descriptiva de la API HTTPX con Apidog

Con Apidog, puedes crear rápidamente documentación de la API HTTPX que incluye todo lo que los desarrolladores de software necesitan con solo unos pocos clics.

Flecha 1 - Primero, presiona el botón Share en el lado izquierdo de la ventana de la aplicación Apidog. A continuación, deberías poder ver la página "Shared Docs", que debería estar vacía.

Flecha 2 - Presiona el botón + New debajo de No Data para comenzar a crear tu primera documentación de la API de Apidog.

Selecciona e incluye propiedades importantes de la documentación de la API

Apidog proporciona a los desarrolladores la opción de elegir las características de la documentación de la API, como quién puede ver la documentación de tu API y establecer una contraseña de archivo, para que solo las personas u organizaciones elegidas puedan verla.

Ver o compartir la documentación de tu API

Ahora puedes compartir tu documentación de la API HTTPX con cualquier otra persona. Si deseas distribuir tu documentación, puedes copiar y pegar la URL en cualquier mensajero o correo electrónico que desees. ¡La otra persona solo tendrá que abrir el enlace para acceder a la documentación de HTTPX!

Si se requieren más detalles, lee este artículo sobre cómo generar documentación de la API con Apidog:

Conclusión

HTTPX emerge como una potente biblioteca de Python para crear comunicación HTTP de alto rendimiento. Su naturaleza asíncrona y su énfasis en la velocidad y la eficiencia la convierten en una opción convincente para el desarrollo web moderno. Cuando se trata de aplicaciones de alto tráfico, procesamiento de datos en tiempo real o grandes transferencias de datos, HTTPX brilla.

Sus capacidades, como la agrupación de conexiones, el soporte de transmisión y el control granular sobre las solicitudes, permiten a los desarrolladores crear aplicaciones web escalables y de alto rendimiento. Si tu proyecto de Python prioriza la velocidad bruta, el manejo eficiente de datos y el control preciso sobre la comunicación HTTP, HTTPX es el campeón que has estado buscando.

Apidog es más que capaz de crear API que se implementarán en aplicaciones incorporadas a HTTPX. Por otro lado, si deseas obtener más información sobre las API, puedes importar varios tipos de archivos de API a Apidog para verlos, modificarlos, simularlos y probarlos. Todo lo que necesitas hacer es descargar APidog a través del botón de abajo.