Repository navigation
Expand file tree
/
Copy pathpulls_resource_group.py
More file actions
1560 lines (1422 loc) · 56.5 KB
/
Copy pathpulls_resource_group.py
File metadata and controls
1560 lines (1422 loc) · 56.5 KB
1
2
3
4
5
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
54
55
56
57
58
59
60
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
106
107
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""AbstractPullsResource, PullsResource, and AsyncPullsResource resource group."""
from abc import ABC, abstractmethod
from typing import List, Optional, Union
from ..._models import (
APIObject,
Issue,
Label,
MergeResult,
MergeStatus,
PullRequest,
PullRequestAssigneeCount,
PullRequestComment,
PullRequestCount,
PullRequestFile,
PullRequestOperationLog,
RepositoryGitCodeTemplate,
UserSummary,
as_model,
)
from ...constants import GITCODE_PULL_REQUEST_TEMPLATE_PATH_RE
from .._shared import (
AsyncResource,
SyncResource,
get_gitcode_template_body_async,
get_gitcode_template_body_sync,
list_gitcode_template_rows_async,
list_gitcode_template_rows_sync,
)
from ._helpers import _comma_join
# mypy: disable-error-code=override
# pylint: disable=invalid-overridden-method,protected-access,redefined-builtin,duplicate-code
class AbstractPullsResource(ABC):
"""Interface for Pulls resource endpoints."""
@abstractmethod
def list(
self,
*,
owner: Optional[str] = None,
repo: Optional[str] = None,
state: Optional[str] = None,
sort: Optional[str] = None,
direction: Optional[str] = None,
page: Optional[int] = None,
per_page: Optional[int] = None,
base: Optional[str] = None,
since: Optional[str] = None,
milestone_number: Optional[int] = None,
labels: Optional[str] = None,
author: Optional[str] = None,
assignee: Optional[str] = None,
reviewer: Optional[str] = None,
merged_after: Optional[str] = None,
merged_before: Optional[str] = None,
only_count: Optional[bool] = None,
created_after: Optional[str] = None,
created_before: Optional[str] = None,
updated_before: Optional[str] = None,
updated_after: Optional[str] = None,
**kwargs,
) -> Union[List[PullRequest], PullRequestCount]:
"""List pull requests for a repository.
When ``only_count`` is true, the API returns a JSON object with counts per state
instead of an array (see Pull Request API).
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path (name). Uses the client default when omitted.
:param state: PR state filter: ``all``, ``open``, ``closed``, ``locked``, ``merged`` (default ``all`` in API).
:param sort: Sort field, typically ``created`` or ``updated``.
:param direction: ``asc`` or ``desc`` (API default is usually ``desc``).
:param page: Current page number.
:param per_page: Page size (max 100 per API documentation).
:param base: Base branch filter.
:param since: Return PRs updated since this ISO 8601 timestamp.
:param milestone_number: Milestone number filter.
:param labels: Comma-separated label names.
:param author: Username of the PR creator.
:param assignee: Username of the PR assignee.
:param reviewer: Username of the PR reviewer.
:param merged_after: Return PRs merged after this ISO 8601 timestamp.
:param merged_before: Return PRs merged before this ISO 8601 timestamp.
:param only_count: If true, only return the count of merge requests.
:param created_after: Return PRs created after this ISO 8601 timestamp.
:param created_before: Return PRs created before this ISO 8601 timestamp.
:param updated_before: Return PRs updated before this ISO 8601 timestamp.
:param updated_after: Return PRs updated after this ISO 8601 timestamp.
:param kwargs: Additional arguments forwarded directly in request.
:returns: A list of pull requests, or an :class:`~gitcode_api._models.APIObject` for count-only responses.
"""
@abstractmethod
def get(self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> PullRequest:
"""Get a single pull request.
:param number: Pull request number in the repository.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: Pull request details.
"""
@abstractmethod
def create(
self,
*,
title: str,
head: str,
base: str,
owner: Optional[str] = None,
repo: Optional[str] = None,
body: Optional[str] = None,
draft: Optional[bool] = None,
assignees: Optional[List[str]] = None,
testers: Optional[List[str]] = None,
labels: Optional[List[str]] = None,
milestone_number: Optional[int] = None,
issue: Optional[str] = None,
prune_source_branch: Optional[bool] = None,
squash: Optional[bool] = None,
squash_commit_message: Optional[str] = None,
fork_path: Optional[str] = None,
) -> PullRequest:
"""Create a pull request.
:param title: Pull request title.
:param head: Source branch ref (head branch, in forks use ``owner:branch`` like "SushiNinja:develop").
:param base: Target branch ref (base branch).
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:param body: Description body.
:param draft: Whether to create as draft.
:param assignees: Assignee logins; sent as a comma-separated string per API.
:param testers: Tester logins; comma-separated in the JSON body.
:param labels: Label names; comma-separated in the JSON body.
:param milestone_number: Target milestone number.
:param issue: Related issue reference when supported by the API.
:param prune_source_branch: Whether to delete the source branch after merge when applicable.
:param squash: Squash-merge preference where supported.
:param squash_commit_message: Custom squash commit message.
:param fork_path: Fork ``owner/repo`` when opening a PR from a fork, like "SushiNinja/agent-core-contrib".
:returns: Created pull request.
"""
@abstractmethod
def update(
self,
*,
number: Union[int, str],
owner: Optional[str] = None,
repo: Optional[str] = None,
title: Optional[str] = None,
body: Optional[str] = None,
state: Optional[str] = None,
base: Optional[str] = None,
labels: Optional[List[str]] = None,
draft: Optional[bool] = None,
) -> PullRequest:
"""Update a pull request.
:param number: Pull request number in the repository.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:param title: New title.
:param body: New description.
:param state: New state as accepted by the API (for example close or reopen semantics).
:param base: New base branch name.
:param labels: Replacement labels; comma-separated in the JSON body.
:param draft: Draft flag.
:returns: Updated pull request.
"""
@abstractmethod
def merge(
self,
*,
number: Union[int, str],
owner: Optional[str] = None,
repo: Optional[str] = None,
merge_commit_message: Optional[str] = None,
squash: Optional[bool] = None,
) -> MergeResult:
"""Merge a pull request.
:param number: Pull request number.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:param merge_commit_message: Optional merge commit message.
:param squash: Whether to squash merge when supported.
:returns: Merge result payload.
"""
@abstractmethod
def get_merge_status(
self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
) -> MergeStatus:
"""Get mergeability status for a pull request (GET on the merge resource).
:param number: Pull request number.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: Merge status / mergeability information.
"""
@abstractmethod
def list_commits(
self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
) -> List[APIObject]:
"""List commits included in a pull request.
:param number: Pull request number.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: Commit objects (wrapped as :class:`~gitcode_api._models.APIObject`).
"""
@abstractmethod
def list_files(
self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
) -> List[PullRequestFile]:
"""List files changed by a pull request.
:param number: Pull request number.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: File change entries.
"""
@abstractmethod
def list_comments(
self,
*,
number: Union[int, str],
owner: Optional[str] = None,
repo: Optional[str] = None,
page: Optional[int] = None,
per_page: Optional[int] = None,
) -> List[PullRequestComment]:
"""List comments on a pull request.
:param number: Pull request number.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:param page: Page number.
:param per_page: Page size.
:returns: Pull request review comments.
"""
@abstractmethod
def create_comment(
self,
*,
number: Union[int, str],
body: str,
owner: Optional[str] = None,
repo: Optional[str] = None,
commit_id: Optional[str] = None,
path: Optional[str] = None,
position: Optional[int] = None,
) -> PullRequestComment:
"""Create a pull request (review) comment.
:param number: Pull request number.
:param body: Comment body.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:param commit_id: Commit SHA the comment applies to.
:param path: File path in the diff.
:param position: Line or diff position as defined by the API.
:returns: Created comment.
"""
@abstractmethod
def get_comment(
self,
*,
comment_id: Union[int, str],
owner: Optional[str] = None,
repo: Optional[str] = None,
) -> PullRequestComment:
"""Get a single pull request comment by id (global comment endpoint).
:param comment_id: Comment id.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: Pull request comment.
"""
@abstractmethod
def update_comment(
self,
*,
comment_id: Union[int, str],
body: str,
owner: Optional[str] = None,
repo: Optional[str] = None,
) -> PullRequestComment:
"""Update a pull request comment.
:param comment_id: Comment id.
:param body: Updated body.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: Updated comment.
"""
@abstractmethod
def delete_comment(
self, *, comment_id: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
) -> None:
"""Delete a pull request comment.
:param comment_id: Comment id.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
"""
@abstractmethod
def list_labels(
self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
) -> List[Label]:
"""List labels attached to a pull request.
:param number: Pull request number.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: Labels on the pull request.
"""
@abstractmethod
def add_labels(
self, *, number: Union[int, str], labels: List[str], owner: Optional[str] = None, repo: Optional[str] = None
) -> List[Label]:
"""Add labels to a pull request.
:param number: Pull request number.
:param labels: Label names (JSON array body per API).
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: Labels after the operation.
"""
@abstractmethod
def replace_labels(
self, *, number: Union[int, str], labels: List[str], owner: Optional[str] = None, repo: Optional[str] = None
) -> List[Label]:
"""Replace all labels on a pull request.
:param number: Pull request number.
:param labels: Complete new label set (JSON array body).
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: Labels after replacement.
"""
@abstractmethod
def remove_label(
self, *, number: Union[int, str], label: str, owner: Optional[str] = None, repo: Optional[str] = None
) -> None:
"""Remove a label from a pull request.
:param number: Pull request number.
:param label: Label name to remove.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
"""
@abstractmethod
def request_review(
self,
*,
number: Union[int, str],
owner: Optional[str] = None,
repo: Optional[str] = None,
event: str,
body: Optional[str] = None,
) -> None:
"""Submit a pull request review event (approve, request changes, etc., per API).
:param number: Pull request number.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:param event: Review event name as required by GitCode (for example ``APPROVE``; see API docs).
:param body: Optional comment body accompanying the event.
:returns: Review result object.
"""
@abstractmethod
def list_operation_logs(
self,
*,
number: Union[int, str],
owner: Optional[str] = None,
repo: Optional[str] = None,
sort: Optional[str] = None,
page: Optional[int] = None,
per_page: Optional[int] = None,
**kwargs,
) -> List[PullRequestOperationLog]:
"""List operation logs for a pull request.
:param number: Pull request number.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:param sort: Sort direction: ``desc`` (default) or ``asc``.
:param page: Page number.
:param per_page: Page size.
:param kwargs: Additional arguments forwarded directly in request.
:returns: Log entries as generic API objects.
"""
@abstractmethod
def request_test(
self,
*,
number: Union[int, str],
owner: Optional[str] = None,
repo: Optional[str] = None,
force: Optional[bool] = None,
**kwargs,
) -> None:
"""Request testing for a pull request.
:param number: Pull request number.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:param force: Force the test to pass (default ``False``), only effective for administrators.
:param kwargs: Additional arguments forwarded directly in request.
"""
@abstractmethod
def update_testers(
self, *, number: Union[int, str], testers: List[str], owner: Optional[str] = None, repo: Optional[str] = None
) -> None:
"""Replace pull request testers.
:param number: Pull request number.
:param testers: New tester list; serialized as a comma-separated ``testers`` field in JSON.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: API response payload.
"""
@abstractmethod
def add_testers(
self, *, number: Union[int, str], testers: List[str], owner: Optional[str] = None, repo: Optional[str] = None
) -> List[UserSummary]:
"""Add testers to a pull request.
:param number: Pull request number.
:param testers: Usernames to add; comma-separated in the JSON body.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: API response payload.
"""
@abstractmethod
def update_assignees(
self, *, number: Union[int, str], assignees: List[str], owner: Optional[str] = None, repo: Optional[str] = None
) -> None:
"""Replace pull request assignees.
:param number: Pull request number.
:param assignees: New assignee list; comma-separated in the JSON body.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: API response payload.
"""
@abstractmethod
def add_assignees(
self, *, number: Union[int, str], assignees: List[str], owner: Optional[str] = None, repo: Optional[str] = None
) -> PullRequestAssigneeCount:
"""Add assignees to a pull request.
:param number: Pull request number.
:param assignees: Usernames to add; comma-separated in the JSON body.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: API response payload.
"""
@abstractmethod
def remove_assignees(
self, *, number: Union[int, str], assignees: List[str], owner: Optional[str] = None, repo: Optional[str] = None
) -> None:
"""Remove assignees from a pull request.
:param number: Pull request number.
:param assignees: Usernames to remove; comma-separated in the JSON body.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
"""
@abstractmethod
def list_issues(
self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
) -> List[Issue]:
"""List issues linked to a pull request.
:param number: Pull request number.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: Linked issues.
"""
@abstractmethod
def list_enterprise(
self,
*,
enterprise: str,
repo: Optional[str] = None,
state: Optional[str] = None,
issue_number: Optional[int] = None,
sort: Optional[str] = None,
direction: Optional[str] = None,
page: Optional[int] = None,
per_page: Optional[int] = None,
**kwargs,
) -> List[PullRequest]:
"""List enterprise pull requests.
:param enterprise: Enterprise path or login.
:param repo: Repository path filter (query parameter).
:param state: Pull request state filter.
:param issue_number: Issue global id filter.
:param sort: Sort field. Default: sorted by creation time.
:param direction: ``asc`` or ``desc``.
:param page: Page number.
:param per_page: Page size.
:param kwargs: Additional arguments forwarded directly in request.
:returns: Pull requests in the enterprise scope.
"""
@abstractmethod
def list_org(
self,
*,
org: str,
state: Optional[str] = None,
issue_number: Optional[int] = None,
sort: Optional[str] = None,
direction: Optional[str] = None,
page: Optional[int] = None,
per_page: Optional[int] = None,
**kwargs,
) -> List[PullRequest]:
"""List pull requests for an organization scope.
:param org: Organization path (``GET .../org/{org}/pull_requests``).
:param state: Pull request state filter.
:param issue_number: Global issue id filter.
:param sort: Sort field. Default: sorted by creation time.
:param direction: ``asc`` or ``desc``.
:param page: Page number.
:param per_page: Page size.
:param kwargs: Additional arguments forwarded directly in request.
:returns: Organization-scoped pull requests.
"""
@abstractmethod
def list_issue_pull_requests(self, *, enterprise: str, number: Union[int, str]) -> List[PullRequest]:
"""List pull requests associated with an enterprise issue.
:param enterprise: Enterprise path or login.
:param number: Enterprise issue number or id in the path.
:returns: Related pull requests.
"""
@abstractmethod
def list_templates(
self,
*,
owner: Optional[str] = None,
repo: Optional[str] = None,
) -> List[RepositoryGitCodeTemplate]:
"""List active pull request templates under ``.gitcode/`` for this repository.
Resolution tries the repository, then the owner's ``.gitcode`` repository, then any
parent main and ``parent/.gitcode`` pairs discovered from forks (each candidate is
inspected with ``GET /repos/{owner}/{repo}``; when ``fork`` is true, its parent's repos
are appended, deduplicated, and visited in order). The first source with matching
templates wins.
Version 1.2.19: Now also supporting GitHub-mirrored repos with a ``.github/`` folder.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:returns: Template metadata entries (paths and SHAs); empty when none match.
"""
@abstractmethod
def get_template(
self,
*,
path: str,
owner: Optional[str] = None,
repo: Optional[str] = None,
encoding: str = "utf-8",
**decoding_kwargs,
) -> str:
"""Load a single pull request template file body from the default branch.
Uses the same resolution order as :meth:`list_templates`. The path must match the
active pull request template naming convention (see GitCode ``.gitcode`` documentation).
:param path: Repository-relative path such as ``.gitcode/PULL_REQUEST_TEMPLATE.md``.
:param owner: Repository owner path. Uses the client default when omitted.
:param repo: Repository path. Uses the client default when omitted.
:param encoding: Codec to use when decoding raw file bytes. Default ``utf-8``.
:param decoding_kwargs: Keyword arguments forwarded to :meth:`bytes.decode`, such as
``errors`` (``"strict"``, ``"ignore"``, or ``"replace"``).
:returns: Decoded template file contents.
"""
class PullsResource(SyncResource, AbstractPullsResource):
"""Synchronous pull request endpoints."""
def list(
self,
*,
owner: Optional[str] = None,
repo: Optional[str] = None,
state: Optional[str] = None,
sort: Optional[str] = None,
direction: Optional[str] = None,
page: Optional[int] = None,
per_page: Optional[int] = None,
base: Optional[str] = None,
since: Optional[str] = None,
milestone_number: Optional[int] = None,
labels: Optional[str] = None,
author: Optional[str] = None,
assignee: Optional[str] = None,
reviewer: Optional[str] = None,
merged_after: Optional[str] = None,
merged_before: Optional[str] = None,
only_count: Optional[bool] = None,
created_after: Optional[str] = None,
created_before: Optional[str] = None,
updated_before: Optional[str] = None,
updated_after: Optional[str] = None,
**kwargs,
) -> Union[List[PullRequest], PullRequestCount]:
path = self._client._repo_path("pulls", owner=owner, repo=repo)
response = self._request(
"GET",
path,
params={
"state": state,
"sort": sort,
"direction": direction,
"page": page,
"per_page": per_page,
"base": base,
"since": since,
"milestone_number": milestone_number,
"labels": labels,
"author": author,
"assignee": assignee,
"reviewer": reviewer,
"merged_after": merged_after,
"merged_before": merged_before,
"only_count": only_count,
"created_after": created_after,
"created_before": created_before,
"updated_before": updated_before,
"updated_after": updated_after,
**kwargs,
},
)
if isinstance(response, dict):
return as_model(response, PullRequestCount)
return [as_model(item, PullRequest) for item in response]
def get(self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None) -> PullRequest:
return self._model("GET", self._client._repo_path("pulls", number, owner=owner, repo=repo), PullRequest)
def create(
self,
*,
title: str,
head: str,
base: str,
owner: Optional[str] = None,
repo: Optional[str] = None,
body: Optional[str] = None,
draft: Optional[bool] = None,
assignees: Optional[List[str]] = None,
testers: Optional[List[str]] = None,
labels: Optional[List[str]] = None,
milestone_number: Optional[int] = None,
issue: Optional[str] = None,
prune_source_branch: Optional[bool] = None,
squash: Optional[bool] = None,
squash_commit_message: Optional[str] = None,
fork_path: Optional[str] = None,
) -> PullRequest:
return self._model(
"POST",
self._client._repo_path("pulls", owner=owner, repo=repo),
PullRequest,
json={
"title": title,
"head": head,
"base": base,
"body": body,
"draft": draft,
"assignees": _comma_join(assignees),
"testers": _comma_join(testers),
"labels": _comma_join(labels),
"milestone_number": milestone_number,
"issue": issue,
"prune_source_branch": prune_source_branch,
"squash": squash,
"squash_commit_message": squash_commit_message,
"fork_path": fork_path,
},
)
def update(
self,
*,
number: Union[int, str],
owner: Optional[str] = None,
repo: Optional[str] = None,
title: Optional[str] = None,
body: Optional[str] = None,
state: Optional[str] = None,
base: Optional[str] = None,
labels: Optional[List[str]] = None,
draft: Optional[bool] = None,
) -> PullRequest:
return self._model(
"PATCH",
self._client._repo_path("pulls", number, owner=owner, repo=repo),
PullRequest,
json={
"title": title,
"body": body,
"state": state,
"base": base,
"labels": _comma_join(labels),
"draft": draft,
},
)
def merge(
self,
*,
number: Union[int, str],
owner: Optional[str] = None,
repo: Optional[str] = None,
merge_commit_message: Optional[str] = None,
squash: Optional[bool] = None,
) -> MergeResult:
return self._model(
"PUT",
self._client._repo_path("pulls", number, "merge", owner=owner, repo=repo),
MergeResult,
json={"merge_commit_message": merge_commit_message, "squash": squash},
)
def get_merge_status(
self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
) -> MergeStatus:
return self._model(
"GET",
self._client._repo_path("pulls", number, "merge", owner=owner, repo=repo),
MergeStatus,
)
def list_commits(
self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
) -> List[APIObject]:
data = self._request("GET", self._client._repo_path("pulls", number, "commits", owner=owner, repo=repo))
return [as_model(item, APIObject) for item in data]
def list_files(
self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
) -> List[PullRequestFile]:
return self._models(
"GET",
self._client._repo_path("pulls", number, "files", owner=owner, repo=repo),
PullRequestFile,
)
def list_comments(
self,
*,
number: Union[int, str],
owner: Optional[str] = None,
repo: Optional[str] = None,
page: Optional[int] = None,
per_page: Optional[int] = None,
) -> List[PullRequestComment]:
return self._models(
"GET",
self._client._repo_path("pulls", number, "comments", owner=owner, repo=repo),
PullRequestComment,
params={"page": page, "per_page": per_page},
)
def create_comment(
self,
*,
number: Union[int, str],
body: str,
owner: Optional[str] = None,
repo: Optional[str] = None,
commit_id: Optional[str] = None,
path: Optional[str] = None,
position: Optional[int] = None,
) -> PullRequestComment:
return self._model(
"POST",
self._client._repo_path("pulls", number, "comments", owner=owner, repo=repo),
PullRequestComment,
json={"body": body, "commit_id": commit_id, "path": path, "position": position},
)
def get_comment(
self,
*,
comment_id: Union[int, str],
owner: Optional[str] = None,
repo: Optional[str] = None,
) -> PullRequestComment:
return self._model(
"GET",
self._client._repo_path("pulls", "comments", comment_id, owner=owner, repo=repo),
PullRequestComment,
)
def update_comment(
self,
*,
comment_id: Union[int, str],
body: str,
owner: Optional[str] = None,
repo: Optional[str] = None,
) -> PullRequestComment:
return self._model(
"PATCH",
self._client._repo_path("pulls", "comments", comment_id, owner=owner, repo=repo),
PullRequestComment,
json={"body": body},
)
def delete_comment(
self, *, comment_id: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
) -> None:
self._request("DELETE", self._client._repo_path("pulls", "comments", comment_id, owner=owner, repo=repo))
def list_labels(
self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
) -> List[Label]:
return self._models(
"GET",
self._client._repo_path("pulls", number, "labels", owner=owner, repo=repo),
Label,
)
def add_labels(
self, *, number: Union[int, str], labels: List[str], owner: Optional[str] = None, repo: Optional[str] = None
) -> List[Label]:
return self._models(
"POST",
self._client._repo_path("pulls", number, "labels", owner=owner, repo=repo),
Label,
json=labels,
)
def replace_labels(
self, *, number: Union[int, str], labels: List[str], owner: Optional[str] = None, repo: Optional[str] = None
) -> List[Label]:
return self._models(
"PUT",
self._client._repo_path("pulls", number, "labels", owner=owner, repo=repo),
Label,
json=labels,
)
def remove_label(
self, *, number: Union[int, str], label: str, owner: Optional[str] = None, repo: Optional[str] = None
) -> None:
self._request("DELETE", self._client._repo_path("pulls", number, "labels", label, owner=owner, repo=repo))
def request_review(
self,
*,
number: Union[int, str],
owner: Optional[str] = None,
repo: Optional[str] = None,
event: str,
body: Optional[str] = None,
) -> None:
self._request(
"POST",
self._client._repo_path("pulls", number, "review", owner=owner, repo=repo),
json={"event": event, "body": body},
)
def list_operation_logs(
self,
*,
number: Union[int, str],
owner: Optional[str] = None,
repo: Optional[str] = None,
sort: Optional[str] = None,
page: Optional[int] = None,
per_page: Optional[int] = None,
**kwargs,
) -> List[PullRequestOperationLog]:
data = self._request(
"GET",
self._client._repo_path("pulls", number, "operate_logs", owner=owner, repo=repo),
params={"sort": sort, "page": page, "per_page": per_page, **kwargs},
)
return [as_model(item, PullRequestOperationLog) for item in data]
def request_test(
self,
*,
number: Union[int, str],
owner: Optional[str] = None,
repo: Optional[str] = None,
force: Optional[bool] = None,
**kwargs,
) -> None:
self._request(
"POST",
self._client._repo_path("pulls", number, "test", owner=owner, repo=repo),
json={"force": force, **kwargs},
)
def update_testers(
self, *, number: Union[int, str], testers: List[str], owner: Optional[str] = None, repo: Optional[str] = None
) -> None:
self._request(
"PATCH",
self._client._repo_path("pulls", number, "testers", owner=owner, repo=repo),
json={"testers": _comma_join(testers)},
)
def add_testers(
self, *, number: Union[int, str], testers: List[str], owner: Optional[str] = None, repo: Optional[str] = None
) -> List[UserSummary]:
data = self._request(
"POST",
self._client._repo_path("pulls", number, "testers", owner=owner, repo=repo),
json={"testers": _comma_join(testers)},
)
return [as_model(item, UserSummary) for item in data]
def update_assignees(
self, *, number: Union[int, str], assignees: List[str], owner: Optional[str] = None, repo: Optional[str] = None
) -> None:
self._request(
"PATCH",
self._client._repo_path("pulls", number, "assignees", owner=owner, repo=repo),
json={"assignees": _comma_join(assignees)},
)
def add_assignees(
self, *, number: Union[int, str], assignees: List[str], owner: Optional[str] = None, repo: Optional[str] = None
) -> PullRequestAssigneeCount:
return self._model(
"POST",
self._client._repo_path("pulls", number, "assignees", owner=owner, repo=repo),
PullRequestAssigneeCount,
json={"assignees": _comma_join(assignees)},
)
def remove_assignees(
self, *, number: Union[int, str], assignees: List[str], owner: Optional[str] = None, repo: Optional[str] = None
) -> None:
self._request(
"DELETE",
self._client._repo_path("pulls", number, "assignees", owner=owner, repo=repo),
json={"assignees": _comma_join(assignees)},
)
def list_issues(
self, *, number: Union[int, str], owner: Optional[str] = None, repo: Optional[str] = None
) -> List[Issue]:
return self._models("GET", self._client._repo_path("pulls", number, "issues", owner=owner, repo=repo), Issue)
def list_enterprise(
self,
*,
enterprise: str,
repo: Optional[str] = None,
state: Optional[str] = None,
issue_number: Optional[int] = None,