Use singular for enum

flaskbb/fixtures/settings.py

@@ -13,7 +13,7 @@ from flaskbb.utils.helpers import \
     get_available_languages as available_languages, \
     get_available_themes as available_themes
 
-from flaskbb.utils.forms import SettingsValueTypes
+from flaskbb.utils.forms import SettingValueType
 
 
 def available_avatar_types():
@@ -28,33 +28,33 @@ fixture = (
         'settings': (
             ('project_title', {
                 'value':        "FlaskBB",
-                'value_type':   SettingsValueTypes.string,
+                'value_type':   SettingValueType.string,
                 'name':         "Project title",
                 'description':  "The title of the project.",
             }),
             ('project_subtitle', {
                 'value':        "A lightweight forum software in Flask",
-                'value_type':   SettingsValueTypes.string,
+                'value_type':   SettingValueType.string,
                 'name':         "Project subtitle",
                 'description':  "A short description of the project.",
             }),
             ('posts_per_page', {
                 'value':        10,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {'min': 5},
                 'name':         "Posts per page",
                 'description':  "Number of posts displayed per page.",
             }),
             ('topics_per_page', {
                 'value':        10,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {'min': 5},
                 'name':         "Topics per page",
                 'description':  "Number of topics displayed per page.",
             }),
             ('users_per_page', {
                 'value':        10,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {'min': 5},
                 'name':         "Users per page",
                 'description':  "Number of users displayed per page.",
@@ -67,79 +67,79 @@ fixture = (
         'settings': (
             ('registration_enabled', {
                 'value':        True,
-                'value_type':   SettingsValueTypes.boolean,
+                'value_type':   SettingValueType.boolean,
                 'name':         "Enable Registration",
                 'description':  "Enable or disable the registration",
             }),
             ('activate_account', {
                 'value':        True,
-                'value_type':   SettingsValueTypes.boolean,
+                'value_type':   SettingValueType.boolean,
                 'name':         "Enable Account Activation",
                 'description':  "Enable to let the user activate their account by sending a email with an activation link."
             }),
             ('auth_username_min_length', {
                 'value':        3,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {'min': 0},
                 'name':         "Username Minimum Length",
                 'description':  "The minimum length of the username. Changing this will only affect new registrations.",
             }),
             ('auth_username_max_length', {
                 'value':        20,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {'min': 0},
                 'name':         "Username Maximum Length",
                 'description':  "The Maximum length of the username. Changing this will only affect new registrations.",
             }),
             ('auth_username_blacklist', {
                 'value':        "me,administrator,moderator",
-                'value_type':   SettingsValueTypes.string,
+                'value_type':   SettingValueType.string,
                 'name':         "Username Blacklist",
                 'description':  "A comma seperated list with forbidden usernames.",
             }),
             ('auth_ratelimit_enabled', {
                 'value':        True,
-                'value_type':   SettingsValueTypes.boolean,
+                'value_type':   SettingValueType.boolean,
                 'name':         "Enable Auth Rate Limiting",
                 'description':  "Enable rate limiting on 'auth' routes. This will limit the amount of requests per minute to a given amount and time.",
             }),
             ('auth_requests', {
                 'value':        20,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {'min': 1},
                 'name':         "Auth Requests",
                 'description':  "Number of requests on each 'auth' route before the user has to wait a given timeout until he can access the resource again.",
             }),
             ('auth_timeout', {
                 'value':        15,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {'min': 0},
                 'name':         "Auth Timeout",
                 'description':  "The timeout for how long the user has to wait until he can access the resource again (in minutes).",
             }),
             ('login_recaptcha', {
                 'value':        5,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {'min': 0},
                 'name':         "Login reCAPTCHA",
                 'description':  "Use a CAPTCHA after a specified amount of failed login attempts."
             }),
             ('recaptcha_enabled', {
                 'value':        False,
-                'value_type':   SettingsValueTypes.boolean,
+                'value_type':   SettingValueType.boolean,
                 'name':         "Enable reCAPTCHA",
                 'description':  ("Helps to prevent bots from creating accounts. "
                                  "For more information visit this link: <a href=http://www.google.com/recaptcha>http://www.google.com/recaptcha</a>"),
             }),
             ('recaptcha_public_key', {
                 'value':        "",
-                'value_type':   SettingsValueTypes.string,
+                'value_type':   SettingValueType.string,
                 'name':         "reCAPTCHA Site Key",
                 'description':  "Your public recaptcha key ('Site key').",
             }),
             ('recaptcha_private_key', {
                 'value':        "",
-                'value_type':   SettingsValueTypes.string,
+                'value_type':   SettingValueType.string,
                 'name':         "reCAPTCHA Secret Key",
                 'description':  "The private key ('Secret key'). Keep this a secret!",
             }),
@@ -151,63 +151,63 @@ fixture = (
         'settings': (
             ('message_quota', {
                 'value':        50,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {"min": 0},
                 'name':         "Private Message Quota",
                 'description':  "The amount of messages a user can have."
             }),
             ('online_last_minutes', {
                 'value':        15,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {'min': 0},
                 'name':         "Online last minutes",
                 'description':  "How long a user can be inactive before he is marked as offline. 0 to disable it.",
             }),
             ('title_length', {
                 'value':        15,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {'min': 0},
                 'name':         "Topic title length",
                 'description':  "The length of the topic title shown on the index."
             }),
             ('tracker_length', {
                 'value':        7,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {'min': 0},
                 'name':         "Tracker length",
                 'description':  "The days for how long the forum should deal with unread topics. 0 to disable it."
             }),
             ('avatar_height', {
                 'value':        150,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {'min': 0},
                 'name':         "Avatar Height",
                 'description':  "The allowed height of an avatar in pixels."
             }),
             ('avatar_width', {
                 'value':        150,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {'min': 0},
                 'name':         "Avatar Width",
                 'description':  "The allowed width of an avatar in pixels."
             }),
             ('avatar_size', {
                 'value':        200,
-                'value_type':   SettingsValueTypes.integer,
+                'value_type':   SettingValueType.integer,
                 'extra':        {'min': 0},
                 'name':         "Avatar Size",
                 'description':  "The allowed size of the avatar in kilobytes."
             }),
             ('avatar_types', {
                 'value':        ["PNG", "JPEG", "GIF"],
-                'value_type':   SettingsValueTypes.selectmultiple,
+                'value_type':   SettingValueType.selectmultiple,
                 'extra':        {"choices": available_avatar_types},
                 'name':         "Avatar Types",
                 'description':  "The allowed types of an avatar. Such as JPEG, GIF or PNG."
             }),
             ('signature_enabled', {
                 'value':        True,
-                'value_type':   SettingsValueTypes.boolean,
+                'value_type':   SettingValueType.boolean,
                 'extra':        {},
                 'name':         "Enable Signatures",
                 'description':  "Enable signatures in posts."
@@ -220,14 +220,14 @@ fixture = (
         "settings": (
             ('default_theme', {
                 'value':        "aurora",
-                'value_type':   SettingsValueTypes.select,
+                'value_type':   SettingValueType.select,
                 'extra':        {'choices': available_themes},
                 'name':         "Default Theme",
                 'description':  "Change the default theme for your forum."
             }),
             ('default_language', {
                 'value':        "en",
-                'value_type':   SettingsValueTypes.select,
+                'value_type':   SettingValueType.select,
                 'extra':        {'choices': available_languages},
                 'name':         "Default Language",
                 'description':  "Change the default language for your forum."

flaskbb/management/models.py

@@ -11,7 +11,7 @@
 from flaskbb._compat import iteritems
 from flaskbb.extensions import db, cache
 from flaskbb.utils.database import CRUDMixin
-from flaskbb.utils.forms import generate_settings_form, SettingsValueTypes
+from flaskbb.utils.forms import generate_settings_form, SettingValueType
 
 
 class SettingsGroup(db.Model, CRUDMixin):
@@ -45,7 +45,7 @@ class Setting(db.Model, CRUDMixin):
     description = db.Column(db.Text, nullable=False)
 
     # Available types: string, integer, float, boolean, select, selectmultiple
-    value_type = db.Column(db.Enum(SettingsValueTypes), nullable=False)
+    value_type = db.Column(db.Enum(SettingValueType), nullable=False)
 
     # Extra attributes like, validation things (min, max length...)
     # For Select*Fields required: choices

flaskbb/plugins/models.py

@@ -16,7 +16,7 @@ from sqlalchemy.orm.collections import attribute_mapped_collection
 from flaskbb._compat import itervalues
 from flaskbb.extensions import db
 from flaskbb.utils.database import CRUDMixin
-from flaskbb.utils.forms import generate_settings_form, SettingsValueTypes
+from flaskbb.utils.forms import generate_settings_form, SettingValueType
 
 
 class PluginStore(CRUDMixin, db.Model):
@@ -24,7 +24,7 @@ class PluginStore(CRUDMixin, db.Model):
     key = db.Column(db.Unicode(255), nullable=False)
     value = db.Column(db.PickleType, nullable=False)
     # Available types: string, integer, float, boolean, select, selectmultiple
-    value_type = db.Column(db.Enum(SettingsValueTypes), nullable=False)
+    value_type = db.Column(db.Enum(SettingValueType), nullable=False)
     # Extra attributes like, validation things (min, max length...)
     # For Select*Fields required: choices
     extra = db.Column(db.PickleType, nullable=True)

flaskbb/utils/forms.py

@@ -15,7 +15,7 @@ from flaskbb._compat import text_type, iteritems
 from enum import Enum
 
 
-class SettingsValueTypes(Enum):
+class SettingValueType(Enum):
     string = 0
     integer = 1
     float = 3
@@ -59,9 +59,10 @@ def generate_settings_form(settings):
     for setting in settings:
         field_validators = []
 
-        if setting.value_type in {SettingsValueTypes.integer, SettingsValueTypes.float}:
+        if setting.value_type in {SettingValueType.integer,
+                                  SettingValueType.float}:
             validator_class = validators.NumberRange
-        elif setting.value_type == SettingsValueTypes.string:
+        elif setting.value_type == SettingValueType.string:
             validator_class = validators.Length
 
         # generate the validators
@@ -79,14 +80,14 @@ def generate_settings_form(settings):
 
         # Generate the fields based on value_type
         # IntegerField
-        if setting.value_type == SettingsValueTypes.integer:
+        if setting.value_type == SettingValueType.integer:
             setattr(
                 SettingsForm, setting.key,
                 IntegerField(setting.name, validators=field_validators,
                              description=setting.description)
             )
         # FloatField
-        elif setting.value_type == SettingsValueTypes.float:
+        elif setting.value_type == SettingValueType.float:
             setattr(
                 SettingsForm, setting.key,
                 FloatField(setting.name, validators=field_validators,
@@ -94,7 +95,7 @@ def generate_settings_form(settings):
             )
 
         # TextField
-        elif setting.value_type == SettingsValueTypes.string:
+        elif setting.value_type == SettingValueType.string:
             setattr(
                 SettingsForm, setting.key,
                 TextField(setting.name, validators=field_validators,
@@ -102,7 +103,7 @@ def generate_settings_form(settings):
             )
 
         # SelectMultipleField
-        elif setting.value_type == SettingsValueTypes.selectmultiple:
+        elif setting.value_type == SettingValueType.selectmultiple:
             # if no coerce is found, it will fallback to unicode
             if "coerce" in setting.extra:
                 coerce_to = setting.extra['coerce']
@@ -120,7 +121,7 @@ def generate_settings_form(settings):
             )
 
         # SelectField
-        elif setting.value_type == SettingsValueTypes.select:
+        elif setting.value_type == SettingValueType.select:
             # if no coerce is found, it will fallback to unicode
             if "coerce" in setting.extra:
                 coerce_to = setting.extra['coerce']
@@ -137,7 +138,7 @@ def generate_settings_form(settings):
             )
 
         # BooleanField
-        elif setting.value_type == SettingsValueTypes.boolean:
+        elif setting.value_type == SettingValueType.boolean:
             setattr(
                 SettingsForm, setting.key,
                 BooleanField(setting.name, description=setting.description)

migrations/7c3fcf8a3335_add_plugin_tables.py

@@ -32,7 +32,7 @@ def upgrade():
         sa.Column('value', sa.PickleType(), nullable=False),
         sa.Column('value_type', sa.Enum(
             'string', 'integer', 'float', 'boolean', 'select', 'selectmultiple',
-            name='settingsvaluetypes'), nullable=False
+            name='settingvaluetype'), nullable=False
         ),
         sa.Column('extra', sa.PickleType(), nullable=True),
         sa.Column('plugin_id', sa.Integer(), nullable=True),