spotify-apimatic-sdk 1.0.0__py3-none-any.whl

spotifywebapi/spotifywebapi_client.py

@@ -0,0 +1,198 @@
+"""spotifywebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from apimatic_core.configurations.global_configuration import (
+    GlobalConfiguration,
+)
+from apimatic_core.decorators.lazy_property import (
+    LazyProperty,
+)
+
+from spotifywebapi.configuration import (
+    Configuration,
+    Environment,
+)
+from spotifywebapi.controllers.albums_controller import (
+    AlbumsController,
+)
+from spotifywebapi.controllers.artists_controller import (
+    ArtistsController,
+)
+from spotifywebapi.controllers.audiobooks_controller import (
+    AudiobooksController,
+)
+from spotifywebapi.controllers.base_controller import (
+    BaseController,
+)
+from spotifywebapi.controllers.categories_controller import (
+    CategoriesController,
+)
+from spotifywebapi.controllers.chapters_controller import (
+    ChaptersController,
+)
+from spotifywebapi.controllers.episodes_controller import (
+    EpisodesController,
+)
+from spotifywebapi.controllers.genres_controller import (
+    GenresController,
+)
+from spotifywebapi.controllers.markets_controller import (
+    MarketsController,
+)
+from spotifywebapi.controllers.o_auth_authorization_controller import (
+    OAuthAuthorizationController,
+)
+from spotifywebapi.controllers.player_controller import (
+    PlayerController,
+)
+from spotifywebapi.controllers.playlists_controller import (
+    PlaylistsController,
+)
+from spotifywebapi.controllers.search_controller import (
+    SearchController,
+)
+from spotifywebapi.controllers.shows_controller import (
+    ShowsController,
+)
+from spotifywebapi.controllers.tracks_controller import (
+    TracksController,
+)
+from spotifywebapi.controllers.users_controller import (
+    UsersController,
+)
+from spotifywebapi.http.auth.o_auth_2 import (
+    OAuth2,
+)
+
+
+class SpotifywebapiClient(object):
+    """Client that provide access to the SpotifywebapiClient APIs."""
+
+    @LazyProperty
+    def albums(self):
+        """Provide access to the AlbumsController endpoints."""
+        return AlbumsController(self.global_configuration)
+
+    @LazyProperty
+    def artists(self):
+        """Provide access to the ArtistsController endpoints."""
+        return ArtistsController(self.global_configuration)
+
+    @LazyProperty
+    def audiobooks(self):
+        """Provide access to the AudiobooksController endpoints."""
+        return AudiobooksController(self.global_configuration)
+
+    @LazyProperty
+    def categories(self):
+        """Provide access to the CategoriesController endpoints."""
+        return CategoriesController(self.global_configuration)
+
+    @LazyProperty
+    def chapters(self):
+        """Provide access to the ChaptersController endpoints."""
+        return ChaptersController(self.global_configuration)
+
+    @LazyProperty
+    def episodes(self):
+        """Provide access to the EpisodesController endpoints."""
+        return EpisodesController(self.global_configuration)
+
+    @LazyProperty
+    def genres(self):
+        """Provide access to the GenresController endpoints."""
+        return GenresController(self.global_configuration)
+
+    @LazyProperty
+    def markets(self):
+        """Provide access to the MarketsController endpoints."""
+        return MarketsController(self.global_configuration)
+
+    @LazyProperty
+    def player(self):
+        """Provide access to the PlayerController endpoints."""
+        return PlayerController(self.global_configuration)
+
+    @LazyProperty
+    def playlists(self):
+        """Provide access to the PlaylistsController endpoints."""
+        return PlaylistsController(self.global_configuration)
+
+    @LazyProperty
+    def search(self):
+        """Provide access to the SearchController endpoints."""
+        return SearchController(self.global_configuration)
+
+    @LazyProperty
+    def shows(self):
+        """Provide access to the ShowsController endpoints."""
+        return ShowsController(self.global_configuration)
+
+    @LazyProperty
+    def tracks(self):
+        """Provide access to the TracksController endpoints."""
+        return TracksController(self.global_configuration)
+
+    @LazyProperty
+    def users(self):
+        """Provide access to the UsersController endpoints."""
+        return UsersController(self.global_configuration)
+
+    @LazyProperty
+    def o_auth_authorization(self):
+        """Provide access to the OAuthAuthorizationController endpoints."""
+        return OAuthAuthorizationController(self.global_configuration)
+
+    @property
+    def oauth_2_0(self):
+        """Provide access to the Oauth20 auth manager."""
+        return self.auth_managers["oauth_2_0"]
+
+    def __init__(self, http_client_instance=None,
+                 override_http_client_configuration=False, http_call_back=None,
+                 timeout=60, max_retries=0, backoff_factor=2,
+                 retry_statuses=None, retry_methods=None, proxy_settings=None,
+                 environment=Environment.PRODUCTION, o_auth_client_id=None,
+                 o_auth_client_secret=None, o_auth_redirect_uri=None,
+                 o_auth_token=None, o_auth_scopes=None,
+                 authorization_code_auth_credentials=None, config=None):
+        """Initialize a new instance of SpotifywebapiClient."""
+        self.config = config or Configuration(
+            http_client_instance=http_client_instance,
+            override_http_client_configuration=override_http_client_configuration,
+            http_call_back=http_call_back, timeout=timeout,
+            max_retries=max_retries, backoff_factor=backoff_factor,
+            retry_statuses=retry_statuses, retry_methods=retry_methods,
+            proxy_settings=proxy_settings, environment=environment,
+            o_auth_client_id=o_auth_client_id,
+            o_auth_client_secret=o_auth_client_secret,
+            o_auth_redirect_uri=o_auth_redirect_uri, o_auth_token=o_auth_token,
+            o_auth_scopes=o_auth_scopes,
+            authorization_code_auth_credentials=authorization_code_auth_credentials)
+
+        self.global_configuration = GlobalConfiguration(self.config)\
+            .global_errors(BaseController.global_errors())\
+            .base_uri_executor(self.config.get_base_uri)\
+            .user_agent(BaseController.user_agent(),
+                BaseController.user_agent_parameters())
+
+        self.auth_managers = {
+            "oauth_2_0": OAuth2(self.config.authorization_code_auth_credentials,
+                                self.global_configuration),
+        }
+        self.global_configuration =\
+            self.global_configuration.auth_managers(self.auth_managers)
+
+    @classmethod
+    def from_environment(cls, dotenv_path=None, **overrides):
+        """Create a client instance using environment variables.
+
+        Returns:
+            SpotifywebapiClient instance.
+
+        """
+        return cls(config=Configuration
+            .from_environment(dotenv_path=dotenv_path, **overrides))

spotifywebapi/utilities/__init__.py

@@ -0,0 +1,6 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "file_wrapper",
+    "pagination",
+]

spotifywebapi/utilities/file_wrapper.py

@@ -0,0 +1,45 @@
+"""
+spotifywebapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+from apimatic_core.types.file_wrapper import FileWrapper as CoreFileWrapper
+
+
+class FileWrapper(CoreFileWrapper):
+    """A wrapper to allow passing in content type for file uploads."""
+
+    def __init__(self, file, content_type: str="application/octet-stream") -> None:
+        """Initialize a new `FileWrapper` instance.
+
+        Args:
+            file: A readable file-like object or byte stream to wrap.
+            content_type (str, optional): The MIME type to associate with the
+                file. Defaults to `"application/octet-stream"`.
+
+        """
+        super().__init__(file, content_type)
+
+    def __repr__(self) -> str:
+        """Return a detailed string representation of the instance.
+
+        Returns:
+            str: A detailed, unambiguous representation of the wrapper.
+
+        """
+        return (f"{self.__class__.__name__}("
+                f"file={self._file_stream!r}, "
+                f"content_type={self.content_type!r})")
+
+    def __str__(self) -> str:
+        """Return a user-friendly string representation of the instance.
+
+        Returns:
+            str: A concise, readable representation of the wrapper.
+
+        """
+        return (f"{self.__class__.__name__}("
+                f"file={self._file_stream!s}, "
+                f"content_type={self.content_type!s})")

