MCPcopy Index your code
hub / github.com/PyGithub/PyGithub / search_users

Method search_users

github/MainClass.py:711–750  ·  view source on GitHub ↗

:calls: `GET /search/users `_ :param query: string :param sort: string ('followers', 'repositories', 'joined') :param order: string ('asc', 'desc') :param qualifiers: keyword dict query qualifiers :rty

(
        self,
        query: str,
        sort: Opt[str] = NotSet,
        order: Opt[str] = NotSet,
        **qualifiers: Any,
    )

Source from the content-addressed store, hash-verified

709 )
710
711 def search_users(
712 self,
713 query: str,
714 sort: Opt[str] = NotSet,
715 order: Opt[str] = NotSet,
716 **qualifiers: Any,
717 ) -> PaginatedList[NamedUserSearchResult]:
718 """
719 :calls: `GET /search/users <https://docs.github.com/en/rest/reference/search>`_
720 :param query: string
721 :param sort: string ('followers', 'repositories', 'joined')
722 :param order: string ('asc', 'desc')
723 :param qualifiers: keyword dict query qualifiers
724 :rtype: :class:`PaginatedList` of :class:`github.NamedUser.NamedUserSearchResult`
725 """
726 assert isinstance(query, str), query
727 url_parameters = dict()
728 if sort is not NotSet:
729 assert sort in ("followers", "repositories", "joined"), sort
730 url_parameters["sort"] = sort
731 if order is not NotSet:
732 assert order in ("asc", "desc"), order
733 url_parameters["order"] = order
734
735 query_chunks = []
736 if query:
737 query_chunks.append(query)
738
739 for qualifier, value in qualifiers.items():
740 query_chunks.append(f"{qualifier}:{value}")
741
742 url_parameters["q"] = " ".join(query_chunks)
743 assert url_parameters["q"], "need at least one qualifier"
744
745 return PaginatedList(
746 github.NamedUser.NamedUserSearchResult,
747 self.__requester,
748 "/search/users",
749 url_parameters,
750 )
751
752 def search_issues(
753 self,

Callers 3

testSearchUsersMethod · 0.80

Calls 1

PaginatedListClass · 0.90

Tested by

no test coverage detected