Bugfix/cleanup2 (#291)

Author: Gonzom

app/config.py.example

@@ -72,12 +72,12 @@ CALENDAR_HOME_PAGE = "calendar.pythonic.guru"
 # link to the application registration page
 CALENDAR_REGISTRATION_PAGE = r"calendar.pythonic.guru/registration"
 
-# import
+# IMPORT
 MAX_FILE_SIZE_MB = 5  # 5MB
 VALID_FILE_EXTENSION = (".txt", ".csv", ".ics")  # Can import only these files.
 # Events must be within 20 years range from the current year.
 EVENT_VALID_YEARS = 20
-EVENT_HEADER_NOT_EMPTY = 1  # 1- for not empty, 0- for empty.
+EVENT_HEADER_NOT_EMPTY = True
 EVENT_HEADER_LIMIT = 50  # Max characters for event header.
 EVENT_CONTENT_LIMIT = 500  # Max characters for event content.
 MAX_EVENTS_START_DATE = 10  # Max Events with the same start date.

app/database/models.py

@@ -20,15 +20,15 @@
 )
 from sqlalchemy.dialects.postgresql import TSVECTOR
 from sqlalchemy.exc import IntegrityError, SQLAlchemyError
-from sqlalchemy.ext.declarative.api import declarative_base
+from sqlalchemy.ext.declarative.api import declarative_base, DeclarativeMeta
 from sqlalchemy.orm import relationship, Session
 from sqlalchemy.sql.schema import CheckConstraint
 
 from app.config import PSQL_ENVIRONMENT
 from app.dependencies import logger
 import app.routers.salary.config as SalaryConfig
 
-Base = declarative_base()
+Base: DeclarativeMeta = declarative_base()
 
 
 class User(Base):

app/internal/astronomy.py

@@ -1,70 +1,78 @@
-import datetime
+from datetime import datetime
 import functools
-from typing import Dict
+from typing import Any, Dict
 
 import httpx
 
 from app import config
 
-# This feature requires an API KEY - get yours free @ www.weatherapi.com
+# This feature requires an API key. Get yours free at www.weatherapi.com.
+ASTRONOMY_URL = "https://api.weatherapi.com/v1/astronomy.json"
+NO_API_RESPONSE = _("No response from server.")
 
-ASTRONOMY_URL = "http://api.weatherapi.com/v1/astronomy.json"
-NO_API_RESPONSE = "No response from server"
 
+async def get_astronomical_data(
+        date: datetime, location: str
+) -> Dict[str, Any]:
+    """Returns astronomical data (sun and moon) for date and location.
 
-@functools.lru_cache(maxsize=128, typed=False)
-async def get_data_from_api(formatted_date: str, location: str) \
-        -> Dict[str, int]:
-    """ get the relevant astronomical data by calling the "weather api" API.
     Args:
-        formatted_date (date) - relevant date.
-        location (str) - location name.
+        date: The requested date for astronomical data.
+        location: The location name.
+
+    Returns:
+        A dictionary with the following entries:
+            success: True or False.
+            error: The error description.
+            location: A dictionary of relevant data, including:
+                name, region, country, lat, lon etc.
+            astronomy: A dictionary of relevant data, including:
+                sunrise, sunset, moonrise, moonset, moon_phase, and
+                moon_illumination.
+    """
+    formatted_date = date.strftime('%Y-%m-%d')
+    return await _get_astronomical_data_from_api(formatted_date, location)
+
+
+@functools.lru_cache(maxsize=128)
+async def _get_astronomical_data_from_api(
+        date: str, location: str
+) -> Dict[str, Any]:
+    """Returns astronomical_data from a Weather API call.
+
+    Args:
+        date: The requested date for astronomical data.
+        location: The location name.
+
     Returns:
