Skip to content

System

System(api, subsonic)

Class that contains all the methods needed to interact with the system endpoints in the Subsonic API.

Source code in .venv/lib/python3.11/site-packages/knuckles/_system.py 
21
22
23
24
25
def __init__(self, api: Api, subsonic: "Subsonic") -> None:
    self.api = api

    # Only to pass it to the models
    self.subsonic = subsonic

check_open_subsonic_extension(extension_name, extension_version)

Check if a OpenSubonic REST API extension is available on the connected server.

Parameters:

Name Type Description Default
extension_name str

The name of the extension to check if its available.

 required
extension_version int

The version of the extension to check if its available.

 required

Returns:

Type Description
bool

If the given extension at the given version is available on the connected server or not.
Source code in .venv/lib/python3.11/site-packages/knuckles/_system.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def check_open_subsonic_extension(
    self, extension_name: str, extension_version: int
) -> bool:
    """Check if a OpenSubonic REST API extension is available on the
    connected server.

    Args:
        extension_name: The name of the extension to check if its
            available.
        extension_version: The version of the extension to check if
            its available.

    Returns:
        If the given extension at the given version is available on
            the connected server or not.
    """

    extensions = self.get_open_subsonic_extensions()

    for extension in extensions:
        if extension.name != extension_name:
            continue

        if extension_version in extension.versions:
            return True

    return False

get_license()

Get the current status of the license of the server.

Returns:

Type Description
License

An object that contains all the info about the status of the license of the server.
Source code in .venv/lib/python3.11/site-packages/knuckles/_system.py 
38
39
40
41
42
43
44
45
46
47
48
def get_license(self) -> License:
    """Get the current status of the license of the server.

    Returns:
        An object that contains all the info about the status
            of the license of the server.
    """

    response = self.api.json_request("getLicense")["license"]

    return License(self.subsonic, **response)

get_open_subsonic_extensions()

Get all the available OpenSubsonic REST API extensions for the connected server.

Returns:

Type Description
list[OpenSubsonicExtension]

A list that contains all the info about all the available extensions in the connected server.
Source code in .venv/lib/python3.11/site-packages/knuckles/_system.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def get_open_subsonic_extensions(self) -> list[OpenSubsonicExtension]:
    """Get all the available OpenSubsonic REST API extensions for the
    connected server.

    Returns:
        A list that contains all the info about all the available
            extensions in the connected server.
    """

    response = self.api.json_request("getOpenSubsonicExtensions")[
        "openSubsonicExtensions"
    ]
    return [
        OpenSubsonicExtension(name, versions) for name, versions in response.items()
    ]

ping()

Make a ping to the server.

Returns:

Type Description
SubsonicResponse

An object that holds all the info returned by the server.
Source code in .venv/lib/python3.11/site-packages/knuckles/_system.py 
27
28
29
30
31
32
33
34
35
36
def ping(self) -> SubsonicResponse:
    """Make a ping to the server.

    Returns:
        An object that holds all the info returned by the server.
    """

    response = self.api.json_request("ping")

    return SubsonicResponse(self.subsonic, **response)