Merge pull request #17 from Segelzwerg/develop-39python

develop/prepare-39

Author: Marcel

.github/workflows/python-check.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-18.04, ubuntu-20.04]
-        python-version: [3.8]
+        python-version: [3.9]
       fail-fast: false
       max-parallel: 4
     runs-on: ${{matrix.os}}
@@ -32,14 +32,14 @@ jobs:
         run: |
           python --version
           python3 --version
+          sudo apt-get update
           sudo apt-get install ffmpeg
-          python3 -m pip install --upgrade pip setuptools
           python3 -m pip install -r requirements.txt
           
       - name: Python Pylint Github Action
         run: |
           python3 -m pylint --version
-          python3 -m pylint --load-plugins pylint_flask_sqlalchemy --rcfile=.pylintrc -j 2 family_foto tests
+          python3 -m pylint --load-plugins=pylint_flask,pylint_flask_sqlalchemy --rcfile=.pylintrc family_foto tests
           
       - name: Python Pytest with Coverage
         run: |

.gitignore

@@ -1,6 +1,17 @@
-# Project exclude paths
-/venv/
-/.idea/
-/app.db
-/coverage.xml
-/.coverage
+venv*/
+.idea/
+app.db
+coverage.xml
+.coverage
+
+*.pyc
+__pycache__/
+
+instance/
+
+.pytest_cache/
+htmlcov/
+
+dist/
+build/
+*.egg-info/

family_foto/__init__.py

@@ -0,0 +1,112 @@
+import os
+from typing import Any
+
+import flask_uploads
+from flask import Flask
+from flask_debugtoolbar import DebugToolbarExtension
+from flask_login import LoginManager
+
+from family_foto.const import UPLOADED_PHOTOS_DEST_RELATIVE, UPLOADED_VIDEOS_DEST_RELATIVE, \
+    RESIZED_DEST_RELATIVE, RESIZED_DEST
+from family_foto.logger import log
+from family_foto.models import db
+from family_foto.models.user import User
+from family_foto.models.user_settings import UserSettings
+
+login_manager = LoginManager()
+
+
+# pylint: disable=import-outside-toplevel
+def create_app(test_config: dict[str, Any] = None, test_instance_path: str = None) -> Flask:
+    """
+    Create the Flask application.
+    :param test_config: config override
+    :param test_instance_path: instance path override
+    :return: the configured app
+    """
+    # create and configure the app
+    app = Flask(__name__, instance_relative_config=True, instance_path=test_instance_path)
+    app.config.from_mapping(
+        SECRET_KEY=os.environ.get('SECRET_KEY') or 'very-secret-key',
+        DATABASE_URL_TEMPLATE='sqlite:///{instance_path}/app.db',
+        SQLALCHEMY_TRACK_MODIFICATIONS=False,
+        UPLOADED_PHOTOS_DEST_RELATIVE='photos',
+        UPLOADED_VIDEOS_DEST_RELATIVE='videos',
+        RESIZED_DEST_RELATIVE='resized-images'
+    )
+
+    if test_config is None:
+        # load the instance config, if it exists, when not testing
+        app.config.from_pyfile('config.py', silent=True)
+    else:
+        # load the test config if passed in
+        app.config.from_mapping(test_config)
+
+    app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('DATABASE_URL') or app.config[
+        'DATABASE_URL_TEMPLATE'].format(instance_path=app.instance_path)
+    app.config['UPLOADED_PHOTOS_DEST'] = os.path.join(app.instance_path,
+                                                      app.config[UPLOADED_PHOTOS_DEST_RELATIVE])
+    app.config['UPLOADED_VIDEOS_DEST'] = os.path.join(app.instance_path,
+                                                      app.config[UPLOADED_VIDEOS_DEST_RELATIVE])
+    app.config[RESIZED_DEST] = os.path.join(app.instance_path,
+                                            app.config[RESIZED_DEST_RELATIVE])
+
+    # ensure the instance folder exists
+    try:
+        os.makedirs(app.instance_path)
+    except OSError:
+        pass
+
+    _ = DebugToolbarExtension(app)
+
+    from family_foto.api import api_bp
+    app.register_blueprint(api_bp)
+
+    from family_foto.web import web_bp
+    app.register_blueprint(web_bp)
+
+    db.init_app(app)
+    db.app = app
+    db.create_all()
+
+    login_manager.init_app(app)
+
+    from family_foto.web import photos, videos
+    flask_uploads.configure_uploads(app, (photos, videos))
+
+    add_user('admin', 'admin')
+
+    return app
+
+
+def add_user(username: str, password: str) -> User:
+    """
+    This registers an user.
+    :param username: name of the user
+    :param password: plain text password
+    """
+    user = User(username=username)
+    user.set_password(password)
+    exists = User.query.filter_by(username=username).first()
+    if exists:
+        log.warning(f'{user.username} already exists.')
+        return exists
+
+    user_settings = UserSettings(user_id=user.id)
+    user.settings = user_settings
+
+    db.session.add(user_settings)
+    db.session.add(user)
+    db.session.commit()
+    log.info(f'{user.username} registered.')
+    return user
+
+
+@login_manager.user_loader
+def load_user(user_id: int):
+    """
+    Loads a user from the database.
+    :param user_id:
+    :return: An user if exists.
+    """
+    return User.query.get(int(user_id))

family_foto/api/__init__.py

@@ -1,7 +1,3 @@
 from flask import Blueprint
 
