28.1.4. File tools
28.1.4.1. Download file via HTTP(S)
Downloads a URL to the file system with an HTTP(S) GET or POST request.
Parameters
Basic parameters
Label |
Name |
Type |
Description |
---|---|---|---|
URL |
|
[string] |
The URL of the file to download. |
File destination |
|
[string] Default: |
Specification of the file destination. One of:
|
Advanced parameters
Label |
Name |
Type |
Description |
---|---|---|---|
Method |
|
[enumeration] Default: 0 |
The HTTP method to use for the request. Options are:
|
Data Optional |
|
[string] |
The data to add in the body if the request is a POST. |
Outputs
Label |
Name |
Type |
Description |
---|---|---|---|
File destination |
|
[string] |
The location of the downloaded file |
Python code
Algorithm ID: qgis:filedownloader
import processing
processing.run("algorithm_id", {parameter_dictionary})
The algorithm id is displayed when you hover over the algorithm in the Processing Toolbox. The parameter dictionary provides the parameter NAMEs and values. See Using processing algorithms from the console for details on how to run processing algorithms from the Python console.
28.1.4.2. HTTP(S) POST/GET request
Performs a HTTP(S) POST/GET request and returns the HTTP status code and the reply data. If an error occurs then the error code and the message will be returned. Optionally, the result can be written to a file on the disk. By default the algorithm will warn on errors. Optionally, the algorithm can be set to treat HTTP errors as failures.
Parameters
Label |
Name |
Type |
Description |
---|---|---|---|
URL or file path |
|
[string] |
The URL or path of the file to open. |
Method |
|
[enumeration] Default: 0 |
The HTTP method to use for the request. Options are:
|
POST Data Optional |
|
[string] |
The data to add in the body if the request is a POST. |
Authentication Optional |
|
[authconfig] Default: No authentication |
An authentication configuration to pass |
Consider HTTP errors as failures |
|
[boolean] Default: False |
If set, the algorithm will fail on encountering an HTTP error. |
File destination Optional |
|
[string] Default: |
The result can be written to a file instead of being returned as a string. Specification of the file destination. One of:
|
Outputs
Label |
Name |
Type |
Description |
---|---|---|---|
File destination |
|
[file] |
The downloaded file with the returned result |
HTTP Status |
|
[string] |
The HTTP Status |
Network error code |
|
[string] |
The error code when it fails (like as well on 404 HTTP Status etc.) |
Network error message |
|
[string] |
A string containing the error message in case of failure |
Result data |
|
[string] |
A string containing the result data in case of success |
Python code
Algorithm ID: native:httprequest
import processing
processing.run("algorithm_id", {parameter_dictionary})
The algorithm id is displayed when you hover over the algorithm in the Processing Toolbox. The parameter dictionary provides the parameter NAMEs and values. See Using processing algorithms from the console for details on how to run processing algorithms from the Python console.
28.1.4.3. Open file or URL
Opens files in their default associated application, or URLs in the user’s default web browser.
Parameters
Label |
Name |
Type |
Description |
---|---|---|---|
URL or file path |
|
[string] |
The URL or path of the file to open. |
Outputs
The algorithm has no output.
Python code
Algorithm ID: native:openurl
import processing
processing.run("algorithm_id", {parameter_dictionary})
The algorithm id is displayed when you hover over the algorithm in the Processing Toolbox. The parameter dictionary provides the parameter NAMEs and values. See Using processing algorithms from the console for details on how to run processing algorithms from the Python console.