Functions

check_version(major: int, minor: int, micro: int) → bool

Like CHECK_VERSION, but the check for soup_check_version is at runtime instead of compile time.

This is useful for compiling against older versions of libsoup, but using features from newer versions.

Parameters:

major – the major version to check
minor – the minor version to check
micro – the micro version to check

Returns:

True if the version of the libsoup currently loaded is the same as or newer than the passed-in version.

cookie_parse(header: str, origin: Uri | None = None) → Cookie | None

Parameters:

header
origin

cookies_from_request(msg: Message) → list[Cookie]

Parses msg’s Cookie request header and returns a SList of SoupCookie’s.

As the “Cookie” header, unlike “Set-Cookie”, only contains cookie names and values, none of the other Cookie fields will be filled in. (Thus, you can’t generally pass a cookie returned from this method directly to cookies_to_response.)

Parameters:: msg – a Message containing a “Cookie” request header
Returns:: a GSList of SoupCookie’s, which can be freed with free.

cookies_from_response(msg: Message) → list[Cookie]

Parses msg’s Set-Cookie response headers and returns a SList of SoupCookie’s.

Cookies that do not specify “path” or “domain” attributes will have their values defaulted from msg.

Parameters:: msg – a Message containing a “Set-Cookie” response header
Returns:: a GSList of SoupCookie’s, which can be freed with free.

cookies_to_cookie_header(cookies: list[Cookie]) → str

Serializes a SList of Cookie into a string suitable for setting as the value of the “Cookie” header.

Parameters:: cookies – a GSList of Cookie
Returns:: the serialization of cookies

cookies_to_request(cookies: list[Cookie], msg: Message) → None

Adds the name and value of each cookie in cookies to msg’s “Cookie” request.

If msg already has a “Cookie” request header, these cookies will be appended to the cookies already present. Be careful that you do not append the same cookies twice, eg, when requeuing a message.

Parameters:

cookies – a GSList of Cookie
msg – a Message

cookies_to_response(cookies: list[Cookie], msg: Message) → None

Appends a “Set-Cookie” response header to msg for each cookie in cookies.

This is in addition to any other “Set-Cookie” headers msg may already have.

Parameters:

cookies – a GSList of Cookie
msg – a Message

date_time_new_from_http_string(date_string: str) → DateTime | None

Parses date_string and tries to extract a date from it.

This recognizes all of the “HTTP-date” formats from RFC 2616, RFC 2822 dates, and reasonable approximations thereof. (Eg, it is lenient about whitespace, leading “0”s, etc.)

Parameters:: date_string – The date as a string
Returns:: a new DateTime, or None if date_string could not be parsed.

date_time_to_string(date: DateTime, format: DateFormat) → str

Converts date to a string in the format described by format.

Parameters:

date – a DateTime
format – the format to generate the date in

Returns:

date as a string or None

form_decode(encoded_form: str) → dict[str, str]

Decodes form.

which is an urlencoded dataset as defined in the HTML 4.01 spec.

Parameters:: encoded_form – data of type “application/x-www-form-urlencoded”
Returns:: a hash table containing the name/value pairs from encoded_form, which you can free with destroy.

form_decode_multipart(multipart: Multipart, file_control_name: str | None = None) → tuple[dict[str, str] | None, str, str, Bytes]

Decodes the “multipart/form-data” request in multipart.

this is a convenience method for the case when you have a single file upload control in a form. (Or when you don’t have any file upload controls, but are still using “multipart/form-data” anyway.) Pass the name of the file upload control in file_control_name, and form_decode_multipart will extract the uploaded file data into filename, content_type, and file. All of the other form control data will be returned (as strings, as with form_decode in the returned HashTable.

You may pass None for filename, content_type and/or file if you do not care about those fields. form_decode_multipart may also return None in those fields if the client did not provide that information. You must free the returned filename and content-type with free, and the returned file data with unref.

If you have a form with more than one file upload control, you will need to decode it manually, using new_from_message and get_part.

Parameters:

multipart – a Multipart
file_control_name – the name of the HTML file upload control

Returns:

a hash table containing the name/value pairs (other than file_control_name) from msg, which you can free with destroy. On error, it will return None.

form_encode_datalist(form_data_set: Data) → str

Encodes form_data_set into a value of type “application/x-www-form-urlencoded”.

Encodes as defined in the HTML 4.01 spec. Unlike form_encode_hash, this preserves the ordering of the form elements, which may be required in some situations.