.fetch_configuration

class: FetchConfiguration

class FetchConfiguration(**kwargs)[source]

The configuration settings to apply to a JavaScript fetch() request.

Class Inheritance
Inheritance diagram of FetchConfiguration

copy(other=None, overwrite=True, **kwargs)

Copy the configuration settings from this instance to the other instance.

Parameters:

  • other (HighchartsMeta) – The target instance to which the properties of this instance should be copied. If None, will create a new instance and populate it with properties copied from self. Defaults to None.

  • overwrite (bool) – if True, properties in other that are already set will be overwritten by their counterparts in self. Defaults to True.

  • kwargs – Additional keyword arguments. Some special descendents of HighchartsMeta may have special implementations of this method which rely on additional keyword arguments.

Returns:

A mutated version of other with new property values

classmethod from_dict(as_dict: dict, allow_snake_case: bool = True)

Construct an instance of the class from a dict object.

Parameters:

  • as_dict (dict) – A dict representation of the object.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

Returns:

A Python object representation of as_dict.

Return type:

HighchartsMeta

classmethod from_js_literal(as_str_or_file, allow_snake_case: bool = True, _break_loop_on_failure: bool = False)

Return a Python object representation of a Highcharts JavaScript object literal.

Parameters:

  • as_str_or_file (str) – The JavaScript object literal, represented either as a str or as a filename which contains the JS object literal.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

  • _break_loop_on_failure (bool) – If True, will break any looping operations in the event of a failure. Otherwise, will attempt to repair the failure. Defaults to False.

Returns:

A Python object representation of the Highcharts JavaScript object literal.

Return type:

HighchartsMeta

classmethod from_json(as_json_or_file, allow_snake_case: bool = True)

Construct an instance of the class from a JSON string.

Parameters:

  • as_json_or_file – The JSON string for the object or the filename of a file that contains the JSON string.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

Returns:

A Python objcet representation of as_json.

Return type:

HighchartsMeta

get_required_modules(include_extension=False) → List[str]

Return the list of URLs from which the Highcharts JavaScript modules needed to render the chart can be retrieved.

Parameters:

include_extension (bool) – if True, will return script names with the '.js' extension included. Defaults to False.

Return type:

list of str

to_dict() → dict

Generate a dict representation of the object compatible with the Highcharts JavaScript library.

Note

The dict representation has a property structure and naming convention that is intentionally consistent with the Highcharts JavaScript library. This is not Pythonic, but it makes managing the interplay between the two languages much, much simpler.

Returns:

A dict representation of the object.

Return type:

dict

to_js_literal(filename=None, encoding='utf-8', careful_validation=False) → str | None

Return the object represented as a str containing the JavaScript object literal.

Parameters:

  • filename (Path-like) – The name of a file to which the JavaScript object literal should be persisted. Defaults to None

  • encoding (str) – The character encoding to apply to the resulting object. Defaults to 'utf-8'.

  • careful_validation – if True, will carefully validate JavaScript values

along the way using the esprima-python library. Defaults to False.

Warning

Setting this value to True will significantly degrade serialization performance, though it may prove useful for debugging purposes.

Return type:

str or None

to_json(filename=None, encoding='utf-8', for_export: bool = False)

Generate a JSON string/byte string representation of the object compatible with the Highcharts JavaScript library.

Note

This method will either return a standard str or a bytes object depending on the JSON serialization library you are using. For example, if your environment has orjson, the result will be a bytes representation of the string.

Parameters:

  • filename (Path-like) – The name of a file to which the JSON string should be persisted. Defaults to None

  • encoding (str) – The character encoding to apply to the resulting object. Defaults to 'utf-8'.

  • for_export (bool) – If True, indicates that the method is being run to produce a JSON for consumption by the export server. Defaults to False.

Returns:

A JSON representation of the object compatible with the Highcharts library.

Return type:

str or bytes

static trim_dict(untrimmed: dict, to_json: bool = False, context: str = None, for_export: bool = False) → dict

Remove keys from untrimmed whose values are None and convert values that have .to_dict() methods.

