Modernization.

Author: coddingtonbear

.github/workflows/lint.yml

@@ -18,7 +18,7 @@ jobs:
         run: pip install black==22.6.0 flake8==5.0.4
 
       - name: Run linters
-        uses: samuelmeuli/lint-action@v1.5.3
+        uses: wearerequired/lint-action
         with:
           github_token: ${{ secrets.github_token }}
           # Enable linters

.pre-commit-config.yaml

@@ -4,24 +4,24 @@ repos:
   # Sort imports prior to black reformatting, to
   # ensure black always takes prescedence
   - repo: https://github.com/timothycrosley/isort
-    rev: 4.3.21
+    rev: 6.0.1
     hooks:
       - id: isort
   - repo: https://github.com/ambv/black
-    rev: 22.6.0
+    rev: 25.1.0
     hooks:
       - id: black
   - repo: https://github.com/pycqa/flake8
-    rev: 5.0.4
+    rev: 7.1.2
     hooks:
       - id: flake8
   - repo: https://github.com/asottile/pyupgrade
-    rev: v1.25.1
+    rev: v3.19.1
     hooks:
       - id: pyupgrade
-        args: ["--py37-plus"]
+        args: ["--py39-plus"]
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.7.1
+    rev: v1.15.0
     hooks:
       - id: mypy
         args:

myfitnesspal/client.py

@@ -8,7 +8,7 @@
 from collections import OrderedDict
 from http.cookiejar import CookieJar
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Union, cast, overload
+from typing import Any, cast, overload
 from urllib import parse
 
 import browser_cookie3
@@ -64,7 +64,7 @@ class Client(MFPBase):
 
     def __init__(
         self,
-        cookiejar: Optional[CookieJar] = None,
+        cookiejar: CookieJar | None = None,
         unit_aware: bool = False,
         log_requests_to: Path | None = None,
     ):
