Módulo google.appengine.api.urlfetch

Resumen

API que descarga URL.

Contenido

google.appengine.api.urlfetch.Fetch(url, payload=None, method=1, headers={}, allow_truncated=False, follow_redirects=True, deadline=None, validate_certificate=None)source

Recupera la URL HTTP determinada y se bloquea hasta que se muestre el resultado.

Las URL se recuperan mediante uno de los siguientes métodos HTTP:

  • GET

  • POST

  • HEAD

  • PUT

  • BORRAR

  • PATCH

Para recuperar el resultado, se usa un proxy compatible con HTTP/1.1.

Parámetros

  • método: Las constantes GET, POST, HEAD, PUT, DELETE o PATCH o los mismos métodos HTTP que las strings.

  • carga útil: POST, PUT o PATCH (el método implícito no es GET, HEAD ni DELETE). Este argumento se ignora si el método no es POST, PUT ni PATCH.

  • encabezados: diccionario de encabezados HTTP que se envían con la solicitud.

  • allow_truncated: si se configura como True, trunca las respuestas grandes y las muestra sin generar un error. De lo contrario, se genera un ResponseTooLargeError cuando se trunca una respuesta.

  • follow_redirects: si se establece en True (el valor predeterminado), los redireccionamientos se siguen con transparencia y la respuesta (si hay menos de 5 redireccionamientos) contiene la carga útil del destino final. El estado de la respuesta es 200. Sin embargo, perderás la información de la cadena de redireccionamiento. Si se configura como False, verás la respuesta HTTP, incluido el encabezado “Ubicación”, y no se siguen los redireccionamientos.

  • deadline: plazo en segundos para la operación.

  • validate_certificate: si se configura como True, las solicitudes no se envían al servidor, a menos que el certificado sea válido, firmado por una CA de confianza y el nombre del host coincida con el certificado. Un valor de None indica que la implementación subyacente urlfetch elegirá el comportamiento.

Muestra

Un objeto que contiene los siguientes campos:

  • content: una string que contiene la respuesta del servidor.

  • status_code: El código de estado HTTP que mostró el servidor.

  • encabezados: el diccionario de encabezados que mostró el servidor.

Tipo de datos que se muestra

objeto

Se genera el error

urlfetch_errors.Error: Si se produce un error. Consulta el módulo urlfetch_errors para obtener más información.

google.appengine.api.urlfetch.create_rpc(deadline=None, callback=None)source

Crea un objeto RPC para usar con la API de urlfetch.

Parámetros

  • deadline: lazo opcional en segundos para la operación. El valor predeterminado es un plazo específico del sistema (por lo general, 5 segundos).

  • callback: opcional que se puede llamar para invocarlo al finalizar.

Muestra

Un objeto apiproxy_stub_map.UserRPC especializado para este servicio.

google.appengine.api.urlfetch.fetch(url, payload=None, method=1, headers={}, allow_truncated=False, follow_redirects=True, deadline=None, validate_certificate=None)source

Recupera la URL HTTP determinada y se bloquea hasta que se muestre el resultado.

Las URL se recuperan mediante uno de los siguientes métodos HTTP:

  • GET

  • POST

  • HEAD

  • PUT

  • BORRAR

  • PATCH

Para recuperar el resultado, se usa un proxy compatible con HTTP/1.1.

Parámetros

  • método: Las constantes GET, POST, HEAD, PUT, DELETE o PATCH o los mismos métodos HTTP que las strings.

  • carga útil: POST, PUT o PATCH (el método implícito no es GET, HEAD ni DELETE). Este argumento se ignora si el método no es POST, PUT ni PATCH.

  • encabezados: diccionario de encabezados HTTP que se envían con la solicitud.

  • allow_truncated: si se configura como True, trunca las respuestas grandes y las muestra sin generar un error. De lo contrario, se genera un ResponseTooLargeError cuando se trunca una respuesta.

  • follow_redirects: si se establece en True (el valor predeterminado), los redireccionamientos se siguen con transparencia y la respuesta (si hay menos de 5 redireccionamientos) contiene la carga útil del destino final. El estado de la respuesta es 200. Sin embargo, perderás la información de la cadena de redireccionamiento. Si se configura como False, verás la respuesta HTTP, incluido el encabezado “Ubicación”, y no se siguen los redireccionamientos.

  • deadline: plazo en segundos para la operación.

  • validate_certificate: si se configura como True, las solicitudes no se envían al servidor, a menos que el certificado sea válido, firmado por una CA de confianza y el nombre del host coincida con el certificado. Un valor de None indica que la implementación subyacente urlfetch elegirá el comportamiento.

Muestra

Un objeto que contiene los siguientes campos:

  • content: una string que contiene la respuesta del servidor.

  • status_code: El código de estado HTTP que mostró el servidor.

  • encabezados: el diccionario de encabezados que mostró el servidor.

Tipo de datos que se muestra

objeto

Se genera el error

urlfetch_errors.Error: Si se produce un error. Consulta el módulo urlfetch_errors para obtener más información.

google.appengine.api.urlfetch.get_default_fetch_deadline()source

Obtiene el valor predeterminado para el parámetro de plazo de create_rpc().

google.appengine.api.urlfetch.make_fetch_call(rpc, url, payload=None, method=1, headers={}, allow_truncated=False, follow_redirects=True, validate_certificate=None)source

Ejecuta la llamada RPC para recuperar una URL HTTP determinada.

El primer argumento es una instancia UserRPC. Consulta urlfetch.fetch para obtener una descripción detallada de los argumentos restantes.

Se genera el error

  • InvalidMethodError: si el método solicitado no está en _VALID_METHODS.

  • ResponseTooLargeError: si la carga útil de la respuesta es demasiado grande.

  • InvalidURLError: si hay problemas con el contenido o el tamaño de la URL solicitada

Muestra

El objeto RPC que se pasó a la función.

google.appengine.api.urlfetch.set_default_fetch_deadline(value)source

Configura el valor predeterminado para el parámetro deadline de create_rpc().

Esta configuración es específica del subproceso, lo que significa que se almacena en un subproceso local. Esta función no verifica el tipo o el rango del valor. El valor predeterminado es None.

También consulta: create_rpc(), fetch()

Parámetros

value: el valor predeterminado que deseas usar para el parámetro deadline de create_rpc().