From 609d6c0a48170e8eeefca2c6f0fd55c014c7ad65 Mon Sep 17 00:00:00 2001 From: sco1 Date: Wed, 18 Sep 2019 15:46:36 -0700 Subject: Update linting rules & partially relint --- pydis_site/apps/api/models/__init__.py | 7 ++++--- pydis_site/apps/api/models/bot/__init__.py | 25 +++++++++++++------------ pydis_site/apps/api/models/bot/bot_setting.py | 2 +- pydis_site/apps/api/models/bot/tag.py | 10 +++++----- pydis_site/apps/api/models/bot/user.py | 2 +- 5 files changed, 24 insertions(+), 22 deletions(-) (limited to 'pydis_site/apps/api/models') diff --git a/pydis_site/apps/api/models/__init__.py b/pydis_site/apps/api/models/__init__.py index a7eccb04..a4656bc3 100644 --- a/pydis_site/apps/api/models/__init__.py +++ b/pydis_site/apps/api/models/__init__.py @@ -1,4 +1,5 @@ -from .bot import ( # noqa +# flake8: noqa +from .bot import ( BotSetting, DocumentationLink, DeletedMessage, @@ -12,5 +13,5 @@ from .bot import ( # noqa Tag, User ) -from .log_entry import LogEntry # noqa -from .utils import ModelReprMixin # noqa +from .log_entry import LogEntry +from .utils import ModelReprMixin diff --git a/pydis_site/apps/api/models/bot/__init__.py b/pydis_site/apps/api/models/bot/__init__.py index b805924a..46219ea2 100644 --- a/pydis_site/apps/api/models/bot/__init__.py +++ b/pydis_site/apps/api/models/bot/__init__.py @@ -1,12 +1,13 @@ -from .bot_setting import BotSetting # noqa -from .deleted_message import DeletedMessage # noqa -from .documentation_link import DocumentationLink # noqa -from .infraction import Infraction # noqa -from .message import Message # noqa -from .message_deletion_context import MessageDeletionContext # noqa -from .nomination import Nomination # noqa -from .off_topic_channel_name import OffTopicChannelName # noqa -from .reminder import Reminder # noqa -from .role import Role # noqa -from .tag import Tag # noqa -from .user import User # noqa +# flake8: noqa +from .bot_setting import BotSetting +from .deleted_message import DeletedMessage +from .documentation_link import DocumentationLink +from .infraction import Infraction +from .message import Message +from .message_deletion_context import MessageDeletionContext +from .nomination import Nomination +from .off_topic_channel_name import OffTopicChannelName +from .reminder import Reminder +from .role import Role +from .tag import Tag +from .user import User diff --git a/pydis_site/apps/api/models/bot/bot_setting.py b/pydis_site/apps/api/models/bot/bot_setting.py index a52f3e34..b1c3e47c 100644 --- a/pydis_site/apps/api/models/bot/bot_setting.py +++ b/pydis_site/apps/api/models/bot/bot_setting.py @@ -5,7 +5,7 @@ from django.db import models from pydis_site.apps.api.models.utils import ModelReprMixin -def validate_bot_setting_name(name): +def validate_bot_setting_name(name: str) -> None: """Raises a ValidationError if the given name is not a known setting.""" known_settings = ( 'defcon', diff --git a/pydis_site/apps/api/models/bot/tag.py b/pydis_site/apps/api/models/bot/tag.py index de4eab30..792e6b43 100644 --- a/pydis_site/apps/api/models/bot/tag.py +++ b/pydis_site/apps/api/models/bot/tag.py @@ -1,5 +1,5 @@ from collections.abc import Mapping -from typing import Any +from typing import Any, Dict, List, Union from django.contrib.postgres import fields as pgfields from django.core.exceptions import ValidationError @@ -15,7 +15,7 @@ def is_bool_validator(value: Any) -> None: raise ValidationError(f"This field must be of type bool, not {type(value)}.") -def validate_tag_embed_fields(fields): +def validate_tag_embed_fields(fields: dict) -> None: """Raises a ValidationError if any of the given embed fields is invalid.""" field_validators = { 'name': (MaxLengthValidator(limit_value=256),), @@ -42,7 +42,7 @@ def validate_tag_embed_fields(fields): validator(value) -def validate_tag_embed_footer(footer): +def validate_tag_embed_footer(footer: Any) -> None: """Raises a ValidationError if the given footer is invalid.""" field_validators = { 'text': ( @@ -67,7 +67,7 @@ def validate_tag_embed_footer(footer): validator(value) -def validate_tag_embed_author(author): +def validate_tag_embed_author(author: Any) -> None: """Raises a ValidationError if the given author is invalid.""" field_validators = { 'name': ( @@ -93,7 +93,7 @@ def validate_tag_embed_author(author): validator(value) -def validate_tag_embed(embed): +def validate_tag_embed(embed: Dict[str, Union[str, List[dict], dict]]) -> None: """ Validate a JSON document containing an embed as possible to send on Discord. diff --git a/pydis_site/apps/api/models/bot/user.py b/pydis_site/apps/api/models/bot/user.py index 00c24d3d..21617dc4 100644 --- a/pydis_site/apps/api/models/bot/user.py +++ b/pydis_site/apps/api/models/bot/user.py @@ -8,7 +8,7 @@ from pydis_site.apps.api.models.utils import ModelReprMixin class User(ModelReprMixin, models.Model): """A Discord user.""" - id = models.BigIntegerField( # noqa + id = models.BigIntegerField( primary_key=True, validators=( MinValueValidator( -- cgit v1.2.3 From 7f799b6ee545a26c3ccc6f087946da54aea11430 Mon Sep 17 00:00:00 2001 From: "S. Co1" Date: Sun, 22 Sep 2019 06:51:55 -0700 Subject: Apply suggestions from code review Co-Authored-By: Mark Co-Authored-By: Sebastiaan Zeeff <33516116+SebastiaanZ@users.noreply.github.com> --- .flake8 | 2 +- pydis_site/apps/api/models/bot/tag.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'pydis_site/apps/api/models') diff --git a/.flake8 b/.flake8 index 66051658..e36c2eb1 100644 --- a/.flake8 +++ b/.flake8 @@ -17,4 +17,4 @@ ignore= # Type Annotations TYP002,TYP003,TYP101,TYP102,TYP204,TYP206 per-file-ignores = - **/tests/**:D101,D102,D103,D105,D106,S106,TYP + **/tests/**:D1,S106,TYP diff --git a/pydis_site/apps/api/models/bot/tag.py b/pydis_site/apps/api/models/bot/tag.py index 792e6b43..5435ee48 100644 --- a/pydis_site/apps/api/models/bot/tag.py +++ b/pydis_site/apps/api/models/bot/tag.py @@ -42,7 +42,7 @@ def validate_tag_embed_fields(fields: dict) -> None: validator(value) -def validate_tag_embed_footer(footer: Any) -> None: +def validate_tag_embed_footer(footer: Dict[str, str]) -> None: """Raises a ValidationError if the given footer is invalid.""" field_validators = { 'text': ( -- cgit v1.2.3 From 5d5ce4b87f138d2ba3ca2be36cf92f0bc8793ca4 Mon Sep 17 00:00:00 2001 From: "S. Co1" Date: Tue, 24 Sep 2019 13:52:32 -0400 Subject: Apply suggestions from code review Co-Authored-By: Mark --- pydis_site/apps/api/models/bot/tag.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'pydis_site/apps/api/models') diff --git a/pydis_site/apps/api/models/bot/tag.py b/pydis_site/apps/api/models/bot/tag.py index 5435ee48..5d4cc393 100644 --- a/pydis_site/apps/api/models/bot/tag.py +++ b/pydis_site/apps/api/models/bot/tag.py @@ -1,5 +1,5 @@ from collections.abc import Mapping -from typing import Any, Dict, List, Union +from typing import Any, Dict from django.contrib.postgres import fields as pgfields from django.core.exceptions import ValidationError @@ -93,7 +93,7 @@ def validate_tag_embed_author(author: Any) -> None: validator(value) -def validate_tag_embed(embed: Dict[str, Union[str, List[dict], dict]]) -> None: +def validate_tag_embed(embed: Any) -> None: """ Validate a JSON document containing an embed as possible to send on Discord. @@ -120,7 +120,7 @@ def validate_tag_embed(embed: Dict[str, Union[str, List[dict], dict]]) -> None: ... Args: - embed (Dict[str, Union[str, List[dict], dict]]): + embed (Any): A dictionary describing the contents of this embed. See the official documentation for a full reference of accepted keys by this dictionary: -- cgit v1.2.3