SectionNode.get_hierarchy_level() - Code Metrics - Inspection of "Upgrade to Cleo 0.6.1." - SDoc/py-sdoc - Measure and Improve Code Quality continuously with Scrutinizer

Passed

by P.R.

created 2017-10-14 12:06 UTC

↳ Parent: SectionNode

Conditions

Total Lines

Lines	0
Ratio	0 %

Tests	2
CRAP Score	1

Changes

1		"""
2		SDoc
3
4		Copyright 2016 Set Based IT Consultancy
5
6		Licence MIT
7		"""
8		# ----------------------------------------------------------------------------------------------------------------------
9	1	from sdoc.sdoc2.NodeStore import NodeStore
10	1	from sdoc.sdoc2.node.HeadingNode import HeadingNode
11
12
13	1	class SectionNode(HeadingNode):
14		"""
15		SDoc2 node for sections.
16		"""
17
18		# ------------------------------------------------------------------------------------------------------------------
19	1	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 section.
25		:param str argument: The title of this section.
26		"""
27	1	super().__init__(io, 'section', options, argument)
28
29		# ------------------------------------------------------------------------------------------------------------------
30	1	def get_command(self):
31		"""
32		Returns the command of this node, i.e. section.
33
34		:rtype: str
35		"""
36	1	return 'section'
37
38		# ------------------------------------------------------------------------------------------------------------------
39	1	def get_hierarchy_level(self, parent_hierarchy_level=-1):
40		"""
41		Returns 2.
42
43		:rtype: int
44		"""
45	1	return 2
46
47
48		# ----------------------------------------------------------------------------------------------------------------------
49		NodeStore.register_inline_command('section', SectionNode)
50

SDoc / py-sdoc