application.py

"""
Copyright ©2024. The Regents of the University of California (Regents). All Rights Reserved.

Permission to use, copy, modify, and distribute this software and its documentation
for educational, research, and not-for-profit purposes, without fee and without a
signed licensing agreement, is hereby granted, provided that the above copyright
notice, this paragraph and the following two paragraphs appear in all copies,
modifications, and distributions.

Contact The Office of Technology Licensing, UC Berkeley, 2150 Shattuck Avenue,
Suite 510, Berkeley, CA 94720-1620, (510) 643-7201, otl@berkeley.edu,
http://ipira.berkeley.edu/industry-info for commercial licensing opportunities.

IN NO EVENT SHALL REGENTS BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL,
INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF
THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF REGENTS HAS BEEN ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.

REGENTS SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED
"AS IS". REGENTS HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.
"""

import os
import socket
import subprocess

import eventlet
from eventlet.green import ssl
# https://eventlet.net/doc/patching.html
eventlet.monkey_patch()
# https://github.com/eventlet/eventlet/issues/692
ssl.timeout_exc = socket.timeout

from squiggy.factory import create_app  # noqa E402

"""Squiggy says HELLO!

Usage mode A:

>>> python application.py

Usage mode B:

>>> export FLASK_APP=application.py
>>> flask run --help
>>> flask run --debugger
>>> flask initdb
"""

# When running under WSGI, system environment variables are not automatically made available to Python code, and
# an app restart will result in configurations being lost. We work around this with an explicit load from the shell
# environment.
if __name__.startswith('_mod_wsgi'):
    command = ['bash', '-c', 'env']
    shell_environment = subprocess.Popen(command, stdout=subprocess.PIPE)
    for line in shell_environment.stdout:
        key, _, value = line.decode('utf-8').rstrip().partition('=')
        os.environ[key] = value

application, socketio = create_app()


@application.cli.command()
def initdb():
    from squiggy.models import development_db
    development_db.load()


host = application.config['HOST']
port = application.config['PORT']

if __name__ == '__main__':
    application.logger.info('Starting development server on %s:%s', host, port)
    is_socket_debug_mode = application.config['SOCKET_IO_DEBUG_MODE']
    if application.config['VUE_LOCALHOST_BASE_URL']:
        # TODO: PyCharm cannot run Squiggy in debug mode when 'SOCKET_IO_DEBUG_MODE' is True. Why?
        socketio.run(
            app=application,
            debug=is_socket_debug_mode,
            log_output=is_socket_debug_mode,
        )
elif __name__.startswith('_mod_wsgi'):
    application.logger.info('Will start WSGI server on %s:%s', host, port)