View GitHub Repository py-sdoc

Schedule Inspection
Subscribe
Completed
Push — master ( 9797b3...5db226 )
by P.R.
03:05
created

SdocStyle.__init__()   A

↳ Parent: SdocStyle

Complexity

Conditions 1

Size

Total Lines 20

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 8
CRAP Score 1

Importance

Changes 3
Bugs 0 Features 0
Metric Value
dl 0
loc 20
ccs 8
cts 8
cp 1
rs 9.4285
c 3
b 0
f 0
cc 1
crap 1
1 1 
from cleo import OutputFormatterStyle
0 ignored issues
– show
Coding Style introduced by
This module should have a docstring.

The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods:

class SomeClass:
    def some_method(self):
        """Do x and return foo."""

If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions.

Loading history...
2 1 
from cleo.styles import CleoStyle
3 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                             1                         
                
                
                
class SdocStyle(CleoStyle):

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                                                                        
                        

                            
                            
2 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The method do_write which was declared abstract in the super-class Output

was not overridden.
                                                                                                                                                    

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Methods which raise NotImplementedError should be overridden in concrete
child classes.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                            




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The method text which was declared abstract in the super-class OutputStyle

was not overridden.
                                                                                                                                                    

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Methods which raise NotImplementedError should be overridden in concrete
child classes.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                
    """

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
    Output style for SDoc.

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
    """

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    10
                

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

            


            
                                                                        
                            
            
                                    
            
            

                
                    11
                

                                    
                             1                         
                
                
                
    def __init__(self, input, output):

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
            Best Practice
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
This seems to re-define the built-in input.
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
It is generally discouraged to redefine built-ins as this makes code very hard to read.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                                        
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
        """

            


            
                                                                        
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
        Object constructor.

            


            
                                                                        
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                

            


            
                                                                        
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
        :param cleo.inputs.input.Input input: The input object.

            


            
                                                                        
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
        :param cleo.outputs.output.Output output: The output object.

            


            
                                                                        
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
        """

            


            
                                                                        
                            
            
                                    
            
            

                
                    18
                

                                    
                             1                         
                
                
                
        CleoStyle.__init__(self, input, output)

            


            
                                                                        
                            
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                

            


            
                                                                        
                            
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
        # Style for file system objects (e.g. file and directory names).

            


            
                                                                        
                            
            
                                    
            
            

                
                    21
                

                                    
                             1                         
                
                
                
        style = OutputFormatterStyle('green', None, ['bold'])

            


            
                                                                        
                            
            
                                    
            
            

                
                    22
                

                                    
                             1                         
                
                
                
        output.get_formatter().set_style('fso', style)

            


            
                                                                        
                            
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                

            


            
                                                                        
                            
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
        # Style for errors.

            


            
                                                                        
                            
            
                                    
            
            

                
                    25
                

                                    
                             1                         
                
                
                
        style = OutputFormatterStyle('red', None, ['bold'])

            


            
                                                                        
                            
            
                                    
            
            

                
                    26
                

                                    
                             1                         
                
                
                
        output.get_formatter().set_style('err', style)

            


            
                                                                        
                            
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                

            


            
                                                                        
                            
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
        # Style for SDoc1 notices.

            


            
                                                                        
                            
            
                                    
            
            

                
                    29
                

                                    
                             1                         
                
                
                
        style = OutputFormatterStyle('yellow')

            


            
                                                                        
                            
            
                                    
            
            

                
                    30
                

                                    
                             1                         
                
                
                
        output.get_formatter().set_style('notice', style)

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    32
                

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

            


            
                                                        
            
                                    
            
            

                
                    33