Skip to content

prefect_github.repository_owner

This is a module containing: GitHub query_repository_owner* tasks

query_repository_owner(login, github_credentials, return_fields=None) async

The query root of GitHub's GraphQL interface.

Parameters:

Name Type Description Default
login str

The username to lookup the owner by.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
return_fields Optional[Iterable[str]]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_github/repository_owner.py
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
54
55
56
57
58
@task
async def query_repository_owner(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The query root of GitHub's GraphQL interface.

    Args:
        login: The username to lookup the owner by.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository_owner(
        **strip_kwargs(
            login=login,
        )
    )

    op_stack = ("repositoryOwner",)
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repositoryOwner"]

query_repository_owner_repositories(login, github_credentials, privacy=None, order_by=None, affiliations=None, owner_affiliations=('OWNER', 'COLLABORATOR'), is_locked=None, after=None, before=None, first=None, last=None, is_fork=None, return_fields=None) async

A list of repositories that the user owns.

Parameters:

Name Type Description Default
login str

The username to lookup the owner by.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
privacy Optional[RepositoryPrivacy]

If non-null, filters repositories according to privacy.

None
order_by Optional[RepositoryOrder]

Ordering options for repositories returned from the connection.

None
affiliations Optional[Iterable[RepositoryAffiliation]]

Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.

None
owner_affiliations Optional[Iterable[RepositoryAffiliation]]

Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.

('OWNER', 'COLLABORATOR')
is_locked Optional[bool]

If non-null, filters repositories according to whether they have been locked.

None
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
is_fork Optional[bool]

If non-null, filters repositories according to whether they are forks of another repository.

None
return_fields Optional[Iterable[str]]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_github/repository_owner.py
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
@task
async def query_repository_owner_repositories(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    privacy: Optional[graphql_schema.RepositoryPrivacy] = None,
    order_by: Optional[graphql_schema.RepositoryOrder] = None,
    affiliations: Optional[Iterable[graphql_schema.RepositoryAffiliation]] = None,
    owner_affiliations: Optional[Iterable[graphql_schema.RepositoryAffiliation]] = (
        "OWNER",
        "COLLABORATOR",
    ),
    is_locked: Optional[bool] = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    is_fork: Optional[bool] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of repositories that the user owns.

    Args:
        login: The username to lookup the owner by.
        github_credentials: Credentials to use for authentication with GitHub.
        privacy: If non-null, filters repositories according to
            privacy.
        order_by: Ordering options for repositories returned from
            the connection.
        affiliations: Array of viewer's affiliation options for
            repositories returned from the connection. For example,
            OWNER will include only repositories that the current viewer
            owns.
        owner_affiliations: Array of owner's affiliation options
            for repositories returned from the connection. For example,
            OWNER will include only repositories that the organization
            or user being viewed owns.
        is_locked: If non-null, filters repositories according to
            whether they have been locked.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        is_fork: If non-null, filters repositories according to
            whether they are forks of another repository.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository_owner(
        **strip_kwargs(
            login=login,
        )
    ).repositories(
        **strip_kwargs(
            privacy=privacy,
            order_by=order_by,
            affiliations=affiliations,
            owner_affiliations=owner_affiliations,
            is_locked=is_locked,
            after=after,
            before=before,
            first=first,
            last=last,
            is_fork=is_fork,
        )
    )

    op_stack = (
        "repositoryOwner",
        "repositories",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repositoryOwner"]["repositories"]

query_repository_owner_repository(login, name, github_credentials, follow_renames=True, return_fields=None) async

Find Repository.

Parameters:

Name Type Description Default
login str

The username to lookup the owner by.

required
name str

Name of Repository to find.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
follow_renames bool

Follow repository renames. If disabled, a repository referenced by its old name will return an error.

True
return_fields Optional[Iterable[str]]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.

Source code in prefect_github/repository_owner.py
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
@task
async def query_repository_owner_repository(  # noqa
    login: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Find Repository.

    Args:
        login: The username to lookup the owner by.
        name: Name of Repository to find.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.repository_owner(
        **strip_kwargs(
            login=login,
        )
    ).repository(
        **strip_kwargs(
            name=name,
            follow_renames=follow_renames,
        )
    )

    op_stack = (
        "repositoryOwner",
        "repository",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["repositoryOwner"]["repository"]