aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/git_data/trees.py
blob: 6032e74fe0eae67c9c84129615c22809b7ae295a (plain) (blame)
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
#!/usr/bin/env python
# -*- encoding: utf-8 -*-

from pygithub3.services.base import Service


class Trees(Service):
    """Consume `Trees API <http://developer.github.com/v3/git/trees/>`_"""

    def get(self, sha, recursive=False, user=None, repo=None):
        """ Get a tree object

        :param str sha: The SHA of the tree you want.
        :param bool recursive: Whether to resolve each sub-tree belonging to
                               this tree
        :param str user: Username
        :param str repo: Repository

        .. note::
            Remember :ref:`config precedence`
        """
        request = self.make_request('git_data.trees.get', sha=sha, user=user,
            repo=repo)
        return self._get(request, recursive=recursive)

    def create(self, data, user=None, repo=None):
        """ Create a tree object

        :param dict data: Input. See `github trees doc`_
        :param str user: Username
        :param str repo: Repository

        .. note::
            Remember :ref:`config precedence`
        """
        request = self.make_request('git_data.trees.create', body=data,
            user=user, repo=repo)
        return self._post(request)