Sign upLogin

SpartaHack/SpartaHack-API

View on GitHub
Star
resources/announcements.py

Summary

Maintainability
F
1 wk
Test Coverage

Function put has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

    def put(self, announcement_id):
        """
        updating announcements. Required things - title, description, pinned
        """
        # check if data from request is serializable
Severity: Minor
Found in resources/announcements.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 post has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    def post(self):
        """
        For POST request. Checks for bad JSON from request, checks if data types in request JSON are correct, Checks user auth status and if he's logged in.
        """
        try:
Severity: Minor
Found in resources/announcements.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 delete has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

    def delete(self, announcement_id):
        """
        For DELETE request for specific id
        """
        user_status, user = has_admin_privileges()
Severity: Minor
Found in resources/announcements.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

Avoid too many return statements within this function.
Open

                    return (not_found, 404, headers)
Severity: Major
Found in resources/announcements.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

                return (internal_server_error, 500, headers)
Severity: Major
Found in resources/announcements.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

                return (internal_server_error, 500, headers)
Severity: Major
Found in resources/announcements.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

            return(forbidden, 403, headers)
Severity: Major
Found in resources/announcements.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

                return (conflict, 409, headers)
Severity: Major
Found in resources/announcements.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

            return (forbidden, 403, headers)
Severity: Major
Found in resources/announcements.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

            return (internal_server_error, 500, headers)
Severity: Major
Found in resources/announcements.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

                return (Announcement_Schema().dump(ret).data, 201, headers)
Severity: Major
Found in resources/announcements.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

                    return (ret, 200, headers)
Severity: Major
Found in resources/announcements.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

                return (internal_server_error, 500, headers)
Severity: Major
Found in resources/announcements.py - About 30 mins to fix

Avoid too many return statements within this function.
Open

            return (forbidden, 403, headers)
Severity: Major
Found in resources/announcements.py - About 30 mins to fix

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

class Announcements_CR(Resource):
    """
    For GET PUT and DELETE for specific announcement
    """
Severity: Major
Found in resources/announcements.py and 1 other location - About 4 days to fix
resources/hardware.py on lines 102..168

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 490.

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 5 locations. Consider refactoring.
Open

    def delete(self, announcement_id):
        """
        For DELETE request for specific id
        """
        user_status, user = has_admin_privileges()
Severity: Major
Found in resources/announcements.py and 4 other locations - About 1 day to fix
resources/faqs.py on lines 80..108
resources/hardware.py on lines 75..100
resources/schedule.py on lines 76..101
resources/sponsors.py on lines 71..98

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 186.

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

        if user_status in ["director", "organizer"]:
            try:
                announcement = g.session.query(
                    g.Base.classes.announcements).get(announcement_id)
                if announcement:
Severity: Major
Found in resources/announcements.py and 1 other location - About 1 day to fix
resources/hardware.py on lines 56..73

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 156.

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

There are no issues that match your filters.

Category
Status