AlexMathew/scrapple

View on GitHub
scrapple/utils/form.py

Summary

Maintainability
A
25 mins
Test Coverage

Cyclomatic complexity is too high in function form_to_json. (7)
Open

def form_to_json(form):
    """
    Takes the form from the POST request in the web interface, and generates the JSON config\
    file 

Severity: Minor
Found in scrapple/utils/form.py by radon

Cyclomatic Complexity

Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

Construct Effect on CC Reasoning
if +1 An if statement is a single decision.
elif +1 The elif statement adds another decision.
else +0 The else statement does not cause a new decision. The decision is at the if.
for +1 There is a decision at the start of the loop.
while +1 There is a decision at the while statement.
except +1 Each except branch adds a new conditional path of execution.
finally +0 The finally block is unconditionally executed.
with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
assert +1 The assert statement internally roughly equals a conditional statement.
Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

Source: http://radon.readthedocs.org/en/latest/intro.html

Function form_to_json has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

def form_to_json(form):
    """
    Takes the form from the POST request in the web interface, and generates the JSON config\
    file 

Severity: Minor
Found in scrapple/utils/form.py - About 25 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

Indentation contains tabs
Open

    """
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    if form['url'] == "":
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    config['scraping']['data'] = list()
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    # TODO : Crawler 'next' parameter handling
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    config['project_name'] = form['project_name']
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    config['scraping']['url'] = form['url']
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    Takes the form from the POST request in the web interface, and generates the JSON config\
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Trailing whitespace
Open

    file 
Severity: Minor
Found in scrapple/utils/form.py by pep8

Trailing whitespace is superfluous.

The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.

Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n    \n    bang = 12

Indentation contains tabs
Open

    :return: None
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

        raise Exception('Project name cannot be empty.')
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    return
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    config['selector_type'] = form['selector_type']
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

            config['scraping']['data'].append(data)
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

            }
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    file 
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

        try:
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    for i in itertools.count(start=1):
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

            data = {
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    with open(os.path.join(os.getcwd(), form['project_name'] + '.json'), 'w') as f:
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    if form['project_name'] == "":
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

                'field': form['field_' + str(i)],
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

                'attr': form['attribute_' + str(i)],
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

        except KeyError:
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

        raise Exception('URL cannot be empty')
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

                'selector': form['selector_' + str(i)],
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

            break
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Line too long (90 > 79 characters)
Open

    Takes the form from the POST request in the web interface, and generates the JSON config\
Severity: Minor
Found in scrapple/utils/form.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.

Indentation contains tabs
Open

    :param form: The form from the POST request
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

        raise Exception('Selector type has to css or xpath')
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Line too long (80 > 79 characters)
Open

    with open(os.path.join(os.getcwd(), form['project_name'] + '.json'), 'w') as f:
Severity: Minor
Found in scrapple/utils/form.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.

Indentation contains tabs
Open

        json.dump(config, f)
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    config['scraping'] = dict()
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    """
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    config = dict()
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

    if form['selector_type'] not in ["css", "xpath"]:
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

Indentation contains tabs
Open

                'default': form['default_' + str(i)]
Severity: Minor
Found in scrapple/utils/form.py by pep8

On new projects, spaces-only are strongly recommended over tabs.

Okay: if True:\n    return
W191: if True:\n\treturn

There are no issues that match your filters.

Category
Status