Skip to content

Doc: Remove un-needed Attributes documentation #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
glensc merged 2 commits into from
Feb 1, 2025
Merged

Doc: Remove un-needed Attributes documentation #68

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c809e00
Remove un-needed Attributes documentation
glensc Jan 31, 2025
877c2f6
Use Auth rather object type
glensc Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions trakt/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,6 @@ def __init__(self, base_url: str, session: Session, timeout=None):
base_url (str): The base URL for API requests.
session (Session): A requests Session object for managing HTTP connections.
timeout (float, optional): Request timeout in seconds. Defaults to a predefined TIMEOUT value if not specified.

Attributes:
_auth (object): Private attribute to store authentication mechanism.
base_url (str): Base URL for API endpoint.
session (Session): Requests session for connection management.
timeout (float): Request timeout duration.
logger (logging.Logger): Logger instance for tracking HTTP client activities.
"""
self._auth = None
self.base_url = base_url
Expand Down Expand Up @@ -88,7 +81,7 @@ def auth(self):
Get the current authentication object for the HTTP client.

Returns:
object: The authentication object associated with the HTTP client, which can be None or an authentication instance.
Auth | None: The authentication object associated with the HTTP client, which can be None or an authentication instance.
"""
return self._auth

Expand All @@ -98,8 +91,7 @@ def auth(self, auth):
Set the authentication method for the HTTP client.

Parameters:
auth (object): An authentication object to be used for API requests.
Typically an instance of TokenAuth or a similar authentication class.
auth (Auth | None): An authentication object to be used for API requests.
"""
self._auth = auth

Expand Down