<reponame>kntoukakis/wifiportal21-map<filename>venv/lib/python3.5/site-packages/jsonrpcclient/id_iterators.py
"""
ID Iterators
************

By default the request ``id`` is a decimal number which increments for each
request. Use a different format by setting ``Request.id_iterator``::

    >>> from jsonrpcclient.request import Request
    >>> from jsonrpcclient.id_iterators import random_iterator
    >>> Request.id_iterator = random_iterator()
    >>> Request('go')
    {'jsonrpc': '2.0', 'method': 'go', 'id': 'fubui5e6'}
"""

from uuid import uuid4
from string import digits, ascii_lowercase
from random import choice


def hex_iterator(start=1):
    """Incremental hexadecimal numbers.

    e.g. '1', '2' .. '9', 'a', 'b', etc.

    ::

        Request.id_iterator = hex_iterator()
    """
    while True:
        yield '%x' % start
        start += 1


def uuid_iterator():
    """Unique uuid ids.

    e.g. '9bfe2c93-717e-4a45-b91b-55422c5af4ff'

    ::

        Request.id_iterator = uuid_iterator()
    """
    while True:
        yield str(uuid4())


def random_iterator(length=8, chars=digits+ascii_lowercase):
    """A random string. Not unique, but has around 1 in a million chance of
    collision with default values.

    e.g. 'fubui5e6'

    ::

        Request.id_iterator = random_iterator(16, 'abc123')

    :param length: Length of the random string.
    :param chars: The characters to randomly choose from.
    """
    while True:
        yield ''.join([choice(chars) for _ in range(length)])

"""
ID Iterators
************

By default the request ``id`` is a decimal number which increments for each
request. Use a different format by setting ``Request.id_iterator``::

    >>> from jsonrpcclient.request import Request
    >>> from jsonrpcclient.id_iterators import random_iterator
    >>> Request.id_iterator = random_iterator()
    >>> Request('go')
    {'jsonrpc': '2.0', 'method': 'go', 'id': 'fubui5e6'}
"""

from uuid import uuid4
from string import digits, ascii_lowercase
from random import choice


def hex_iterator(start=1):
    """Incremental hexadecimal numbers.

    e.g. '1', '2' .. '9', 'a', 'b', etc.

    ::

        Request.id_iterator = hex_iterator()
    """
    while True:
        yield '%x' % start
        start += 1


def uuid_iterator():
    """Unique uuid ids.

    e.g. '9bfe2c93-717e-4a45-b91b-55422c5af4ff'

    ::

        Request.id_iterator = uuid_iterator()
    """
    while True:
        yield str(uuid4())


def random_iterator(length=8, chars=digits+ascii_lowercase):
    """A random string. Not unique, but has around 1 in a million chance of
    collision with default values.

    e.g. 'fubui5e6'

    ::

        Request.id_iterator = random_iterator(16, 'abc123')

    :param length: Length of the random string.
    :param chars: The characters to randomly choose from.
    """
    while True:
        yield ''.join([choice(chars) for _ in range(length)])
ID Iterators ************  By default the request ``id`` is a decimal number which increments for each request. Use a different format by setting ``Request.id_iterator``::      >>> from jsonrpcclient.request import Request     >>> from jsonrpcclient.id_iterators import random_iterator     >>> Request.id_iterator = random_iterator()     >>> Request('go')     {'jsonrpc': '2.0', 'method': 'go', 'id': 'fubui5e6'} Incremental hexadecimal numbers.      e.g. '1', '2' .. '9', 'a', 'b', etc.      ::          Request.id_iterator = hex_iterator() Unique uuid ids.      e.g. '9bfe2c93-717e-4a45-b91b-55422c5af4ff'      ::          Request.id_iterator = uuid_iterator() A random string. Not unique, but has around 1 in a million chance of     collision with default values.      e.g. 'fubui5e6'      ::          Request.id_iterator = random_iterator(16, 'abc123')      :param length: Length of the random string.     :param chars: The characters to randomly choose from.