PythonRequirement.multiple()

Complexity

Conditions

4

Size

Total Lines

54

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	PythonRequirement.__init__()	0	17	1

from coalib.bears.requirements.PackageRequirement import PackageRequirement


class PythonRequirement(PackageRequirement):
    """
    This class is a subclass of ``PackageRequirement``, and helps specifying
    requirements from ``pip``, without using the manager name.

    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.
    """

    def __init__(self, package, version=""):
        """
        Constructs a new ``PythonRequirement``, using the ``PackageRequirement``
        constructor.

        >>> pr = PythonRequirement('setuptools', '19.2')
        >>> pr.manager
        'pip'
        >>> pr.package
        'setuptools'
        >>> pr.version
        '19.2'

        :param package: A string with the name of the package to be installed.
        :param version: A version string. Leave empty to specify latest version.
        """
        PackageRequirement.__init__(self, 'pip', package, version)