• 📝 Generate Docstrings

• X
• Mastodon
• Reddit
• LinkedIn

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

@@            Coverage Diff            @@
##              main      #113   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           34        36    +2     
  Lines         1374      1427   +53     
=========================================
+ Hits          1374      1427   +53     

Flags with carried forward coverage won't be shown. Click here to find out more.

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

At the top of src/garth/cli.py, ensure you have:

 import argparse
 import getpass
+import sys
+from typing import NoReturn

Change the signature of main() to return an int:

- def main():
+ def main() -> int:

Replace the Python 3.10 match-case block with an if/else:

-    match args.command:
-        case "login":
-            email = input("Email: ")
-            password = getpass.getpass("Password: ")
-            garth.login(email, password)
-            token = garth.client.dumps()
-            print(token)
-        case _:
-            parser.print_help()
+    if args.command == "login":
+        # login logic goes here
+        email = input("Email: ")
+        password = getpass.getpass("Password: ")
+        garth.login(email, password)
+        token = garth.client.dumps()
+        print(token)
+        return 0
+    else:
+        parser.print_help()
+        return 0

Wrap the dispatch in try/except blocks to handle errors cleanly:

-    if args.command == "login":
-        # ...
+    try:
+        if args.command == "login":
+            try:
+                email = input("Email: ")
+                password = getpass.getpass("Password: ")
+            except KeyboardInterrupt:
+                print("\nLogin cancelled by user", file=sys.stderr)
+                return 1
+
+            try:
+                garth.login(email, password)
+                token = garth.client.dumps()
+                print(token)
+                return 0
+            except garth.GarthException as e:
+                print(f"Authentication error: {e}", file=sys.stderr)
+                return 1
+            except Exception as e:
+                print(f"Unexpected error during login: {e}", file=sys.stderr)
+                return 1
+        else:
+            parser.print_help()
+            return 0
+    except Exception as e:
+        print(f"Fatal error: {e}", file=sys.stderr)
+        return 1

At the bottom, update the entry point to exit with the returned code:

 if __name__ == "__main__":
-    main()
+    sys.exit(main())

Run the CI workflow or locally invoke the CLI under both Python 3.9 and 3.10. Verify:

• garth --help prints usage to stdout and returns 0
• garth login with correct credentials returns 0
• KeyboardInterrupt during input returns exit code 1 with the correct stderr message
• garth login raising GarthException returns exit code 1 with the authentication error message

Create the file tests/test_cli.py with the following content:

import io
import sys
from unittest import mock

import pytest

from garth import cli, GarthException

def test_main_help():
    """Test that help message is displayed when no command is provided."""
    with mock.patch("sys.stdout", new=io.StringIO()) as fake_out:
        with mock.patch("sys.argv", ["garth", "--help"]):
            with pytest.raises(SystemExit):
                cli.main()
        assert "usage: garth" in fake_out.getvalue()

@mock.patch("getpass.getpass")
@mock.patch("builtins.input")
@mock.patch("garth.login")
@mock.patch("garth.client.dumps")
def test_login_success(mock_dumps, mock_login, mock_input, mock_getpass):
    """Test successful login flow."""
    mock_input.return_value = "[email protected]"
    mock_getpass.return_value = "password123"
    mock_dumps.return_value = "test-token"

    with mock.patch("sys.stdout", new=io.StringIO()) as fake_out:
        with mock.patch("sys.argv", ["garth", "login"]):
            result = cli.main()

    mock_input.assert_called_once_with("Email: ")
    mock_getpass.assert_called_once_with("Password: ")
    mock_login.assert_called_once_with("[email protected]", "password123")
    mock_dumps.assert_called_once()
    assert result == 0
    assert "test-token" in fake_out.getvalue()

@mock.patch("getpass.getpass")
@mock.patch("builtins.input")
@mock.patch("garth.login")
def test_login_auth_error(mock_login, mock_input, mock_getpass):
    """Test login with authentication error."""
    mock_input.return_value = "[email protected]"
    mock_getpass.return_value = "wrong-password"
    mock_login.side_effect = GarthException("Invalid credentials")

    with mock.patch("sys.stderr", new=io.StringIO()) as fake_err:
        with mock.patch("sys.argv", ["garth", "login"]):
            result = cli.main()
    assert result == 1
    assert "Authentication error: Invalid credentials" in fake_err.getvalue()

