Skip to content

Commit 9085e30

Browse files
committed
Standardize code style across pagination implementation
- Make TYPE_CHECKING comments consistent across all files - Remove redundant comments about circular imports - Maintain consistent formatting and documentation style
1 parent a946c8e commit 9085e30

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

fitbit_client/resources/activity.py

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,7 @@
2323
from fitbit_client.utils.types import JSONList
2424
from fitbit_client.utils.types import ParamDict
2525

26-
# We use TYPE_CHECKING to avoid circular imports at runtime.
27-
# PaginatedIterator is only needed for type annotations, not for runtime code.
28-
# This pattern is recommended by the Python typing documentation:
29-
# https://docs.python.org/3/library/typing.html#typing.TYPE_CHECKING
26+
# Use TYPE_CHECKING to avoid circular imports
3027
if TYPE_CHECKING:
3128
# Local imports - only imported during type checking
3229
# Local imports
@@ -271,7 +268,6 @@ def get_activity_log_list(
271268
return cast(JSONDict, result)
272269

273270
# Return as iterator if requested
274-
# We use string literal type annotation 'PaginatedIterator' to avoid circular imports
275271
if as_iterator:
276272
return create_paginated_iterator(
277273
response=cast(JSONDict, result),

fitbit_client/resources/electrocardiogram.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@
1717
from fitbit_client.utils.types import JSONDict
1818
from fitbit_client.utils.types import ParamDict
1919

20+
# Use TYPE_CHECKING to avoid circular imports
2021
if TYPE_CHECKING:
22+
# Local imports - only imported during type checking
2123
# Local imports
2224
from fitbit_client.resources.pagination import PaginatedIterator
2325

@@ -128,7 +130,6 @@ def get_ecg_log_list(
128130
return cast(JSONDict, result)
129131

130132
# Return as iterator if requested
131-
# We use TYPE_CHECKING for PaginatedIterator type to avoid circular imports
132133
if as_iterator:
133134
return create_paginated_iterator(
134135
response=cast(JSONDict, result),

fitbit_client/resources/irregular_rhythm_notifications.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
from fitbit_client.utils.types import JSONDict
1616
from fitbit_client.utils.types import ParamDict
1717

18+
# Use TYPE_CHECKING to avoid circular imports
1819
if TYPE_CHECKING:
20+
# Local imports - only imported during type checking
1921
# Local imports
2022
from fitbit_client.resources.pagination import PaginatedIterator
2123

@@ -129,7 +131,6 @@ def get_irn_alerts_list(
129131
return cast(JSONDict, result)
130132

131133
# Return as iterator if requested
132-
# We use TYPE_CHECKING for PaginatedIterator type to avoid circular imports
133134
if as_iterator:
134135
return create_paginated_iterator(
135136
response=cast(JSONDict, result),

fitbit_client/resources/pagination.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@
1717
# Set up logging
1818
logger = logging.getLogger(__name__)
1919

20-
# Avoid circular imports
20+
# Use TYPE_CHECKING to avoid circular imports
2121
if TYPE_CHECKING:
22+
# Local imports - only imported during type checking
2223
# Local imports
2324
from fitbit_client.resources.base import BaseResource
2425

fitbit_client/resources/sleep.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@
1919
from fitbit_client.utils.types import JSONDict
2020
from fitbit_client.utils.types import ParamDict
2121

22+
# Use TYPE_CHECKING to avoid circular imports
2223
if TYPE_CHECKING:
24+
# Local imports - only imported during type checking
2325
# Local imports
2426
from fitbit_client.resources.pagination import PaginatedIterator
2527

@@ -391,7 +393,6 @@ def get_sleep_log_list(
391393
return cast(JSONDict, result)
392394

393395
# Return as iterator if requested
394-
# We use TYPE_CHECKING for PaginatedIterator type to avoid circular imports
395396
if as_iterator:
396397
return create_paginated_iterator(
397398
response=cast(JSONDict, result),

0 commit comments

Comments
 (0)