python-gitlab/gitlab/v4/cli.py at master · PPaques/python-gitlab · GitHub

Repository navigation

History

442 lines (373 loc) · 15.5 KB

Raw

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

#!/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/>.

import inspect

import operator

import sys

import gitlab

import gitlab.base

from gitlab import cli

import gitlab.v4.objects

class GitlabCLI(object):

def __init__(self, gl, what, action, args):

self.cls_name = cli.what_to_cls(what)

self.cls = gitlab.v4.objects.__dict__[self.cls_name]

self.what = what.replace("-", "_")

self.action = action.lower()

self.gl = gl

self.args = args

self.mgr_cls = getattr(gitlab.v4.objects, self.cls.__name__ + "Manager")

# We could do something smart, like splitting the manager name to find

# parents, build the chain of managers to get to the final object.

# Instead we do something ugly and efficient: interpolate variables in

# the class _path attribute, and replace the value with the result.

self.mgr_cls._path = self.mgr_cls._path % self.args

self.mgr = self.mgr_cls(gl)

types = getattr(self.mgr_cls, "_types", {})

if types:

for attr_name, type_cls in types.items():

if attr_name in self.args.keys():

obj = type_cls()

obj.set_from_cli(self.args[attr_name])

self.args[attr_name] = obj.get()

def __call__(self):

# Check for a method that matches object + action

method = "do_%s_%s" % (self.what, self.action)

if hasattr(self, method):

return getattr(self, method)()

# Fallback to standard actions (get, list, create, ...)

method = "do_%s" % self.action

if hasattr(self, method):

return getattr(self, method)()

# Finally try to find custom methods

return self.do_custom()

def do_custom(self):

in_obj = cli.custom_actions[self.cls_name][self.action][2]

# Get the object (lazy), then act

if in_obj:

data = {}

if hasattr(self.mgr, "_from_parent_attrs"):

for k in self.mgr._from_parent_attrs:

data[k] = self.args[k]

if gitlab.mixins.GetWithoutIdMixin not in inspect.getmro(self.cls):

data[self.cls._id_attr] = self.args.pop(self.cls._id_attr)

o = self.cls(self.mgr, data)

method_name = self.action.replace("-", "_")

return getattr(o, method_name)(**self.args)

else:

return getattr(self.mgr, self.action)(**self.args)

def do_project_export_download(self):

try:

project = self.gl.projects.get(int(self.args["project_id"]), lazy=True)

data = project.exports.get().download()

sys.stdout.buffer.write(data)

except Exception as e:

cli.die("Impossible to download the export", e)

def do_create(self):

try:

return self.mgr.create(self.args)

except Exception as e:

cli.die("Impossible to create object", e)

def do_list(self):

try:

return self.mgr.list(**self.args)

except Exception as e:

cli.die("Impossible to list objects", e)

def do_get(self):

id = None

if gitlab.mixins.GetWithoutIdMixin not in inspect.getmro(self.mgr_cls):

id = self.args.pop(self.cls._id_attr)

try:

return self.mgr.get(id, **self.args)

except Exception as e:

cli.die("Impossible to get object", e)

def do_delete(self):

id = self.args.pop(self.cls._id_attr)

try:

self.mgr.delete(id, **self.args)

except Exception as e:

cli.die("Impossible to destroy object", e)

def do_update(self):

id = None

if gitlab.mixins.GetWithoutIdMixin not in inspect.getmro(self.mgr_cls):

id = self.args.pop(self.cls._id_attr)

try:

return self.mgr.update(id, self.args)

except Exception as e:

cli.die("Impossible to update object", e)

def _populate_sub_parser_by_class(cls, sub_parser):

mgr_cls_name = cls.__name__ + "Manager"

mgr_cls = getattr(gitlab.v4.objects, mgr_cls_name)

for action_name in ["list", "get", "create", "update", "delete"]:

if not hasattr(mgr_cls, action_name):

continue

sub_parser_action = sub_parser.add_parser(action_name)

sub_parser_action.add_argument("--sudo", required=False)

if hasattr(mgr_cls, "_from_parent_attrs"):

[

sub_parser_action.add_argument(

"--%s" % x.replace("_", "-"), required=True

)

for x in mgr_cls._from_parent_attrs

]

if action_name == "list":

if hasattr(mgr_cls, "_list_filters"):

