CompletableGithubObjectWithPaginatedProperty

class github.GithubObject.CompletableGithubObjectWithPaginatedProperty

A CompletableGithubObject that has a property that is subject to pagination.

An instance created from a Requester with a non-default value for per_page must have the per_page value in the URL in order for the paginated property to use the per_page value.

A CompletableGithubObject can be partially initialised (completed=False). Accessing attributes that are not initialized will then trigger a request to complete all attributes.

A partially initialized CompletableGithubObject (completed=False) can be completed via complete(). This requires the url to be given via parameter url or attributes.

With a requester where Requester.is_lazy == True, this CompletableGithubObjects is partially initialized. This requires the url to be given via parameter url or attributes. Any CompletableGithubObject created from this lazy object will be lazy itself if created with parameter url or attributes.

Parameters:

• requester – requester

• headers – response headers

• attributes – attributes to initialize

• completed – do not update non-initialized attributes when True

• url – url of this instance, overrides attributes[‘url’]

• accept – use this accept header when completing this instance

update(additional_headers: dict[str, Any] | None = None, parameters: dict[str, Any] | None = None) → bool

Check and update the object with conditional request :rtype: Boolean value indicating whether the object is changed.