SDoc2Command - Code Metrics - Inspection of "Sdoc-52: Implement IO" - SDoc/py-sdoc - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#40)

by Oleg

created 2016-07-07 12:32 UTC

SDoc2Command A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	26
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	1
c	1
b	0
f	0
dl	0
loc	26
rs	10

1 Method

Rating	Name	Duplication	Size	Complexity
A	handle()	0	10	1

"""
SDoc

Copyright 2016 Set Based IT Consultancy

Licence MIT
"""
# ----------------------------------------------------------------------------------------------------------------------
from cleo import Command
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

from sdoc.SDoc import SDoc
from sdoc.style.SdocStyle import SdocStyle
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3


class SDoc2Command(Command):

    """
    This command starts executing sdoc2 component.
    """

    name = 'sdoc2'

    arguments = [
        {
            'name': 'main_sdoc_file',
            'description': "The 'sdoc' file which we want to parse",
            'required': True
        }
    ]

    # ------------------------------------------------------------------------------------------------------------------
    def handle(self):
        """
        Reads the arguments and starts SDoc application.
        """
        self.output = SdocStyle(self.input, self.output)
class Foo:
    def __init__(self, x=None):
        self.x = x

        main_sdoc_file = self.argument('main_sdoc_file')


        sdoc = SDoc(self.output)
        sdoc.test_sdoc2(main_sdoc_file)

# ----------------------------------------------------------------------------------------------------------------------


Pull Request — master (#40)

SDoc2Command A

Complexity

Size/Duplication

Importance

1 Method

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1			"""
2			SDoc
3
4			Copyright 2016 Set Based IT Consultancy
5
6			Licence MIT
7			"""
8			# ----------------------------------------------------------------------------------------------------------------------
9			from cleo import Command
			0 ignored issues – show Configuration introduced 2016-07-07 08:29 UTC by Report Bug Copy Issue Report The import `cleo` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
10
11			from sdoc.SDoc import SDoc
12			from sdoc.style.SdocStyle import SdocStyle
			0 ignored issues – show Bug introduced 2016-07-07 12:34 UTC by Report Bug Copy Issue Report The name `style` does not seem to exist in module `sdoc`. Loading history... Configuration introduced 2016-07-07 12:34 UTC by Report Bug Copy Issue Report The import `sdoc.style.SdocStyle` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
13
14
15			class SDoc2Command(Command):
			0 ignored issues – show Coding Style introduced 2016-07-07 08:29 UTC by Report Bug Copy Issue Report This class has no `__init__` method. Loading history...
16			"""
17			This command starts executing sdoc2 component.
18			"""
19
20			name = 'sdoc2'
21
22			arguments = [
23			{
24			'name': 'main_sdoc_file',
25			'description': "The 'sdoc' file which we want to parse",
26			'required': True
27			}
28			]
29
30			# ------------------------------------------------------------------------------------------------------------------
31			def handle(self):
32			"""
33			Reads the arguments and starts SDoc application.
34			"""
35			self.output = SdocStyle(self.input, self.output)
			0 ignored issues – show Bug introduced 2016-07-07 12:34 UTC by Report Bug Copy Issue Report The Instance of `SDoc2Command` does not seem to have a member named `input`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history... Coding Style introduced 2016-07-07 12:34 UTC by Report Bug Copy Issue Report The attribute `output` was defined outside `__init__`. It is generally a good practice to initialize all attributes to default values in the `__init__` method: class Foo: def __init__(self, x=None): self.x = x Loading history...
36
37			main_sdoc_file = self.argument('main_sdoc_file')
			0 ignored issues – show Bug introduced 2016-07-07 08:29 UTC by Report Bug Copy Issue Report The Instance of `SDoc2Command` does not seem to have a member named `argument`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
38
39			sdoc = SDoc(self.output)
40			sdoc.test_sdoc2(main_sdoc_file)
41
42			# ----------------------------------------------------------------------------------------------------------------------
43

SDoc / py-sdoc

Pull Request — master (#40)

SDoc2Command A

Complexity

Size/Duplication

Importance

1 Method

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

2. Missing init.py files

2. Missing init.py files