@mock.patch("builtins.input")
def test_login_keyboard_interrupt(mock_input):
    """Test login with keyboard interrupt."""
    mock_input.side_effect = KeyboardInterrupt()

    with mock.patch("sys.stderr", new=io.StringIO()) as fake_err:
        with mock.patch("sys.argv", ["garth", "login"]):
            result = cli.main()
    assert result == 1
    assert "Login cancelled by user" in fake_err.getvalue()

@mock.patch("garth.login")
@mock.patch("getpass.getpass")
@mock.patch("builtins.input")
def test_login_unexpected_error(mock_input, mock_getpass, mock_login):
    """Test login with an unexpected error."""
    mock_input.return_value = "[email protected]"
    mock_getpass.return_value = "password123"
    mock_login.side_effect = Exception("Something went wrong")

    with mock.patch("sys.stderr", new=io.StringIO()) as fake_err:
        with mock.patch("sys.argv", ["garth", "login"]):
            result = cli.main()
    assert result == 1
    assert "Unexpected error during login: Something went wrong" in fake_err.getvalue()

Run pytest to confirm that all new tests pass and that the CLI behaves correctly under help, success, authentication failure, and interrupt scenarios.

Modify the import at the top of the file:

- from typing import List
+ from typing import TypeVar

Update each attribute annotation from List[str] to list[str]. For example:

-     favorite_activity_types: List[str]
+     favorite_activity_types: list[str]

-     favorite_cycling_activity_types: List[str]
+     favorite_cycling_activity_types: list[str]

-     user_roles: List[str]
+     user_roles: list[str]

Change the import:

- from typing import Dict, List
+ from typing import Dict

Convert type annotations:

-     hydration_containers: List[Dict[str, float | str | None]]
+     hydration_containers: list[Dict[str, float | str | None]]

-     user_sleep_windows: List[UserSleepWindow] | None = None
+     user_sleep_windows: list[UserSleepWindow] | None = None

Remove List from the import:

- from typing import ClassVar, List
+ from typing import ClassVar

Update the return annotation of the list classmethod:

-     ) -> List[Self]:
+     ) -> list[Self]:

Adjust the import:

- from typing import List, Optional, Union
+ from typing import Optional, Union

Convert annotations:

-     sleep_movement: Optional[List[SleepMovement]] = None
+     sleep_movement: Optional[list[SleepMovement]] = None

Update the return type of the list method:

-     ) -> List[Self]:
+     ) -> list[Self]:

Update the import statement:
diff - from typing import List, Optional, Union + from typing import Optional, Union

On the line
sleep_movement: Optional[List[SleepMovement]] = None
change it to
python sleep_movement: Optional[list[SleepMovement]] = None

In the signature of the classmethod list (formerly returning List[Self]), change:
diff - ) -> List[Self]: + ) -> list[Self]:

On line 2, remove List from the import so it reads:

from typing import Optional, Union

On line 105, change the field annotation from:

sleep_movement: Optional[List[SleepMovement]] = None

to:

sleep_movement: Optional[list[SleepMovement]] = None

On line 129, change the classmethod return annotation from:

) -> List[Self]:

to:

) -> list[Self]:

On line 2, remove List from the typing import. Change:

- from typing import List, Optional, Union
+ from typing import Optional, Union

On line 105, update the Optional[List[SleepMovement]] annotation to use the built-in list type. Change:

-     sleep_movement: Optional[List[SleepMovement]] = None
+     sleep_movement: Optional[list[SleepMovement]] = None

On line 129, update the return type annotation of the classmethod list() to use the built-in list type. Change:

-     def list(cls, *args, **kwargs) -> List[Self]:
+     def list(cls, *args, **kwargs) -> list[Self]:

Save the file and run the type checker (for example, mypy) to confirm there are no remaining references to typing.List in this file.

Swap out the import:

- from typing import List
+ from typing import TypeVar

Change the attribute annotation:

-     hrv_readings: List[HRVReading]
+     hrv_readings: list[HRVReading]

Remove List from the import:

- from typing import List
+ from typing import TypeVar

