ChapterNode.get_hierarchy_level() - Code Metrics - Inspection of "Use Cleo 0.5.0. Use target_dir config parameter fo..." - SDoc/py-sdoc - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

by P.R.

created 2017-10-14 11:37 UTC

↳ Parent: ChapterNode

Conditions

Total Lines

Lines	0
Ratio	0 %

Tests	0
CRAP Score	2

Changes

1			"""
2			SDoc
3
4			Copyright 2016 Set Based IT Consultancy
5
6			Licence MIT
7			"""
8			# ----------------------------------------------------------------------------------------------------------------------
9			from sdoc.sdoc2.NodeStore import NodeStore
10			from sdoc.sdoc2.node.HeadingNode import HeadingNode
11
12
13			class ChapterNode(HeadingNode):
14			"""
15			SDoc2 node for chapters.
16			"""
17
18			# ------------------------------------------------------------------------------------------------------------------
19			def __init__(self, io, options, argument):
20			"""
21			Object constructor.
22
23			:param None\|cleo.styles.output_style.OutputStyle io: The IO object.
24			:param dict[str,str] options: The options of this chapter.
25			:param str argument: The title of this chapter.
26			"""
27			super().__init__(io, 'chapter', options, argument)
28
29			# ------------------------------------------------------------------------------------------------------------------
30			def get_command(self):
31			"""
32			Returns the command of this node, i.e. chapter.
33
34			:rtype: str
35			"""
36			return 'chapter'
37
38			# ------------------------------------------------------------------------------------------------------------------
39			def get_hierarchy_level(self, parent_hierarchy_level=-1):
40			"""
41			Returns 1.
42
43			:rtype: int
44			"""
45			return 1
46
47
48			# ----------------------------------------------------------------------------------------------------------------------
49			NodeStore.register_inline_command('chapter', ChapterNode)
50

SDoc / py-sdoc