udata 10.3.2.dev34895__py2.py3-none-any.whl → 10.3.2.dev34905__py2.py3-none-any.whl

udata/core/topic/models.py

@@ -21,7 +21,7 @@ class Topic(db.Document, Owned, db.Datetimed):
     datasets = db.ListField(db.LazyReferenceField("Dataset", reverse_delete_rule=db.PULL))
     reuses = db.ListField(db.LazyReferenceField("Reuse", reverse_delete_rule=db.PULL))
 
-    featured = db.BooleanField()
+    featured = db.BooleanField(default=False)
     private = db.BooleanField()
     extras = db.ExtrasField()
 

udata/core/topic/parsers.py

@@ -1,4 +1,5 @@
 from bson.objectid import ObjectId
+from flask_restx.inputs import boolean
 
 from udata.api import api
 from udata.api.parsers import ModelApiParser
@@ -20,6 +21,7 @@ class TopicApiParser(ModelApiParser):
         self.parser.add_argument("granularity", type=str, location="args")
         self.parser.add_argument("organization", type=str, location="args")
         self.parser.add_argument("owner", type=str, location="args")
+        self.parser.add_argument("featured", type=boolean, location="args")
 
     @staticmethod
     def parse_filters(topics, args):
@@ -38,6 +40,8 @@ class TopicApiParser(ModelApiParser):
             topics = topics.filter(spatial__zones=args["geozone"])
         if args.get("granularity"):
             topics = topics.filter(spatial__granularity=args["granularity"])
+        if args.get("featured") is not None:
+            topics = topics.filter(featured=args["featured"])
         if args.get("organization"):
             if not ObjectId.is_valid(args["organization"]):
                 api.abort(400, "Organization arg must be an identifier")

udata/migrations/2025-04-24-topic-featured-default-false.py

@@ -0,0 +1,15 @@
+"""
+This migration updates Topic.featured to False when it is None.
+"""
+
+import logging
+
+from udata.models import Topic
+
+log = logging.getLogger(__name__)
+
+
+def migrate(db):
+    log.info("Processing topics...")
+    count = Topic.objects(featured__exists=False).update(featured=False)
+    log.info(f"\tConverted {count} topics from `featured=None` to `featured=False`")

udata/tests/api/test_topics_api.py

@@ -28,12 +28,13 @@ class TopicsAPITest(APITestCase):
         private_topic = TopicFactory(private=True)
         geozone_topic = TopicFactory(spatial=SpatialCoverageFactory(zones=[paca.id]))
         granularity_topic = TopicFactory(spatial=SpatialCoverageFactory(granularity="country"))
+        featured_topic = TopicFactory(featured=True)
         owner_topic = TopicFactory(owner=owner)
         org_topic = TopicFactory(organization=org)
 
         response = self.get(url_for("api.topics"))
         self.assert200(response)
-        self.assertEqual(len(response.json["data"]), 7)
+        self.assertEqual(len(response.json["data"]), 8)
 
         response = self.get(url_for("api.topics", q="topic-for"))
         self.assert200(response)
@@ -69,7 +70,7 @@ class TopicsAPITest(APITestCase):
 
         response = self.get(url_for("api.topics", include_private="true"))
         self.assert200(response)
-        self.assertEqual(len(response.json["data"]), 7)
+        self.assertEqual(len(response.json["data"]), 8)
         # we're not logged in, so the private topic does not appear
         self.assertNotIn(str(private_topic.id), [t["id"] for t in response.json["data"]])
 
@@ -83,6 +84,16 @@ class TopicsAPITest(APITestCase):
         self.assertEqual(len(response.json["data"]), 1)
         self.assertIn(str(granularity_topic.id), [t["id"] for t in response.json["data"]])
 
