ref: Add black, isort and pre-commit hook #6787

iamareebjamal · 2020-01-24T20:20:24Z

Add isort for sorting imports
Add black for formatting
Add pre-commit hooks for standard checks

tests/hook_main.py

houndci-bot · 2020-01-24T20:21:19Z

tests/all/integration/api/helpers/test_order.py

-from app.factories.attendee import AttendeeFactoryBase, AttendeeFactory
+from app.api.attendees import get_sold_and_reserved_tickets_count
+from app.api.helpers.db import save_to_db
+from app.api.helpers.order import delete_related_attendees_for_order, set_expiry_for_order


Black would make changes.

populate_db.py

app/models/user.py

app/api/orders.py

app/api/users.py

app/api/user_favourite_events.py

app/api/tickets.py

houndci-bot · 2020-01-24T20:25:17Z

app/api/routes.py

+)
+from app.api.event_topics import EventTopicDetail, EventTopicList, EventTopicRelationship
+from app.api.event_types import EventTypeDetail, EventTypeList, EventTypeRelationship
+from app.api.events import EventCopyResource, EventDetail, EventList, EventRelationship


'app.api.events.EventCopyResource' imported but unused

houndci-bot · 2020-01-24T20:25:17Z

app/api/routes.py

+    EventSubTopicRelationshipOptional,
+    EventSubTopicRelationshipRequired,
+)
+from app.api.event_topics import EventTopicDetail, EventTopicList, EventTopicRelationship


Black would make changes.

app/api/modules.py

houndci-bot · 2020-01-24T20:25:18Z

app/api/helpers/tasks.py

+)
+from app.api.helpers.ICalExporter import ICalExporter
+from app.api.helpers.mail import check_smtp_config, send_export_mail, send_import_mail
+from app.api.helpers.notification import send_notif_after_export, send_notif_after_import


Black would make changes.

app/api/helpers/tasks.py

app/api/helpers/scheduled_jobs.py

app/api/events.py

houndci-bot · 2020-01-24T20:25:19Z

app/api/custom/attendees.py

 from flask_jwt_extended import current_user
 from sqlalchemy.orm.exc import NoResultFound

+from app.api.helpers.errors import ForbiddenError, NotFoundError, UnprocessableEntityError


Black would make changes.

app/api/attendees.py

houndci-bot · 2020-01-24T20:25:20Z

app/api/custom/orders.py

 from app.api.auth import return_file
-from app.api.helpers.db import safe_query, get_count
+from app.api.helpers.db import get_count, safe_query
+from app.api.helpers.errors import ForbiddenError, NotFoundError, UnprocessableEntityError


Black would make changes.

codecov · 2020-01-24T20:48:32Z

Codecov Report

Merging #6787 into development will decrease coverage by 0.06%.
The diff coverage is 57.93%.

@@               Coverage Diff               @@
##           development    #6787      +/-   ##
===============================================
- Coverage        65.38%   65.31%   -0.07%     
===============================================
  Files              302      302              
  Lines            15348    15319      -29     
===============================================
- Hits             10035    10006      -29     
  Misses            5313     5313

Impacted Files	Coverage Δ
app/models/base.py	`100% <ø> (ø)`	⬆️
app/models/track.py	`67.64% <ø> (ø)`	⬆️
app/factories/event_invoice.py	`100% <ø> (ø)`	⬆️
app/factories/track.py	`100% <ø> (ø)`	⬆️
app/factories/session.py	`100% <ø> (ø)`	⬆️
app/api/admin_sales/utils.py	`40% <ø> (ø)`	⬆️
app/factories/speaker.py	`100% <ø> (ø)`	⬆️
app/models/page.py	`60% <ø> (ø)`	⬆️
app/api/schema/modules.py	`100% <ø> (ø)`	⬆️
app/api/settings.py	`63.04% <ø> (+0.82%)`	⬆️
... and 368 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9791fb7...14b73ff. Read the comment docs.

houndci-bot · 2020-01-24T21:29:03Z

tests/hook_main.py

@@ -4057,7 +4223,9 @@ def order_statistics_event_get(transaction):
        db.session.commit()


