Commitd29a489

committed

docs(cli): add PyYAML requirement notice

1 parent6585c96 commitd29a489Copy full SHA for d29a489

File tree

+21

-6

lines changed

+21

-6

lines changed

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -157,6 +157,11 @@ These options must be defined before the mandatory arguments.`
`157`	`157`	``--output``, ``-o``
`158`	`158`	Output format. Defaults to a custom format. Can also be ``yaml`` or ``json``.
`159`	`159`
	`160`	`+ Notice:`
	`161`	`+`
	`162`	+ The `PyYAML package<https://pypi.org/project/PyYAML/>`_ is required to use the yaml output option.
	`163`	+ You need to install it separately using ``pip install PyYAML``
	`164`	`+`
`160`	`165`	``--fields``, ``-f``
`161`	`166`	Comma-separated list of fields to display (``yaml`` and ``json`` output
`162`	`167`	`formats only). If not used, all the object fields are displayed.`

Lines changed: 16 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -302,14 +302,24 @@ def display_list(self, data, fields, **kwargs):`
`302`	`302`
`303`	`303`	`classYAMLPrinter(object):`
`304`	`304`	`defdisplay(self,d,**kwargs):`
`305`		`-importyaml# noqa`
`306`		`-print(yaml.safe_dump(d,default_flow_style=False))`
	`305`	`+try:`
	`306`	`+importyaml# noqa`
	`307`	`+print(yaml.safe_dump(d,default_flow_style=False))`
	`308`	`+exceptImportError:`
	`309`	`+exit("PyYaml is not installed.\n"`
	`310`	+"Install it with `pip install PyYaml` "
	`311`	`+"to use the yaml output feature")`
`307`	`312`
`308`	`313`	`defdisplay_list(self,data,fields,**kwargs):`
`309`		`-importyaml# noqa`
`310`		`-print(yaml.safe_dump(`
`311`		`- [get_dict(obj,fields)forobjindata],`
`312`		`-default_flow_style=False))`
	`314`	`+try:`
	`315`	`+importyaml# noqa`
	`316`	`+print(yaml.safe_dump(`
	`317`	`+ [get_dict(obj,fields)forobjindata],`
	`318`	`+default_flow_style=False))`
	`319`	`+exceptImportError:`
	`320`	`+exit("PyYaml is not installed.\n"`
	`321`	+"Install it with `pip install PyYaml` "
	`322`	`+"to use the yaml output feature")`
`313`	`323`
`314`	`324`
`315`	`325`	`classLegacyPrinter(object):`

Comments

(0)