python-gitlab/gitlab/cli.py at 9cb6bbedd350a2241113fe1d731b4cfe56c19d4f · matusf/python-gitlab · GitHub

Repository navigation

History

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

#!/usr/bin/env python

# -*- coding: utf-8 -*-

# This program is free software: you can redistribute it and/or modify

# it under the terms of the GNU Lesser General Public License as published by

# the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

# GNU Lesser General Public License for more details.

# You should have received a copy of the GNU Lesser General Public License

# along with this program. If not, see <http://www.gnu.org/licenses/>.

from __future__ import print_function

import argparse

import functools

import importlib

import re

import sys

import gitlab.config

camel_re = re.compile('(.)([A-Z])')

# custom_actions = {

# cls: {

# action: (mandatory_args, optional_args, in_obj),

# },

# }

custom_actions = {}

def register_custom_action(cls_names, mandatory=tuple(), optional=tuple()):

def wrap(f):

@functools.wraps(f)

def wrapped_f(*args, **kwargs):

return f(*args, **kwargs)

# in_obj defines whether the method belongs to the obj or the manager

in_obj = True

classes = cls_names

if type(cls_names) != tuple:

classes = (cls_names, )

for cls_name in classes:

final_name = cls_name

if cls_name.endswith('Manager'):

final_name = cls_name.replace('Manager', '')

in_obj = False

if final_name not in custom_actions:

custom_actions[final_name] = {}

action = f.__name__.replace('_', '-')

custom_actions[final_name][action] = (mandatory, optional, in_obj)

return wrapped_f

return wrap

def die(msg, e=None):

if e:

msg = "%s (%s)" % (msg, e)

sys.stderr.write(msg + "\n")

sys.exit(1)

def what_to_cls(what):

return "".join([s.capitalize() for s in what.split("-")])

def cls_to_what(cls):

return camel_re.sub(r'\1-\2', cls.__name__).lower()

def _get_base_parser(add_help=True):

parser = argparse.ArgumentParser(

add_help=add_help,

description="GitLab API Command Line Interface")

parser.add_argument("--version", help="Display the version.",

action="store_true")

parser.add_argument("-v", "--verbose", "--fancy",

help="Verbose mode (legacy format only)",

action="store_true")

parser.add_argument("-d", "--debug",

help="Debug mode (display HTTP requests)",

action="store_true")

parser.add_argument("-c", "--config-file", action='append',

help=("Configuration file to use. Can be used "

"multiple times."))

parser.add_argument("-g", "--gitlab",

help=("Which configuration section should "

"be used. If not defined, the default selection "

"will be used."),

required=False)

parser.add_argument("-o", "--output",

help=("Output format (v4 only): json|legacy|yaml"),

required=False,

choices=['json', 'legacy', 'yaml'],

default="legacy")

parser.add_argument("-f", "--fields",

help=("Fields to display in the output (comma "

"separated). Not used with legacy output"),

required=False)

return parser

def _get_parser(cli_module):

parser = _get_base_parser()

return cli_module.extend_parser(parser)

def _parse_value(v):

if isinstance(v, str) and v.startswith('@'):

# If the user-provided value starts with @, we try to read the file

# path provided after @ as the real value. Exit on any error.

try:

return open(v[1:]).read()

except Exception as e:

sys.stderr.write("%s\n" % e)

sys.exit(1)

return v

def main():

if "--version" in sys.argv:

print(gitlab.__version__)

exit(0)

parser = _get_base_parser(add_help=False)

# This first parsing step is used to find the gitlab config to use, and

# load the propermodule (v3 or v4) accordingly. At that point we don't have

# any subparser setup

(options, args) = parser.parse_known_args(sys.argv)

config = gitlab.config.GitlabConfigParser(options.gitlab,

options.config_file)

cli_module = importlib.import_module('gitlab.v%s.cli' % config.api_version)

# Now we build the entire set of subcommands and do the complete parsing

parser = _get_parser(cli_module)

args = parser.parse_args(sys.argv[1:])

config_files = args.config_file

gitlab_id = args.gitlab

verbose = args.verbose

output = args.output

fields = []

if args.fields:

fields = [x.strip() for x in args.fields.split(',')]

debug = args.debug

action = args.action

what = args.what

args = args.__dict__

# Remove CLI behavior-related args

for item in ('gitlab', 'config_file', 'verbose', 'debug', 'what', 'action',

'version', 'output'):

args.pop(item)

args = {k: _parse_value(v) for k, v in args.items() if v is not None}

try:

gl = gitlab.Gitlab.from_config(gitlab_id, config_files)

if gl.private_token or gl.oauth_token:

gl.auth()

except Exception as e:

die(str(e))

if debug:

gl.enable_debug()

cli_module.run(gl, what, action, args, verbose, output, fields)

sys.exit(0)

python-gitlab/gitlab/cli.py at 9cb6bbedd350a2241113fe1d731b4cfe56c19d4f · matusf/python-gitlab · GitHub

Repository navigation

Expand file tree

Breadcrumbs

cli.py

Latest commit

History

Breadcrumbs

cli.py

File metadata and controls