Parameters:

  • untrimmed (dict) – The dict whose values may still be None or Python objects.

  • to_json (bool) – If True, will remove all keys from untrimmed that are not serializable to JSON. Defaults to False.

  • context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.

  • for_export (bool) – If True, indicates that the method is being run to produce a JSON for consumption by the export server. Defaults to False.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False, context: str = None, for_export: bool = False)

Convert any EnforcedNullType values in untrimmed to 'null'.

Parameters:

  • untrimmed (iterable) – The iterable whose members may still be None or Python objects.

  • to_json (bool) – If True, will remove all members from untrimmed that are not serializable to JSON. Defaults to False.

  • context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.

  • for_export (bool) – If True, indicates that the method is being run to produce a JSON for consumption by the export server. Defaults to False.

Return type:

iterable

property body: str | None

The body to supply when making the request. Defaults to None.

Warning

Will only be supplied if .method is 'POST', 'PUT', or 'PATCH'.

Return type:

str or None

property cache: str | None

Determines how the request will interact with the browser’s HTTP cache. Defaults to None, which behaves as 'default'.

Accepts the values:

  • 'default'

  • 'no-store'

  • 'reload'

  • 'no-cache'

  • 'force-cache'

  • 'only-if-cached'

Return type:

str or None

property credentials: str | None

Determines what browsers do with credentials (cookies, HTTP authentication entries, and TLS client certificates). Defaults to None, which acts as if 'same-origin' was provided.

Accepts the following:

  • 'omit' - tells browsers to exclude credentials from the request, and ignore any credentials sent back in the response (e.g., any Set-Cookie header).

  • 'same-origin' (default) - tells browsers to include credentials with requests to same-origin URLs, and use any credentials sent back in responses from same-origin URLs.

  • 'include' - tells browsers to include credentials in both same- and cross-origin requests, and always use any credentials sent back in responses.

Return type:

str or None

property headers: dict | None

Headers to supply as HTTP headers with the request. Expects a dict whose keys are the header and whose values are the header value. Defaults to None.

Return type:

dict or None

property integrity: str | None

The subresource integrity value of the request (e.g. 'sha256-BpfBw7ivV8q2jLiT13fxDYAe2tJllusRSZ273h2nFSE='). Defaults to None.

Return type:

str or None

property is_valid: bool

Indicates whether the FetchConfiguration can construct a valid (JavaScript) fetch() call. True indicates validity, False means the call will fail.

Return type:

bool

property keepalive: bool | None

If True, the request can outlive the page (client context) which made the fetch request. Defaults to None, which behaves as False.

Return type:

bool or None

property method: str | None

The HTTP method to use when requesting the .url. Defaults to 'GET'.

Accepts:

  • 'GET'

  • 'HEAD'

  • 'POST'

  • 'PUT'

  • 'DELETE'

  • 'CONNECT'

  • 'OPTIONS'

  • 'TRACE'

  • 'PATCH'

Return type:

str or None

property mode: str | None

The mode that you wish to use for the request. Defaults to None.

Accepts:

  • 'cors'

  • 'no-cors'

  • 'same-origin'

Return type:

str or None

property redirect: str | None

Determines how to handle a redirect response. Defaults to None, which behaves as 'follow'.

Accepts:

  • 'follow' (default) - automatically follow redirects

  • 'error' - abort with an error if a redirect occurs

  • 'manual' - caller intends to process the response in another context

Return type:

str or None

property referrer: str | None

A string specifying the referrer of the request. This can be a same-origin URL, 'about:client', or an empty string. Defaults to None.

Return type:

str or None

property referrer_policy: str | None

Specifies the referrer policy to use for the request. Defaults to None.

Accepts:

  • 'no-referrer'

  • 'no-referrer-when-downgrade'

  • 'same-origin'

  • 'origin'

  • 'strict-origin'

  • 'origin-when-cross-origin'

  • 'strict-origin-when-cross-origin'

  • 'unsafe-url'

Return type:

str or None

property url: str | None

The URL that the (JavaScript) fetch() function will be requesting. Defaults to None.

Return type:

str or None