Backend: add month as a filter with lower precedence than day

server/app/pseudo_tweets/routes.py

@@ -24,6 +24,7 @@
     TweetRead,
     TweetUpdate,
 )
+from ..tweets_common.types import Month
 from . import router
 
 
@@ -45,13 +46,14 @@ def read_pseudo_tweets(
     limit: conint(le=10, gt=0) = 10,
     topics: Optional[List[Topics]] = Query(None),
     day: Optional[date] = None,
+    month: Optional[Month] = Query(None, description="Month in %Y-%m format"),
     maximize_labels: bool = False,
     session: Session = Depends(get_session),
 ):
     """
     Read pseudo tweets within the offset and limit
     """
-    selection = get_filtered_selection(topics, day, PseudoTweet)
+    selection = get_filtered_selection(topics, day, month, PseudoTweet)
 
     # others should be exclusively provided, hence the last check
     is_others = topics is not None and len(topics) and topics[0] == Topics.others

server/app/tweets/routes.py

@@ -16,6 +16,7 @@
     make_tweet_read,
 )
 from ..tweets_common.models import Overview, Topics, Tweet, TweetRead, TweetUpdate
+from ..tweets_common.types import Month
 from . import router
 
 
@@ -35,12 +36,13 @@ def read_tweets(
     limit: conint(le=10, gt=0) = 10,
     topics: Optional[List[Topics]] = Query(None),
     day: Optional[date] = None,
+    month: Optional[Month] = Query(None, description="Month in %Y-%m format"),
     session: Session = Depends(get_session),
 ):
     """
     Read tweets within the offset and limit
     """
-    selection = get_filtered_selection(topics, day, Tweet)
+    selection = get_filtered_selection(topics, day, month, Tweet)
 
     tweets = session.exec(
         selection.order_by(Tweet.id.desc()).offset(offset).limit(limit)

server/app/tweets_common/helper_functions.py

@@ -1,12 +1,13 @@
 from datetime import date
-from typing import Any, Callable, List, Optional, Tuple, TypeVar
+from typing import Callable, List, Optional, Tuple, TypeVar
 
 from fastapi import HTTPException
 from pydantic import PositiveInt
 from sqlmodel import Integer, Session, and_, func, not_, select, text, union_all
 from sqlmodel.sql.expression import Select
 
 from .models import PseudoTweet, Topics, Tweet, TweetRead, TweetUpdate
+from .types import Month
 
 # Make a Generic Type to get the original type completion back
 ModelType = TypeVar("ModelType", Tweet, PseudoTweet)
@@ -15,6 +16,7 @@
 def get_filtered_selection(
     topics: Optional[List[Topics]],
     day: Optional[date],
+    month: Optional[Month],
     Model: ModelType,
 ):
     """
@@ -31,13 +33,18 @@ def get_filtered_selection(
             # Since others is defined in the selection, directly provide the column
             filter = text(Topics.others)
         else:
-
             filter = and_(*tuple(getattr(Model, topic) for topic in topics))
 
         selection = selection.filter(filter)
 
-    if day is not None:
-        selection = selection.filter(func.date(Model.created_at) == day)
+    if day is not None or month is not None:
+        # If both specified, use day only
+        filter = (
+            func.date(Model.created_at) == day
+            if day is not None
+            else func.strftime("%Y-%m", Model.created_at) == month
+        )
+        selection = selection.filter(filter)
 
     return selection
 

server/app/tweets_common/types.py

@@ -0,0 +1,43 @@
+class Month(str):
+    """
+    Month with the year corresponding to it.
+    It is epected in the format of %Y-%m.
+    """
+
+    @classmethod
+    def __get_validators__(cls):
+        # one or more validators may be yielded which will be called in the
+        # order to validate the input, each validator will receive as an input
+        # the value returned from the previous validator
+        yield cls.validate
+
+    @classmethod
+    def validate(cls, v):
+        if not isinstance(v, str):
+            raise TypeError("string required")
+
+        splits = v.strip().split("-", 1)
+
+        if len(splits) != 2:
+            raise ValueError("Month Format should be: %Y-%m")
+
+        for s in splits:
+            if not s.isdecimal():
+                raise ValueError(f"{s} is not a number.")
+
+        year, month = tuple(map(int, splits))
+
+        # Twitter was established in 2006
+        if year < 2006 or year > 2100:
+            raise ValueError(f"{year} is not a valid year.")
+
+        if month < 1 or month > 12:
+            raise ValueError(f"{month} is not a valid month.")
+
+        # you could also return a string here pydantic won't care
+        # but you could end up with some confusion since the
+        # value's type won't match the type annotation exactly
+        return cls(f"{year}-{month:02}")
+
+    def __repr__(self):
+        return f"Month: {super().__repr__()}"

server/test/test_utils.py

@@ -1,13 +1,12 @@
 from typing import List
 
-from app.tweets_common.models import PseudoTweet, Tweet
+from sqlalchemy.exc import OperationalError
+from sqlmodel import Session
 
+from app.tweets_common.models import PseudoTweet, Tweet
 from utils.load_labels import load_database as load_label
 from utils.load_pseudo_labels import load_database as load_pseudo_label
 
-from sqlmodel import Session
-from sqlalchemy.exc import OperationalError
-
 
 def test_labels(session: Session):
     # Test suite may not contain the database to get the verifier id

server/utils/load_labels.py

@@ -6,9 +6,8 @@
 from sqlmodel import Session, select
 
 from app.auth.models import User
-from app.tweets_common.models import Tweet
-
 from app.database import get_session
+from app.tweets_common.models import Tweet
 
 
 def load_database(write_session: Session):