Completed
Pull Request — master (#2166)
by Zatreanu
01:53
created

PackageRequirement   A

Complexity

Total Complexity 2

Size/Duplication

Total Lines 48
Duplicated Lines 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 48
rs 10
wmc 2

2 Methods

Rating   Name   Duplication   Size   Complexity  
A __init__() 0 19 1
A check() 0 12 1
1
from coala_decorators.decorators import generate_eq, generate_repr
2
3
4
@generate_eq("manager", "package", "version")
5
@generate_repr()
6
class PackageRequirement:
7
    """
8
    This class helps keeping track of bear requirements. It should simply
9
    be appended to the REQUIREMENTS tuple inside the Bear class.
10
11
    Two ``PackageRequirements`` should always be equal if they have the same
12
    manager, package and version:
13
14
    >>> pr1 = PackageRequirement('pip', 'coala_decorators', '0.1.0')
15
    >>> pr2 = PackageRequirement('pip', 'coala_decorators', '0.1.0')
16
    >>> pr1 == pr2
17
    True
18
    """
19
20
    def __init__(self, manager: str, package: str, version=""):
21
        """
22
        Constructs a new ``PackageRequirement``.
23
24
        >>> pr = PackageRequirement('pip', 'colorama', '0.1.0')
25
        >>> pr.manager
26
        'pip'
27
        >>> pr.package
28
        'colorama'
29
        >>> pr.version
30
        '0.1.0'
31
32
        :param manager: A string with the name of the manager (pip, npm, etc).
33
        :param package: A string with the name of the package to be installed.
34
        :param version: A version string. Leave empty to specify latest version.
35
        """
36
        self.manager = manager
37
        self.package = package
38
        self.version = version
39
40
    def check(self):
41
        """
42
        Check if the requirement is satisfied.
43
44
        >>> PackageRequirement('pip', 'coala_decorators', '0.2.1').check()
45
        Traceback (most recent call last):
46
        ...
47
        NotImplementedError
48
49
        :return: Returns True if satisfied, False if not.
50
        """
51
        raise NotImplementedError
52