+        response = self.get(url_for("api.topics", featured="true"))
+        self.assert200(response)
+        self.assertEqual(len(response.json["data"]), 1)
+        self.assertIn(str(featured_topic.id), [t["id"] for t in response.json["data"]])
+
+        response = self.get(url_for("api.topics", featured="false"))
+        self.assert200(response)
+        self.assertEqual(len(response.json["data"]), 7)
+        self.assertNotIn(str(featured_topic.id), [t["id"] for t in response.json["data"]])
+
         response = self.get(url_for("api.topics", owner=owner.id))
         self.assert200(response)
         self.assertEqual(len(response.json["data"]), 1)

udata/tests/apiv2/test_topics.py

@@ -25,13 +25,14 @@ class TopicsAPITest(APITestCase):
         private_topic = TopicFactory(private=True)
         geozone_topic = TopicFactory(spatial=SpatialCoverageFactory(zones=[paca.id]))
         granularity_topic = TopicFactory(spatial=SpatialCoverageFactory(granularity="country"))
+        featured_topic = TopicFactory(featured=True)
         owner_topic = TopicFactory(owner=owner)
         org_topic = TopicFactory(organization=org)
 
         response = self.get(url_for("apiv2.topics_list"))
         assert response.status_code == 200
         data = response.json["data"]
-        assert len(data) == 7
+        assert len(data) == 8
 
         hateoas_fields = ["rel", "href", "type", "total"]
         assert all(k in data[0]["datasets"] for k in hateoas_fields)
@@ -57,7 +58,7 @@ class TopicsAPITest(APITestCase):
 
         response = self.get(url_for("api.topics", include_private="true"))
         assert response.status_code == 200
-        assert len(response.json["data"]) == 7
+        assert len(response.json["data"]) == 8
         # we're not logged in, so the private topic does not appear
         assert str(private_topic.id) not in [t["id"] for t in response.json["data"]]
 
@@ -71,6 +72,16 @@ class TopicsAPITest(APITestCase):
         assert len(response.json["data"]) == 1
         assert str(granularity_topic.id) in [t["id"] for t in response.json["data"]]
 
+        response = self.get(url_for("api.topics", featured="true"))
+        assert response.status_code == 200
+        assert len(response.json["data"]) == 1
+        assert str(featured_topic.id) in [t["id"] for t in response.json["data"]]
+
+        response = self.get(url_for("api.topics", featured="false"))
+        assert response.status_code == 200
+        assert len(response.json["data"]) == 7
+        assert str(featured_topic.id) not in [t["id"] for t in response.json["data"]]
+
         response = self.get(url_for("api.topics", owner=owner.id))
         assert response.status_code == 200
         assert len(response.json["data"]) == 1