-        response_json (json dict) including:
-        relevant part (data / error) of the JSON returned by the API.
-        Success (bool)
-        ErrorDescription (str) - error message.
+        A dictionary with the results from the API call.
     """
-    input_query_string = {'key': config.ASTRONOMY_API_KEY, 'q': location,
-                          'dt': formatted_date}
-    output = {}
+    input_query_string = {
+        'key': config.ASTRONOMY_API_KEY,
+        'q': location,
+        'dt': date,
+    }
+
+    output: Dict[str, Any] = {}
     try:
         async with httpx.AsyncClient() as client:
-            response = await client.get(ASTRONOMY_URL,
-                                        params=input_query_string)
+            response = await client.get(
+                ASTRONOMY_URL, params=input_query_string)
     except httpx.HTTPError:
-        output["Success"] = False
-        output["ErrorDescription"] = NO_API_RESPONSE
+        output["success"] = False
+        output["error"] = NO_API_RESPONSE
         return output
+
     if response.status_code != httpx.codes.OK:
-        output["Success"] = False
-        output["ErrorDescription"] = NO_API_RESPONSE
+        output["success"] = False
+        output["error"] = NO_API_RESPONSE
         return output
-    output["Success"] = True
+
+    output["success"] = True
     try:
         output.update(response.json()['location'])
         return output
     except KeyError:
-        output["Success"] = False
-        output["ErrorDescription"] = response.json()['error']['message']
+        output["success"] = False
+        output["error"] = response.json()['error']['message']
         return output
-
-
-async def get_astronomical_data(requested_date: datetime.datetime,
-                                location: str) -> Dict[str, int]:
-    """ get astronomical data (Sun & Moon) for date & location -
-        main function.
-    Args:
-        requested_date (date) - date requested for astronomical data.
-        location (str) - location name.
-    Returns: dictionary with the following entries:
-        Status - success / failure.
-        ErrorDescription - error description (relevant only in case of error).
-        location - relevant location values(relevant only in case of success).
-            name, region, country, lat, lon etc.
-        astronomy - relevant astronomy values, all time in local time -
-            (relevant only in case of success):
-            sunrise, sunset, moonrise, moonset, moon_phase, moon_illumination.
-    """
-    formatted_date = requested_date.strftime('%Y-%m-%d')
-    return await get_data_from_api(formatted_date, location)

app/internal/celebrity.py

@@ -2,6 +2,5 @@
 
 
 def get_today_month_and_day() -> str:
-    """Get today's month and day - %m-%d"""
-
+    """Returns today's month and day in the format: %m-%d"""
     return datetime.date.today().strftime("%m-%d")

app/internal/daily_quotes.py

@@ -9,22 +9,39 @@
 TOTAL_DAYS = 366
 
 
-def create_quote_object(quotes_fields: Dict[str, Optional[str]]) -> Quote:
-    """This function create a quote object from given fields dictionary.
-    It is used for adding the data from the json into the db"""
+def get_quote(quote_: Dict[str, Optional[str]]) -> Quote:
+    """Returns a Quote object from the dictionary data.
+
+    Args:
+        quote_: A dictionary quote related information.
+
+    Returns:
+        A new Quote object.
+    """
     return Quote(
-        text=quotes_fields['text'],
-        author=quotes_fields['author']
+        text=quote_['text'],
+        author=quote_['author'],
     )
 
 
-def quote_per_day(
-        session: Session, date: date = date.today()
+def get_quote_of_day(
+        session: Session, requested_date: date = date.today()
 ) -> Optional[Quote]:
-    """This function provides a daily quote, relevant to the current
-    day of the year. The quote is randomally selected from a set
-    of quotes matching to the given day"""
-    day_num = date.timetuple().tm_yday
-    quote = session.query(Quote).filter(
-        Quote.id % TOTAL_DAYS == day_num).order_by(func.random()).first()
+    """Returns the Quote object for the specific day.
+
+    The quote is randomly selected from a set of quotes matching the given day.
+
+    Args:
+        session: The database connection.
+        requested_date: Optional; The requested date.
+
+    Returns:
+        A Quote object.
+    """
+    day_number = requested_date.timetuple().tm_yday
+    quote = (session.query(Quote)
+             .filter(Quote.id % TOTAL_DAYS == day_number)
+             .order_by(func.random())
+             .first()
+             )
     return quote