Module push_to_3yourmind.types

This module contains NoValue class and type aliases for type annotations

Classes

class NoValue

Expand source code

class NoValue:
    """
    Some class methods accept arguments that are optional. Skipping them means
    "no data changed" and will lead to not sending them to the 3YD API. To skip such an
    argument give it a `NoValue` value.

    For example, `client.my_profile.set_preferences` can accept 4 arguments:
    country, currency, language, unit. If you need to update user's unit but leave other
    settings unchanged:

    >>> client.my_profile.set_preferences(unit="inch", country=NoValue, currency=NoValue, language=NoValue)
    # or shorter
    >>> client.my_profile.set_preferences(unit="inch")

    The following:

    >>> client.my_profile.set_preferences(unit="inch", country=None, currency=None, language=None)

    ... it will mean that you want to set user's country, currency and language setting to NULL.
    """

Some class methods accept arguments that are optional. Skipping them means "no data changed" and will lead to not sending them to the 3YD API. To skip such an argument give it a NoValue value.

For example, client.my_profile.set_preferences can accept 4 arguments: country, currency, language, unit. If you need to update user's unit but leave other settings unchanged:

>>> client.my_profile.set_preferences(unit="inch", country=NoValue, currency=NoValue, language=NoValue)
# or shorter
>>> client.my_profile.set_preferences(unit="inch")

The following:

>>> client.my_profile.set_preferences(unit="inch", country=None, currency=None, language=None)

… it will mean that you want to set user's country, currency and language setting to NULL.