goodmap 1.4.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

goodmap/core_api.py

@@ -7,6 +7,7 @@ import numpy
 import pysupercluster
 from flask import Blueprint, jsonify, make_response, request
 from flask_babel import gettext
+from platzky import FeatureFlagSet
 from platzky.attachment import AttachmentProtocol
 from platzky.config import AttachmentConfig, LanguagesMapping
 from spectree import Response, SpecTree
@@ -24,6 +25,7 @@ from goodmap.clustering import (
     match_clusters_uuids,
 )
 from goodmap.exceptions import LocationValidationError
+from goodmap.feature_flags import CategoriesHelp
 from goodmap.formatter import prepare_pin
 from goodmap.json_security import (
     MAX_JSON_DEPTH_LOCATION,
@@ -83,7 +85,7 @@ def core_pages(
     location_model,
     photo_attachment_class: type[AttachmentProtocol],
     photo_attachment_config: AttachmentConfig,
-    feature_flags={},
+    feature_flags: FeatureFlagSet,
 ) -> Blueprint:
     core_api_blueprint = Blueprint("api", __name__, url_prefix="/api")
 
@@ -383,15 +385,15 @@ def core_pages(
         raw_categories = database.get_categories()
         categories = make_tuple_translation(raw_categories)
 
-        if not feature_flags.get("CATEGORIES_HELP", False):
+        if CategoriesHelp not in feature_flags:
             return jsonify(categories)
-        else:
-            category_data = database.get_category_data()
-            categories_help = category_data.get("categories_help")
-            proper_categories_help = []
-            if categories_help is not None:
-                for option in categories_help:
-                    proper_categories_help.append({option: gettext(f"categories_help_{option}")})
+
+        category_data = database.get_category_data()
+        categories_help = category_data.get("categories_help")
+        proper_categories_help = []
+        if categories_help is not None:
+            for option in categories_help:
+                proper_categories_help.append({option: gettext(f"categories_help_{option}")})
 
         return jsonify({"categories": categories, "categories_help": proper_categories_help})
 
@@ -415,7 +417,7 @@ def core_pages(
                 "options": make_tuple_translation(options),
             }
 
-            if feature_flags.get("CATEGORIES_HELP", False):
+            if CategoriesHelp in feature_flags:
                 option_help_list = categories_options_help.get(key, [])
                 proper_options_help = []
                 for option in option_help_list:
@@ -428,7 +430,7 @@ def core_pages(
 
         response = {"categories": result}
 
-        if feature_flags.get("CATEGORIES_HELP", False):
+        if CategoriesHelp in feature_flags:
             categories_help = categories_data.get("categories_help", [])
             proper_categories_help = []
             for option in categories_help:
@@ -466,15 +468,15 @@ def core_pages(
                 proper_categories_options_help.append(
                     {option: gettext(f"categories_options_help_{option}")}
                 )
-        if not feature_flags.get("CATEGORIES_HELP", False):
+        if CategoriesHelp not in feature_flags:
             return jsonify(local_data)
-        else:
-            return jsonify(
-                {
-                    "categories_options": local_data,
-                    "categories_options_help": proper_categories_options_help,
-                }
-            )
+
+        return jsonify(
+            {
+                "categories_options": local_data,
+                "categories_options_help": proper_categories_options_help,
+            }
+        )
 
     # Register Spectree with blueprint after all routes are defined
     spec.register(core_api_blueprint)

goodmap/feature_flags.py

@@ -0,0 +1,7 @@
+from platzky import FeatureFlag
+
+CategoriesHelp = FeatureFlag(alias="CATEGORIES_HELP", description="Show category help text")
+UseLazyLoading = FeatureFlag(
+    alias="USE_LAZY_LOADING", description="Enable lazy loading of location fields"
+)
+EnableAdminPanel = FeatureFlag(alias="ENABLE_ADMIN_PANEL", description="Enable admin panel")

goodmap/goodmap.py

@@ -18,6 +18,7 @@ from goodmap.db import (
     extend_db_with_goodmap_queries,
     get_location_obligatory_fields,
 )
+from goodmap.feature_flags import EnableAdminPanel, UseLazyLoading
 
 logger = logging.getLogger(__name__)
 
@@ -35,20 +36,6 @@ def create_app(config_path: str) -> platzky.Engine:
     return create_app_from_config(config)
 
 
-# TODO Checking if there is a feature flag secition should be part of configs logic not client app
-def is_feature_enabled(config: GoodmapConfig, feature: str) -> bool:
-    """Check if a feature flag is enabled in the configuration.
-
-    Args:
-        config: Goodmap configuration object
-        feature: Name of the feature flag to check
-
-    Returns:
-        bool: True if feature is enabled, False otherwise
-    """
-    return config.feature_flags.get(feature, False) if config.feature_flags else False
-
-
 def create_app_from_config(config: GoodmapConfig) -> platzky.Engine:
     """Create and configure Goodmap application from config object.
 
@@ -73,7 +60,7 @@ def create_app_from_config(config: GoodmapConfig) -> platzky.Engine:
     if "MAX_CONTENT_LENGTH" not in app.config:
         app.config["MAX_CONTENT_LENGTH"] = 100 * 1024  # 100KB
 
-    if is_feature_enabled(config, "USE_LAZY_LOADING"):
+    if app.is_enabled(UseLazyLoading):
         location_obligatory_fields = get_location_obligatory_fields(app.db)
         # Extend db with goodmap queries first so we can use the bound method
         location_model = create_location_model(location_obligatory_fields, {})
@@ -175,7 +162,7 @@ def create_app_from_config(config: GoodmapConfig) -> platzky.Engine:
         Returns:
             Rendered goodmap-admin.html template or redirect to login
         """
-        if not is_feature_enabled(config, "ENABLE_ADMIN_PANEL"):
+        if not app.is_enabled(EnableAdminPanel):
             return redirect("/")
 
         user = session.get("user", None)
@@ -194,7 +181,7 @@ def create_app_from_config(config: GoodmapConfig) -> platzky.Engine:
 
     app.register_blueprint(goodmap)
 
-    if is_feature_enabled(config, "ENABLE_ADMIN_PANEL"):
+    if app.is_enabled(EnableAdminPanel):
         admin_bp = admin_pages(app.db, location_model)
         app.register_blueprint(admin_bp)
 

{goodmap-1.4.0.dist-info → goodmap-1.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: goodmap
-Version: 1.4.0
+Version: 1.5.0
 Summary: Map engine to serve all the people :)
 Author: Krzysztof Kolodzinski
 Author-email: krzysztof.kolodzinski@problematy.pl
@@ -20,11 +20,11 @@ Requires-Dist: aiohttp (>=3.8.4,<4.0.0)
 Requires-Dist: deprecation (>=2.1.0,<3.0.0)
 Requires-Dist: google-cloud-storage (>=2.7.0,<3.0.0)
 Requires-Dist: gql (>=3.4.0,<4.0.0)
-Requires-Dist: gunicorn (>=20.1,<24.0)
+Requires-Dist: gunicorn (>=20.1,<25.0)
 Requires-Dist: humanize (>=4.6.0,<5.0.0)
 Requires-Dist: myst-parser (>=4.0.0,<5.0.0) ; extra == "docs"
 Requires-Dist: numpy (>=2.2.0,<3.0.0)
-Requires-Dist: platzky (>=1.3.0,<2.0.0)
+Requires-Dist: platzky (>=1.4.1,<2.0.0)
 Requires-Dist: pydantic (>=2.7.1,<3.0.0)
 Requires-Dist: pysupercluster-problematy (>=0.7.8,<0.8.0)
 Requires-Dist: scipy (>=1.15.1,<2.0.0)

{goodmap-1.4.0.dist-info → goodmap-1.5.0.dist-info}/RECORD

@@ -4,17 +4,18 @@ goodmap/api_models.py,sha256=Bv4OTGuckNneCrxaQ1Y_PMeu7YFLvGUqU2EorvDlUjY,3438
 goodmap/clustering.py,sha256=ULB-fPNOUDblgpBK4vzuo0o2yqIcvG84F3R6Za2X_l4,2905
 goodmap/config.py,sha256=CsmC1zuvVab90VW50dtARHbFJpy2vfsIfbque8Zgc-U,1313
 goodmap/core.py,sha256=AgdGLfeJvL7TlTX893NR2YdCS8EuXx93Gx6ndvWws7s,2673
-goodmap/core_api.py,sha256=CgAVRJP4Ggd5b33yAVNxAIJtEVy34NqOGKq1JRtNSLo,20006
+goodmap/core_api.py,sha256=CnQHXzSxym-URHE4teVkyOAT-iIMWWEX0cP7R_01Tg4,19981
 goodmap/data_models/location.py,sha256=_I27R06ovEL9ctv_SZ3yoLL-RwmyE3VDsVOG4a89q50,6798
 goodmap/data_validator.py,sha256=lBmVAPxvSmEOdUGeVYSjUvVVmKfPyq4CWoHfczTtEMM,4090
 goodmap/db.py,sha256=TcqYGbK5yk6S735Si1AzjNqcbB1nsd9pFGOy5qN9Vec,46589
 goodmap/exceptions.py,sha256=jkFAUoc5LHk8iPjxHxbcRp8W6qFCSEA25A8XaSwxwyo,2906
+goodmap/feature_flags.py,sha256=-hiqTX4OlhfY_4M1Kvy-_z1Fx6YTaFi3SVGYa0Pamcw,334
 goodmap/formatter.py,sha256=4rqcg9A9Y9opAi7eb8kMDdUC03M3uzZgCxx29cvvIag,1403
-goodmap/goodmap.py,sha256=OZWxVXtvjftbNPFoJ3myCshv4BOHe0J3x0yLg2Cxm9A,8030
+goodmap/goodmap.py,sha256=f69aUloRe4bpx2JRwZFiHOeUSk0Exq-Qv2FCdwiwLA0,7541
 goodmap/json_security.py,sha256=EHAxNlb16AVwphgf4F7yObtMZpbR9M538dwn_STRcMo,3275
 goodmap/templates/goodmap-admin.html,sha256=LSiOZ9-n29CnlfVNwdgmXwT7Xe7t5gvGh1xSrFGqOIY,35669
 goodmap/templates/map.html,sha256=Uk7FFrZwvHZvG0DDaQrGW5ZrIMD21XrJzMub76uIlAg,4348
-goodmap-1.4.0.dist-info/LICENSE.md,sha256=nkCQOR7uheLRvHRfXmwx9LhBnMcPeBU9d4ebLojDiQU,1067
-goodmap-1.4.0.dist-info/METADATA,sha256=M8Y6Fq8-gh2--o1VnhPd35NznVOC0R9DNGZo7LAEMbU,5798
-goodmap-1.4.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-goodmap-1.4.0.dist-info/RECORD,,
+goodmap-1.5.0.dist-info/LICENSE.md,sha256=nkCQOR7uheLRvHRfXmwx9LhBnMcPeBU9d4ebLojDiQU,1067
+goodmap-1.5.0.dist-info/METADATA,sha256=PpLVvzHAcIIKEUVAqBkTZ1zcLXNnFFUivPUFIieiu6k,5798
+goodmap-1.5.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+goodmap-1.5.0.dist-info/RECORD,,