Skip to content

Commit

Permalink
docs: update dev docs, specifically on running the Python linter (#2103)
Browse files Browse the repository at this point in the history
  • Loading branch information
@nicomiguelino
nicomiguelino authored Oct 30, 2024
1 parent 70afe9b commit c8c8604
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 31 deletions.
65 changes: 36 additions & 29 deletions api/serializers.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,22 @@ class AssetRequestSerializer(Serializer):
uri = CharField()
start_date = DateTimeField(default_timezone=timezone.utc)
end_date = DateTimeField(default_timezone=timezone.utc)
duration = IntegerField()
duration = CharField()
mimetype = CharField()
is_enabled = BooleanField()
nocache = BooleanField()
is_enabled = IntegerField(min_value=0, max_value=1)
nocache = IntegerField(min_value=0, max_value=1)
play_order = IntegerField()
skip_asset_check = BooleanField()
skip_asset_check = IntegerField(min_value=0, max_value=1)


class AssetSerializer(ModelSerializer):
duration = CharField()
is_enabled = IntegerField(min_value=0, max_value=1)
is_active = IntegerField(min_value=0, max_value=1)
is_processing = IntegerField(min_value=0, max_value=1)
nocache = IntegerField(min_value=0, max_value=1)
skip_asset_check = IntegerField(min_value=0, max_value=1)

class Meta:
model = Asset
fields = [
Expand Down Expand Up @@ -61,13 +68,13 @@ def __init__(self, *args, unique_name=False, **kwargs):
uri = CharField()
start_date = DateTimeField(default_timezone=timezone.utc, required=False)
end_date = DateTimeField(default_timezone=timezone.utc, required=False)
duration = IntegerField(required=False)
duration = CharField(required=False)
mimetype = CharField()
is_enabled = BooleanField(required=False)
is_processing = BooleanField(required=False)
is_enabled = IntegerField(min_value=0, max_value=1, required=False)
is_processing = IntegerField(min_value=0, max_value=1, required=False)
nocache = BooleanField(required=False)
play_order = IntegerField(required=False)
skip_asset_check = BooleanField(required=False)
skip_asset_check = IntegerField(min_value=0, max_value=1, required=False)

def validate(self, data):
name = data['name']
Expand All @@ -89,9 +96,9 @@ def validate(self, data):
'name': name,
'mimetype': data.get('mimetype'),
'asset_id': data.get('asset_id'),
'is_enabled': data.get('is_enabled', False),
'is_processing': data.get('is_processing', False),
'nocache': data.get('nocache', False),
'is_enabled': data.get('is_enabled', 0),
'is_processing': data.get('is_processing', 0),
'nocache': data.get('nocache', 0),
}

uri = data.get('uri')
Expand Down Expand Up @@ -119,14 +126,14 @@ def validate(self, data):
asset['uri'] = uri

if "video" in asset['mimetype']:
if data.get('duration') == 0:
if int(data.get('duration')) == 0:
asset['duration'] = int(
get_video_duration(uri).total_seconds())
else:
# Crashes if it's not an int. We want that.
asset['duration'] = data.get('duration')
asset['duration'] = int(data.get('duration'))

asset['skip_asset_check'] = data.get('skip_asset_check', False)
asset['skip_asset_check'] = int(data.get('skip_asset_check', 0))

if data.get('start_date'):
asset['start_date'] = data.get('start_date').replace(tzinfo=None)
Expand Down Expand Up @@ -155,13 +162,13 @@ def __init__(self, *args, unique_name=False, **kwargs):
uri = CharField()
start_date = DateTimeField(default_timezone=timezone.utc)
end_date = DateTimeField(default_timezone=timezone.utc)
duration = IntegerField()
duration = CharField()
mimetype = CharField()
is_enabled = BooleanField()
is_processing = BooleanField(required=False)
nocache = BooleanField(required=False)
is_enabled = IntegerField(min_value=0, max_value=1)
is_processing = IntegerField(min_value=0, max_value=1, required=False)
nocache = IntegerField(min_value=0, max_value=1, required=False)
play_order = IntegerField(required=False)
skip_asset_check = BooleanField(required=False)
skip_asset_check = IntegerField(min_value=0, max_value=1, required=False)

def prepare_asset(self, data, asset_id=None):
ampersand_fix = '&'
Expand All @@ -182,8 +189,8 @@ def prepare_asset(self, data, asset_id=None):
asset = {
'name': name,
'mimetype': data.get('mimetype'),
'is_enabled': data.get('is_enabled', False),
'nocache': data.get('nocache', False),
'is_enabled': data.get('is_enabled', 0),
'nocache': data.get('nocache', 0),
}

uri = (
Expand Down Expand Up @@ -217,17 +224,17 @@ def prepare_asset(self, data, asset_id=None):
uri, asset['name'], asset['duration']
) = download_video_from_youtube(uri, asset['asset_id'])
asset['mimetype'] = 'video'
asset['is_processing'] = True
asset['is_processing'] = 1

asset['uri'] = uri

if "video" in asset['mimetype']:
if data.get('duration') == 0:
if int(data.get('duration')) == 0:
asset['duration'] = int(
get_video_duration(uri).total_seconds())
elif data.get('duration'):
# Crashes if it's not an int. We want that.
asset['duration'] = data.get('duration')
asset['duration'] = int(data.get('duration'))
else:
asset['duration'] = 10

Expand Down Expand Up @@ -257,12 +264,12 @@ class UpdateAssetSerializer(Serializer):
name = CharField()
start_date = DateTimeField(default_timezone=timezone.utc)
end_date = DateTimeField(default_timezone=timezone.utc)
duration = IntegerField()
is_enabled = BooleanField()
is_processing = BooleanField(required=False)
nocache = BooleanField(required=False)
duration = CharField()
is_enabled = IntegerField(min_value=0, max_value=1)
is_processing = IntegerField(min_value=0, max_value=1, required=False)
nocache = IntegerField(min_value=0, max_value=1, required=False)
play_order = IntegerField(required=False)
skip_asset_check = BooleanField(required=False)
skip_asset_check = IntegerField(min_value=0, max_value=1, required=False)

def update(self, instance, validated_data):
instance.name = validated_data.get('name', instance.name)
Expand Down
2 changes: 1 addition & 1 deletion api/tests.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ def test_update_asset_should_return_updated_asset(self, version):

self.assertEqual(updated_asset['name'], 'Anthias')
self.assertEqual(updated_asset['uri'], 'https://anthias.screenly.io')
self.assertEqual(updated_asset['duration'], 15)
self.assertEqual(updated_asset['duration'], '15')
self.assertEqual(updated_asset['is_enabled'], 1)
self.assertEqual(updated_asset['play_order'], 0)

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-documentation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ After installing Poetry, run the following commands:
```bash
# Install the dependencies
$ poetry install --only=dev-host
$ poetry run flake8 $(git ls-files '**/*.py')
$ poetry run flake8 $(git ls-files '*.py')
```

To run the linter on a specific file, run the following command:
Expand Down

0 comments on commit c8c8604

Please sign in to comment.