6.2. foundations.common

common.py

Platform:

Windows, Linux, Mac Os X.

Description:

This module defines Foundations package common utilities objects that don’t fall in any specific category.

Others:

isBinaryFile() from Jorge Orpinel: http://stackoverflow.com/questions/898669/how-can-i-detect-if-a-file-is-binary-non-text-in-python dependencyResolver() from Louis RIVIERE: http://code.activestate.com/recipes/576570-dependency-resolver/

6.2.1. Module Attributes

foundations.common.LOGGER

foundations.common.CONNECTION_IP

foundations.common.DEFAULT_HOST_IP

6.2.2. Functions

foundations.common.uniqify(sequence)

This definition uniqifies the given sequence even if unhashable.

Parameters:sequence – Sequence. ( Object ) Returns:Uniqified sequence. ( List ) Note :The sequence order is not maintained by this definition.

foundations.common.orderedUniqify(sequence)

This definition uniqifies the given hashable sequence while preserving its order.

Parameters:sequence – Sequence. ( Object ) Returns:Uniqified sequence. ( List )

foundations.common.unpackDefault(iterable, length=3, default=None)

This definition unpacks given iterable maintaining given length and filling missing entries with given default.

Parameters:

• iterable – iterable. ( Object )
• length – Iterable length. ( Integer )
• default – Filling default object. ( Object )

Returns:

Unpacked iterable. ( Object )

foundations.common.pathExists(path)

This definition returns if given path exists.

Parameters:path – Path. ( String ) Returns:Path existence. ( Boolean )

foundations.common.filterPath(path)

This definition filters given path.

Parameters:path – Path. ( String ) Returns:Filtered path. ( String )

foundations.common.getFirstItem(iterable, default=None)

This definition returns the first item of given iterable.

Parameters:

• iterable – Iterable. ( Object )
• default – Default value. ( Object )

Returns:

First iterable item. ( Object )

foundations.common.getLastItem(iterable, default=None)

This definition returns the last item of given iterable.

Parameters:

• iterable – Iterable. ( Object )
• default – Default value. ( Object )

Returns:

Last iterable item. ( Object )

foundations.common.isBinaryFile(file)

This definition returns if given file is a binary file.

Parameters:file – File path. ( String ) Returns:Is file binary. ( Boolean )

foundations.common.repeat(object, iterations=1)

This definition repeats given object iterations times.

Parameters:

• object – Object to repeat. ( Object )
• iterations – Repetitions number. ( Integer )

Returns:

Object return values. ( List )

foundations.common.dependencyResolver(dependencies)

This definition resolves given dependencies.

Parameters:dependencies – Dependencies to resolve. ( Dictionary ) Returns:Resolved dependencies. ( List )

foundations.common.isInternetAvailable(ip=u'www.google.com', timeout=1.5)

This definition returns if an internet connection is available.

Parameters:

• ip – Alternative address ip to check against. ( String )
• timeout – Timeout in seconds. ( Integer )

Returns:

Is internet available. ( Boolean )

foundations.common.getHostAddress(host=None, defaultAddress=u'127.0.0.1')

This definition returns the given host address.

Parameters:

• host – Host to retrieve the address. ( String )
• defaultAddress – Default address if the host is unreachable. ( String )

Returns:

Host address. ( String )