[

sub_parser_action.add_argument(

"--%s" % x.replace("_", "-"), required=False

)

for x in mgr_cls._list_filters

]

sub_parser_action.add_argument("--page", required=False)

sub_parser_action.add_argument("--per-page", required=False)

sub_parser_action.add_argument("--all", required=False, action="store_true")

if action_name == "delete":

if cls._id_attr is not None:

id_attr = cls._id_attr.replace("_", "-")

sub_parser_action.add_argument("--%s" % id_attr, required=True)

if action_name == "get":

if gitlab.mixins.GetWithoutIdMixin not in inspect.getmro(cls):

if cls._id_attr is not None:

id_attr = cls._id_attr.replace("_", "-")

sub_parser_action.add_argument("--%s" % id_attr, required=True)

if hasattr(mgr_cls, "_optional_get_attrs"):

[

sub_parser_action.add_argument(

"--%s" % x.replace("_", "-"), required=False

)

for x in mgr_cls._optional_get_attrs

]

if action_name == "create":

if hasattr(mgr_cls, "_create_attrs"):

[

sub_parser_action.add_argument(

"--%s" % x.replace("_", "-"), required=True

)

for x in mgr_cls._create_attrs[0]

]

[

sub_parser_action.add_argument(

"--%s" % x.replace("_", "-"), required=False

)

for x in mgr_cls._create_attrs[1]

]

if action_name == "update":

if cls._id_attr is not None:

id_attr = cls._id_attr.replace("_", "-")

sub_parser_action.add_argument("--%s" % id_attr, required=True)

if hasattr(mgr_cls, "_update_attrs"):

[

sub_parser_action.add_argument(

"--%s" % x.replace("_", "-"), required=True

)

for x in mgr_cls._update_attrs[0]

if x != cls._id_attr

]

[

sub_parser_action.add_argument(

"--%s" % x.replace("_", "-"), required=False

)

for x in mgr_cls._update_attrs[1]

if x != cls._id_attr

]

if cls.__name__ in cli.custom_actions:

name = cls.__name__

for action_name in cli.custom_actions[name]:

sub_parser_action = sub_parser.add_parser(action_name)

# Get the attributes for URL/path construction

if hasattr(mgr_cls, "_from_parent_attrs"):

[

sub_parser_action.add_argument(

"--%s" % x.replace("_", "-"), required=True

)

for x in mgr_cls._from_parent_attrs

]

sub_parser_action.add_argument("--sudo", required=False)

# We need to get the object somehow

if gitlab.mixins.GetWithoutIdMixin not in inspect.getmro(cls):

if cls._id_attr is not None:

id_attr = cls._id_attr.replace("_", "-")

sub_parser_action.add_argument("--%s" % id_attr, required=True)

required, optional, dummy = cli.custom_actions[name][action_name]

[

sub_parser_action.add_argument(

"--%s" % x.replace("_", "-"), required=True

)

for x in required

if x != cls._id_attr

]

[

sub_parser_action.add_argument(

"--%s" % x.replace("_", "-"), required=False

)

for x in optional

if x != cls._id_attr

]

if mgr_cls.__name__ in cli.custom_actions:

name = mgr_cls.__name__

for action_name in cli.custom_actions[name]:

sub_parser_action = sub_parser.add_parser(action_name)

if hasattr(mgr_cls, "_from_parent_attrs"):

[

sub_parser_action.add_argument(

"--%s" % x.replace("_", "-"), required=True

)

for x in mgr_cls._from_parent_attrs

]

sub_parser_action.add_argument("--sudo", required=False)

required, optional, dummy = cli.custom_actions[name][action_name]

[

sub_parser_action.add_argument(

"--%s" % x.replace("_", "-"), required=True

)

for x in required

if x != cls._id_attr

]

[

sub_parser_action.add_argument(

"--%s" % x.replace("_", "-"), required=False

)

for x in optional

if x != cls._id_attr

]

def extend_parser(parser):

subparsers = parser.add_subparsers(

title="object", dest="what", help="Object to manipulate."

)

subparsers.required = True

# populate argparse for all Gitlab Object

classes = []

for cls in gitlab.v4.objects.__dict__.values():

try:

if gitlab.base.RESTManager in inspect.getmro(cls):

if cls._obj_cls is not None:

