File: PullRequest.rst

package info (click to toggle)
pygithub 2.6.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 33,476 kB
  • sloc: python: 38,409; sh: 7; makefile: 6
file content (62 lines) | stat: -rw-r--r-- 1,655 bytes parent folder | download
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
PullRequest
===========

Create a new Pull Request
-------------------------

.. code-block:: python

    >>> repo = g.get_repo("PyGithub/PyGithub")
    >>> body = '''
    >>> SUMMARY
    >>> Change HTTP library used to send requests
    >>>
    >>> TESTS
    >>>   - [x] Send 'GET' request
    >>>   - [x] Send 'POST' request with/without body
    >>> '''
    >>> pr = repo.create_pull(base="master", head="develop", title="Use 'requests' instead of 'httplib'", body=body)
    >>> pr
    PullRequest(title="Use 'requests' instead of 'httplib'", number=664)

Get Pull Request by Number
---------------------------

.. code-block:: python

    >>> repo = g.get_repo("PyGithub/PyGithub")
    >>> pr = repo.get_pull(664)
    >>> pr
    PullRequest(title="Use 'requests' instead of 'httplib'", number=664)

Get Pull Requests by Query
--------------------------

.. code-block:: python

    >>> repo = g.get_repo("PyGithub/PyGithub")
    >>> pulls = repo.get_pulls(state='open', sort='created', base='master')
    >>> for pr in pulls:
    ...    print(pr.number)
    ...
    400
    861
    875
    876

Add and modify Pull Request comment
-----------------------------------

.. code-block:: python

    >>> repo = g.get_repo("PyGithub/PyGithub")
    >>> pr = repo.get_pull(2390)
    >>> last_commit = pr.get_commits()[pr.commits - 1]
    >>> comment = pr.create_comment("This is a comment", last_commit, "file.txt", 0)
    >>> comment
    PullRequestComment(user=NamedUser(login="anonymous"), id=1057297855)
    >>> comment.body
    'This is a comment'
    >>> comment.edit("This is a modified comment")
    >>> comment.body
    'This is a modified comment'