From bcbdddb33a25272f74037623da9d5e9b72d2b54e Mon Sep 17 00:00:00 2001 From: NatSquared Date: Mon, 11 Mar 2024 15:54:16 -0700 Subject: [PATCH] Flake8 validation - attempt 1 --- .../src/met_api/models/engagement_metadata.py | 3 ++- met-api/src/met_api/resources/metadata_taxon.py | 1 + .../src/met_api/schemas/engagement_metadata.py | 14 ++++++-------- .../unit/models/test_engagement_metadata.py | 16 ++++++++-------- .../unit/services/test_engagement_metadata.py | 2 +- met-api/tests/utilities/factory_utils.py | 5 ++--- 6 files changed, 20 insertions(+), 21 deletions(-) diff --git a/met-api/src/met_api/models/engagement_metadata.py b/met-api/src/met_api/models/engagement_metadata.py index 63497c1bc..a1c3139e5 100644 --- a/met-api/src/met_api/models/engagement_metadata.py +++ b/met-api/src/met_api/models/engagement_metadata.py @@ -144,7 +144,8 @@ def __repr__(self) -> str: @property def preset_values(self) -> list[str]: - # Get preset values - any metadata entries with no specific engagement + """Get preset values - any metadata entries with no specific engagement + """ return [entry.value for entry in self.entries if entry.engagement_id is None] @preset_values.setter diff --git a/met-api/src/met_api/resources/metadata_taxon.py b/met-api/src/met_api/resources/metadata_taxon.py index b378665bc..c4fb68b73 100644 --- a/met-api/src/met_api/resources/metadata_taxon.py +++ b/met-api/src/met_api/resources/metadata_taxon.py @@ -79,6 +79,7 @@ def ensure_tenant_access(): """ Provide access to the tenant as a DB model for the decorated function. + This does not provide security; that is handled by @require_role. """ def wrapper(f: Callable): diff --git a/met-api/src/met_api/schemas/engagement_metadata.py b/met-api/src/met_api/schemas/engagement_metadata.py index 5611ca50c..12468ea6a 100644 --- a/met-api/src/met_api/schemas/engagement_metadata.py +++ b/met-api/src/met_api/schemas/engagement_metadata.py @@ -1,9 +1,5 @@ -""" -Schemas for serializing and deserializing classes related to engagement metadata. -""" +"""Schemas for serializing and deserializing classes related to engagement metadata.""" -from met_api.models.engagement_metadata import (EngagementMetadata, - MetadataTaxon, MetadataTaxonDataType) from marshmallow import ValidationError, fields, pre_load, validate from marshmallow_sqlalchemy import SQLAlchemyAutoSchema from marshmallow_sqlalchemy.fields import Nested @@ -64,12 +60,14 @@ class Meta: 'get_preset_values', deserialize='set_preset_values') def get_preset_values(self, obj): - # This method is used by Marshmallow to serialize the preset_values property + """This method is used by Marshmallow to serialize the preset_values property + """ return obj.preset_values def set_preset_values(self, values): - # Deserialize the preset_values into a list of strings. - # The rest is handled in the preset_values property setter. + """Deserialize the preset_values into a list of strings. + The rest is handled in the preset_values property setter. + """ return [str(value) for value in values] @pre_load diff --git a/met-api/tests/unit/models/test_engagement_metadata.py b/met-api/tests/unit/models/test_engagement_metadata.py index c4cead08d..7f72de2ec 100644 --- a/met-api/tests/unit/models/test_engagement_metadata.py +++ b/met-api/tests/unit/models/test_engagement_metadata.py @@ -11,9 +11,7 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. -""" -Tests for the EngagementMetadata model. -""" +"""Tests for the EngagementMetadata model.""" from faker import Faker @@ -35,7 +33,8 @@ def test_create_basic_engagement_metadata(session): }) assert engagement_metadata.id is not None, ( 'Engagement Metadata ID is missing') - engagement_metadata_existing = EngagementMetadata.find_by_id(engagement_metadata.id) + engagement_metadata_existing = EngagementMetadata.find_by_id( + engagement_metadata.id) assert engagement_metadata.value == engagement_metadata_existing.value, ( 'Engagement Metadata value is missing or incorrect') @@ -75,10 +74,11 @@ def test_create_engagement_metadata(session): 'value': fake.text(max_nb_chars=256) }) assert engagement_metadata.id is not None, 'Engagement Metadata ID is missing' - engagement_metadata_existing = EngagementMetadata.find_by_id(engagement_metadata.id) + engagement_metadata_existing = EngagementMetadata.find_by_id( + engagement_metadata.id) assert engagement_metadata.value == engagement_metadata_existing.value, ( - 'Engagement Metadata value is missing or incorrect') + 'Engagement Metadata value is missing or incorrect') assert engagement_metadata.taxon_id == engagement_metadata_existing.taxon_id, ( - 'Engagement Metadata taxon ID is missing or incorrect') + 'Engagement Metadata taxon ID is missing or incorrect') assert engagement_metadata.engagement_id == engagement_metadata_existing.engagement_id, ( - 'Engagement Metadata engagement ID is missing or incorrect') + 'Engagement Metadata engagement ID is missing or incorrect') diff --git a/met-api/tests/unit/services/test_engagement_metadata.py b/met-api/tests/unit/services/test_engagement_metadata.py index 90f92384a..b7c8b4f03 100644 --- a/met-api/tests/unit/services/test_engagement_metadata.py +++ b/met-api/tests/unit/services/test_engagement_metadata.py @@ -125,7 +125,7 @@ def test_bulk_update_engagement_metadata(session): assert len(metadata_updated_2) == 5 # and the values should be updated again for i, meta in enumerate(metadata_updated_2): - assert meta['value'] == new_values_2[i], f"{meta}, {new_values_2[i]}" + assert meta['value'] == new_values_2[i], f'{meta}, {new_values_2[i]}' def test_delete_engagement_metadata(session): diff --git a/met-api/tests/utilities/factory_utils.py b/met-api/tests/utilities/factory_utils.py index b70424e3b..e6452ca58 100644 --- a/met-api/tests/utilities/factory_utils.py +++ b/met-api/tests/utilities/factory_utils.py @@ -22,7 +22,6 @@ from met_api.auth import Auth from met_api.config import get_named_config -from met_api.constants.email_verification import EmailVerificationType from met_api.constants.engagement_status import Status from met_api.constants.widget import WidgetType from met_api.models import Tenant @@ -55,7 +54,6 @@ from met_api.models.widget_video import WidgetVideo as WidgetVideoModel from met_api.utils.constants import TENANT_ID_HEADER from met_api.utils.enums import MembershipStatus -from met_api.constants.email_verification import EmailVerificationType from tests.utilities.factory_scenarios import ( TestCommentInfo, TestEngagementInfo, TestEngagementMetadataInfo, TestEngagementMetadataTaxonInfo, TestEngagementSlugInfo, TestFeedbackInfo, TestJwtClaims, TestLanguageInfo, TestParticipantInfo, TestPollAnswerInfo, @@ -608,7 +606,8 @@ def factory_survey_translation_and_engagement_model(): survey_id=survey.id, language_id=lang.id, name=TestSurveyTranslationInfo.survey_translation1.get('name'), - form_json=TestSurveyTranslationInfo.survey_translation1.get('form_json'), + form_json=TestSurveyTranslationInfo.survey_translation1.get( + 'form_json'), ) translation.save() return translation, survey, lang