Utilities¶

Data structures¶

class route4me.sdk.utils.PagedList(total=None, limit=None, offset=None, items=None)[source]¶

Bases: list

Enumerable structure for array-like responses of the Route4Me API.

Several endpoints of Route4Me API return enumerable responses, which contains meta-information about paging (fields like total, limit, offset). This class allows enumerating requested data along with mentioned meta-data fields.

__init__(total=None, limit=None, offset=None, items=None)[source]¶

limit¶

Limit used during endpoint access

Getter:	Value of `limit` parameter if it was used in query
Return type:	int

offset¶

Offset used during endpoint access

Getter:	Value of `offset` parameter if it was used in query
Return type:	int

total¶

Total results count (taken from API response)

Getter:	Results count, when available
Return type:	int

Typeconv¶

route4me.sdk._internals.typeconv.bool201(boolvalue)[source]¶

Converts bool value to string: u'0' or u'1' — a returned value is in unicode.

Parameters:	boolvalue (bool) – Value to convert
Returns:	String `'0'` or `'1'`
Return type:	str
Raises:	TypeError – if not a bool argument was passed

route4me.sdk._internals.typeconv.str2bool(strvalue, default=None)[source]¶

Converts string value to bool. Can parse human-readable values, like 'yes' and 'off'.

If value is not recognized – the value of the :paramref:`~str2bool.default` argument will be returned.

Note

str2bool() is not an extension of default bool. For example, it doesn’t recognize integer 2 (or any other number) as True value.

Parameters:	strvalue (str) – Value to parse default – Default value, defaults to `None`
Returns:	Parsed boolean value or :paramref:`~str2bool.default` (if defined). Not a bool value will be returned only if value was not recognized.
Return type:	bool or *