Skip to content

Share

Share(subsonic, id, url=None, description=None, username=None, created=None, expires=None, lastVisited=None, visitCount=None, entry=None)

Bases: Model

Object that holds all the info about a share.

Attributes:

Name Type Description
id str

The ID of the share.
url str | None

The URL to access the shared media.
description str | None

The description of the share.
user User | None

All the info related with the user creator of the share.
created datetime | None

The timestamp when the share was created.
expires datetime | None

The timestamp when the share will expire.
last_visited datetime | None

The timestamp when the share was last visited.
visit_count int | None

Number of times the share has been visited.
songs list[Song] | None

List that holds all the info about all the songs available to access with the share.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_share.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def __init__(
    self,
    subsonic: "Subsonic",
    id: str,
    url: str | None = None,
    description: str | None = None,
    username: str | None = None,
    created: str | None = None,
    expires: str | None = None,
    lastVisited: str | None = None,
    visitCount: int | None = None,
    entry: list[dict[str, Any]] | None = None,
) -> None:
    super().__init__(subsonic)

    self.id = id
    self.url = url
    self.description = description
    self.user = User(self._subsonic, username) if username else None
    self.created = parser.parse(created) if created else None
    self.expires = parser.parse(expires) if expires else None
    self.last_visited = parser.parse(lastVisited) if lastVisited else None
    self.visit_count = visitCount
    self.songs = [Song(self._subsonic, **song) for song in entry] if entry else None

create()

Create a new share with the same info of the current one.

Raises:

Type Description
ShareInvalidSongList

Raised if the song list contained in the share is empty.

Returns:

Type Description
Share

The new created share.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_share.py 
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def create(self) -> "Share":
    """Create a new share with the same info of the current one.

    Raises:
        ShareInvalidSongList: Raised if the song list contained in
            the share is empty.

    Returns:
        The new created share.
    """

    if self.songs is None or self.songs == []:
        raise ShareInvalidSongList(
            (
                "A list with at least one song model object in the songs parameter"
                + "is necessary to create a share"
            )
        )

    songs_ids = [song.id for song in self.songs]

    new_share = self._subsonic.sharing.create_share(
        songs_ids, self.description, self.expires
    )

    return new_share

delete()

Delete the share from the server.

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_share.py 
116
117
118
119
120
121
122
123
124
125
def delete(self) -> Self:
    """Delete the share from the server.

    Returns:
        The object itself.
    """

    self._subsonic.sharing.delete_share(self.id)

    return self

generate()

Return a new share object 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().

Returns:

Type Description
Share | None

A new object with all the updated info.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_share.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
def generate(self) -> "Share | None":
    """Return a new share object 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()`.

    Returns:
        A new object with all the updated info.
    """

    get_share = self._subsonic.sharing.get_share(self.id)

    if get_share is None:
        raise ResourceNotFound

    return get_share

update()

Update the info of the share with the one in the model.

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_share.py 
105
106
107
108
109
110
111
112
113
114
def update(self) -> Self:
    """Update the info of the share with the one in the model.

    Returns:
        The object itself.
    """

    self._subsonic.sharing.update_share(self.id, self.description, self.expires)

    return self