Sign upLogin

18F/autoapi

View on GitHub
Star

Showing 11 of 11 total issues

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    assert response.json['resources'] == [
        {'id': 1, 'name': 'Tom', 'dob': '1980-02-26', 'number_of_pets': 0},
        {'id': 3, 'name': 'Harry', 'dob': '1972-11-24', 'number_of_pets': 2},
        {'id': 2, 'name': 'Dick', 'dob': '1982-03-14', 'number_of_pets': 3},
Severity: Major
Found in test_api.py and 1 other location - About 2 hrs to fix
test_api.py on lines 29..32

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 51.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    assert response.json['resources'] == [
        {'id': 2, 'name': 'Dick', 'dob': '1982-03-14', 'number_of_pets': 3},
        {'id': 3, 'name': 'Harry', 'dob': '1972-11-24', 'number_of_pets': 2},
        {'id': 1, 'name': 'Tom', 'dob': '1980-02-26', 'number_of_pets': 0},
Severity: Major
Found in test_api.py and 1 other location - About 2 hrs to fix
test_api.py on lines 23..26

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 51.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Function _index_table has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

def _index_table(tablename, metadata, engine, case_insensitive=False):
    """Index all columns on `tablename`, optionally using case-insensitive
    indexes on string columns when supported by the database.
    """
    table = sa.Table(tablename, metadata, autoload_with=engine)
Severity: Minor
Found in utils.py - About 1 hr 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 make_app has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

def make_app():
    app = sandman2.get_app(config.SQLA_URI, Base=utils.AutomapModel)

    app.json_encoder = utils.APIJSONEncoder
    app.config['CASE_INSENSITIVE'] = config.CASE_INSENSITIVE
Severity: Minor
Found in app.py - About 1 hr 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 apify has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

def apify(filename, tablename=None):
    try:
        filenames = glob.glob(filename, recursive=True)
    except TypeError:  # recursive glob in Python 3.5+ only
        filenames = glob.glob(filename)
Severity: Minor
Found in tasks.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 load_table has 6 arguments (exceeds 4 allowed). Consider refactoring.
Open

def load_table(filename,
Severity: Minor
Found in utils.py - About 45 mins to fix

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

    def register_rules(app, spec, service, schema, page_schema):
    Severity: Minor
    Found in swagger.py - About 35 mins to fix

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

      def to_sql(name, engine, frame, chunksize=None, **kwargs):
      Severity: Minor
      Found in utils.py - About 35 mins to fix

        Function entrypoint has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

        def entrypoint(argv):
    '''
    This is a Docker entrypoint that configures the container to run
    as the same uid of the user on the host container, rather than
    the Docker default of root. Aside from following security best
        Severity: Minor
        Found in entrypoint.py - About 35 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 get_message has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

        def get_message(payload):
    if payload['Type'] == 'Notification':
        keys = NOTIFICATION_KEYS
    elif payload['Type'] in ['SubscriptionConfirmation',
                             'UnsubscribeConfirmation']:
        Severity: Minor
        Found in signing.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

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

            def handle_notification(self, data):
        client = boto3.client('s3')
        message = json.loads(data['Message'])
        for record in message.get('Records', []):
            bucket = record['s3']['bucket']
        Severity: Minor
        Found in aws.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

        Severity
        Category
        Status
        Source
        Language