:calls: `GET /search/code `_ :param query: string :param sort: string ('indexed') :param order: string ('asc', 'desc') :param highlight: boolean (True, False) :param qualifiers: keyword dict query qual
(
self,
query: str,
sort: Opt[str] = NotSet,
order: Opt[str] = NotSet,
highlight: bool = False,
**qualifiers: Any,
)
| 786 | return PaginatedList(github.Issue.IssueSearchResult, self.__requester, "/search/issues", url_parameters) |
| 787 | |
| 788 | def search_code( |
| 789 | self, |
| 790 | query: str, |
| 791 | sort: Opt[str] = NotSet, |
| 792 | order: Opt[str] = NotSet, |
| 793 | highlight: bool = False, |
| 794 | **qualifiers: Any, |
| 795 | ) -> PaginatedList[ContentFileSearchResult]: |
| 796 | """ |
| 797 | :calls: `GET /search/code <https://docs.github.com/en/rest/reference/search>`_ |
| 798 | :param query: string |
| 799 | :param sort: string ('indexed') |
| 800 | :param order: string ('asc', 'desc') |
| 801 | :param highlight: boolean (True, False) |
| 802 | :param qualifiers: keyword dict query qualifiers |
| 803 | :rtype: :class:`PaginatedList` of :class:`github.ContentFile.ContentFileSearchResult` |
| 804 | """ |
| 805 | assert isinstance(query, str), query |
| 806 | url_parameters = dict() |
| 807 | if sort is not NotSet: # pragma no branch (Should be covered) |
| 808 | assert sort in ("indexed",), sort |
| 809 | url_parameters["sort"] = sort |
| 810 | if order is not NotSet: # pragma no branch (Should be covered) |
| 811 | assert order in ("asc", "desc"), order |
| 812 | url_parameters["order"] = order |
| 813 | |
| 814 | query_chunks = [] |
| 815 | if query: # pragma no branch (Should be covered) |
| 816 | query_chunks.append(query) |
| 817 | |
| 818 | for qualifier, value in qualifiers.items(): |
| 819 | query_chunks.append(f"{qualifier}:{value}") |
| 820 | |
| 821 | url_parameters["q"] = " ".join(query_chunks) |
| 822 | assert url_parameters["q"], "need at least one qualifier" |
| 823 | |
| 824 | headers = {"Accept": Consts.highLightSearchPreview} if highlight else None |
| 825 | |
| 826 | return PaginatedList( |
| 827 | github.ContentFile.ContentFileSearchResult, |
| 828 | self.__requester, |
| 829 | "/search/code", |
| 830 | url_parameters, |
| 831 | headers=headers, |
| 832 | ) |
| 833 | |
| 834 | def search_commits( |
| 835 | self, |
no test coverage detected