Update the return type of the list classmethod:

-     ) -> List[Self]:
+     ) -> list[Self]:

Adjust the import:

- from typing import Any, Dict, List, Union
+ from typing import Any, Dict, Union

Convert function signature:

- def some_function(
-     some_param: List[str],
- ) -> None:
+ def some_function(
+     some_param: list[str],
+ ) -> None:

Adjust the test matrix to Python 3.10, 3.11, 3.12:

-        python-version: [3.7, 3.8, 3.9]
+        python-version: [3.10, 3.11, 3.12]

Modify the lint step to exit zero on warnings:

-      - name: Lint
-        run: ruff .
+      - name: Lint
+        run: ruff . --exit-zero

For each file that imports List from typing (as identified by the grep), open the file and remove List from the import.
Example change in src/garth/data/_base.py:

-from typing import List
+from typing import TypeVar

After edits, remove any now-unused List imports, run isort to reorder imports, and run flake8 to confirm there are no import or annotation errors.

Run mypy or your type checker to verify that list[...] annotations are accepted and there are no type errors.

Create the file src/garth/tests/test_cli.py with the following content:

import io
import sys
from unittest import mock

import pytest

from garth import cli, GarthException


def test_main_help():
    """Test that help message is displayed when no command is provided."""
    with mock.patch("sys.stdout", new=io.StringIO()) as fake_out:
        with mock.patch("sys.argv", ["garth"]):
            result = cli.main()
    assert result == 0
    assert "usage: garth" in fake_out.getvalue()


@mock.patch("getpass.getpass")
@mock.patch("builtins.input")
@mock.patch("garth.login")
@mock.patch("garth.client.dumps")
def test_login_success(mock_dumps, mock_login, mock_input, mock_getpass):
    """Test successful login flow."""
    mock_input.return_value = "[email protected]"
    mock_getpass.return_value = "password123"
    mock_dumps.return_value = "test-token"

    with mock.patch("sys.stdout", new=io.StringIO()) as fake_out:
        with mock.patch("sys.argv", ["garth", "login"]):
            result = cli.main()

    mock_input.assert_called_once_with("Email: ")
    mock_getpass.assert_called_once_with("Password: ")
    mock_login.assert_called_once_with("[email protected]", "password123")
    mock_dumps.assert_called_once()
    assert result == 0
    assert "test-token" in fake_out.getvalue()


@mock.patch("getpass.getpass")
@mock.patch("builtins.input")
@mock.patch("garth.login")
def test_login_auth_error(mock_login, mock_input, mock_getpass):
    """Test login with authentication error."""
    mock_input.return_value = "[email protected]"
    mock_getpass.return_value = "wrong-password"
    mock_login.side_effect = GarthException("Invalid credentials")

    with mock.patch("sys.stderr", new=io.StringIO()) as fake_err:
        with mock.patch("sys.argv", ["garth", "login"]):
            result = cli.main()

    assert result == 1
    assert "Authentication error: Invalid credentials" in fake_err.getvalue()


@mock.patch("builtins.input")
def test_login_keyboard_interrupt(mock_input):
    """Test login with keyboard interrupt."""
    mock_input.side_effect = KeyboardInterrupt()

    with mock.patch("sys.stderr", new=io.StringIO()) as fake_err:
        with mock.patch("sys.argv", ["garth", "login"]):
            result = cli.main()

    assert result == 1
    assert "Login cancelled by user" in fake_err.getvalue()


@mock.patch("garth.login")
@mock.patch("getpass.getpass")
@mock.patch("builtins.input")
def test_login_unexpected_error(mock_input, mock_getpass, mock_login):
    """Test login with an unexpected error."""
    mock_input.return_value = "[email protected]"
    mock_getpass.return_value = "password123"
    mock_login.side_effect = Exception("Something went wrong")

    with mock.patch("sys.stderr", new=io.StringIO()) as fake_err:
        with mock.patch("sys.argv", ["garth", "login"]):
            result = cli.main()

    assert result == 1
    assert "Unexpected error during login: Something went wrong" in fake_err.getvalue()

Ensure pytest is listed in dev dependencies, then run pytest -q to confirm all new tests pass under the updated CLI behavior.