spotifywebapi/utilities/union_type_lookup.py

@@ -0,0 +1,113 @@
+
+"""
+spotifywebapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from __future__ import annotations
+
+from typing import (
+    Callable,
+    ClassVar,
+)
+
+from apimatic_core.types.union_types.leaf_type import (
+    LeafType,
+)
+from apimatic_core.types.union_types.one_of import (
+    OneOf,
+)
+from apimatic_core.types.union_types.union_type_context import (
+    UnionTypeContext as Context,
+)
+
+from spotifywebapi.models.episode_object import (
+    EpisodeObject,
+)
+from spotifywebapi.models.track_object import (
+    TrackObject,
+)
+
+
+class UnionTypeLookUp:
+    """
+    Provides lookup and factory methods for predefined union type templates.
+    This class stores a mapping of template names to callables that construct
+    union type instances. These templates are used to describe compatible
+    data shapes by combining primitive or model-based types into a single
+    resolved representation at runtime.
+
+    Attributes:
+        _templates (dict): A mapping of template names to factory callables
+        that create configured union types.
+
+    """
+
+    _templates: ClassVar[dict[str, Callable]] = {
+        "PlaylistTrackObjectTrack": lambda: OneOf(
+            [
+                LeafType(TrackObject),
+                LeafType(EpisodeObject),
+            ],
+            Context.create(
+               is_optional=True,
+            ),
+        ),
+        "QueueObjectCurrentlyPlaying": lambda: OneOf(
+            [
+                LeafType(TrackObject),
+                LeafType(EpisodeObject),
+            ],
+            Context.create(
+               is_optional=True,
+            ),
+        ),
+        "QueueObjectQueue": lambda: OneOf(
+            [
+                LeafType(TrackObject),
+                LeafType(EpisodeObject),
+            ],
+            Context.create(
+               is_array=True,
+               is_optional=True,
+            ),
+        ),
+        "CurrentlyPlayingContextObjectItem": lambda: OneOf(
+            [
+                LeafType(TrackObject),
+                LeafType(EpisodeObject),
+            ],
+            Context.create(
+               is_optional=True,
+            ),
+        ),
+        "CurrentlyPlayingObjectItem": lambda: OneOf(
+            [
+                LeafType(TrackObject),
+                LeafType(EpisodeObject),
+            ],
+            Context.create(
+               is_optional=True,
+            ),
+        ),
+    }
+
+    @staticmethod
+    def get(name):
+        """
+        Retrieve and construct a union type template by name.
+
+        Args:
+            name (str): The key identifying the template to resolve.
+
+        Returns:
+            Any: A new instance of the union type defined for the given name.
+
+        Raises:
+            KeyError: If no template exists for the specified name.
+
+        """
+        return UnionTypeLookUp._templates[name]()