Sign upLogin

noirbizarre/json4humans

View on GitHub
Star
json4humans/protocol.py

Summary

Maintainability
A
1 hr
Test Coverage
C
75%

Function implement has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

def implement(
    grammar: str, transformer: Transformer, encoder: type[JSONEncoder], lexer: LexerType = "auto"
):
    """
    A [JSON module][json4humans.protocol.JSONModule] attributes factory.
Severity: Minor
Found in json4humans/protocol.py - About 55 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function dump has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def dump(
Severity: Minor
Found in json4humans/protocol.py - About 35 mins to fix

    Line too long (91 > 79 characters)
    Open

            :param cls: An encoder class to use. Will use the default module encoder if `None`.
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (95 > 79 characters)
    Open

            The parameters have the  same meaning as [dump()][json4humans.protocol.JSONModule.dump]
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (96 > 79 characters)
    Open

        Only provide the grammar, the transformer, the encoder class (and a few optional parameters)
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (101 > 79 characters)
    Open

                           or a string representing the indentation characters to be used as indentation.
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (83 > 79 characters)
    Open

            :param out: A file-like object or path to a file to serialize to JSON into.
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (93 > 79 characters)
    Open

        :param grammar: the base name of the grammar (will use the Lark grammar of the same name)
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (96 > 79 characters)
    Open

            self, obj: Any, *, cls: type[JSONEncoder] | None = None, indent: str | int | None = None
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (91 > 79 characters)
    Open

            :param cls: An encoder class to use. Will use the default module encoder if `None`.
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (83 > 79 characters)
    Open

            :param file: A file-like object or path to a file containing JSON to parse.
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (101 > 79 characters)
    Open

                           or a string representing the indentation characters to be used as indentation.
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (97 > 79 characters)
    Open

        grammar: str, transformer: Transformer, encoder: type[JSONEncoder], lexer: LexerType = "auto"
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (90 > 79 characters)
    Open

            :param indent: Indentation to use, either an integer defining the number of spaces
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (81 > 79 characters)
    Open

    LexerType = Literal["auto", "basic", "contextual", "dynamic", "complete_dynamic"]
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (86 > 79 characters)
    Open

        and this factory will create all the missing helpers and boiler plate to implement
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Line too long (90 > 79 characters)
    Open

            :param indent: Indentation to use, either an integer defining the number of spaces
    Severity: Minor
    Found in json4humans/protocol.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    Expected an indentation at 24 instead of at 23.
    Open

                           or a string representing the indentation characters to be used as indentation.
    Severity: Minor
    Found in json4humans/protocol.py by editorconfig

    Expected an indentation at 24 instead of at 23.
    Open

                           or a string representing the indentation characters to be used as indentation.
    Severity: Minor
    Found in json4humans/protocol.py by editorconfig

    There are no issues that match your filters.

    Category
    Status