Generic audio file handler. Subclasses for specific audio containers or formats include
-
+
* :class:`FLACAudio` for audio encoded using the Free Lossless Audio Codec (FLAC), * :class:`MP3Audio` for audio encoded and stored in the MPEG Audio
@@ -628,7 +632,7 @@
Source code for minim.audio
container, * :class:`OggAudio` for Opus or Vorbis audio stored in an Ogg file, and
- * :class:`WAVEAudio` for audio encoded using linear pulse-code
+ * :class:`WAVEAudio` for audio encoded using linear pulse-code modulation (LPCM) and in the Waveform Audio File Format (WAVE). .. note::
@@ -638,14 +642,14 @@
Source code for minim.audio
there may be instances when this detection fails, especially when the audio codec and format combination is rarely seen. As such, it is always best to directly use one of the subclasses above to
- create a file handler for your audio file when its audio codec
+ create a file handler for your audio file when its audio codec and format are known. Parameters ---------- file : `str` or `pathlib.Path` Audio filename or path.
-
+
pattern : `tuple`, keyword-only, optional Regular expression search pattern and the corresponding metadata field(s).
@@ -653,16 +657,16 @@
Source code for minim.audio
.. container:: **Valid values**:
-
+
The supported metadata fields are * :code:`"artist"` for the track artist,
- * :code:`"title"` for the track title, and
+ * :code:`"title"` for the track title, and * :code:`"track_number"` for the track number. **Examples**:
- * :code:`("(.*) - (.*)", ("artist", "title"))` matches
+ * :code:`("(.*) - (.*)", ("artist", "title"))` matches filenames like "Taylor Swift - Cruel Summer.flac". * :code:`("(\\d*) - (.*)", ("track_number", "title"))` matches filenames like "04 - The Man.m4a".
@@ -670,12 +674,12 @@
Source code for minim.audio
filenames like "13 You Need to Calm Down.mp3". multivalue : `bool`
- Determines whether multivalue tags are supported. If
+ Determines whether multivalue tags are supported. If :code:`False`, the items in `value` are concatenated using the separator(s) specified in `sep`. sep : `str` or `tuple`, keyword-only, default: :code:`(", ", " & ")`
- Separator(s) to use to concatenate multivalue tags. If a
+ Separator(s) to use to concatenate multivalue tags. If a :code:`str` is provided, it is used to concatenate all values. If a :code:`tuple` is provided, the first :code:`str` is used to concatenate the first :math:`n - 1` values, and the second
@@ -685,13 +689,13 @@
Source code for minim.audio
---------- album : `str` Album title.
-
+
album_artist : `str` or `list` Album artist(s).
-
+
artist : `str` or `list` Artist(s).
-
+
artwork : `bytes` or `str` Byte-representation of, URL leading to, or filename of file containing the cover artwork.
@@ -707,7 +711,7 @@
filename:str=None,preserve:bool=True)->None:"""
- Convert the current audio file to another format.
+ Convert the current audio file to another format. .. admonition:: Software dependency Requires `FFmpeg <https://ffmpeg.org/>`_.
-
+
.. note:: The audio file handler is automatically updated to reflect
@@ -863,22 +867,22 @@
Source code for minim.audio
**Valid values**:
- * :code:`"aac"`, :code:`"m4a"`, :code:`"mp4"`, or
+ * :code:`"aac"`, :code:`"m4a"`, :code:`"mp4"`, or :code:`"mp4a"` for lossy AAC audio. * :code:`"alac"` for lossless ALAC audio. * :code:`"flac"` for lossless FLAC audio. * :code:`"mp3"` for lossy MP3 audio. * :code:`"ogg"` or :code:`"opus"` for lossy Opus audio * :code:`"vorbis"` for lossy Vorbis audio.
- * :code:`"lpcm"`, :code:`"wav"`, or :code:`"wave"` for
+ * :code:`"lpcm"`, :code:`"wav"`, or :code:`"wave"` for lossless LPCM audio. container : `str`, optional
- New audio file container. If not specified, the best
+ New audio file container. If not specified, the best container is determined based on `codec`. .. container::
-
+
**Valid values**: * :code:`"flac"` for a FLAC audio container, which only
@@ -890,12 +894,12 @@
Source code for minim.audio
supports MP3 audio. * :code:`"ogg"` for an Ogg audio container, which supports FLAC, Opus, and Vorbis audio.
- * :code:`"wav"` or :code:`"wave"` for an WAVE audio
+ * :code:`"wav"` or :code:`"wave"` for an WAVE audio container, which only supports LPCM audio. options : `str`, optional
- FFmpeg command-line options, excluding the input and output
- files, the :code:`-y` flag (to overwrite files), and the
+ FFmpeg command-line options, excluding the input and output
+ files, the :code:`-y` flag (to overwrite files), and the :code:`-c:v copy` argument (to preserve cover art for containers that support it).
@@ -903,24 +907,24 @@
Source code for minim.audio
**Defaults**:
- * AAC audio: :code:`"-c:a aac -b:a 256k"` (or
+ * AAC audio: :code:`"-c:a aac -b:a 256k"` (or :code:`"-c:a libfdk_aac -b:a 256k"` if FFmpeg was compiled with :code:`--enable-libfdk-aac`) * ALAC audio: :code:`"-c:a alac"` * FLAC audio: :code:`"-c:a flac"` * MP3 audio: :code:`"-c:a libmp3lame -q:a 0"` * Opus audio: :code:`"-c:a libopus -b:a 256k -vn"`
- * Vorbis audio:
- :code:`"-c:a vorbis -strict experimental -vn"` (or
- :code:`"-c:a libvorbis -vn"` if FFmpeg was compiled
+ * Vorbis audio:
+ :code:`"-c:a vorbis -strict experimental -vn"` (or
+ :code:`"-c:a libvorbis -vn"` if FFmpeg was compiled with :code:`--enable-libvorbis`)
- * WAVE audio: :code:`"-c:a pcm_s16le"` or
+ * WAVE audio: :code:`"-c:a pcm_s16le"` or :code:`"-c:a pcm_s24le"`, depending on the bit depth of the original audio file. filename : `str`, keyword-only, optional Filename of the converted audio file. If not provided, the
- filename of the original audio file, but with the
+ filename of the original audio file, but with the appropriate new extension appended, is used. preserve : `bool`, keyword-only, default: :code:`True`
@@ -941,7 +945,7 @@
---------- data : `dict` Information about the track in JSON format obtained using
- the iTunes Search API via
+ the iTunes Search API via :meth:`minim.itunes.SearchAPI.search` or :meth:`minim.itunes.SearchAPI.lookup`. album_data : `dict`, keyword-only, optional Information about the track's album in JSON format obtained
- using the iTunes Search API via
- :meth:`minim.itunes.SearchAPI.search` or
- :meth:`minim.itunes.SearchAPI.lookup`. If not provided,
+ using the iTunes Search API via
+ :meth:`minim.itunes.SearchAPI.search` or
+ :meth:`minim.itunes.SearchAPI.lookup`. If not provided, album artist and copyright information is unavailable. artwork_size : `int` or `str`, keyword-only, default: :code:`1400`
@@ -1078,11 +1082,18 @@
Source code for minim.audio
withurllib.request.urlopen(self.artwork)asr:self.artwork=r.read()ifself._artwork_format=="tif":
- withImage.open(BytesIO(self.artwork))asa:
- withBytesIO()asb:
- a.save(b,format="png")
- self.artwork=b.getvalue()
- self._artwork_format="png"
+ ifFOUND_PILLOW:
+ withImage.open(BytesIO(self.artwork))asa:
+ withBytesIO()asb:
+ a.save(b,format="png")
+ self.artwork=b.getvalue()
+ self._artwork_format="png"
+ else:
+ wmsg=("The Pillow library is required to process "
+ "TIFF images, but was not found. No artwork "
+ "will be embedded for the current track.")
+ warnings.warn(wmsg)
+ self.artwork=self._artwork_format=Noneifself.compilationisNoneoroverwrite:self.compilation=self.album_artist=="Various Artists"if"releaseDate"indataand(self.dateisNoneoroverwrite):
@@ -1091,7 +1102,7 @@
[docs]defset_metadata_using_spotify(
- self,data:dict[str,Any],*,
- audio_features:dict[str,Any]=None,
+ self,data:dict[str,Any],*,
+ audio_features:dict[str,Any]=None,lyrics:Union[str,dict[str,Any]]=None,overwrite:bool=False
- )->None:
+ )->None:""" Populate tags using data retrieved from the Spotify Web API
@@ -1256,7 +1267,7 @@
Source code for minim.audio
---------- data : `dict` Information about the track in JSON format obtained using
- the Spotify Web API via
+ the Spotify Web API via :meth:`minim.spotify.WebAPI.get_track`. audio_features : `dict`, keyword-only, optional
@@ -1267,7 +1278,7 @@
Source code for minim.audio
lyrics : `str` or `dict`, keyword-only Information about the track's formatted or time-synced
- lyrics obtained using the Spotify Lyrics service via
+ lyrics obtained using the Spotify Lyrics service via :meth:`minim.spotify.PrivateLyricsService.get_lyrics`. If not provided, lyrics are unavailable.
@@ -1297,7 +1308,7 @@
using the TIDAL API via :meth:`minim.tidal.API.get_album`, :meth:`minim.tidal.API.search`, :meth:`minim.tidal.PrivateAPI.get_album`, or
- :meth:`minim.tidal.PrivateAPI.search`. If not provided,
- album artist and disc and track numbering information is
+ :meth:`minim.tidal.PrivateAPI.search`. If not provided,
+ album artist and disc and track numbering information is unavailable. artwork_size : `int`, keyword-only, default: :code:`1280` Maximum artwork size in pixels.
- **Valid values**: `artwork_size` should be between
+ **Valid values**: `artwork_size` should be between :code:`80` and :code:`1280`.
-
+
composers : `str`, `list`, or `dict`, keyword-only, optional
- Information about the track's composers in a formatted
+ Information about the track's composers in a formatted `str`, a `list`, or a `dict` obtained using the TIDAL API via :meth:`minim.tidal.PrivateAPI.get_track_composers`, :meth:`minim.tidal.PrivateAPI.get_track_contributors`, or
- :meth:`minim.tidal.PrivateAPI.get_track_credits`. If not
+ :meth:`minim.tidal.PrivateAPI.get_track_credits`. If not provided, songwriting credits are unavailable. lyrics : `str` or `dict`, keyword-only, optional
@@ -1373,7 +1384,7 @@
.. seealso::
- For a full list of attributes and their descriptions, see
+ For a full list of attributes and their descriptions, see :class:`Audio`. Parameters
@@ -1473,16 +1484,16 @@
Source code for minim.audio
.. container:: **Valid values**:
-
+
The supported metadata fields are * :code:`"artist"` for the track artist,
- * :code:`"title"` for the track title, and
+ * :code:`"title"` for the track title, and * :code:`"track_number"` for the track number. **Examples**:
- * :code:`("(.*) - (.*)", ("artist", "title"))` matches
+ * :code:`("(.*) - (.*)", ("artist", "title"))` matches filenames like "Taylor Swift - Fearless.flac". * :code:`("(\\d*) - (.*)", ("track_number", "title"))` matches filenames like "03 - Love Story.flac".
@@ -1490,12 +1501,12 @@
Source code for minim.audio
filenames like "06 You Belong with Me.flac". multivalue : `bool`
- Determines whether multivalue tags are supported. If
+ Determines whether multivalue tags are supported. If :code:`False`, the items in `value` are concatenated using the separator(s) specified in `sep`. sep : `str` or `tuple`, keyword-only, default: :code:`(", ", " & ")`
- Separator(s) to use to concatenate multivalue tags. If a
+ Separator(s) to use to concatenate multivalue tags. If a :code:`str` is provided, it is used to concatenate all values. If a :code:`tuple` is provided, the first :code:`str` is used to concatenate the first :math:`n - 1` values, and the second
@@ -1506,7 +1517,7 @@
.. seealso::
- For a full list of attributes and their descriptions, see
+ For a full list of attributes and their descriptions, see :class:`Audio`. Parameters
@@ -1553,16 +1564,16 @@
Source code for minim.audio
.. container:: **Valid values**:
-
+
The supported metadata fields are * :code:`"artist"` for the track artist,
- * :code:`"title"` for the track title, and
+ * :code:`"title"` for the track title, and * :code:`"track_number"` for the track number. **Examples**:
- * :code:`("(.*) - (.*)", ("artist", "title"))` matches
+ * :code:`("(.*) - (.*)", ("artist", "title"))` matches filenames like "Taylor Swift - Red.mp3". * :code:`("(\\d*) - (.*)", ("track_number", "title"))` matches filenames like "04 - I Knew You Were Trouble.mp3".
@@ -1570,12 +1581,12 @@
Source code for minim.audio
filenames like "06 22.mp3". multivalue : `bool`
- Determines whether multivalue tags are supported. If
+ Determines whether multivalue tags are supported. If :code:`False`, the items in `value` are concatenated using the separator(s) specified in `sep`. sep : `str` or `tuple`, keyword-only, default: :code:`(", ", " & ")`
- Separator(s) to use to concatenate multivalue tags. If a
+ Separator(s) to use to concatenate multivalue tags. If a :code:`str` is provided, it is used to concatenate all values. If a :code:`tuple` is provided, the first :code:`str` is used to concatenate the first :math:`n - 1` values, and the second
@@ -1586,7 +1597,7 @@
.. seealso::
- For a full list of attributes and their descriptions, see
+ For a full list of attributes and their descriptions, see :class:`Audio`. Parameters
@@ -1632,16 +1643,16 @@
Source code for minim.audio
.. container:: **Valid values**:
-
+
The supported metadata fields are * :code:`"artist"` for the track artist,
- * :code:`"title"` for the track title, and
+ * :code:`"title"` for the track title, and * :code:`"track_number"` for the track number. **Examples**:
- * :code:`("(.*) - (.*)", ("artist", "title"))` matches
+ * :code:`("(.*) - (.*)", ("artist", "title"))` matches filenames like "Taylor Swift - Mine.m4a". * :code:`("(\\d*) - (.*)", ("track_number", "title"))` matches filenames like "04 - Speak Now.m4a".
@@ -1649,12 +1660,12 @@
Source code for minim.audio
filenames like "07 The Story of Us.m4a". multivalue : `bool`
- Determines whether multivalue tags are supported. If
+ Determines whether multivalue tags are supported. If :code:`False`, the items in `value` are concatenated using the separator(s) specified in `sep`. sep : `str` or `tuple`, keyword-only, default: :code:`(", ", " & ")`
- Separator(s) to use to concatenate multivalue tags. If a
+ Separator(s) to use to concatenate multivalue tags. If a :code:`str` is provided, it is used to concatenate all values. If a :code:`tuple` is provided, the first :code:`str` is used to concatenate the first :math:`n - 1` values, and the second
@@ -1686,14 +1697,14 @@
.. seealso::
- For a full list of attributes and their descriptions, see
+ For a full list of attributes and their descriptions, see :class:`Audio`. Parameters
@@ -1825,7 +1836,7 @@
Source code for minim.audio
Ogg audio filename or path. codec : `str`, optional
- Audio codec. If not specified, it will be determined
+ Audio codec. If not specified, it will be determined automatically. **Valid values**: :code:`"flac"`, :code:`"opus"`, or
@@ -1838,16 +1849,16 @@
Source code for minim.audio
.. container:: **Valid values**:
-
+
The supported metadata fields are * :code:`"artist"` for the track artist,
- * :code:`"title"` for the track title, and
+ * :code:`"title"` for the track title, and * :code:`"track_number"` for the track number. **Examples**:
- * :code:`("(.*) - (.*)", ("artist", "title"))` matches
+ * :code:`("(.*) - (.*)", ("artist", "title"))` matches filenames like "Taylor Swift - Blank Space.ogg". * :code:`("(\\d*) - (.*)", ("track_number", "title"))` matches filenames like "03 - Style.ogg".
@@ -1855,12 +1866,12 @@
Source code for minim.audio
filenames like "06 Shake It Off.ogg". multivalue : `bool`
- Determines whether multivalue tags are supported. If
+ Determines whether multivalue tags are supported. If :code:`False`, the items in `value` are concatenated using the separator(s) specified in `sep`. sep : `str` or `tuple`, keyword-only, default: :code:`(", ", " & ")`
- Separator(s) to use to concatenate multivalue tags. If a
+ Separator(s) to use to concatenate multivalue tags. If a :code:`str` is provided, it is used to concatenate all values. If a :code:`tuple` is provided, the first :code:`str` is used to concatenate the first :math:`n - 1` values, and the second
@@ -1868,18 +1879,18 @@
.. seealso::
- For a full list of attributes and their descriptions, see
+ For a full list of attributes and their descriptions, see :class:`Audio`. Parameters
@@ -1937,16 +1948,16 @@
Source code for minim.audio
.. container:: **Valid values**:
-
+
The supported metadata fields are * :code:`"artist"` for the track artist,
- * :code:`"title"` for the track title, and
+ * :code:`"title"` for the track title, and * :code:`"track_number"` for the track number. **Examples**:
- * :code:`("(.*) - (.*)", ("artist", "title"))` matches
+ * :code:`("(.*) - (.*)", ("artist", "title"))` matches filenames like "Taylor Swift - Don't Blame Me.wav". * :code:`("(\\d*) - (.*)", ("track_number", "title"))` matches filenames like "05 - Delicate.wav".
@@ -1954,12 +1965,12 @@
Source code for minim.audio
filenames like "06 Look What You Made Me Do.wav". multivalue : `bool`
- Determines whether multivalue tags are supported. If
+ Determines whether multivalue tags are supported. If :code:`False`, the items in `value` are concatenated using the separator(s) specified in `sep`. sep : `str` or `tuple`, keyword-only, default: :code:`(", ", " & ")`
- Separator(s) to use to concatenate multivalue tags. If a
+ Separator(s) to use to concatenate multivalue tags. If a :code:`str` is provided, it is used to concatenate all values. If a :code:`tuple` is provided, the first :code:`str` is used to concatenate the first :math:`n - 1` values, and the second
@@ -1970,7 +1981,7 @@
Discogs=======.. moduleauthor:: Benjamin Ye <GitHub: bbye98>
+
+This module contains a complete implementation of the Discogs API."""fromhttp.serverimportHTTPServer,BaseHTTPRequestHandler
@@ -262,7 +264,7 @@
__all__=["API"]class_DiscogsRedirectHandler(BaseHTTPRequestHandler):
-
+
""" HTTP request handler for the Discogs OAuth 1.0a flow. """defdo_GET(self):
-
+
""" Handles an incoming GET request and parses the query string. """
@@ -291,7 +293,7 @@
Source code for minim.discogs
self.send_response(200)self.send_header("Content-Type","text/html")self.end_headers()
- status="denied"if"denied"inself.server.responseelse"granted"
+ status="denied"if"denied"inself.server.responseelse"granted"self.wfile.write(f"Access {status}. You may close this page now.".encode())
@@ -303,7 +305,7 @@
Source code for minim.discogs
""" Discogs API client.
- The Discogs API lets developers build their own Discogs-powered
+ The Discogs API lets developers build their own Discogs-powered applications for the web, desktop, and mobile devices. It is a RESTful interface to Discogs data and enables accessing JSON- formatted information about artists, releases, and labels,
@@ -312,32 +314,32 @@
Source code for minim.discogs
.. seealso::
- For more information, see the `Discogs API home page
+ For more information, see the `Discogs API home page <https://www.discogs.com/developers>`_. The Discogs API can be accessed with or without authentication.
- (client credentials, personal access token, or OAuth access token
+ (client credentials, personal access token, or OAuth access token and access token secret). However, it is recommended that users at
- least provide client credentials to enjoy higher rate limits and
- access to image URLs. The consumer key and consumer secret can
- either be provided to this class's constructor as keyword arguments
- or be stored as :code:`DISCOGS_CONSUMER_KEY` and
- :code:`DISCOGS_CONSUMER_SECRET` in the operating system's
- environment variables.
-
+ least provide client credentials to enjoy higher rate limits and
+ access to image URLs. The consumer key and consumer secret can
+ either be provided to this class's constructor as keyword arguments
+ or be stored as :code:`DISCOGS_CONSUMER_KEY` and
+ :code:`DISCOGS_CONSUMER_SECRET` in the operating system's
+ environment variables.
+
.. seealso:: To get client credentials, see the Registration section of the `Authentication page <https://www.discogs.com/developers
- /#page:authentication>`_ of the Discogs API website. To take
- advantage of Minim's automatic access token retrieval
+ /#page:authentication>`_ of the Discogs API website. To take
+ advantage of Minim's automatic access token retrieval functionality for the OAuth 1.0a flow, the redirect URI should be
- in the form :code:`http://localhost:{port}/callback`, where
+ in the form :code:`http://localhost:{port}/callback`, where :code:`{port}` is an open port on :code:`localhost`.
-
+
To view and make changes to account information and resources, users
- must either provide a personal access token to this class's
- constructor as a keyword argument or undergo the OAuth 1.0a flow,
+ must either provide a personal access token to this class's
+ constructor as a keyword argument or undergo the OAuth 1.0a flow, which require valid client credentials, using Minim. If an existing OAuth access token/secret pair is available, it can be provided to this class's constructor as keyword arguments to bypass the access
@@ -349,9 +351,9 @@
Source code for minim.discogs
at any time using :meth:`set_flow` and :meth:`set_access_token`, respectively.
- Minim also stores and manages access tokens and their properties.
- When the OAuth 1.0a flow is used to acquire an access token/secret
- pair, it is automatically saved to the Minim configuration file to
+ Minim also stores and manages access tokens and their properties.
+ When the OAuth 1.0a flow is used to acquire an access token/secret
+ pair, it is automatically saved to the Minim configuration file to be loaded on the next instantiation of this class. This behavior can be disabled if there are any security concerns, like if the computer being used is a shared device.
@@ -360,20 +362,20 @@
Source code for minim.discogs
---------- consumer_key : `str`, keyword-only, optional Consumer key. Required for the OAuth 1.0a flow, and can be used
- in the Discogs authorization flow alongside a consumer secret.
- If it is not stored as :code:`DISCOGS_CONSUMER_KEY` in the
+ in the Discogs authorization flow alongside a consumer secret.
+ If it is not stored as :code:`DISCOGS_CONSUMER_KEY` in the operating system's environment variables or found in the Minim configuration file, it can be provided here. consumer_secret : `str`, keyword-only, optional Consumer secret. Required for the OAuth 1.0a flow, and can be used in the Discogs authorization flow alongside a consumer key.
- If it is not stored as :code:`DISCOGS_CONSUMER_SECRET` in the
+ If it is not stored as :code:`DISCOGS_CONSUMER_SECRET` in the operating system's environment variables or found in the Minim configuration file, it can be provided here. flow : `str`, keyword-only, optional
- Authorization flow. If :code:`None` and no access token is
+ Authorization flow. If :code:`None` and no access token is provided, no user authentication will be performed and client credentials will not be attached to requests, even if found or provided.
@@ -388,13 +390,13 @@
Source code for minim.discogs
browser : `bool`, keyword-only, default: :code:`False` Determines whether a web browser is automatically opened for the
- OAuth 1.0a flow. If :code:`False`, users will have to manually
+ OAuth 1.0a flow. If :code:`False`, users will have to manually open the authorization URL and provide the full callback URI via the terminal. web_framework : `str`, keyword-only, optional Determines which web framework to use for the OAuth 1.0a flow.
-
+
.. container:: **Valid values**:
@@ -402,22 +404,22 @@
Source code for minim.discogs
* :code:`"http.server"` for the built-in implementation of HTTP servers. * :code:`"flask"` for the Flask framework.
- * :code:`"playwright"` for the Playwright framework by
+ * :code:`"playwright"` for the Playwright framework by Microsoft. port : `int` or `str`, keyword-only, default: :code:`8888` Port on :code:`localhost` to use for the OAuth 1.0a flow with
- the :code:`http.server` and Flask frameworks. Only used if
+ the :code:`http.server` and Flask frameworks. Only used if `redirect_uri` is not specified. redirect_uri : `str`, keyword-only, optional
- Redirect URI for the OAuth 1.0a flow. If not on
+ Redirect URI for the OAuth 1.0a flow. If not on :code:`localhost`, the automatic request access token retrieval functionality is not available. access_token : `str`, keyword-only, optional Personal or OAuth access token. If provided here or found in the
- Minim configuration file, the authentication process is
+ Minim configuration file, the authentication process is bypassed. access_token_secret : `str`, keyword-only, optional
@@ -429,7 +431,7 @@
Source code for minim.discogs
save : `bool`, keyword-only, default: :code:`True` Determines whether newly obtained access tokens and their
- associated properties are stored to the Minim configuration
+ associated properties are stored to the Minim configuration file. Attributes
@@ -445,7 +447,7 @@
Source code for minim.discogs
REQUEST_TOKEN_URL : `str` URL for the OAuth 1.0a request token endpoint.
-
+
session : `requests.Session` Session used to send requests to the Discogs API. """
@@ -460,11 +462,11 @@
def_get_json(self,url:str,**kwargs)->dict:"""
- Send a GET request and return the JSON-encoded content of the
+ Send a GET request and return the JSON-encoded content of the response. Parameters ---------- url : `str` URL for the GET request.
-
+
**kwargs Keyword arguments to pass to :meth:`requests.request`.
@@ -541,7 +543,7 @@
---------- flow : `str` Authorization flow. If :code:`None`, no user authentication
- will be performed and client credentials will not be
+ will be performed and client credentials will not be attached to requests, even if found or provided. .. container::
@@ -783,10 +785,10 @@
Source code for minim.discogs
consumer_secret : `str`, keyword-only, optional Consumer secret. Required for the OAuth 1.0a flow, and can
- be used in the Discogs authorization flow alongside a
- consumer key. If it is not stored as
- :code:`DISCOGS_CONSUMER_SECRET` in the operating system's
- environment variables or found in the Minim configuration
+ be used in the Discogs authorization flow alongside a
+ consumer key. If it is not stored as
+ :code:`DISCOGS_CONSUMER_SECRET` in the operating system's
+ environment variables or found in the Minim configuration file, it can be provided here. browser : `bool`, keyword-only, default: :code:`False`
@@ -806,7 +808,7 @@
Source code for minim.discogs
* :code:`"http.server"` for the built-in implementation of HTTP servers. * :code:`"flask"` for the Flask framework.
- * :code:`"playwright"` for the Playwright framework by
+ * :code:`"playwright"` for the Playwright framework by Microsoft. port : `int` or `str`, keyword-only, default: :code:`8888`
@@ -815,9 +817,9 @@
Source code for minim.discogs
if `redirect_uri` is not specified. redirect_uri : `str`, keyword-only, optional
- Redirect URI for the OAuth 1.0a flow. If not on
- :code:`localhost`, the automatic request access token
- retrieval functionality is not available.
+ Redirect URI for the OAuth 1.0a flow. If not on
+ :code:`localhost`, the automatic request access token
+ retrieval functionality is not available. save : `bool`, keyword-only, default: :code:`True` Determines whether newly obtained access tokens and their
@@ -842,7 +844,7 @@
Source code for minim.discogs
ifredirect_uri:self._redirect_uri=redirect_uriif"localhost"inredirect_uri:
- self._port=re.search(r"localhost:(\d+)",
+ self._port=re.search(r"localhost:(\d+)",redirect_uri).group(1)elifweb_framework:wmsg=("The redirect URI is not on localhost, "
@@ -857,8 +859,8 @@
username : `str`, optional The username of the user whose rating you are requesting. If
- not specified, the username of the authenticated user is
+ not specified, the username of the authenticated user is used. **Example**: :code:`"memory"`.
@@ -1096,14 +1098,14 @@
[docs]defupdate_user_release_rating(
- self,release_id:Union[int,str],rating:int,
+ self,release_id:Union[int,str],rating:int,username:str=None)->dict[str,Any]:
-
+
""" `Database > Release Rating By User > Update Release Rating By User <https://www.discogs.com/developers
@@ -1123,7 +1125,7 @@
Source code for minim.discogs
.. admonition:: User authentication :class: warning
-
+
Requires user authentication with a personal access token or via the OAuth 1.0a flow.
@@ -1139,7 +1141,7 @@
Source code for minim.discogs
username : `str`, optional The username of the user whose rating you are requesting. If
- not specified, the username of the authenticated user is
+ not specified, the username of the authenticated user is used. **Example**: :code:`"memory"`.
@@ -1159,7 +1161,7 @@
.. admonition:: User authentication :class: warning
-
+
Requires user authentication with a personal access token or via the OAuth 1.0a flow.
@@ -1202,20 +1204,20 @@
Source code for minim.discogs
username : `str`, optional The username of the user whose rating you are requesting. If
- not specified, the username of the authenticated user is
+ not specified, the username of the authenticated user is used. **Example**: :code:`"memory"`. """self._check_authentication("delete_user_release_rating")
-
+
ifusernameisNone:ifhasattr(self,"_username"):username=self._usernameelse:raiseValueError("No username provided.")
-
+
returnself._request("delete",f"{self.API_URL}/releases/{release_id}/rating/{username}"
@@ -1226,7 +1228,7 @@
.. attention::
- This endpoint does not appear to be working correctly.
+ This endpoint does not appear to be working correctly. Currently, the response will be of the form .. code::
@@ -1304,7 +1306,7 @@
Returns ------- versions : `dict`
- Discogs database information for all releases that are
+ Discogs database information for all releases that are versions of the specified master. .. admonition:: Sample
@@ -1515,7 +1517,7 @@
[docs]defget_label(self,label_id:Union[int,str])->dict[str,Any]:
-
+
""" `Database > Label <https://www.discogs.com/developers
- /#page:database,header:database-label-get>`_: Get a label,
+ /#page:database,header:database-label-get>`_: Get a label, company, recording studio, locxation, or other entity involved with artists and releases.
@@ -1733,12 +1735,12 @@