{udata-10.3.2.dev34895.dist-info → udata-10.3.2.dev34905.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: udata
-Version: 10.3.2.dev34895
+Version: 10.3.2.dev34905
 Summary: Open data portal
 Home-page: https://github.com/opendatateam/udata
 Author: Opendata Team
@@ -141,7 +141,7 @@ It is collectively taken care of by members of the
 
 ## Current (in progress)
 
-- Nothing yet
+- feat(topics): add featured filter in API [#3301](https://github.com/opendatateam/udata/pull/3301)
 
 ## 10.3.1 (2025-04-29)
 

{udata-10.3.2.dev34895.dist-info → udata-10.3.2.dev34905.dist-info}/RECORD

@@ -231,8 +231,8 @@ udata/core/topic/api.py,sha256=xVBp3EFOAEWQlt2CQvII9gq21qeIK048pSkh1uTmdBo,5472
 udata/core/topic/apiv2.py,sha256=9-CdR-xcVp7yS7664PgRCsAthxg1VgpKgoAaVlEhF6k,10461
 udata/core/topic/factories.py,sha256=RpUpwLd2gYwwS0vc7FcbQ-4tC0FSsAg7O8bPgozYKgE,684
 udata/core/topic/forms.py,sha256=NGC_k6PRw8uswEHaXW1Q3ih_2sx2-dNUY--LD-me80Y,973
-udata/core/topic/models.py,sha256=WR1SmVuTKBIRFvb0s54vuG3ICoCxtTmsVKJi3GGeuoM,2039
-udata/core/topic/parsers.py,sha256=dk4Siju3G5hOkMa3O01y14V1bRtdA01uvEUGrseimF4,2189
+udata/core/topic/models.py,sha256=X-jScC_mMNdZp0hQ_SD-NBHsIPS8aYqpq99x6l4dKz4,2052
+udata/core/topic/parsers.py,sha256=ugkBd-w8TewInqowNF2w36UPwKYMYluK4U-grkAu-wg,2411
 udata/core/topic/permissions.py,sha256=RtFPPlxuU_Bv7ip6LDO4AoPrKFnIOEs9cCMXaSSmEdk,118
 udata/core/user/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 udata/core/user/activities.py,sha256=x-mSiwx7TzM2ci6KMkMiNx0sFs8J3LTJNbigtE8cA0s,2807
@@ -363,6 +363,7 @@ udata/migrations/2024-11-19-keep-only-local_authority-if-also-public_service-org
 udata/migrations/2024-12-05-contact-point-is-now-a-list.py,sha256=il2qSFhOTq-YhqhFaq_5OwysUlKXaK_En-qGP6v9rf0,1065
 udata/migrations/2025-01-05-dataservices-fields-changes.py,sha256=HlqHg3sG3rk3sYVrOwAlXMNhTmTKd1YT82P-gXOqmZM,4647
 udata/migrations/2025-03-20-save-quality-for-datasets.py,sha256=FPTfGVByXSHr18V4RFlktC7t-H-5rgEcZQMTRpMrGqo,607
+udata/migrations/2025-04-24-topic-featured-default-false.py,sha256=t4OyhehtPQiosKtAo9SWRWm3ObGUHvqD_roXQ34vIH4,369
 udata/migrations/__init__.py,sha256=RBCBDaTlLjuMs_Qzwji6Z6T4r7FCGXhESKoxQbT5qAA,11221
 udata/models/__init__.py,sha256=txbZwa-lRG3mq99eQ9E5YcFWiNUdjDVSyJJvlqUMFfs,1413
 udata/mongo/__init__.py,sha256=y4Rv-kq3o_kcEulcNpePLzocXPBNpx3Jd82G-VZPaMc,1421
@@ -634,7 +635,7 @@ udata/tests/api/test_reports_api.py,sha256=fCSz9NwMXBs6cxdXBVVI6y564AtovmZYw3xkg
 udata/tests/api/test_reuses_api.py,sha256=d8mtUrDURIfnUK-sLogvAP-rOID2FDJ0UVTM0ravQ-Q,24642
 udata/tests/api/test_swagger.py,sha256=eE6La9qdTYTIUFevRVPJgtj17Jq_8uOlsDwzCNR0LL8,760
 udata/tests/api/test_tags_api.py,sha256=36zEBgthVEn6pctJ0kDgPmEaUr-iqRAHeZRcRG2LEXQ,2425
-udata/tests/api/test_topics_api.py,sha256=mpIjztDEQ2fx25E9dl4eIARGqtYuh1w8x68PhRr47Ss,11651
+udata/tests/api/test_topics_api.py,sha256=beIPbDA8PHo4FZogeio-j1MO6Eatt9oFSlp-aHpgEtQ,12200
 udata/tests/api/test_transfer_api.py,sha256=-OLv-KjyLZL14J8UHl-ak_sYUj6wFiZWyoXC2SMXmEQ,7503
 udata/tests/api/test_user_api.py,sha256=hfDHOv5F81tehbc5u3dYH5rAyYgzgHGCWVcGR3kLIZw,16591
 udata/tests/apiv2/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -642,7 +643,7 @@ udata/tests/apiv2/test_datasets.py,sha256=zjTtjY7lJKOOjiV698RqGvRMuuMxY2dMhEcnhO
 udata/tests/apiv2/test_me_api.py,sha256=RAgu5iKGB3Pp8cDN-427ovly-VOz5MTL4GpPZ1NcVXI,1418
 udata/tests/apiv2/test_organizations.py,sha256=os_43s-coSRqjgY-5fAjSiRlB3g2685u7d-Es0aOhks,6390
 udata/tests/apiv2/test_swagger.py,sha256=RKedaq-2UeyEuxlmUaAN7pmEe-lQYYmpDUVc8HF3CH4,785
-udata/tests/apiv2/test_topics.py,sha256=RZ3S--lTZ8hIBpc-0wDz0h4vBNHbHYp0HJDzE6jd7_E,11104
+udata/tests/apiv2/test_topics.py,sha256=KwWAMta-C_MgwxBOwfUuPqxkO--SHvvth_c9VFGt2zA,11644
 udata/tests/cli/test_cli_base.py,sha256=0a3U_5ROp1lCTG8d6TpCjF4nbKVNerAeLO0VxU-NTUk,321
 udata/tests/cli/test_db_cli.py,sha256=_AZM_sZjePJw9ZaymuQoEAKXyX_EYz-S1PekxrMhMpU,1764
 udata/tests/contact_point/test_contact_point_models.py,sha256=b8vraZPPrs9LeQMWLnOCrpI02sXMEM_BcMJXKTeAuAw,923
@@ -724,9 +725,9 @@ udata/translations/pt/LC_MESSAGES/udata.mo,sha256=xmSQ7RTl9XV24Vq3A7f_NIRDrOJwbs
 udata/translations/pt/LC_MESSAGES/udata.po,sha256=PXrrhfIjZxheUotQan9VVh1fvNHSzeMAitaouIHaR7U,46793
 udata/translations/sr/LC_MESSAGES/udata.mo,sha256=1pAf_rXvbOoO_jjZmH77GbzvdT_YtPTJKFumMnMto2g,29169
 udata/translations/sr/LC_MESSAGES/udata.po,sha256=AalMHaFLZobKmuAnZ4X1rQtk46NdW2rktMFQHD5DTcM,53768
-udata-10.3.2.dev34895.dist-info/LICENSE,sha256=V8j_M8nAz8PvAOZQocyRDX7keai8UJ9skgmnwqETmdY,34520
-udata-10.3.2.dev34895.dist-info/METADATA,sha256=CUY3jwCW9wNWPMByIUFsq9MwRoxl09_2N7vDBaRtn2c,144922
-udata-10.3.2.dev34895.dist-info/WHEEL,sha256=Kh9pAotZVRFj97E15yTA4iADqXdQfIVTHcNaZTjxeGM,110
-udata-10.3.2.dev34895.dist-info/entry_points.txt,sha256=ETvkR4r6G1duBsh_V_fGWENQy17GTFuobi95MYBAl1A,498
-udata-10.3.2.dev34895.dist-info/top_level.txt,sha256=39OCg-VWFWOq4gCKnjKNu-s3OwFlZIu_dVH8Gl6ndHw,12
-udata-10.3.2.dev34895.dist-info/RECORD,,
+udata-10.3.2.dev34905.dist-info/LICENSE,sha256=V8j_M8nAz8PvAOZQocyRDX7keai8UJ9skgmnwqETmdY,34520
+udata-10.3.2.dev34905.dist-info/METADATA,sha256=QiDRRN48mYIZG81xHTE5nGxk_NGPyHQ4m0OuGHcV9Qk,145008
+udata-10.3.2.dev34905.dist-info/WHEEL,sha256=Kh9pAotZVRFj97E15yTA4iADqXdQfIVTHcNaZTjxeGM,110
+udata-10.3.2.dev34905.dist-info/entry_points.txt,sha256=ETvkR4r6G1duBsh_V_fGWENQy17GTFuobi95MYBAl1A,498
+udata-10.3.2.dev34905.dist-info/top_level.txt,sha256=39OCg-VWFWOq4gCKnjKNu-s3OwFlZIu_dVH8Gl6ndHw,12
+udata-10.3.2.dev34905.dist-info/RECORD,,