Source code for pif.utils

__title__ = 'pif.utils'
__version__ = '0.5'
__build__ = 0x000005
__author__ = 'Artur Barseghyan'
__all__ = ('ensure_autodiscover', 'list_checkers', 'get_public_ip')

from six import print_

from pif.base import registry
from pif.discover import autodiscover

[docs]def ensure_autodiscover():
    """
    Ensures the IP checkers are discovered.
    """
    if not registry._registry:
        autodiscover()

[docs]def list_checkers():
    """
    Lists available checkers.

    :return list:
    """
    return registry._registry.keys()

[docs]def get_public_ip(preferred_checker=None, print_info=False):
    """
    Gets IP using one of the services.

    :param str preffered checker: Checker UID. If given, the preferred checker is used.
    :param bool print_info: If set to True, debug info is printed.
    :return str:
    """
    ensure_autodiscover()

    # If use preferred checker.
    if preferred_checker:
        ip_checker_cls = registry.get(preferred_checker)

        if not ip_checker_cls:
            return False

        ip_checker = ip_checker_cls()
        ip = ip_checker.get_public_ip()

        if print_info:
            print_('provider: ', ip_checker_cls)
        return ip

    # Using all checkers.

    for ip_checker_name, ip_checker_cls in registry._registry.items():
        ip_checker = ip_checker_cls()
        try:
            ip = ip_checker.get_public_ip()
            if ip:
                if print_info:
                    print_('provider: ', ip_checker_cls)
                return ip

        except Exception as e:
            pass

    return False