-@hooks.before("Order Statistics > Order Statistics Details By Ticket > Show Order Statistics By Ticket")
+@hooks.before(
+    "Order Statistics > Order Statistics Details By Ticket > Show Order Statistics By Ticket"


line too long (93 > 90 characters)

houndci-bot · 2020-01-24T21:29:03Z

tests/hook_main.py

-@hooks.before("Order Statistics > Order Statistics Details By Event > Show Order Statistics By Event")
+
+@hooks.before(
+    "Order Statistics > Order Statistics Details By Event > Show Order Statistics By Event"


line too long (91 > 90 characters)

houndci-bot · 2020-01-24T21:29:03Z

tests/hook_main.py

@@ -3992,7 +4153,8 @@ def event_sessions_export_pdf_get(transaction):


 @hooks.before(
-    "Event Export > Start Speakers Export as PDF > Start a Task to Export Speakers of an Event as PDF")
+    "Event Export > Start Speakers Export as PDF > Start a Task to Export Speakers of an Event as PDF"


line too long (102 > 90 characters)

houndci-bot · 2020-01-24T21:29:04Z

tests/hook_main.py

@@ -3979,7 +4139,8 @@ def event_speakers_export_csv_get(transaction):


 @hooks.before(
-    "Event Export > Start Sessions Export as PDF > Start a Task to Export Sessions of an Event as PDF")
+    "Event Export > Start Sessions Export as PDF > Start a Task to Export Sessions of an Event as PDF"


line too long (102 > 90 characters)

houndci-bot · 2020-01-24T21:29:04Z

tests/hook_main.py

@@ -3966,7 +4125,8 @@ def event_sessions_export_csv_get(transaction):


 @hooks.before(
-    "Event Export > Start Speakers Export as CSV > Start a Task to Export Speakers of an Event as CSV")
+    "Event Export > Start Speakers Export as CSV > Start a Task to Export Speakers of an Event as CSV"


line too long (102 > 90 characters)

houndci-bot · 2020-01-24T21:29:06Z

tests/hook_main.py

@@ -3875,7 +4027,8 @@ def event_export_ical_get(transaction):


 @hooks.before(
-    "Event Export > Start Event Export as xCalendar > Start a Task to Export an Event as xCalendar")
+    "Event Export > Start Event Export as xCalendar > Start a Task to Export an Event as xCalendar"


line too long (99 > 90 characters)

houndci-bot · 2020-01-24T21:29:07Z

tests/hook_main.py

@@ -3862,7 +4013,8 @@ def event_export_post(transaction):


 @hooks.before(
-    "Event Export > Start Event Export as iCal file > Start a Task to Export an Event as iCal event")
+    "Event Export > Start Event Export as iCal file > Start a Task to Export an Event as iCal event"


line too long (100 > 90 characters)

houndci-bot · 2020-01-24T21:29:07Z

tests/hook_main.py

@@ -3834,7 +3982,9 @@ def stripe_authorization_delete(transaction):
        db.session.commit()


-@hooks.before("Stripe Authorization > Stripe Authorization for an Event > Get Stripe Authorization Details of an Event")
+@hooks.before(
+    "Stripe Authorization > Stripe Authorization for an Event > Get Stripe Authorization Details of an Event"


line too long (109 > 90 characters)

houndci-bot · 2020-01-24T21:29:07Z

tests/hook_main.py

@@ -3648,7 +3777,9 @@ def custom_placeholder_sub_topic_get_detail(transaction):


 # ------------------------- Custom Placeholders -------------------------
-@hooks.before("Custom Placeholders > Custom Placeholders Collection > List All Event Custom Placeholders")
+@hooks.before(
+    "Custom Placeholders > Custom Placeholders Collection > List All Event Custom Placeholders"


line too long (95 > 90 characters)

houndci-bot · 2020-01-24T21:29:08Z

tests/hook_main.py

@@ -3631,7 +3759,8 @@ def event_event_sub_topic_get_detail(transaction):


 @hooks.before(
-    "Event Sub Topics > Event Sub Topic of Custom Placeholder > Event Sub Topic Details of Custom Placeholder")
+    "Event Sub Topics > Event Sub Topic of Custom Placeholder > Event Sub Topic Details of Custom Placeholder"


line too long (110 > 90 characters)

niranjan94 · 2020-01-24T21:34:12Z

Here is an overview of what got changed by this pull request:

Issues
======
+ Solved 47
- Added 12
           

Clones added
============
- app/api/admin_statistics_api/sessions.py  1
- app/api/admin_statistics_api/mails.py  1
- app/api/speakers.py  1
- app/api/order_statistics/events.py  5
- app/api/attendees.py  3
- app/api/tax.py  1
- app/api/sessions.py  1
- app/api/access_codes.py  1
- app/api/order_statistics/tickets.py  6
- app/api/admin_statistics_api/users.py  1
- app/api/tickets.py  1
- app/api/orders.py  2
- app/models/discount_code.py  1
- app/api/admin_sales/events.py  1
- app/models/access_code.py  1
- app/api/admin_sales/organizer.py  1
         

Clones removed
==============
+ app/models/event_sub_topic.py  -1
+ app/models/event_type.py  -1
+ tests/all/integration/api/helpers/test_systemnotifications.py  -1

See the complete overview on Codacy

niranjan94 · 2020-01-24T21:34:13Z

app/api/orders.py

@@ -613,21 +840,34 @@ def omise_checkout(order_identifier):
    try:
        charge = OmisePaymentsManager.charge_payment(order_identifier, token)
    except omise.errors.BaseError as e:
-        logging.exception(f"""OmiseError: {repr(e)}.  See https://www.omise.co/api-errors""")
+        logging.exception(
+            f"""OmiseError: {repr(e)}.  See https://www.omise.co/api-errors"""


Issue found: invalid syntax

niranjan94 · 2020-01-24T21:34:14Z

app/api/order_statistics/events.py

+        )
+        max = (
+            db.session.query(func.sum(Ticket.quantity.label('sum')))
+            .filter(Ticket.event_id == obj_id, Ticket.deleted_at == None)


Issue found: comparison to None should be 'if cond is None:'

niranjan94 · 2020-01-24T21:34:15Z

app/models/ticket.py

+        'DiscountCode', secondary=discount_codes_tickets, backref="tickets"
+    )
+
+    def __init__(


Issue found: as argument

niranjan94 · 2020-01-24T21:34:16Z

app/api/helpers/scheduled_jobs.py

-                                  TicketHolder.created_at + datetime.timedelta(minutes=order_expiry_time)
-                                  < datetime.datetime.utcnow()).delete(synchronize_session=False)
+        TicketHolder.query.filter(
+            TicketHolder.order_id == None,


Issue found: comparison to None should be 'if cond is None:'

niranjan94 · 2020-01-24T21:34:17Z

manage.py

+    speakers = Speaker.query.filter(
+        Speaker.photo_url.isnot(None),
+        or_(
+            Speaker.icon_image_url == None,


Issue found: comparison to None should be 'if cond is None:'

niranjan94 · 2020-01-24T21:34:18Z

tests/hook_main.py

 sys.path.insert(1, path.abspath(path.join(__file__, "../..")))

 from flask_migrate import Migrate
 from flask import Flask
 from app.models import db
 from app.models.user import OWNER
-from app.models.user_token_blacklist import UserTokenBlackListTime  # noqa Workaround for registering unimported model
+from app.models.user_token_blacklist import (


Issue found: 'app.models.user_token_blacklist.UserTokenBlackListTime' imported but unused

niranjan94 · 2020-01-24T21:34:19Z

app/api/helpers/import_helpers.py

@@ -386,8 +388,9 @@ def import_event_json(task_handle, zip_path, creator_id):
    except ValueError:
        db.session.delete(new_event)
        db.session.commit()
-        raise make_error(item[0], er=ServerError(source='Zip Upload',
-                                                 detail='Invalid json'))
+        raise make_error(


Issue found: Raising a new style class which doesn't inherit from BaseException

niranjan94 · 2020-01-24T21:34:20Z

manage.py

+    events = Event.query.filter(
+        Event.original_image_url.isnot(None),
+        or_(
+            Event.thumbnail_image_url == None,


Issue found: comparison to None should be 'if cond is None:'

niranjan94 · 2020-01-24T21:34:22Z

app/api/routes.py

+)
+from app.api.event_topics import EventTopicDetail, EventTopicList, EventTopicRelationship
+from app.api.event_types import EventTypeDetail, EventTypeList, EventTypeRelationship
+from app.api.events import EventCopyResource, EventDetail, EventList, EventRelationship


Issue found: Unused EventCopyResource imported from app.api.events

niranjan94 · 2020-01-24T21:34:23Z

app/instance.py

-            app.logger.warning(f'Using random secret "{ random_secret }" for development server. '
-                               'This is NOT recommended. Set proper SECRET_KEY in .env or environment variables')
+            app.logger.warning(
+                f'Using random secret "{ random_secret }" for development server. '


Issue found: invalid syntax

niranjan94 · 2020-01-24T21:34:24Z

app/api/custom/orders.py

    attendee_list = []
    for ticket in tickets:
        for ticket_amount in range(ticket['quantity']):
-            attendee = TicketHolder(**result[0], event_id=int(data['event_id']), ticket_id=int(ticket['id']))
+            attendee = TicketHolder(
+                **result[0], event_id=int(data['event_id']), ticket_id=int(ticket['id'])


Issue found: invalid syntax

niranjan94 · 2020-01-24T21:34:25Z

app/api/routes.py

+)
+from app.api.event_topics import EventTopicDetail, EventTopicList, EventTopicRelationship
+from app.api.event_types import EventTypeDetail, EventTypeList, EventTypeRelationship
+from app.api.events import EventCopyResource, EventDetail, EventList, EventRelationship


Issue found: 'app.api.events.EventCopyResource' imported but unused

houndci-bot reviewed Jan 24, 2020

View reviewed changes

ref: Sort imports using isort

3a13122

iamareebjamal force-pushed the isort branch from 87d3f58 to 303624d Compare January 24, 2020 20:49

ref: Remove unused imports

1da150d

iamareebjamal force-pushed the isort branch from 303624d to 1da150d Compare January 24, 2020 20:50

iamareebjamal added 2 commits January 25, 2020 02:44

ref: Format files using black

8838951

chore: Add pre-commit hooks

14b73ff

iamareebjamal added the refactor label Jan 24, 2020

houndci-bot reviewed Jan 24, 2020

View reviewed changes

iamareebjamal changed the title ~~ref: Sort imports using isort~~ ref: Add black, isort and pre-commit hook Jan 24, 2020

niranjan94 reviewed Jan 24, 2020

View reviewed changes

app/models/ticket.py

'DiscountCode', secondary=discount_codes_tickets, backref="tickets"

)

def __init__(

Copy link

Member

niranjan94 Jan 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issue found: as argument

niranjan94 reviewed Jan 24, 2020

View reviewed changes

iamareebjamal merged commit b7ed60b into fossasia:development Jan 24, 2020

iamareebjamal deleted the isort branch January 24, 2020 21:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ref: Add black, isort and pre-commit hook #6787

ref: Add black, isort and pre-commit hook #6787

iamareebjamal commented Jan 24, 2020 •

edited

houndci-bot Jan 24, 2020

houndci-bot Jan 24, 2020

houndci-bot Jan 24, 2020

houndci-bot Jan 24, 2020

houndci-bot Jan 24, 2020

houndci-bot Jan 24, 2020

codecov bot commented Jan 24, 2020 •

edited

houndci-bot Jan 24, 2020

houndci-bot Jan 24, 2020

houndci-bot Jan 24, 2020

houndci-bot Jan 24, 2020

houndci-bot Jan 24, 2020

houndci-bot Jan 24, 2020

houndci-bot Jan 24, 2020

houndci-bot Jan 24, 2020

houndci-bot Jan 24, 2020

houndci-bot Jan 24, 2020

niranjan94 commented Jan 24, 2020

niranjan94 Jan 24, 2020

niranjan94 Jan 24, 2020

niranjan94 Jan 24, 2020

niranjan94 Jan 24, 2020

niranjan94 Jan 24, 2020

niranjan94 Jan 24, 2020

niranjan94 Jan 24, 2020

niranjan94 Jan 24, 2020

niranjan94 Jan 24, 2020

niranjan94 Jan 24, 2020

niranjan94 Jan 24, 2020

niranjan94 Jan 24, 2020

ref: Add black, isort and pre-commit hook #6787

ref: Add black, isort and pre-commit hook #6787

Conversation

iamareebjamal commented Jan 24, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jan 24, 2020 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

niranjan94 commented Jan 24, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iamareebjamal commented Jan 24, 2020 •

edited

codecov bot commented Jan 24, 2020 •

edited