-api = Blueprint('api', __name__)
-
-# avoid circular imports
-# pylint: disable=wrong-import-position
-from family_foto.api import errors, auth
+api_bp = Blueprint('api', __name__, url_prefix='/api')

family_foto/api/auth.py

@@ -1,10 +1,8 @@
-from typing import Union
-
 from flask import jsonify
 from flask_httpauth import HTTPBasicAuth, HTTPTokenAuth
 from flask_login import current_user
 
-from family_foto.api import api
+from family_foto.api import api_bp
 from family_foto.api.errors import error_response
 from family_foto.logger import log
 from family_foto.models import db
@@ -15,7 +13,7 @@
 token_auth = HTTPTokenAuth()
 
 
-@api.route('/token', methods=['POST'])
+@api_bp.route('/token', methods=['POST'])
 @basic_auth.login_required
 def get_token():
     """
@@ -29,7 +27,7 @@ def get_token():
 
 
 @basic_auth.verify_password
-def verify_password(username: str, password: str) -> Union[None, User]:
+def verify_password(username: str, password: str) -> [None, User]:
     """
     Verifies the password for given user.
     :param username: the username string

family_foto/api/errors.py

@@ -8,7 +8,7 @@ def error_response(status_code: int, message: str = None):
     :param status_code: http error code
     :param message: optional message
     """
-    payload = {'error': HTTP_STATUS_CODES.get(status_code, 'Unkown error')}
+    payload = {'error': HTTP_STATUS_CODES.get(status_code, 'Unknown error')}
     if message:
         payload['message'] = message
     response = jsonify(payload)

family_foto/config.py

@@ -0,0 +1,8 @@
+UPLOADED_PHOTOS_DEST = 'UPLOADED_PHOTOS_DEST'
+UPLOADED_PHOTOS_DEST_RELATIVE = 'UPLOADED_PHOTOS_DEST_RELATIVE'
+
+UPLOADED_VIDEOS_DEST = 'UPLOADED_VIDEOS_DEST'
+UPLOADED_VIDEOS_DEST_RELATIVE = 'UPLOADED_VIDEOS_DEST_RELATIVE'
+
+RESIZED_DEST = 'RESIZED_DEST'
+RESIZED_DEST_RELATIVE = 'RESIZED_DEST_RELATIVE'

family_foto/const.py

@@ -1,9 +1,10 @@
-from wtforms import SelectMultipleField, widgets
+from wtforms import SelectMultipleField
+from wtforms.widgets import ListWidget, CheckboxInput
 
 
 class MultiCheckboxField(SelectMultipleField):
     """
     Field for selecting multiple fields from checkbox list.
     """
-    widget = widgets.ListWidget(html_tag='ul', prefix_label=False)
-    option_widget = widgets.CheckboxInput()
+    widget = ListWidget(html_tag='ul', prefix_label=False)
+    option_widget = CheckboxInput()

family_foto/forms/fields/multi_checkbox_field.py

@@ -7,8 +7,6 @@ class UploadForm(FlaskForm):
     """
     Data form of upload mask.
     """
-    file = MultipleFileField('File',
-                             validators=[FileRequired(),
-                                         FileAllowed(['jpg', 'png'],
-                                                     'Images Only!')])
+    file = MultipleFileField('File', validators=[FileRequired(),
+                                                 FileAllowed(['jpg', 'png'], 'Images Only!')])
     submit = SubmitField('Upload')

family_foto/forms/upload_form.py

@@ -3,6 +3,7 @@
 from datetime import datetime
 from typing import List, Union
 
+from flask import current_app
 from sqlalchemy import ForeignKey
 from sqlalchemy.orm import relationship
 
@@ -36,21 +37,22 @@ def path(self):
         """
         Path of the file on the server.
         """
-        raise NotImplementedError('Each file type has it\'s directory.')
+        raise NotImplementedError('Each file type has its directory.')
 
     @property
     def abs_path(self):
         """
         Returns absolute path of the photo.
         """
-        return os.path.abspath(f'/photo/{self.filename}')
+        return os.path.abspath(os.path.join(current_app.instance_path, self.path))
 
     @property
+    @abstractmethod
     def image_view(self):
         """
         Returns path to image viewer template of this photo.
         """
-        return f'/image/{self.filename}'
+        raise NotImplementedError('Each file type has its directory.')
 
     @property
     @abstractmethod
@@ -61,18 +63,20 @@ def meta(self):
         raise NotImplementedError('Each media type has is custom meta data retriever.')
 
     @property
+    @abstractmethod
     def height(self):
         """
         Returns the image height.
         """
-        return int(self.meta['ExifImageHeight'])
+        raise NotImplementedError('Each media type has is custom meta data retriever.')
 
     @property
+    @abstractmethod
     def width(self):
         """
         Returns image width
         """
-        return int(self.meta['ExifImageWidth'])
+        raise NotImplementedError('Each media type has is custom meta data retriever.')
 
     @abstractmethod
     def thumbnail(self, width: int, height: int):
@@ -81,7 +85,7 @@ def thumbnail(self, width: int, height: int):
         :param width: thumbnail width in pixel
         :param height: thumbnail height in pixel (aspect ratio will be kept)
         """
-        raise NotImplementedError(f'{self} is abstract and not thumbnail() is not implemented.')
+        raise NotImplementedError(f'{self} is abstract and thumbnail() is not implemented.')
 
     def share_with(self, other_users: Union[User, List[User]]) -> None:
         """