Sign upLogin

vpoulailleau/simplelogging

View on GitHub
Star

Showing 6 of 6 total issues

Function get_logger has 8 arguments (exceeds 4 allowed). Consider refactoring.
Open

def get_logger(
Severity: Major
Found in simplelogging/__init__.py - About 1 hr to fix

    Function configure_main_logger has 8 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def configure_main_logger(
    Severity: Major
    Found in simplelogging/__init__.py - About 1 hr to fix

      Remove this commented out code.
      Open

      # log = simplelogging.get_logger(console_level=simplelogging.DEBUG)
      Severity: Major
      Found in example/quick_start/main.py by sonar-python

      Programmers should not comment out code as it bloats programs and reduces readability.

      Unused code should be deleted and can be retrieved from source control history if required.

      See

      • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
      • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
      • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
      • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

      Remove this commented out code.
      Open

      # log = simplelogging.get_logger(console_level=simplelogging.DEBUG)
      Severity: Major
      Found in example/with_modules/main.py by sonar-python

      Programmers should not comment out code as it bloats programs and reduces readability.

      Unused code should be deleted and can be retrieved from source control history if required.

      See

      • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
      • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
      • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
      • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

      Function "get_logger" has 8 parameters, which is greater than the 7 authorized.
      Open

          name=None,
    logger_level=DEBUG,
    console=True,
    console_format=DEFAULT_CONSOLE_FORMAT,
    console_level=INFO,
      Severity: Major
      Found in simplelogging/__init__.py by sonar-python

      A long parameter list can indicate that a new structure should be created to wrap the numerous parameters or that the function is doing too many things.

      Noncompliant Code Example

      With a maximum number of 4 parameters:

      def do_something(param1, param2, param3, param4, param5):
    ...

      Compliant Solution

      def do_something(param1, param2, param3, param4):
    ...

      Function "configure_main_logger" has 8 parameters, which is greater than the 7 authorized.
      Open

          logger,
    logger_level=DEBUG,
    console=True,
    console_format=DEFAULT_CONSOLE_FORMAT,
    console_level=INFO,
      Severity: Major
      Found in simplelogging/__init__.py by sonar-python

      A long parameter list can indicate that a new structure should be created to wrap the numerous parameters or that the function is doing too many things.

      Noncompliant Code Example

      With a maximum number of 4 parameters:

      def do_something(param1, param2, param3, param4, param5):
    ...

      Compliant Solution

      def do_something(param1, param2, param3, param4):
    ...
      Severity
      Category
      Status
      Source
      Language