Skip to content

project_collection module

Collection of Data to Science projects.

Source code in d2spy/models/project_collection.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class ProjectCollection:
    """Collection of Data to Science projects."""

    def __init__(self, collection: List[Project] = []):
        self.collection = collection

    def __getitem__(self, index: int) -> Project:
        return self.collection[int(index)]

    def __len__(self) -> int:
        return len(self.collection)

    def __repr__(self) -> str:
        return f"ProjectCollection({self.collection})"

    def filter_by_description(self, keyword: str) -> "ProjectCollection":
        """Returns list of projects with descriptions containing text that matches
        the keyword text.

        Args:
            keyword (str): Keyword text that will be matched with project descriptions.

        Returns:
            ProjectCollection: Collection of projects with keyword matches.
        """
        filtered_collection = [
            project
            for project in self.collection
            if keyword.lower() in project.description.lower()
        ]
        return ProjectCollection(collection=filtered_collection)

    def filter_by_title(self, keyword: str) -> "ProjectCollection":
        """Returns list of projects with titles containing text that matches
        the keyword text.

        Args:
            keyword (str): Keyword text that will be matched with project titles.

        Returns:
            List[Project]: List of projects with keyword matches.
        """
        filtered_collection = [
            project
            for project in self.collection
            if keyword.lower() in project.title.lower()
        ]
        return ProjectCollection(collection=filtered_collection)

filter_by_description(keyword)

Returns list of projects with descriptions containing text that matches the keyword text.

Parameters:

Name Type Description Default
keyword str

Keyword text that will be matched with project descriptions.

 required

Returns:

Name Type Description
ProjectCollection ProjectCollection

Collection of projects with keyword matches.
Source code in d2spy/models/project_collection.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def filter_by_description(self, keyword: str) -> "ProjectCollection":
    """Returns list of projects with descriptions containing text that matches
    the keyword text.

    Args:
        keyword (str): Keyword text that will be matched with project descriptions.

    Returns:
        ProjectCollection: Collection of projects with keyword matches.
    """
    filtered_collection = [
        project
        for project in self.collection
        if keyword.lower() in project.description.lower()
    ]
    return ProjectCollection(collection=filtered_collection)

filter_by_title(keyword)

Returns list of projects with titles containing text that matches the keyword text.

Parameters:

Name Type Description Default
keyword str

Keyword text that will be matched with project titles.

 required

Returns:

Type Description
ProjectCollection

List[Project]: List of projects with keyword matches.
Source code in d2spy/models/project_collection.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def filter_by_title(self, keyword: str) -> "ProjectCollection":
    """Returns list of projects with titles containing text that matches
    the keyword text.

    Args:
        keyword (str): Keyword text that will be matched with project titles.

    Returns:
        List[Project]: List of projects with keyword matches.
    """
    filtered_collection = [
        project
        for project in self.collection
        if keyword.lower() in project.title.lower()
    ]
    return ProjectCollection(collection=filtered_collection)