pif Package

pif Package

pif.__init__.get_public_ip(preferred_checker=None, verbose=False)

Gets IP using one of the services.

Parameters:
  • preffered checker (str) – Checker UID. If given, the preferred checker is used.
  • verbose (bool) – If set to True, debug info is printed.
Return str:

base Module

class pif.base.BasePublicIPChecker(verbose=False)[source]

Bases: object

Base public IP checker.

get_local_ip()[source]

Gets local IP

Return str:
get_public_ip()[source]

Get public IP.

Return str:
uid = None
verbose = False

benchmark Module

pif.benchmark.run_benchmark_test()[source]

Runs the benchmark test to identify the fastest provider.

conf Module

defaults Module

discover Module

pif.discover.autodiscover()[source]

Autodiscovers the pif IP checkers in checkers directory.

exceptions Module

exception pif.exceptions.InvalidRegistryItemType[source]

Bases: exceptions.ValueError

Raised when an attempt is made to register an item in the registry which does not have a proper type.

helpers Module

pif.helpers.PROJECT_DIR(base)

tests Module

class pif.tests.PifTest(methodName='runTest')[source]

Bases: unittest.case.TestCase

Tests

setUp()[source]
test_01_autodiscover(*args, **kwargs)[source]
test_02_get_public_ip(*args, **kwargs)[source]
test_03_get_public_ip_using_preferred_checker_whatismyip(*args, **kwargs)[source]
test_04_get_public_ip_using_preferred_checker_ident(*args, **kwargs)[source]
test_05_get_public_ip_using_preferred_checker_dyndns(*args, **kwargs)[source]
test_06_list_checkers(*args, **kwargs)[source]
test_07_unregister_checker(*args, **kwargs)[source]
test_08_register_custom_checker(*args, **kwargs)[source]

utils Module

pif.utils.ensure_autodiscover()[source]

Ensures the IP checkers are discovered.

pif.utils.list_checkers()[source]

Lists available checkers.

Return list:
pif.utils.get_public_ip(preferred_checker=None, verbose=False)[source]

Gets IP using one of the services.

Parameters:
  • preffered checker (str) – Checker UID. If given, the preferred checker is used.
  • verbose (bool) – If set to True, debug info is printed.
Return str: