Current File : //proc/thread-self/root/lib/python2.7/site-packages/salt/modules/github.pyo
�
���^c @@ st d Z d d l m Z m Z m Z d d l Z d d l m Z d d l m Z d d l
Z e Z
y> d d l Z d d l Z d d l Z d d l m Z e Z
Wn e k
r� n Xe j e � Z d Z d � Z d � Z d
� Z d d � Z d e d � Z d e d
� Z d e d � Z d d � Z! d d � Z" d d d d � Z# d d d d d � Z$ d d d d d d d d d d d d d d �
Z% d d d d d d d d � Z& d d d d d d � Z' d � Z( d e d � Z) d d � Z* d d � Z+ d d � Z, d d! � Z- d d d d d d d d d d d" �
Z. d d d d d d d d# � Z/ d d$ � Z0 d d% � Z1 d d d d d d& � Z2 d d d d d' � Z3 d d( � Z4 d e d) � Z5 d d d* � Z6 d d+ � Z7 d e d, � Z8 d e d- � Z9 d d. � Z: d d/ � Z; d d0 � Z< d e d1 � Z= d d d d d d d d d d2 � Z> d3 � Z? d4 � Z@ d d d d5 d d d6 d d7 � ZA d S(8 u
Module for interacting with the GitHub v3 API.
.. versionadded:: 2016.3.0
:depends: PyGithub python module
Configuration
-------------
Configure this module by specifying the name of a configuration
profile in the minion config, minion pillar, or master config. The module
will use the 'github' key by default, if defined.
For example:
.. code-block:: yaml
github:
token: abc1234
org_name: my_organization
# optional: some functions require a repo_name, which
# can be set in the config file, or passed in at the CLI.
repo_name: my_repo
# optional: it can be dangerous to change the privacy of a repository
# in an automated way. set this to True to allow privacy modifications
allow_repo_privacy_changes: False
i ( t absolute_importt unicode_literalst print_functionN( t CommandExecutionError( t six( t UnknownObjectExceptionu githubc C@ s t r
t St d f S( uH
Only load this module if PyGithub is installed on this minion.
uP The github execution module cannot be loaded: PyGithub library is not installed.( t HAS_LIBSt __virtualname__t False( ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt __virtual__; s c C@ sh t d | � } | s. t d j | � � � n | j | � } | d k rd t d j | | � � � n | S( u!
Helper function that returns a profile's configuration value based on
the supplied configuration name.
profile
The profile name that contains configuration information.
config_name
The configuration item's name to use to return configuration values.
u
config.optionuD Authentication information could not be found for the '{0}' profile.u7 The '{0}' parameter was not found in the '{1}' profile.N( t __salt__R t formatt gett None( t profilet config_namet configt config_value( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt _get_config_valueE s c C@ sZ t | d � } d j | t | d � � } | t k rR t j | d d �t | <n t | S( uK
Return the GitHub client, cached into __context__ for performance
u tokenu github.{0}:{1}u org_namet per_pageid ( R R t __context__t githubt Github( R t tokent key( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt _get_clientd s c C@ s) t j j t j j | j | j d | � S( Nu /members( R t
PaginatedListt NamedUsert
_requestert url( t organizationt params( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt _get_membersv s
c C@ s t | d � } d j | � } | t k s< | s< | d k r� t | d � } t | � } | j | � } t j j t j j | j | j
d | � } | d k r� | Sg } xF | D]> } | j | � d j | | j j
� � }
t | � t |
<q� W| t | <n t | S( Nu org_nameu github.{0}:reposu /reposu github.{0}:{1}:repo_info( R R R R
R t get_organizationR R t
RepositoryR R t appendt namet lowert
_repo_to_dict( R R t ignore_cachet org_nameR t clientR t resultt next_resultt repot repo_key( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt
_get_repos s(
c C@ s t | d � } d j | � } | t k s0 | rw t | � } | j | � } g t | d � D] } | j ^ q[ t | <n t | S( u�
List all users within the organization.
profile
The name of the profile configuration to use. Defaults to ``github``.
ignore_cache
Bypasses the use of cached users.
.. versionadded:: 2016.11.0
CLI Example:
.. code-block:: bash
salt myminion github.list_users
salt myminion github.list_users profile='my-github-profile'
u org_nameu github.{0}:usersN( R R R R R! R R
t login( R R' R( R R) R t member( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt
list_users� s ,c C@ sq | r | t | � k r t Si } t | � } | j t | d � � } y | j | � } Wn t k
r{ t j d � t SX| j
| d <| j | d <| j | d <| j
| d <| j | d <| j | d <| j | d <| j | d
<| j | d <y- | j j d | j d
| j � \ } } Wn& t k
rFd | d <t | d <| SX| j | � | d <| j d � | d <| S( u�
Get a GitHub user by name.
name
The user for which to obtain information.
profile
The name of the profile configuration to use. Defaults to ``github``.
user_details
Prints user information details. Defaults to ``False``. If the user is
already in the organization and user_details is set to False, the
get_user function returns ``True``. If the user is not already present
in the organization, user details will be printed by default.
CLI Example:
.. code-block:: bash
salt myminion github.get_user github-handle
salt myminion github.get_user github-handle user_details=true
u org_nameu Resource not foundu companyu
created_atu emailu html_urlu idu loginu nameu typeu urlu GETu
/memberships/u nonexistentu membership_stateu in_orgu state( R1 t TrueR R! R t get_userR t logt exceptionR t companyt
created_att emailt html_urlt idR/ R$ t typeR R t requestJsonAndCheckt _identityt has_in_membersR ( R$ R t user_detailst responseR) R t usert headerst data( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyR3 � s>
!
c C@ s� t | � } | j t | d � � } y | j | � } Wn t k
rX t j d � t SX| j j d | j
d | j � \ } } | j d � d k S( u
Add a GitHub user.
name
The user for which to obtain information.
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.add_user github-handle
u org_nameu Resource not foundu PUTu
/memberships/u stateu pending(
R R! R R3 R R4 R5 R R R< R R= R ( R$ R R) R t github_named_userRB RC ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt add_user s
c C@ s� t | � } | j t | d � � } y | j | � } Wn t k
rX t j d � t SX| j | � rx | j | � n | j | � S( u"
Remove a Github user by name.
name
The user for which to obtain information.
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.remove_user github-handle
u org_nameu Resource not found(
R R! R R3 R R4 R5 R R> t remove_from_members( R$ R R) R t git_user( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt remove_user' s
u minc
C@ s� t | d � } | d
k r- t | d � } n d j d | | g � } d t j | � } i } t | d | d | �} | j d � } | d k r� | | | <n t | � | | <| S( uU
Return information about a single issue in a named repository.
.. versionadded:: 2016.11.0
issue_number
The number of the issue to retrieve.
repo_name
The name of the repository from which to get the issue. This argument is
required, either passed via the CLI, or defined in the configured
profile. A ``repo_name`` passed as a CLI argument will override the
repo_name defined in the configured profile, if provided.
profile
The name of the profile configuration to use. Defaults to ``github``.
output
The amount of data returned by each issue. Defaults to ``min``. Change
to ``full`` to see all issue output.
CLI Example:
.. code-block:: bash
salt myminion github.get_issue 514
salt myminion github.get_issue 514 repo_name=salt
u org_nameu repo_nameu /u reposu issues/t actiont commandu idu fullN( R R
t joinR t text_typet _queryR t
_format_issue(
t issue_numbert repo_nameR t outputR( RI RJ t rett
issue_datat issue_id( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt get_issueI s
c
C@ s3 t | d � } | d k r- t | d � } n d j d | | g � } d j d t j | � d g � } i } | r | | d <n t | d | d | d
| �} i }
x� | D]� } | j d � } | d k r� | |
| <q� i | j d � d 6| j d
� d
6| j d � d 6| j d � j d � d 6|
| <q� W|
S( u
Return information about the comments for a given issue in a named repository.
.. versionadded:: 2016.11.0
issue_number
The number of the issue for which to retrieve comments.
repo_name
The name of the repository to which the issue belongs. This argument is
required, either passed via the CLI, or defined in the configured
profile. A ``repo_name`` passed as a CLI argument will override the
repo_name defined in the configured profile, if provided.
profile
The name of the profile configuration to use. Defaults to ``github``.
since
Only comments updated at or after this time are returned. This is a
timestamp in ISO 8601 format: ``YYYY-MM-DDTHH:MM:SSZ``.
output
The amount of data returned by each issue. Defaults to ``min``. Change
to ``full`` to see all issue output.
CLI Example:
.. code-block:: bash
salt myminion github.get_issue_comments 514
salt myminion github.get_issue 514 repo_name=salt
u org_nameu repo_nameu /u reposu issuesu commentsu sinceRI RJ t argsu idu fullu
created_atu
updated_atu useru loginu
user_loginN( R R
RK R RL RM R (
RO RP R t sinceRQ R( RI RJ RV t commentsRR t commentt
comment_id( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt get_issue_commentsy s& % !
$u openu createdu descc
C@ s� t | d � }
| d k r- t | d � } n d j d |
| g � } i } | r^ | | d <n | rq | | d <n | r� | | d <n | r� | | d <n | r� | | d <n |
r� |
| d
<n | r� | | d <n | r� | d k r� | | d
<n | r| d k r| | d <n | r-| d k r-| | d <n i } t | d | d d d | �} x[ | D]S } | j d � rsqXn | j d � } | d k r�| | | <qXt | � | | <qXW| S( u+
Returns information for all issues in a given repository, based on the search options.
.. versionadded:: 2016.11.0
repo_name
The name of the repository for which to list issues. This argument is
required, either passed via the CLI, or defined in the configured
profile. A ``repo_name`` passed as a CLI argument will override the
repo_name defined in the configured profile, if provided.
profile
The name of the profile configuration to use. Defaults to ``github``.
milestone
The number of a GitHub milestone, or a string of either ``*`` or
``none``.
If a number is passed, it should refer to a milestone by its number
field. Use the ``github.get_milestone`` function to obtain a milestone's
number.
If the string ``*`` is passed, issues with any milestone are
accepted. If the string ``none`` is passed, issues without milestones
are returned.
state
Indicates the state of the issues to return. Can be either ``open``,
``closed``, or ``all``. Default is ``open``.
assignee
Can be the name of a user. Pass in ``none`` (as a string) for issues
with no assigned user or ``*`` for issues assigned to any user.
creator
The user that created the issue.
mentioned
A user that's mentioned in the issue.
labels
A string of comma separated label names. For example, ``bug,ui,@high``.
sort
What to sort results by. Can be either ``created``, ``updated``, or
``comments``. Default is ``created``.
direction
The direction of the sort. Can be either ``asc`` or ``desc``. Default
is ``desc``.
since
Only issues updated at or after this time are returned. This is a
timestamp in ISO 8601 format: ``YYYY-MM-DDTHH:MM:SSZ``.
output
The amount of data returned by each issue. Defaults to ``min``. Change
to ``full`` to see all issue output.
per_page
GitHub paginates data in their API calls. Use this value to increase or
decrease the number of issues gathered from GitHub, per page. If not set,
GitHub defaults are used. Maximum is 100.
CLI Example:
.. code-block:: bash
salt myminion github.get_issues my-github-repo
u org_nameu repo_nameu /u reposu milestoneu assigneeu creatoru mentionedu labelsu sinceu per_pageu openu stateu createdu sortu descu directionRI RJ u issuesRV u pull_requestu idu fullN( R R
RK RM R RN ( RP R t milestonet statet assigneet creatort mentionedt labelst sortt directionRW RQ R R( RI RV RR t issuest issueRT ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt
get_issues� sF S
u due_onu ascc C@ sM t | d � } | d k r- t | d � } n d j d | | g � } i } | r^ | | d <n | r} | d k r} | | d <n | r� | d k r� | | d <n | r� | d
k r� | | d <n i }
t | d | d
d d | �} xg | D]_ } | j d � }
| d k r| |
|
<q� | j d � | j d � | j d � | |
|
<q� W|
S( u�
Return information about milestones for a given repository.
.. versionadded:: 2016.11.0
repo_name
The name of the repository for which to list issues. This argument is
required, either passed via the CLI, or defined in the configured
profile. A ``repo_name`` passed as a CLI argument will override the
repo_name defined in the configured profile, if provided.
profile
The name of the profile configuration to use. Defaults to ``github``.
state
The state of the milestone. Either ``open``, ``closed``, or ``all``.
Default is ``open``.
sort
What to sort results by. Either ``due_on`` or ``completeness``. Default
is ``due_on``.
direction
The direction of the sort. Either ``asc`` or ``desc``. Default is ``asc``.
output
The amount of data returned by each issue. Defaults to ``min``. Change
to ``full`` to see all issue output.
per_page
GitHub paginates data in their API calls. Use this value to increase or
decrease the number of issues gathered from GitHub, per page. If not set,
GitHub defaults are used.
CLI Example:
.. code-block:: bash
salt myminion github.get_milestones
u org_nameu repo_nameu /u reposu per_pageu openu stateu due_onu sortu ascu directionRI RJ u
milestonesRV u idu fullu creatoru html_urlu
labels_urlN( R R
RK RM R t pop( RP R R] Rb Rc RQ R R( RI RV RR t
milestonesR\ t milestone_id( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt get_milestones; s0 0
c C@ s\ i } t | | g � s' t d � � n t | d � } | d k rT t | d � } n d j d | | g � } | r� d t j | � } t | d | d | �} | j d � }
| d
k r� | | |
<n1 | j d � | j d � | j d
� | | |
<| St
d | d | d | � } x@ t j | � D]/ \ } }
|
j d � | k r%|
| | <| Sq%W| S( u�
Return information about a single milestone in a named repository.
.. versionadded:: 2016.11.0
number
The number of the milestone to retrieve. If provided, this option
will be favored over ``name``.
name
The name of the milestone to retrieve.
repo_name
The name of the repository for which to list issues. This argument is
required, either passed via the CLI, or defined in the configured
profile. A ``repo_name`` passed as a CLI argument will override the
repo_name defined in the configured profile, if provided.
profile
The name of the profile configuration to use. Defaults to ``github``.
output
The amount of data returned by each issue. Defaults to ``min``. Change
to ``full`` to see all issue output.
CLI Example:
.. code-block:: bash
salt myminion github.get_milestone 72
salt myminion github.get_milestone name=my_milestone
u7 Either a milestone 'name' or 'number' must be provided.u org_nameu repo_nameu /u reposu milestones/RI RJ u idu fullu creatoru html_urlu
labels_urlRP R RQ u titleN( t anyR R R
RK R RL RM R Rg Rj t iteritems( t numberR$ RP R RQ RR R( RI RJ t milestone_dataRi Rh R t val( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt
get_milestone� s2 &
c C@ s i } | j | d <| j | d <| j | d <| j j | d <| j | d <| j | d <| j | d <| j | d <| j | d <| j
| d
<| j | d <| j | d <| j
| d
<| j | d <| j | d <| j | d <| j | d <| j | d <| j | d <| j | d <| j | d <| S( Nu idu nameu full_nameu owneru privateu html_urlu descriptionu forku homepageu sizeu stargazers_countu watchers_countu languageu open_issues_countu forksu open_issuesu watchersu default_branchu
has_issuesu has_wikiu
has_downloads( R: R$ t full_namet ownerR/ t privateR9 t descriptiont forkt homepaget sizet stargazers_countt watchers_countt languaget open_issues_countt forkst open_issuest watcherst default_brancht
has_issuest has_wikit
has_downloads( R, RR ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyR& � s.
c C@ s� t | d � } d j t | d � | j � � } | t k sB | r� t | � } yB | j d j | | g � � } | sy i St | � } | t | <Wq� t j k
r� t
d j | | � � � q� Xn t | S( u�
Return information for a given repo.
.. versionadded:: 2016.11.0
repo_name
The name of the repository.
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.get_repo_info salt
salt myminion github.get_repo_info salt profile='my-github-profile'
u org_nameu github.{0}:{1}:repo_infou /uE The '{0}' repository under the '{1}' organization could not be found.( R R R% R R t get_repoRK R& R R R ( RP R R' R( R R) R, RR ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt
get_repo_info� s$ c C@ s� g } t | d � } t | � } y" | j d j | | g � � } Wn, t j k
rq t d j | | � � � n XyL | j � } x9 | D]1 } | j i | j
d 6| j d 6| j d 6� q� WWn, t j k
r� t d j | | � � � n X| S( u�
Return teams belonging to a repository.
.. versionadded:: 2017.7.0
repo_name
The name of the repository from which to retrieve teams.
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.get_repo_teams salt
salt myminion github.get_repo_teams salt profile='my-github-profile'
u org_nameu /uE The '{0}' repository under the '{1}' organization could not be found.u idu nameu
permissionuK Unable to retrieve teams for repository '{0}' under the '{1}' organization.(
R R R� RK R R R R t get_teamsR# R: R$ t
permission( RP R RR R( R) R, t teamst team( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt get_repo_teams# s* "
c C@ s g t | � D] } | j ^ q
S( u�
List all repositories within the organization. Includes public and private
repositories within the organization Dependent upon the access rights of
the profile token.
.. versionadded:: 2016.11.0
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.list_repos
salt myminion github.list_repos profile='my-github-profile'
( R. R$ ( R R, ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt
list_reposQ s c C@ sC g } x6 t | � D]( } | j t k r | j | j � q q W| S( u�
List private repositories within the organization. Dependent upon the access
rights of the profile token.
.. versionadded:: 2016.11.0
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.list_private_repos
salt myminion github.list_private_repos profile='my-github-profile'
( R. Rs R2 R# R$ ( R t reposR, ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt list_private_reposf s
c C@ sC g } x6 t | � D]( } | j t k r | j | j � q q W| S( u^
List public repositories within the organization.
.. versionadded:: 2016.11.0
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.list_public_repos
salt myminion github.list_public_repos profile='my-github-profile'
( R. Rs R R# R$ ( R R� R, ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt list_public_repos~ s
c C@ s y� t |
� } | j t |
d � � } i | d 6| d 6| d 6| d 6| d 6| d 6| d 6| d 6| d
6}
i | d 6} x6 t j |
� D]% \ } } | d k r� | | | <q� q� W| j j d | j d
d | �t SWn" t
j k
r� t j
d � t SXd S( u$
Create a new github repository.
name
The name of the team to be created.
description
The description of the repository.
homepage
The URL with more information about the repository.
private
The visiblity of the repository. Note that private repositories require
a paid GitHub account.
has_issues
Whether to enable issues for this repository.
has_wiki
Whether to enable the wiki for this repository.
has_downloads
Whether to enable downloads for this repository.
auto_init
Whether to create an initial commit with an empty README.
gitignore_template
The desired language or platform for a .gitignore, e.g "Haskell".
license_template
The desired LICENSE template to apply, e.g "mit" or "mozilla".
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.add_repo 'repo_name'
.. versionadded:: 2016.11.0
u org_nameu descriptionu homepageu privateu
has_issuesu has_wikiu
has_downloadsu auto_initu gitignore_templateu license_templateu nameu POSTu /repost inputu Error creating a repoN( R R! R R Rl R
R R< R R2 R t GithubExceptionR4 R5 R ( R$ Rt Rv Rs R� R� R� t auto_initt gitignore_templatet license_templateR R) R t given_paramst
parameterst
param_namet param_value( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt add_repo� s4 8
c C@ sd y t | d � } Wn t k
r, t } n X| d k rX | rX t d j | � � � n y� t | � } | j t | d � � }
|
j | � } i | d 6| d 6| d 6| d 6| d 6| d 6} i | d
6}
x6 t j | � D]% \ } } | d k r� | |
| <q� q� W|
j
j d | j d |
�t
| d
| d t �t SWn" t j k
r_t j d � t SXd S( u
Updates an existing Github repository.
name
The name of the team to be created.
description
The description of the repository.
homepage
The URL with more information about the repository.
private
The visiblity of the repository. Note that private repositories require
a paid GitHub account.
has_issues
Whether to enable issues for this repository.
has_wiki
Whether to enable the wiki for this repository.
has_downloads
Whether to enable downloads for this repository.
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.add_repo 'repo_name'
.. versionadded:: 2016.11.0
u allow_repo_privacy_changesub The private field is set to be changed for repo {0} but allow_repo_privacy_changes disallows this.u org_nameu descriptionu homepageu privateu
has_issuesu has_wikiu
has_downloadsu nameu PATCHR� R R' u Error editing a repoN( R R R R
R R R! R� R Rl R R< R R� R2 R R� R4 R5 ( R$ Rt Rv Rs R� R� R� R t allow_private_changeR) R R, R� R� R� R� ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt edit_repo� s@ -
c C@ s� t | d | �} | s, t j d | � t SyX t | � } | j t | d � � } | j | � } | j � t d | d t
� t
SWn" t j k
r� t j
d � t SXd S( u=
Remove a Github repository.
name
The name of the repository to be removed.
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.remove_repo 'my-repo'
.. versionadded:: 2016.11.0
R u% Repo %s to be removed does not exist.u org_nameR' u Error deleting a repoN( R� R4 t errorR R R! R R� t deleteR. R2 R R� R5 ( R$ R t repo_infoR) R R, ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt remove_repoD s
c C@ s t | � j | � S( uZ
Returns the team details if a team with the given name exists, or None
otherwise.
name
The team name for which to obtain information.
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.get_team 'team_name'
( t
list_teamsR ( R$ R ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt get_teamh s c C@ s� y� t | � } | j t | d � � } i } | | d <| d k rP | | d <n | d k ri | | d <n | d k r� | | d <n | d k r� | | d <n | j j d | j d d | �t d
t � t SWn" t j
k
r� t j d � t
SXd S(
u�
Create a new Github team within an organization.
name
The name of the team to be created.
description
The description of the team.
repo_names
The names of repositories to add the team to.
privacy
The level of privacy for the team, can be 'secret' or 'closed'.
permission
The default permission for new repositories added to the team, can be
'pull', 'push' or 'admin'.
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.add_team 'team_name'
.. versionadded:: 2016.11.0
u org_nameu nameu descriptionu
repo_namesu
permissionu privacyu POSTu /teamsR� R' u Error creating a teamN( R R! R R
R R< R R� R2 R R� R4 R5 R ( R$ Rt t
repo_namest privacyR� R R) R R� ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt add_team| s. $
c C@ s t | d | �} | s, t j d | � t Sy� t | � } | j t | d � � } | j | d � } i } | d k r� | | d <n | d k r� | | d <n | d k r� | | d <n | d k r� | | d <n | j j d | j
d
| �t SWn t k
rt j
d � t SXd S(
uf
Updates an existing Github team.
name
The name of the team to be edited.
description
The description of the team.
privacy
The level of privacy for the team, can be 'secret' or 'closed'.
permission
The default permission for new repositories added to the team, can be
'pull', 'push' or 'admin'.
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.edit_team 'team_name' description='Team description'
.. versionadded:: 2016.11.0
R u Team %s does not existu org_nameu idu nameu descriptionu privacyu
permissionu PATCHR� u Resource not foundN( R� R4 R� R R R! R R
R R< R R2 R R5 ( R$ Rt R� R� R R� R) R R� ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt edit_team� s4
c C@ s� t | d | �} | s, t j d | � t Syg t | � } | j t | d � � } | j | d � } | j � t d t d | � j
| � d k SWn" t j
k
r� t j d � t SXd S( u3
Remove a github team.
name
The name of the team to be removed.
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.remove_team 'team_name'
.. versionadded:: 2016.11.0
R u% Team %s to be removed does not exist.u org_nameu idR' u Error deleting a teamN( R� R4 R� R R R! R R� R� R2 R R
R R� R5 ( R$ R t team_infoR) R R� ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt remove_team� s
&
c
C@ sX t | d | �} | s, t j d | � t S| j d � rO | rO | j d � Sy; t | � } | j t | d � � } | j | d � } Wn% t k
r� t j d | d � n Xyy i } x^ | j
� D]P } d } | j j r� d } n | j j
r� d } n i | d
6| | j j � <q� W| | d <| SWn& t k
rSt j d | d � g SXd S( u�
Gets the repo details for a given team as a dict from repo_name to repo details.
Note that repo names are always in lower case.
team_name
The name of the team from which to list repos.
profile
The name of the profile configuration to use. Defaults to ``github``.
ignore_cache
Bypasses the use of cached team repos.
CLI Example:
.. code-block:: bash
salt myminion github.list_team_repos 'team_name'
.. versionadded:: 2016.11.0
R u Team %s does not exist.u reposu org_nameu idu Resource not found: %su pullu adminu pushu
permissionN( R� R4 R� R R R R! R R R5 t get_repost permissionst admint pushR$ R% (
t team_nameR R' t cached_teamR) R R� R� R, R� ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt list_team_repos s8
c C@ s
t | d | �} | s, t j d | � t SyJ t | � } | j t | d � � } | j | d � } | j | � } Wn& t k
r� t j d | d � t SXd } | d k r� i | d 6} n | j j d | j
d | j d | �\ } }
t | d | d
t �t S( u�
Adds a repository to a team with team_name.
repo_name
The name of the repository to add.
team_name
The name of the team of which to add the repository.
profile
The name of the profile configuration to use. Defaults to ``github``.
permission
The permission for team members within the repository, can be 'pull',
'push' or 'admin'. If not specified, the default permission specified on
the team will be used.
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt myminion github.add_team_repo 'my_repo' 'team_name'
.. versionadded:: 2016.11.0
R u Team %s does not existu org_nameu idu Resource not found: %su
permissionu PUTu /repos/R� R' N( R� R4 R� R R R! R R� R R5 R
R R< R R= R� R2 ( RP R� R R� R� R) R R, R RB RC ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt
add_team_repoZ s,
c C@ s� t | d | �} | s, t j d | � t SyJ t | � } | j t | d � � } | j | d � } | j | � } Wn& t k
r� t j d | d � t SX| j
| � | t | d | d t �k S( u�
Removes a repository from a team with team_name.
repo_name
The name of the repository to remove.
team_name
The name of the team of which to remove the repository.
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.remove_team_repo 'my_repo' 'team_name'
.. versionadded:: 2016.11.0
R u Team %s does not existu org_nameu idu Resource not found: %sR' (
R� R4 R� R R R! R R� R R5 t remove_from_reposR� R2 ( RP R� R R� R) R R, ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt remove_team_repo� s
c C@ s t | d | �} | s, t j d | � t S| j d � rO | rO | j d � Sy; t | � } | j t | d � � } | j | d � } Wn% t k
r� t j d | d � n Xy8 g | j
� D] } | j j � ^ q� | d <| d SWn& t k
rt j d | d � g SXd S( u�
Gets the names of team members in lower case.
team_name
The name of the team from which to list members.
profile
The name of the profile configuration to use. Defaults to ``github``.
ignore_cache
Bypasses the use of cached team members.
CLI Example:
.. code-block:: bash
salt myminion github.list_team_members 'team_name'
.. versionadded:: 2016.11.0
R u Team %s does not exist.u membersu org_nameu idu Resource not found: %sN(
R� R4 R� R R R R! R R R5 t get_membersR/ R% ( R� R R' R� R) R R� R0 ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt list_team_members� s(
)
c C@ s� d j t | d � � } | t k s* | r� t | � } | j t | d � � } d } t t j j d � rr d } n g t | i d | 6� D] } | j j
� ^ q� t | <n t | S( ua
List all members (in lower case) without MFA turned on.
profile
The name of the profile configuration to use. Defaults to ``github``.
ignore_cache
Bypasses the use of cached team repos.
CLI Example:
.. code-block:: bash
salt myminion github.list_members_without_mfa
.. versionadded:: 2016.11.0
u github.{0}:non_mfa_usersu org_nameu filteru
membershipu filter_u 2fa_disabled( R R R R R! t hasattrR t TeamR R/ R% ( R R' R R) R t
filter_keyt m( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt list_members_without_mfa� s 6c C@ s | j � t | d | �k S( u�
Returns True if the github user is in the team with team_name, or False
otherwise.
name
The name of the user whose membership to check.
team_name
The name of the team to check membership in.
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.is_team_member 'user_name' 'team_name'
.. versionadded:: 2016.11.0
R ( R% R� ( R$ R� R ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt is_team_member s c C@ s t | d | �} | s, t j d | � t SyJ t | � } | j t | d � � } | j | d � } | j | � } Wn& t k
r� t j d | d � t SXyG | j
j d | j d | j
d i d d
6d i d d
6�\ } } Wn" t j k
r
t j d � t SXt S(
u�
Adds a team member to a team with team_name.
name
The name of the team member to add.
team_name
The name of the team of which to add the user.
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.add_team_member 'user_name' 'team_name'
.. versionadded:: 2016.11.0
R u Team %s does not existu org_nameu idu Resource not found: %su PUTu
/memberships/R� u memberu roleR� u" Error in adding a member to a team( R� R4 R� R R R! R R3 R R5 R R< R R= R R� R2 ( R$ R� R R� R) R R0 RB RC ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt add_team_member' s.
c C@ s� t | d | �} | s, t j d | � t SyJ t | � } | j t | d � � } | j | d � } | j | � } Wn& t k
r� t j d | d � t SXt
| d � s� t d f S| j | � | j | � S( u�
Removes a team member from a team with team_name.
name
The name of the team member to remove.
team_name
The name of the team from which to remove the user.
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.remove_team_member 'user_name' 'team_name'
.. versionadded:: 2016.11.0
R u Team %s does not existu org_nameu idu Resource not found: %su remove_from_membersuK PyGithub 1.26.0 or greater is required for team management, please upgrade.(
R� R4 R� R R R! R R3 R R5 R� RF R> ( R$ R� R R� R) R R0 ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt remove_team_memberZ s"
c C@ s� d j t | d � � } | t k s* | r� t | � } | j t | d � � } | j � } i } xU | D]M } i | j d 6| j d 6| j d d 6| j d 6| j d d 6| | j
<qg W| t | <n t | S( u=
Lists all teams with the organization.
profile
The name of the profile configuration to use. Defaults to ``github``.
ignore_cache
Bypasses the use of cached teams.
CLI Example:
.. code-block:: bash
salt myminion github.list_teams
.. versionadded:: 2016.11.0
u github.{0}:teamsu org_nameu idu slugu descriptionu
permissionu privacy( R R R R R! R� R: t slugt _rawDataR� R$ ( R R' R R) R t
teams_dataR� R� ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyR� � s"
c C@ sR t | d � } | d k r- t | d � } n d j d | | g � }
i } | r^ | | d <n | rq | | d <n | r� | | d <n | r� | d k r� | | d <n | r� | d
k r� | | d <n | r� | d k r� | | d
<n i } t | d |
d d d | �}
xF |
D]> } | j d � } | d k r:| | | <q t | � | | <q W| S( uN
Returns information for all pull requests in a given repository, based on
the search options provided.
.. versionadded:: 2017.7.0
repo_name
The name of the repository for which to list pull requests. This
argument is required, either passed via the CLI, or defined in the
configured profile. A ``repo_name`` passed as a CLI argument will
override the ``repo_name`` defined in the configured profile, if
provided.
profile
The name of the profile configuration to use. Defaults to ``github``.
state
Indicates the state of the pull requests to return. Can be either
``open``, ``closed``, or ``all``. Default is ``open``.
head
Filter pull requests by head user and branch name in the format of
``user:ref-name``. Example: ``'github:new-script-format'``. Default
is ``None``.
base
Filter pulls by base branch name. Example: ``gh-pages``. Default is
``None``.
sort
What to sort results by. Can be either ``created``, ``updated``,
``popularity`` (comment count), or ``long-running`` (age, filtering
by pull requests updated within the last month). Default is ``created``.
direction
The direction of the sort. Can be either ``asc`` or ``desc``. Default
is ``desc``.
output
The amount of data returned by each pull request. Defaults to ``min``.
Change to ``full`` to see all pull request output.
per_page
GitHub paginates data in their API calls. Use this value to increase or
decrease the number of pull requests gathered from GitHub, per page. If
not set, GitHub defaults are used. Maximum is 100.
CLI Example:
.. code-block:: bash
salt myminion github.get_prs
salt myminion github.get_prs base=2016.11
u org_nameu repo_nameu /u reposu headu baseu per_pageu openu stateu createdu sortu descu directionRI RJ u pullsRV u idu fullN( R R
RK RM R t
_format_pr( RP R R] t headt baseRb Rc RQ R R( RI RV RR t prst pr_t pr_id( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt get_prs� s2 ?
c C@ s� i | j d � d 6| j d � d 6| j d � d 6| j d � d 6| j d � j d � d 6| j d � d 6| j d � j d
� d 6} | S( u�
Helper function to format API return information into a more manageable
and useful dictionary for pull request information.
pr_
The pull request to format.
u idu numberu pr_numberu stateu titleu useru loginu html_urlu baseu refu base_branch( R ( R� RR ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyR� s c C@ s i | j d � d 6| j d � d 6| j d � d 6| j d � d 6| j d � j d � d 6| j d � d 6} | j d � } | r� | j d � } n | j d
� } g } x$ | D] } | j | j d � � q� W| j d � } | r� | j d � } n | | d <| | d
<| | d <| S(
u�
Helper function to format API return information into a more manageable
and useful dictionary for issue information.
issue
The issue to format.
u idu numberu issue_numberu stateu titleu useru loginu html_urlu assigneeu labelsu nameu milestone( R R# ( Re RR R^ Ra t label_namest labelR\ ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyRN + s(
u GETu https://api.github.com/c C@ si t | t � s i } n | r+ | | 7} n | rG | d j | � 7} n t j d | � d | j � k r t | d � | d <n | r� d | j � k r� | | d <n | d% k r� i } n | d k r� d | d <n t } | d k r� t } n g }
t } d
} xc| t k rd| r!| | d <n t
j j j
| | d | d
| d | d | d d d t d t d t d d g d t �
}
t j d |
d � |
d d k r�t |
d t � r�|
d S|
|
d }
n t d j |
j d � � � � y) |
j d � j d � j d � d } Wn t k
r+t } qn Xd! | k r[| j d" � d j d# � d$ } qt } qW|
S(& uL
Make a web call to the GitHub API and deal with paginated results.
u /{0}u GitHub URL: %su access_tokenu tokenu per_pageu POSTu application/jsonu Acceptu DELETEu u pageR RC t header_dictt decodet decode_typeu jsonRB t statust textt hide_fieldst optsu GitHub Response Status Code: %su statusi� u dictu GitHub Response Error: {0}u erroru headersu Linku ,i u nextu >u &page=i N( t
isinstancet dictR R4 t debugt keysR R
R2 R t saltt utilst httpt queryt __opts__R R t splitt AttributeError( R RI RJ RV t methodR� RC R R R� t complete_resultt next_paget page_numberR* t link_info( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyRM N sj
)
#
(B t __doc__t
__future__R R R t loggingt salt.exceptionsR t salt.extR t salt.utils.httpR� R R R t github.PaginatedListt github.NamedUsert github.GithubExceptionR R2 t ImportErrort getLoggert __name__R4 R R R R R
R R. R1 R3 RE RH RU R[ Rf Rj Rp R& R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� RN RM ( ( ( s7 /usr/lib/python2.7/site-packages/salt/modules/github.pyt <module> s�
# C $ "1 ; w L E 3 . O P $ = < #:8 '.' 3 -. [ $
Mini Shell