config
Description
Module loads the application’s configuration.
The extension and custom configurations are defined here.
Classes
|
Default configuration options. |
Development configuration options. |
|
|
Metaclass for updating Config options. |
Production configuration options. |
|
Testing configuration options. |
- class config.Config
Default configuration options.
- ALLOWED_CONTENT_TYPES = {'application/json', 'application/octet-stream', 'multipart/form-data'}
- ALLOWED_MIME_TYPES = {'application/pdf', 'application/vnd.ms-excel'}
- DATABASE = {'engine': 'peewee.SqliteDatabase', 'name': None, 'pragmas': {'cache_size': -64000, 'foreign_keys': 1, 'ignore_check_constraints': 0, 'journal_mode': 'wal', 'synchronous': 0}}
- DEBUG = False
- DEVELOPMENT = False
- FLASK_RESTFUL_PREFIX = '/api'
- HOME = '/home/docs'
- LOGIN_DISABLED = False
- LOG_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest/log'
- MAIL_PASSWORD = None
- MAIL_PORT = None
- MAIL_SERVER = None
- MAIL_USERNAME = None
- MAIL_USE_SSL = False
- MAIL_USE_TLS = True
- MOCKUP_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest/storage/mockups'
- RESET_TOKEN_EXPIRES = 86400
- RESTX_ERROR_404_HELP = False
- RESTX_MASK_SWAGGER = False
- ROOT_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest'
- SECRET_KEY = None
- SECURITY_PASSWORD_HASH = 'pbkdf2_sha512'
- SECURITY_PASSWORD_LENGTH_MIN = 8
- SECURITY_PASSWORD_SALT = None
- SECURITY_TOKEN_AUTHENTICATION_HEADER = 'Authorization'
- SECURITY_TOKEN_MAX_AGE = None
- SERVER_NAME = None
- STORAGE_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest/storage'
- SWAGGER_API_URL = 'http://None/static/swagger.yaml'
- SWAGGER_URL = '/docs'
- TESTING = False
- TEST_USER_EMAIL = None
- TEST_USER_PASSWORD = None
- accept_content = ['json']
- broker_url = 'pyamqp://'
- enable_utc = True
- include = ['app.celery.tasks']
- result_backend = 'amqp://'
- result_expires = 3600
- result_extended = True
- result_serializer = 'json'
- task_always_eager = False
- task_default_rate_limit = 3
- task_serializer = 'json'
- task_track_started = True
- timezone = 'UTC'
- worker_log_format = '%(asctime)s - %(levelname)s - %(processName)s - %(message)s'
- worker_task_log_format = '%(asctime)s - %(levelname)s - %(processName)s - %(task_name)s - %(task_id)s - %(message)s'
- class config.DevConfig
Development configuration options.
- ALLOWED_CONTENT_TYPES = {'application/json', 'application/octet-stream', 'multipart/form-data'}
- ALLOWED_MIME_TYPES = {'application/pdf', 'application/vnd.ms-excel'}
- DATABASE = {'engine': 'peewee.SqliteDatabase', 'name': None, 'pragmas': {'cache_size': -64000, 'foreign_keys': 1, 'ignore_check_constraints': 0, 'journal_mode': 'wal', 'synchronous': 0}}
- DEBUG = True
- DEVELOPMENT = True
- FLASK_RESTFUL_PREFIX = '/api'
- HOME = '/home/docs'
- LOGIN_DISABLED = False
- LOG_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest/log'
- MAIL_PASSWORD = None
- MAIL_PORT = None
- MAIL_SERVER = None
- MAIL_USERNAME = None
- MAIL_USE_SSL = False
- MAIL_USE_TLS = True
- MOCKUP_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest/storage/mockups'
- RESET_TOKEN_EXPIRES = 86400
- RESTX_ERROR_404_HELP = False
- RESTX_MASK_SWAGGER = False
- ROOT_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest'
- SECRET_KEY = None
- SECURITY_PASSWORD_HASH = 'pbkdf2_sha512'
- SECURITY_PASSWORD_LENGTH_MIN = 8
- SECURITY_PASSWORD_SALT = None
- SECURITY_TOKEN_AUTHENTICATION_HEADER = 'Authorization'
- SECURITY_TOKEN_MAX_AGE = None
- SERVER_NAME = None
- STORAGE_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest/storage'
- SWAGGER_API_URL = 'http://None/static/swagger.yaml'
- SWAGGER_URL = '/docs'
- TESTING = False
- TEST_USER_EMAIL = None
- TEST_USER_PASSWORD = None
- accept_content = ['json']
- broker_url = 'pyamqp://'
- enable_utc = True
- include = ['app.celery.tasks']
- result_backend = 'amqp://'
- result_expires = 3600
- result_extended = True
- result_serializer = 'json'
- task_always_eager = False
- task_default_rate_limit = 3
- task_serializer = 'json'
- task_track_started = True
- timezone = 'UTC'
- worker_log_format = '%(asctime)s - %(levelname)s - %(processName)s - %(message)s'
- worker_task_log_format = '%(asctime)s - %(levelname)s - %(processName)s - %(task_name)s - %(task_id)s - %(message)s'
- class config.Meta(name: str, bases: tuple, dict: dict)
Metaclass for updating Config options.
- classmethod _rename_celery_settings(config: type) None
Rename old Celery setting names with new ones.
References
https://docs.celeryproject.org/en/latest/userguide/configuration.html#new-lowercase-settings
- mro()
Return a type’s method resolution order.
- class config.ProdConfig
Production configuration options.
- ALLOWED_CONTENT_TYPES = {'application/json', 'application/octet-stream', 'multipart/form-data'}
- ALLOWED_MIME_TYPES = {'application/pdf', 'application/vnd.ms-excel'}
- DATABASE = {'engine': 'peewee.SqliteDatabase', 'name': None, 'pragmas': {'cache_size': -64000, 'foreign_keys': 1, 'ignore_check_constraints': 0, 'journal_mode': 'wal', 'synchronous': 0}}
- DEBUG = False
- DEVELOPMENT = False
- FLASK_RESTFUL_PREFIX = '/api'
- HOME = '/home/docs'
- LOGIN_DISABLED = False
- LOG_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest/log'
- MAIL_PASSWORD = None
- MAIL_PORT = None
- MAIL_SERVER = None
- MAIL_USERNAME = None
- MAIL_USE_SSL = False
- MAIL_USE_TLS = True
- MOCKUP_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest/storage/mockups'
- RESET_TOKEN_EXPIRES = 86400
- RESTX_ERROR_404_HELP = False
- RESTX_MASK_SWAGGER = False
- ROOT_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest'
- SECRET_KEY = None
- SECURITY_PASSWORD_HASH = 'pbkdf2_sha512'
- SECURITY_PASSWORD_LENGTH_MIN = 8
- SECURITY_PASSWORD_SALT = None
- SECURITY_TOKEN_AUTHENTICATION_HEADER = 'Authorization'
- SECURITY_TOKEN_MAX_AGE = None
- SERVER_NAME = None
- STORAGE_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest/storage'
- SWAGGER_API_URL = 'http://None/static/swagger.yaml'
- SWAGGER_URL = '/docs'
- TESTING = False
- TEST_USER_EMAIL = None
- TEST_USER_PASSWORD = None
- accept_content = ['json']
- broker_url = 'pyamqp://'
- enable_utc = True
- include = ['app.celery.tasks']
- result_backend = 'amqp://'
- result_expires = 3600
- result_extended = True
- result_serializer = 'json'
- task_always_eager = False
- task_default_rate_limit = 3
- task_serializer = 'json'
- task_track_started = True
- timezone = 'UTC'
- worker_log_format = '%(asctime)s - %(levelname)s - %(processName)s - %(message)s'
- worker_task_log_format = '%(asctime)s - %(levelname)s - %(processName)s - %(task_name)s - %(task_id)s - %(message)s'
- class config.TestConfig
Testing configuration options.
- ALLOWED_CONTENT_TYPES = {'application/json', 'application/octet-stream', 'multipart/form-data'}
- ALLOWED_MIME_TYPES = {'application/pdf', 'application/vnd.ms-excel'}
- DATABASE = {'engine': 'peewee.SqliteDatabase', 'name': 'test.db', 'pragmas': {'cache_size': -64000, 'foreign_keys': 1, 'ignore_check_constraints': 0, 'journal_mode': 'wal', 'synchronous': 0}}
- DEBUG = True
- DEVELOPMENT = True
- FLASK_RESTFUL_PREFIX = '/api'
- HOME = '/home/docs'
- LOGIN_DISABLED = False
- LOG_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest/log'
- MAIL_PASSWORD = None
- MAIL_PORT = None
- MAIL_SERVER = None
- MAIL_USERNAME = None
- MAIL_USE_SSL = False
- MAIL_USE_TLS = True
- MOCKUP_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest/storage/mockups'
- RESET_TOKEN_EXPIRES = 86400
- RESTX_ERROR_404_HELP = False
- RESTX_MASK_SWAGGER = False
- ROOT_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest'
- SECRET_KEY = None
- SECURITY_PASSWORD_HASH = 'pbkdf2_sha512'
- SECURITY_PASSWORD_LENGTH_MIN = 8
- SECURITY_PASSWORD_SALT = None
- SECURITY_TOKEN_AUTHENTICATION_HEADER = 'Authorization'
- SECURITY_TOKEN_MAX_AGE = None
- SERVER_NAME = None
- STORAGE_DIRECTORY = '/home/docs/checkouts/readthedocs.org/user_builds/flask-api/checkouts/latest/storage/tests'
- SWAGGER_API_URL = 'http://None/static/swagger.yaml'
- SWAGGER_URL = '/docs'
- TESTING = True
- TEST_USER_EMAIL = None
- TEST_USER_PASSWORD = None
- accept_content = ['json']
- broker_url = 'pyamqp://'
- enable_utc = True
- include = ['app.celery.tasks']
- result_backend = 'amqp://'
- result_expires = 3600
- result_extended = True
- result_serializer = 'json'
- task_always_eager = False
- task_default_rate_limit = 3
- task_serializer = 'json'
- task_track_started = True
- timezone = 'UTC'
- worker_log_format = '%(asctime)s - %(levelname)s - %(processName)s - %(message)s'
- worker_task_log_format = '%(asctime)s - %(levelname)s - %(processName)s - %(task_name)s - %(task_id)s - %(message)s'