PythonRequirement.multiple()

Complexity

Conditions

4

Size

Total Lines

53

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

from coalib.bears.requirements.PackageRequirement import PackageRequirement
    @classmethod
    def multiple(cls, *args):
        """
        Creates a tuple of multiple ``PythonRequirements``.

        You should use the ``multiple`` method if you have more
        requirements from the same manager. This can receive both tuples of
        strings, in case you want a specific version, or a simple string, in
        case you want the latest version to be specified.

        This is the case where you would provide strings only, to specify the
        latest version automatically:

        >>> REQUIREMENTS = PythonRequirement.multiple(
        ...     'coala_decorators', 'setuptools')

        And if you choose to mix them, specifying version for some and for some
        not:

        >>> REQUIREMENTS = PythonRequirement.multiple(
        ...     'coala_decorators', ('setuptools', '19.2'))

        Lists are also valid arguments:

        >>> REQUIREMENTS = PythonRequirement.multiple(
        ...     ['coala_decorators', '19.2'],)

        In case you provide too many arguments into the tuple, an error will be
        raised:

        >>> REQUIREMENTS = PythonRequirement.multiple(
        ...     'coala_decorators', ('setuptools', '19.2', 'colorama'))
        Traceback (most recent call last):
        ...
        TypeError: Too many elements provided.

        :param args:       Should be iterables with two elements:
                           ``('packageName', 'version')`` or strings:
                           ``'packageName'`` if latest version is wanted.
        :return:           A tuple containing ``PythonRequirements``.
        :raises TypeError: In case the iterables contain more than two
                           elements.
        """
        reqs = []
        for requirement in args:
            if isinstance(requirement, str):
                reqs.append(cls(requirement))
            elif len(requirement) == 2:
                name, version = requirement
                reqs.append(cls(name, version))
            else:
                raise TypeError('Too many elements provided.')
        return tuple(reqs)