@@ -97,7 +97,7 @@ def __init__(
         self._user_metadata = self._get_user_metadata()
 
     @property
-    def user_id(self) -> Optional[types.MyfitnesspalUserId]:
+    def user_id(self) -> types.MyfitnesspalUserId | None:
         """The user_id of the logged-in account."""
         if self._auth_data is None:
             return None
@@ -110,7 +110,7 @@ def user_metadata(self) -> types.UserMetadata:
         return self._user_metadata
 
     @property
-    def access_token(self) -> Optional[str]:
+    def access_token(self) -> str | None:
         """The access token for the logged-in account."""
         if self._auth_data is None:
             return None
@@ -222,7 +222,7 @@ def _get_request_for_url(
         self,
         url: str,
         send_token: bool = False,
-        headers: Optional[Dict[str, str]] = None,
+        headers: dict[str, str] | None = None,
         **kwargs,
     ) -> requests.Response:
         request_id = uuid.uuid4()
@@ -292,7 +292,7 @@ def _get_json_for_url(self, url):
 
         return json.loads(content)
 
-    def _get_measurement(self, name: str, value: Optional[float]) -> MeasureBase:
+    def _get_measurement(self, name: str, value: float | None) -> MeasureBase:
         if not self.unit_aware:
             return value
         measure, kwarg = self.DEFAULT_MEASURE_AND_UNIT[name]
@@ -357,7 +357,7 @@ def _get_completion(self, document) -> bool:
 
         return False  # Who knows, probably not my diary.
 
-    def _get_meals(self, document) -> List[Meal]:
+    def _get_meals(self, document) -> list[Meal]:
         meals = []
         fields = None
         meal_headers = document.xpath("//tr[@class='meal_header']")
@@ -514,12 +514,10 @@ def _extract_value(self, element):
         return value
 
     @overload
-    def get_date(self, year: int, month: int, day: int) -> Day:
-        ...
+    def get_date(self, year: int, month: int, day: int) -> Day: ...
 
     @overload
-    def get_date(self, date: datetime.date) -> Day:
-        ...
+    def get_date(self, date: datetime.date) -> Day: ...
 
     def get_date(self, *args, **kwargs) -> Day:
         """Returns your meal diary for a particular date"""
@@ -600,9 +598,9 @@ def _ensure_upper_lower_bound(self, lower_bound, upper_bound):
     def get_measurements(
         self,
         measurement="Weight",
-        lower_bound: Optional[datetime.date] = None,
-        upper_bound: Optional[datetime.date] = None,
-    ) -> Dict[datetime.date, float]:
+        lower_bound: datetime.date | None = None,
+        upper_bound: datetime.date | None = None,
+    ) -> dict[datetime.date, float]:
         """Returns measurements of a given name between two dates."""
         upper_bound, lower_bound = self._ensure_upper_lower_bound(
             lower_bound, upper_bound
@@ -654,8 +652,8 @@ def get_measurements(
     def set_measurements(
         self,
         measurement="Weight",
-        value: Optional[float] = None,
-        date: Optional[datetime.date] = None,
+        value: float | None = None,
+        date: datetime.date | None = None,
     ) -> None:
         """Sets measurement for today's date."""
         if value is None:
@@ -734,7 +732,7 @@ def _get_measurements(self, document):
 
         return measurements_dict
 
-    def _get_measurement_ids(self, document) -> Dict[str, int]:
+    def _get_measurement_ids(self, document) -> dict[str, int]:
         ids = {}
         for next_data in document.xpath("//script[@id='__NEXT_DATA__']"):
             next_data_json = json.loads(next_data.text)
@@ -758,7 +756,7 @@ def _get_notes(self, date: datetime.date) -> Note:
         )
         return Note(result.json()["item"])
 
-    def _get_water(self, date: datetime.date) -> Union[float, Volume]:
+    def _get_water(self, date: datetime.date) -> float | Volume:
         result = self._get_request_for_url(
             parse.urljoin(
                 self.BASE_URL_SECURE,
@@ -776,9 +774,9 @@ def get_report(
         self,
         report_name: str = "Net Calories",
         report_category: str = "Nutrition",
-        lower_bound: Optional[datetime.date] = None,
-        upper_bound: Optional[datetime.date] = None,
-    ) -> Dict[datetime.date, float]:
+        lower_bound: datetime.date | None = None,
+        upper_bound: datetime.date | None = None,
+    ) -> dict[datetime.date, float]:
         """
         Returns report data of a given name and category between two dates.
         """
@@ -818,15 +816,18 @@ def _get_url_for_report(
         return (
             parse.urljoin(
                 self.BASE_URL_SECURE,
-                "api/services/reports/results/" + report_category.lower() + "/" + report_name,
+                "api/services/reports/results/"
+                + report_category.lower()
+                + "/"
+                + report_name,
             )
             + f"/{str(delta.days)}.json"
         )
 
-    def _get_report_data(self, json_data: dict) -> Dict[datetime.date, float]:
-        report_data: Dict[datetime.date, float] = {}
+    def _get_report_data(self, json_data: dict) -> dict[datetime.date, float]:
+        report_data: dict[datetime.date, float] = {}
 
-        data = json_data.get("outcome").get("results")
+        data = json_data.get("outcome", {}).get("results")
 
         if not data:
             return report_data
@@ -848,7 +849,7 @@ def _get_report_data(self, json_data: dict) -> Dict[datetime.date, float]:
     def __str__(self) -> str:
         return f"MyFitnessPal Client for {self.effective_username}"
 
-    def get_food_search_results(self, query: str) -> List[FoodItem]:
+    def get_food_search_results(self, query: str) -> list[FoodItem]:
         """Search for foods matching a specified query."""
         search_url = parse.urljoin(self.BASE_URL_SECURE, self.SEARCH_PATH)
         document = self._get_document_for_url(search_url)
@@ -875,7 +876,7 @@ def get_food_search_results(self, query: str) -> List[FoodItem]:
 
         return self._get_food_search_results(document)
 
-    def _get_food_search_results(self, document) -> List[FoodItem]:
+    def _get_food_search_results(self, document) -> list[FoodItem]:
         item_divs = document.xpath("//li[@class='matched-food']")
 
         items = []
@@ -970,19 +971,19 @@ def set_new_food(
         fat: float,
         carbs: float,
         protein: float,
-        sodium: Optional[float] = None,
-        potassium: Optional[float] = None,
-        saturated_fat: Optional[float] = None,
-        polyunsaturated_fat: Optional[float] = None,
-        fiber: Optional[float] = None,
-        monounsaturated_fat: Optional[float] = None,
-        sugar: Optional[float] = None,
-        trans_fat: Optional[float] = None,
-        cholesterol: Optional[float] = None,
-        vitamin_a: Optional[float] = None,
-        calcium: Optional[float] = None,
-        vitamin_c: Optional[float] = None,
-        iron: Optional[float] = None,
+        sodium: float | None = None,
+        potassium: float | None = None,
+        saturated_fat: float | None = None,
+        polyunsaturated_fat: float | None = None,
+        fiber: float | None = None,
+        monounsaturated_fat: float | None = None,
+        sugar: float | None = None,
+        trans_fat: float | None = None,
+        cholesterol: float | None = None,
+        vitamin_a: float | None = None,
+        calcium: float | None = None,
+        vitamin_c: float | None = None,
+        iron: float | None = None,
         serving_size: str = "1 Serving",
         servingspercontainer: float = 1.0,
         sharepublic: bool = False,
@@ -1104,12 +1105,12 @@ def set_new_goal(
         self,
         energy: float,
         energy_unit: str = "calories",
-        carbohydrates: Optional[float] = None,
-        protein: Optional[float] = None,
-        fat: Optional[float] = None,
-        percent_carbohydrates: Optional[float] = None,
-        percent_protein: Optional[float] = None,
-        percent_fat: Optional[float] = None,
+        carbohydrates: float | None = None,
+        protein: float | None = None,
+        fat: float | None = None,
+        percent_carbohydrates: float | None = None,
+        percent_protein: float | None = None,
+        percent_fat: float | None = None,
     ) -> None:
         """Updates your nutrition goals.
 
@@ -1259,7 +1260,7 @@ def set_new_goal(
                 "status code: {status}".format(status=result.status_code)
             )
 
-    def get_recipes(self) -> Dict[int, str]:
+    def get_recipes(self) -> dict[int, str]:
         """Returns a dictionary with all saved recipes.
 
         Recipe ID will be used as dictionary key, recipe title as dictionary value.
@@ -1313,7 +1314,7 @@ def get_recipe(self, recipeid: int) -> types.Recipe:
         recipe_url = parse.urljoin(self.BASE_URL_SECURE, recipe_path)
         document = self._get_document_for_url(recipe_url)
 
-        recipe_dict: Dict[str, Any] = {
+        recipe_dict: dict[str, Any] = {
             "@context": "https://schema.org",
             "@type": "Recipe",
             "author": self.effective_username,
@@ -1372,7 +1373,7 @@ def get_recipe(self, recipeid: int) -> types.Recipe:
         recipe_dict["tags"] = ["MyFitnessPal"]
         return cast(types.Recipe, recipe_dict)
 
-    def get_meals(self) -> Dict[int, str]:
+    def get_meals(self) -> dict[int, str]:
         """Returns a dictionary with all saved meals.
 
         Key: Meal ID
@@ -1386,7 +1387,7 @@ def get_meals(self) -> Dict[int, str]:
         meals = document.xpath(
             "//*[@id='matching']/li"
         )  # get all items in the recipe list
-        _idx: Optional[int] = None
+        _idx: int | None = None
         try:
             for _idx, meal in enumerate(meals):
                 meal_path = meal.xpath("./a")[0].attrib["href"]
@@ -1409,7 +1410,7 @@ def get_meal(self, meal_id: int, meal_title: str) -> types.Recipe:
         meal_url = parse.urljoin(self.BASE_URL_SECURE, meal_path)
         document = self._get_document_for_url(meal_url)
 
-        recipe_dict: Dict[str, Any] = {
+        recipe_dict: dict[str, Any] = {
             "@context": "https://schema.org",
             "@type": "Recipe",
             "author": self.effective_username,

setup.cfg

@@ -2,11 +2,18 @@
 # https://github.com/ambv/black#line-length
 max-line-length = 88
 ignore =
-  E203,  # E203: whitespace before ':' (defer to black)
-  E231,  # E231: missing whitespace after ',' (defer to black)
-  E501,  # E501: line length (defer to black)
-  W503,  # W503: break before binary operators (defer to black)
-  A003,  # A003: [builtins] allow class attributes to be named after builtins (e.g., `id`)
+  # E203: whitespace before ':' (defer to black)
+  E203,
+  # E231: missing whitespace after ',' (defer to black)
+  E231,
+  # E501: line length (defer to black)
+  E501,
+  # W503: break before binary operators (defer to black)
+  W503,
+  # A003: [builtins] allow class attributes to be named after builtins (e.g., `id`)
+  A003,
+  # E704: Allow multiple statements on one line
+  E704,
 
 [pep8]
 max-line-length = 88