classes.append(cls._obj_cls)

except AttributeError:

pass

classes.sort(key=operator.attrgetter("__name__"))

for cls in classes:

arg_name = cli.cls_to_what(cls)

object_group = subparsers.add_parser(arg_name)

object_subparsers = object_group.add_subparsers(

title="action", dest="whaction", help="Action to execute."

)

_populate_sub_parser_by_class(cls, object_subparsers)

object_subparsers.required = True

return parser

def get_dict(obj, fields):

if isinstance(obj, str):

return obj

if fields:

return {k: v for k, v in obj.attributes.items() if k in fields}

return obj.attributes

class JSONPrinter(object):

def display(self, d, **kwargs):

import json # noqa

print(json.dumps(d))

def display_list(self, data, fields, **kwargs):

import json # noqa

print(json.dumps([get_dict(obj, fields) for obj in data]))

class YAMLPrinter(object):

def display(self, d, **kwargs):

try:

import yaml # noqa

print(yaml.safe_dump(d, default_flow_style=False))

except ImportError:

exit(

"PyYaml is not installed.\n"

"Install it with `pip install PyYaml` "

"to use the yaml output feature"

)

def display_list(self, data, fields, **kwargs):

try:

import yaml # noqa

print(

yaml.safe_dump(

[get_dict(obj, fields) for obj in data], default_flow_style=False

)

except ImportError:

exit(

"PyYaml is not installed.\n"

"Install it with `pip install PyYaml` "

"to use the yaml output feature"

)

class LegacyPrinter(object):

def display(self, d, **kwargs):

verbose = kwargs.get("verbose", False)

padding = kwargs.get("padding", 0)

obj = kwargs.get("obj")

def display_dict(d, padding):

for k in sorted(d.keys()):

v = d[k]

if isinstance(v, dict):

print("%s%s:" % (" " * padding, k.replace("_", "-")))

new_padding = padding + 2

self.display(v, verbose=True, padding=new_padding, obj=v)

continue

print("%s%s: %s" % (" " * padding, k.replace("_", "-"), v))

if verbose:

if isinstance(obj, dict):

display_dict(obj, padding)

return

# not a dict, we assume it's a RESTObject

if obj._id_attr:

id = getattr(obj, obj._id_attr, None)

print("%s: %s" % (obj._id_attr, id))

attrs = obj.attributes

if obj._id_attr:

attrs.pop(obj._id_attr)

display_dict(attrs, padding)

else:

if obj._id_attr:

id = getattr(obj, obj._id_attr)

print("%s: %s" % (obj._id_attr.replace("_", "-"), id))

if hasattr(obj, "_short_print_attr"):

value = getattr(obj, obj._short_print_attr) or "None"

value = value.replace("\r", "").replace("\n", " ")

# If the attribute is a note (ProjectCommitComment) then we do

# some modifications to fit everything on one line

line = "%s: %s" % (obj._short_print_attr, value)

# ellipsize long lines (comments)

if len(line) > 79:

line = line[:76] + "..."

print(line)

def display_list(self, data, fields, **kwargs):

verbose = kwargs.get("verbose", False)

for obj in data:

if isinstance(obj, gitlab.base.RESTObject):

self.display(get_dict(obj, fields), verbose=verbose, obj=obj)

else:

print(obj)

print("")

PRINTERS = {"json": JSONPrinter, "legacy": LegacyPrinter, "yaml": YAMLPrinter}

def run(gl, what, action, args, verbose, output, fields):

g_cli = GitlabCLI(gl, what, action, args)

data = g_cli()

printer = PRINTERS[output]()

if isinstance(data, dict):

printer.display(data, verbose=True, obj=data)

elif isinstance(data, list):

printer.display_list(data, fields, verbose=verbose)

elif isinstance(data, gitlab.base.RESTObject):

printer.display(get_dict(data, fields), verbose=verbose, obj=data)

elif isinstance(data, str):

print(data)

elif isinstance(data, bytes):

sys.stdout.buffer.write(data)

elif hasattr(data, "decode"):

print(data.decode())

python-gitlab/gitlab/v4/cli.py at master · PPaques/python-gitlab · GitHub

Repository navigation

Expand file tree

Breadcrumbs

cli.py

Latest commit

History

Breadcrumbs

cli.py

File metadata and controls