Skip to content

Genre

Genre(subsonic, value, songCount=None, albumCount=None)

Bases: Model

Object that holds all the info about a genre.

Attributes:

Name Type Description
value str

The name of the genre.
song_count int | None

Number of songs tagged with the genre.
album_count int | None

Number of albums tagged with the genre.

:param subsonic: The subsonic object to make all the internal requests with it. :type subsonic: Subsonic :param value: The name of the genre. :type value: str :param songCount: The number of songs with this genre, defaults to None. :type songCount: int | None, optional :param albumCount: The number of albums with this genre, defaults to None. :type albumCount: int | None, optional

Source code in .venv/lib/python3.11/site-packages/knuckles/models/_genre.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def __init__(
    self,
    subsonic: "Subsonic",
    value: str,
    songCount: int | None = None,
    albumCount: int | None = None,
) -> None:
    """Representation of all the data related to a genre in Subsonic.

    :param subsonic: The subsonic object to make all the internal requests with it.
    :type subsonic: Subsonic
    :param value: The name of the genre.
    :type value: str
    :param songCount: The number of songs with this genre, defaults to None.
    :type songCount: int | None, optional
    :param albumCount: The number of albums with this genre, defaults to None.
    :type albumCount: int | None, optional
    """

    super().__init__(subsonic)

    self.value = value
    self.song_count = songCount
    self.album_count = albumCount

generate()

Return a new genre with all the data updated from the API, using the endpoint that return the most information possible.

Useful for making copies with updated data or updating the object itself with immutability, e.g., foo = foo.generate().

:return: A new genre object with all the data updated. :rtype: Genre

Source code in .venv/lib/python3.11/site-packages/knuckles/models/_genre.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
def generate(self) -> "Genre":
    """Return a new genre with all the data updated from the API,
    using the endpoint that return the most information possible.

    Useful for making copies with updated data or updating the object itself
    with immutability, e.g., foo = foo.generate().

    :return: A new genre object with all the data updated.
    :rtype: Genre
    """
    get_genre = self._subsonic.browsing.get_genre(self.value)

    if get_genre is None:
        raise ResourceNotFound(
            "Unable to generate genre as it does not exist in the server"
        )

    return get_genre

ItemGenre(subsonic, name)

Bases: Model

Object that holds all the info about a item genre.

Attributes:

Name Type Description
name

The name of the genre.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_genre.py 
17
18
19
20
def __init__(self, subsonic: "Subsonic", name: str) -> None:
    super().__init__(subsonic)

    self.name = name