client ¤

def add_metalink(
    self,
    metalink: str,
    options: dict | None = None,
    position: int | None = None,
) -> list[str]:
    """Add a Metalink download.

    This method adds a Metalink download by uploading a ".metalink" file
    and returns an array of GIDs of newly registered downloads.

    Original signature:

        aria2.addMetalink([secret], metalink[, options[, position]])

    If [`--rpc-save-upload-metadata`][aria2p.options.Options.rpc_save_upload_metadata] is true,
    the uploaded data is saved as a file named hex string of SHA-1 hash of data plus ".metalink"
    in the directory specified by [`--dir`][aria2p.options.Options.dir] option.
    E.g. a file name might be 0a3893293e27ac0490424c06de4d09242215f0a6.metalink.
    If a file with the same name already exists, it is overwritten!
    If the file cannot be saved successfully
    or [`--rpc-save-upload-metadata`][aria2p.options.Options.rpc_save_upload_metadata] is false,
    the downloads added by this method are not saved by [`--save-session`][aria2p.options.Options.save_session].

    Parameters:
        metalink: `metalink` is a base64-encoded string which contains the contents of the ".metalink" file.
        options: `options` is a struct and its members are pairs of option name and value.
            See [Options][aria2p.options.Options] for more details.
        position: If `position` is given, it must be an integer starting from 0.
            The new download will be inserted at `position` in the waiting queue.
            If `position` is omitted or `position` is larger than the current size of the queue,
            the new download is appended to the end of the queue.

    Returns:
        The GID of the created download.

    Examples:
        **Original JSON-RPC Example**

        The following examples add local file file.meta4.

        >>> import urllib2, json, base64
        >>> metalink = base64.b64encode(open('file.meta4').read())
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'aria2.addMetalink',
        ...                       'params':[metalink]})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> c.read()
        '{"id":"qwer","jsonrpc":"2.0","result":["0000000000000001"]}'
    """
    return self.call(self.ADD_METALINK, [metalink, options, position])  # type: ignore

def add_torrent(
    self,
    torrent: str,
    uris: list[str],
    options: dict | None = None,
    position: int | None = None,
) -> str:
    """Add a BitTorrent download.

    This method adds a BitTorrent download by uploading a ".torrent" file and returns the GID of the
    newly registered download.

    Original signature:

        aria2.addTorrent([secret], torrent[, uris[, options[, position]]])

    If you want to add a BitTorrent Magnet URI, use the [`add_uri()`][aria2p.client.Client.add_uri] method instead.

    If [`--rpc-save-upload-metadata`][aria2p.options.Options.rpc_save_upload_metadata] is true,
    the uploaded data is saved as a file named as the hex string of SHA-1 hash of data plus ".torrent"
    in the directory specified by [`--dir`][aria2p.options.Options.dir] option.
    E.g. a file name might be 0a3893293e27ac0490424c06de4d09242215f0a6.torrent.
    If a file with the same name already exists, it is overwritten!
    If the file cannot be saved successfully
    or [`--rpc-save-upload-metadata`][aria2p.options.Options.rpc_save_upload_metadata] is false,
    the downloads added by this method are not saved by [`--save-session`][aria2p.options.Options.save_session].

    Parameters:
        torrent: `torrent` must be a base64-encoded string containing the contents of the ".torrent" file.
        uris: `uris` is an array of URIs (string). `uris` is used for Web-seeding.
            For single file torrents, the URI can be a complete URI pointing to the resource; if URI ends with /,
            name in torrent file is added. For multi-file torrents, name and path in torrent are added to form a URI
            for each file.
        options: `options` is a struct and its members are pairs of option name and value.
            See [Options][aria2p.options.Options] for more details.
        position: If `position` is given, it must be an integer starting from 0.
            The new download will be inserted at `position` in the waiting queue.
            If `position` is omitted or `position` is larger than the current size of the queue,
            the new download is appended to the end of the queue.

    Returns:
        The GID of the created download.

    Examples:
        **Original JSON-RPC Example**

        The following examples add local file file.torrent.

        >>> import urllib2, json, base64
        >>> torrent = base64.b64encode(open('file.torrent').read())
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'asdf',
        ...                       'method':'aria2.addTorrent', 'params':[torrent]})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> c.read()
        '{"id":"asdf","jsonrpc":"2.0","result":"0000000000000001"}'
    """
    return self.call(self.ADD_TORRENT, [torrent, uris, options, position])  # type: ignore

def add_uri(
    self,
    uris: list[str],
    options: dict | None = None,
    position: int | None = None,
) -> str:
    """Add a new download.

    This method adds a new download and returns the GID of the newly registered download.

    Original signature:

        aria2.addUri([secret], uris[, options[, position]])

    Parameters:
        uris: `uris` is an array of HTTP/FTP/SFTP/BitTorrent URIs (strings) pointing to the same resource.
            If you mix URIs pointing to different resources,
            then the download may fail or be corrupted without aria2 complaining.
            When adding BitTorrent Magnet URIs,
            uris must have only one element and it should be BitTorrent Magnet URI.
        options: `options` is a struct and its members are pairs of option name and value.
            See [Options][aria2p.options.Options] for more details.
        position: If `position` is given, it must be an integer starting from 0.
            The new download will be inserted at `position` in the waiting queue.
            If `position` is omitted or `position` is larger than the current size of the queue,
            the new download is appended to the end of the queue.

    Returns:
        The GID of the created download.

    Examples:
        **Original JSON-RPC Example**

        The following example adds http://example.org/file:

        >>> import urllib2, json
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'aria2.addUri',
        ...                       'params':[['http://example.org/file']]})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> c.read()
        '{"id":"qwer","jsonrpc":"2.0","result":"0000000000000001"}'
    """
    return self.call(self.ADD_URI, params=[uris, options, position])  # type: ignore

def batch_call(
    self,
    calls: CallsType,
    insert_secret: bool = True,  # noqa: FBT001,FBT002
) -> list[CallReturnType]:
    """Call multiple methods in one request.

    A batch call is simply a list of full payloads, sent at once to the remote process. The differences with a
    multicall are:

    - multicall is a special "system" method, whereas batch_call is simply the concatenation of several methods
    - multicall payloads define the "jsonrpc" and "id" keys only once, whereas these keys are repeated in
      each part of the batch_call payload
    - as a result of the previous line, you must pass different IDs to the batch_call methods, whereas the
      ID in multicall is optional

    Parameters:
        calls: A list of tuples composed of method name, parameters and ID.
        insert_secret: Whether to insert the secret token in the parameters or not.

    Returns:
        The results for each call in the batch.
    """
    payloads = []

    for method, params, msg_id in calls:
        params = self.get_params(*params)  # noqa: PLW2901
        if insert_secret and self.secret and method.startswith("aria2."):
            params.insert(0, f"token:{self.secret}")
        payloads.append(self.get_payload(method, params, msg_id, as_json=False))

    payload: str = json.dumps(payloads)
    responses = self.post(payload)
    return [self.res_or_raise(resp) for resp in responses]

def call(
    self,
    method: str,
    params: list[Any] | None = None,
    msg_id: int | str | None = None,
    insert_secret: bool = True,  # noqa: FBT001,FBT002
) -> CallReturnType:
    """Call a single JSON-RPC method.

    Parameters:
        method: The method name. You can use the constant defined in [`Client`][aria2p.client.Client].
        params: A list of parameters.
        msg_id: The ID of the call, sent back with the server's answer.
        insert_secret: Whether to insert the secret token in the parameters or not.

    Returns:
        The answer from the server, as a Python object.
    """
    params = self.get_params(*(params or []))

    if insert_secret and self.secret:
        if method.startswith("aria2."):
            params.insert(0, f"token:{self.secret}")
        elif method == self.MULTICALL:
            for param in params[0]:
                param["params"].insert(0, f"token:{self.secret}")

    payload: str = self.get_payload(method, params, msg_id=msg_id)  # type: ignore
    return self.res_or_raise(self.post(payload))

def change_global_option(self, options: dict) -> str:
    """Change the global options dynamically.

    Original signature:

        aria2.changeGlobalOption([secret], options)

    Parameters:
        options: The following options are available:

            - `bt-max-open-files`
            - `download-result`
            - `keep-unfinished-download-result`
            - `log`
            - `log-level`
            - `max-concurrent-downloads`
            - `max-download-result`
            - `max-overall-download-limit`
            - `max-overall-upload-limit`
            - `optimize-concurrent-downloads`
            - `save-cookies`
            - `save-session`
            - `server-stat-of`

            In addition, options listed in the Input File subsection are available, except for following options:
            `checksum`, `index-out`, `out`, `pause` and `select-file`.

            With the log option, you can dynamically start logging or change log file. To stop logging, specify an
            empty string ("") as the parameter value. Note that log file is always opened in append mode.

    Returns:
        `"OK"` for success.
    """
    return self.call(self.CHANGE_GLOBAL_OPTION, [options])  # type: ignore

def change_option(self, gid: str, options: dict) -> str:
    """Change a download options dynamically.

    Original signature:

        aria2.changeOption([secret], gid, options)

    Parameters:
        gid: The download to change options of.
        options: The options listed in Input File subsection are available, except for following options:

            - `dry-run`
            - `metalink-base-uri`
            - `parameterized-uri`
            - `pause`
            - `piece-length`
            - `rpc-save-upload-metadata`

            Except for the following options, changing the other options of active download makes it restart (restart
            itself is managed by aria2, and no user intervention is required):

            - `bt-max-peers`
            - `bt-request-peer-speed-limit`
            - `bt-remove-unselected-file`
            - `force-save`
            - `max-download-limit`
            - `max-upload-limit`

    Returns:
        `"OK"` for success.

    Examples:
        **Original JSON-RPC Example**

        The following examples set the max-download-limit option to 20K for the download GID#0000000000000001.

        >>> import urllib2, json
        >>> from pprint import pprint
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'aria2.changeOption',
        ...                       'params':['0000000000000001',
        ...                                 {'max-download-limit':'10K'}]})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        {u'id': u'qwer', u'jsonrpc': u'2.0', u'result': u'OK'}
    """
    return self.call(self.CHANGE_OPTION, [gid, options])  # type: ignore

def change_position(self, gid: str, pos: int, how: str) -> int:
    """Change position of a download.

    This method changes the position of the download denoted by `gid` in the queue.

    Original signature:

        aria2.changePosition([secret], gid, pos, how)

    Parameters:
        gid: The download to change the position of.
        pos: An integer.
        how: `POS_SET`, `POS_CUR` or `POS_END`.

            - If `how` is `POS_SET`, it moves the download to a position relative to the beginning of the queue.
            - If `how` is `POS_CUR`, it moves the download to a position relative to the current position.
            - If `how` is `POS_END`, it moves the download to a position relative to the end of the queue.
            - If the destination position is less than 0 or beyond the end of the queue,
              it moves the download to the beginning or the end of the queue respectively.

            For example, if GID#0000000000000001 is currently in position 3,
            `change_position('0000000000000001', -1, 'POS_CUR')` will change its position to 2. Additionally
            `change_position('0000000000000001', 0, 'POS_SET')` will change its position to 0 (the beginning of the queue).

    Returns:
        An integer denoting the resulting position.

    Examples:
        **Original JSON-RPC Example**

        The following examples move the download GID#0000000000000001 to the front of the queue.

        >>> import urllib2, json
        >>> from pprint import pprint
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'aria2.changePosition',
        ...                       'params':['0000000000000001', 0, 'POS_SET']})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        {u'id': u'qwer', u'jsonrpc': u'2.0', u'result': 0}
    """
    return self.call(self.CHANGE_POSITION, [gid, pos, how])  # type: ignore

def change_uri(
    self,
    gid: str,
    file_index: int,
    del_uris: list[str],
    add_uris: list[str],
    position: int | None = None,
) -> list[int]:
    """Remove the URIs in `del_uris` from and appends the URIs in `add_uris` to download denoted by gid.

    Original signature:

        aria2.changeUri([secret], gid, fileIndex, delUris, addUris[, position])

    Parameters:
        gid: The download to change URIs of.
        file_index: Used to select which file to remove/attach given URIs. `file_index` is 1-based.
        del_uris: List of strings.
        add_uris: List of strings.
        position: Used to specify where URIs are inserted in the existing waiting URI list. `position` is 0-based.
            When position is omitted, URIs are appended to the back of the list.
            This method first executes the removal and then the addition.
            `position` is the position after URIs are removed, not the position when this
            method is called.

    A download can contain multiple files and URIs are attached to each file.
    When removing an URI, if the same URIs exist in download, only one of them is removed for
    each URI in `del_uris`. In other words, if there are three URIs http://example.org/aria2 and you want
    remove them all, you have to specify (at least) 3 http://example.org/aria2 in `del_uris`.

    Returns:
        A list which contains two integers.
        The first integer is the number of URIs deleted.
        The second integer is the number of URIs added.

    Examples:
        **Original JSON-RPC Example**

        The following examples add the URI http://example.org/file to the file whose index is 1 and belongs to the
        download GID#0000000000000001.

        >>> import urllib2, json
        >>> from pprint import pprint
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'aria2.changeUri',
        ...                       'params':['0000000000000001', 1, [],
                                           ['http://example.org/file']]})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        {u'id': u'qwer', u'jsonrpc': u'2.0', u'result': [0, 1]}
    """
    return self.call(self.CHANGE_URI, [gid, file_index, del_uris, add_uris, position])  # type: ignore

def force_pause(self, gid: str) -> str:
    """Force pause a download.

    This method pauses the download denoted by gid.
    This method behaves just like [`pause()`][aria2p.client.Client.pause] except that
    this method pauses downloads without performing any actions which take time,
    such as contacting BitTorrent trackers to unregister the download first.

    Original signature:

        aria2.forcePause([secret], gid)

    Parameters:
        gid: The download to force pause.

    Returns:
        The GID of the paused download.
    """
    return self.call(self.FORCE_PAUSE, [gid])  # type: ignore

def force_pause_all(self) -> str:
    """Force pause all active/waiting downloads.

    This method is equal to calling [`force_pause()`][aria2p.client.Client.force_pause] for every active/waiting download.

    Original signature:

        aria2.forcePauseAll([secret])

    Returns:
        `"OK"`.
    """
    return self.call(self.FORCE_PAUSE_ALL)  # type: ignore

def force_remove(self, gid: str) -> str:
    """Force remove a download.

    This method removes the download denoted by gid.
    This method behaves just like [`remove()`][aria2p.client.Client.remove] except
    that this method removes the download without performing any actions which take time, such as contacting
    BitTorrent trackers to unregister the download first.

    Original signature:

        aria2.forceRemove([secret], gid)

    Parameters:
        gid: The download to force remove.

    Returns:
        The GID of the removed download.
    """
    return self.call(self.FORCE_REMOVE, [gid])  # type: ignore

def force_shutdown(self) -> str:
    """Force shutdown aria2.

    This method shuts down aria2. This method behaves like [`shutdown()`][aria2p.client.Client.shutdown] without performing any
    actions which take time, such as contacting BitTorrent trackers to unregister downloads first.

    Original signature:

        aria2.forceShutdown([secret])

    Returns:
        `"OK"`.
    """
    return self.call(self.FORCE_SHUTDOWN)  # type: ignore

def get_files(self, gid: str) -> dict:
    """Return file list of a download.

    This method returns the file list of the download denoted by gid (string). The response is an array of
    structs which contain following keys. Values are strings.

    - `index`: Index of the file, starting at 1, in the same order as files appear in the multi-file torrent.
    - `path`: File path.
    - `length`: File size in bytes.
    - `completedLength`: Completed length of this file in bytes.
      Please note that it is possible that sum of `completedLength`
      is less than the `completedLength` returned by the [`tell_status()`][aria2p.client.Client.tell_status] method.
      This is because `completedLength` in [`get_files()`][aria2p.client.Client.get_files] only includes completed pieces.
      On the other hand, `completedLength` in [`tell_status()`][aria2p.client.Client.tell_status]
      also includes partially completed pieces.
    - `selected`: true if this file is selected by [`--select-file`][aria2p.options.Options.select_file] option.
      If [`--select-file`][aria2p.options.Options.select_file] is not specified
      or this is single-file torrent or not a torrent download at all, this value is always true. Otherwise false.
    - `uris` Returns a list of URIs for this file.
      The element type is the same struct used in the [`get_uris()`][aria2p.client.Client.get_uris] method.

    Original signature:

        aria2.getFiles([secret], gid)

    Parameters:
        gid: The download to list files of.

    Returns:
        The file list of a download.

    Examples:
        **Original JSON-RPC Example**

        >>> import urllib2, json
        >>> from pprint import pprint
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'aria2.getFiles',
        ...                       'params':['0000000000000001']})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        {u'id': u'qwer',
         u'jsonrpc': u'2.0',
         u'result': [{u'index': u'1',
                      u'length': u'34896138',
                      u'completedLength': u'34896138',
                      u'path': u'/downloads/file',
                      u'selected': u'true',
                      u'uris': [{u'status': u'used',
                                 u'uri': u'http://example.org/file'}]}]}
    """
    return self.call(self.GET_FILES, [gid])  # type: ignore

def get_global_option(self) -> dict:
    """Return the global options.

    Note that this method does not return options which have no default value and have not
    been set on the command-line, in configuration files or RPC methods. Because global options are used as a
    template for the options of newly added downloads, the response contains keys returned by the
    [`get_option()`][aria2p.client.Client.get_option] method.

    Original signature:

        aria2.getGlobalOption([secret])

    Returns:
        The global options. The response is a struct. Its keys are the names of options.
        Values are strings.
    """
    return self.call(self.GET_GLOBAL_OPTION)  # type: ignore

def get_global_stat(self) -> dict:
    """Return global statistics such as the overall download and upload speeds.

    Original signature:

        aria2.getGlobalStat([secret])

    Returns:
        A struct that contains the following keys (values are strings):

        - `downloadSpeed`: Overall download speed (byte/sec).
        - `uploadSpeed`: Overall upload speed(byte/sec).
        - `numActive`: The number of active downloads.
        - `numWaiting`: The number of waiting downloads.
        - `numStopped`: The number of stopped downloads in the current session. This value is capped by the
            [`--max-download-result`][aria2p.options.Options.max_download_result] option.
        - `numStoppedTotal`: The number of stopped downloads in the current session and not capped by the
            [`--max-download-result`][aria2p.options.Options.max_download_result] option.

    Examples:
        **Original JSON-RPC Example**

        >>> import urllib2, json
        >>> from pprint import pprint
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'aria2.getGlobalStat'})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        {u'id': u'qwer',
         u'jsonrpc': u'2.0',
         u'result': {u'downloadSpeed': u'21846',
                     u'numActive': u'2',
                     u'numStopped': u'0',
                     u'numWaiting': u'0',
                     u'uploadSpeed': u'0'}}
    """
    return self.call(self.GET_GLOBAL_STAT)  # type: ignore

def get_option(self, gid: str) -> dict:
    """Return options of a download.

    Original signature:

        aria2.getOption([secret], gid)

    Parameters:
        gid: The download to get the options of.

    Returns:
        A struct where keys are the names of options. The values are strings.
        Note that this method does not return options which have
        no default value and have not been set on the command-line, in configuration files or RPC methods.

    Examples:
        **Original JSON-RPC Example**

        The following examples get options of the download GID#0000000000000001.

        >>> import urllib2, json
        >>> from pprint import pprint
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'aria2.getOption',
        ...                       'params':['0000000000000001']})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        {u'id': u'qwer',
         u'jsonrpc': u'2.0',
         u'result': {u'allow-overwrite': u'false',
                     u'allow-piece-length-change': u'false',
                     u'always-resume': u'true',
                     u'async-dns': u'true',
         ...
    """
    return self.call(self.GET_OPTION, [gid])  # type: ignore

@staticmethod
def get_params(*args: Any) -> list:
    """Build the list of parameters.

    This method simply removes the `None` values from the given arguments.

    Parameters:
        *args: List of parameters.

    Returns:
        A new list, with `None` values filtered out.
    """
    return [_ for _ in args if _ is not None]

@staticmethod
def get_payload(
    method: str,
    params: list[Any] | None = None,
    msg_id: int | str | None = None,
    as_json: bool = True,  # noqa: FBT001,FBT002
) -> str | dict:
    """Build a payload.

    Parameters:
        method: The method name. You can use the constant defined in [`Client`][aria2p.client.Client].
        params: The list of parameters.
        msg_id: The ID of the call, sent back with the server's answer.
        as_json: Whether to return the payload as a JSON-string or Python dictionary.

    Returns:
        The payload as a JSON string or as Python dictionary.
    """
    payload: dict[str, Any] = {"jsonrpc": "2.0", "method": method}

    if msg_id is None:
        payload["id"] = DEFAULT_ID
    else:
        payload["id"] = msg_id

    if params:
        payload["params"] = params

    return json.dumps(payload) if as_json else payload

def get_peers(self, gid: str) -> dict:
    """Return peers list of a download.

    This method returns the list of peers of the download denoted by gid (string). This method is for BitTorrent
    only. The response is an array of structs and contains the following keys. Values are strings.

    - `peerId`: Percent-encoded peer ID.
    - `ip`: IP address of the peer.
    - `port`: Port number of the peer.
    - `bitfield`: Hexadecimal representation of the download progress of the peer. The highest bit corresponds to
      the piece at index 0. Set bits indicate the piece is available and unset bits indicate the piece is
      missing. Any spare bits at the end are set to zero.
    - `amChoking`: true if aria2 is choking the peer. Otherwise false.
    - `peerChoking`: true if the peer is choking aria2. Otherwise false.
    - `downloadSpeed`: Download speed (byte/sec) that this client obtains from the peer.
    - `uploadSpeed`: Upload speed(byte/sec) that this client uploads to the peer.
    - `seeder`: true if this peer is a seeder. Otherwise false.

    Original signature:

        aria2.getPeers([secret], gid)

    Parameters:
        gid: The download to get peers from.

    Returns:
        The peers connected to a download.

    Examples:
        **Original JSON-RPC Example**

        >>> import urllib2, json
        >>> from pprint import pprint
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'aria2.getPeers',
        ...                       'params':['0000000000000001']})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        {u'id': u'qwer',
         u'jsonrpc': u'2.0',
         u'result': [{u'amChoking': u'true',
                      u'bitfield': u'ffffffffffffffffffffffffffffffffffffffff',
                      u'downloadSpeed': u'10602',
                      u'ip': u'10.0.0.9',
                      u'peerChoking': u'false',
                      u'peerId': u'aria2%2F1%2E10%2E5%2D%87%2A%EDz%2F%F7%E6',
                      u'port': u'6881',
                      u'seeder': u'true',
                      u'uploadSpeed': u'0'},
                     {u'amChoking': u'false',
                      u'bitfield': u'ffffeff0fffffffbfffffff9fffffcfff7f4ffff',
                      u'downloadSpeed': u'8654',
                      u'ip': u'10.0.0.30',
                      u'peerChoking': u'false',
                      u'peerId': u'bittorrent client758',
                      u'port': u'37842',
                      u'seeder': u'false',
                      u'uploadSpeed': u'6890'}]}
    """
    return self.call(self.GET_PEERS, [gid])  # type: ignore

def get_servers(self, gid: str) -> dict:
    """Return servers currently connected for a download.

    This method returns currently connected HTTP(S)/FTP/SFTP servers of the download denoted by gid (string). The
    response is an array of structs and contains the following keys. Values are strings.

    - `index`: Index of the file, starting at 1, in the same order as files appear in the multi-file metalink.
    - `servers`: A list of structs which contain the following keys.
        - `uri`: Original URI.
        - `currentUri`: This is the URI currently used for downloading.
          If redirection is involved, currentUri and uri may differ.
        - `downloadSpeed`: Download speed (byte/sec).

    Original signature:

        aria2.getServers([secret], gid)

    Parameters:
        gid: The download to get servers from.

    Returns:
        The servers connected to a download.

    Examples:
        **Original JSON-RPC Example**

        >>> import urllib2, json
        >>> from pprint import pprint
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'aria2.getServers',
        ...                       'params':['0000000000000001']})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        {u'id': u'qwer',
         u'jsonrpc': u'2.0',
         u'result': [{u'index': u'1',
                      u'servers': [{u'currentUri': u'http://example.org/file',
                                    u'downloadSpeed': u'10467',
                                    u'uri': u'http://example.org/file'}]}]}
    """
    return self.call(self.GET_SERVERS, [gid])  # type: ignore

def get_session_info(self) -> dict:
    """Return session information.

    Returns:
        A struct that contains the `sessionId` key, which is generated each time aria2 is invoked.

    Original signature:

        aria2.getSessionInfo([secret])

    Examples:
        **Original JSON-RPC Example**

        >>> import urllib2, json
        >>> from pprint import pprint
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'aria2.getSessionInfo'})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        {u'id': u'qwer',
         u'jsonrpc': u'2.0',
         u'result': {u'sessionId': u'cd6a3bc6a1de28eb5bfa181e5f6b916d44af31a9'}}
    """
    return self.call(self.GET_SESSION_INFO)  # type: ignore

def get_uris(self, gid: str) -> dict:
    """Return URIs used in a download.

    This method returns the URIs used in the download denoted by gid (string). The response is an array of
    structs and it contains following keys. Values are string.

    - `uri`: URI
    - `status`: 'used' if the URI is in use. 'waiting' if the URI is still waiting in the queue.

    Original signature:

        aria2.getUris([secret], gid)

    Parameters:
        gid: The download to list URIs of.

    Returns:
        The URIs used in a download.

    Examples:
        **Original JSON-RPC Example**

        >>> import urllib2, json
        >>> from pprint import pprint
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'aria2.getUris',
        ...                       'params':['0000000000000001']})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        {u'id': u'qwer',
         u'jsonrpc': u'2.0',
         u'result': [{u'status': u'used',
                      u'uri': u'http://example.org/file'}]}
    """
    return self.call(self.GET_URIS, [gid])  # type: ignore

def get_version(self) -> str:
    """Return aria2 version and the list of enabled features.

    Original signature:

        aria2.getVersion([secret])

    Returns:
        A struct that contains the following keys:

        - `version`: Version number of aria2 as a string.
        - `enabledFeatures`: List of enabled features. Each feature is given as a string.

    Examples:
        **Original JSON-RPC Example**

        >>> import urllib2, json
        >>> from pprint import pprint
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'aria2.getVersion'})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        {u'id': u'qwer',
         u'jsonrpc': u'2.0',
         u'result': {u'enabledFeatures': [u'Async DNS',
                                          u'BitTorrent',
                                          u'Firefox3 Cookie',
                                          u'GZip',
                                          u'HTTPS',
                                          u'Message Digest',
                                          u'Metalink',
                                          u'XML-RPC'],
                     u'version': u'1.11.0'}}
    """
    return self.call(self.GET_VERSION)  # type: ignore

def list_methods(self) -> list[str]:
    """Return the available RPC methods.

    This method returns all the available RPC methods in an array of string. Unlike other methods,
    this method does not require secret token. This is safe because this method just returns the available
    method names.

    Original signature:

        system.listMethods()

    Returns:
        The list of available RPC methods.

    Examples:
        **Original JSON-RPC Example**

        >>> import urllib2, json
        >>> from pprint import pprint
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'system.listMethods'})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        {u'id': u'qwer',
         u'jsonrpc': u'2.0',
         u'result': [u'aria2.addUri',
                     u'aria2.addTorrent',
         ...
    """
    return self.call(self.LIST_METHODS)  # type: ignore

def list_notifications(self) -> list[str]:
    """Return all the available RPC notifications.

    This method returns all the available RPC notifications in an array of string. Unlike other methods,
    this method does not require secret token. This is safe because this method just returns the available
    notifications names.

    Original signature:

        system.listNotifications()

    Returns:
        The list of available RPC notifications.

    Examples:
        **Original JSON-RPC Example**

        >>> import urllib2, json
        >>> from pprint import pprint
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'system.listNotifications'})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        {u'id': u'qwer',
         u'jsonrpc': u'2.0',
         u'result': [u'aria2.onDownloadStart',
                     u'aria2.onDownloadPause',
         ...
    """
    return self.call(self.LIST_NOTIFICATIONS)  # type: ignore

def listen_to_notifications(
    self,
    on_download_start: Callable | None = None,
    on_download_pause: Callable | None = None,
    on_download_stop: Callable | None = None,
    on_download_complete: Callable | None = None,
    on_download_error: Callable | None = None,
    on_bt_download_complete: Callable | None = None,
    timeout: int = 5,
    handle_signals: bool = True,  # noqa: FBT001,FBT002
) -> None:
    """Start listening to aria2 notifications via WebSocket.

    This method opens a WebSocket connection to the server and wait for notifications (or events) to be received.
    It accepts callbacks as arguments, which are functions accepting one parameter called "gid", for each type
    of notification.

    Stop listening to notifications with the [`stop_listening`][aria2p.client.Client.stop_listening] method.

    Parameters:
        on_download_start: Callback for the `onDownloadStart` event.
        on_download_pause: Callback for the `onDownloadPause` event.
        on_download_stop: Callback for the `onDownloadStop` event.
        on_download_complete: Callback for the `onDownloadComplete` event.
        on_download_error: Callback for the `onDownloadError` event.
        on_bt_download_complete: Callback for the `onBtDownloadComplete` event.
        timeout: Timeout when waiting for data to be received. Use a small value for faster reactivity
            when stopping to listen. Default is 5 seconds.
        handle_signals: Whether to add signal handlers to gracefully stop the loop on SIGTERM and SIGINT.
    """
    self.listening = True
    ws_server = self.ws_server
    log_prefix = f"Notifications ({ws_server})"

    logger.debug(f"{log_prefix}: opening WebSocket with timeout={timeout}")
    try:
        socket = websocket.create_connection(ws_server, timeout=timeout)
    except (ConnectionRefusedError, ConnectionResetError):
        logger.error(f"{log_prefix}: connection refused. Is the server running?")
        return

    callbacks = {
        NOTIFICATION_START: on_download_start,
        NOTIFICATION_PAUSE: on_download_pause,
        NOTIFICATION_STOP: on_download_stop,
        NOTIFICATION_COMPLETE: on_download_complete,
        NOTIFICATION_ERROR: on_download_error,
        NOTIFICATION_BT_COMPLETE: on_bt_download_complete,
    }

    stopped = SignalHandler(["SIGTERM", "SIGINT"]) if handle_signals else False

    while not stopped:
        logger.debug(f"{log_prefix}: waiting for data over WebSocket")
        try:
            message = socket.recv()
        except websocket.WebSocketConnectionClosedException:
            logger.error(f"{log_prefix}: connection to server was closed. Is the server running?")
            break
        except websocket.WebSocketTimeoutException:
            logger.debug(f"{log_prefix}: reached timeout ({timeout}s)")
        else:
            notification = Notification.get_or_raise(json.loads(message))
            logger.info(
                f"{log_prefix}: received {notification.type} with gid={notification.gid}",
            )
            callback = callbacks.get(notification.type)
            if callable(callback):
                logger.debug(f"{log_prefix}: calling {callback} with gid={notification.gid}")
                callback(notification.gid)
            else:
                logger.debug(f"{log_prefix}: no callback given for type " + notification.type)

        if not self.listening:
            logger.debug(f"{log_prefix}: stopped listening")
            break

    if stopped:
        logger.debug(f"{log_prefix}: stopped listening after receiving a signal")
        self.listening = False

    logger.debug(f"{log_prefix}: closing WebSocket")
    socket.close()

def multicall(self, methods: list[dict]) -> list[CallReturnType]:
    """Call multiple methods in a single request.

    This methods encapsulates multiple method calls in a single request.

    Original signature:

        system.multicall(methods)

    Parameters:
        methods: An array of structs. The structs contain two keys: `methodName` and `params`.
            - `methodName` is the method name to call and
            - `params` is array containing parameters to the method call.

    Returns:
        An array of responses.
        The elements will be either a one-item array containing the return value of the method call or a struct of fault
        element if an encapsulated method call fails.

    Examples:
        **Original JSON-RPC Example**

        In the following examples, we add 2 downloads. The first one is http://example.org/file and the second one is
        file.torrent.

        >>> import urllib2, json, base64
        >>> from pprint import pprint
        >>> jsonreq = json.dumps({'jsonrpc':'2.0', 'id':'qwer',
        ...                       'method':'system.multicall',
        ...                       'params':[[{'methodName':'aria2.addUri',
        ...                                   'params':[['http://example.org']]},
        ...                                  {'methodName':'aria2.addTorrent',
        ...                                   'params':[base64.b64encode(open('file.torrent').read())]}]]})
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        {u'id': u'qwer', u'jsonrpc': u'2.0', u'result': [[u'0000000000000001'], [u'd2703803b52216d1']]}

        JSON-RPC additionally supports Batch requests as described in the JSON-RPC 2.0 Specification:

        >>> jsonreq = json.dumps([{'jsonrpc':'2.0', 'id':'qwer',
        ...                        'method':'aria2.addUri',
        ...                        'params':[['http://example.org']]},
        ...                       {'jsonrpc':'2.0', 'id':'asdf',
        ...                        'method':'aria2.addTorrent',
        ...                        'params':[base64.b64encode(open('file.torrent').read())]}])
        >>> c = urllib2.urlopen('http://localhost:6800/jsonrpc', jsonreq)
        >>> pprint(json.loads(c.read()))
        [{u'id': u'qwer', u'jsonrpc': u'2.0', u'result': u'0000000000000001'},
         {u'id': u'asdf', u'jsonrpc': u'2.0', u'result': u'd2703803b52216d1'}]
    """
    return self.call(self.MULTICALL, [methods])  # type: ignore

def multicall2(self, calls: Multicalls2Type, insert_secret: bool = True) -> CallReturnType:  # noqa: FBT001,FBT002
    """Call multiple methods in one request.

    A method equivalent to multicall, but with a simplified usage.

    Instead of providing dictionaries with "methodName" and "params" keys and values, this method allows you
    to provide the values only, in tuples of length 2.

    With a classic multicall, you would write your params like:

        [
            {"methodName": client.REMOVE, "params": ["0000000000000001"]},
            {"methodName": client.REMOVE, "params": ["2fa07b6e85c40205"]},
        ]

    With multicall2, you can reduce the verbosity:

        [
            (client.REMOVE, ["0000000000000001"]),
            (client.REMOVE, ["2fa07b6e85c40205"]),
        ]

    Note:
        multicall2 is not part of the JSON-RPC protocol specification.
        It is implemented here as a simple convenience method.

    Parameters:
        calls: List of tuples composed of method name and parameters.
        insert_secret: Whether to insert the secret token in the parameters or not.

    Returns:
        The answer from the server, as a Python object (dict / list / str / int).
    """
    multicall_params = []

    for method, params in calls:
        params = self.get_params(*params)  # noqa: PLW2901
        if insert_secret and self.secret and method.startswith("aria2."):
            params.insert(0, f"token:{self.secret}")
        multicall_params.append({"methodName": method, "params": params})

    payload: str = self.get_payload(self.MULTICALL, [multicall_params])  # type: ignore
    return self.res_or_raise(self.post(payload))

def pause(self, gid: str) -> str:
    """Pause a download.

    This method pauses the download denoted by gid (string).
    The status of paused download becomes paused.
    If the download was active, the download is placed in the front of waiting queue.
    While the status is paused, the download is not started.
    To change status to waiting, use the [`unpause()`][aria2p.client.Client.unpause] method.

    Original signature:

        aria2.pause([secret], gid)

    Parameters:
        gid: The download to pause.

    Returns:
        The GID of the paused download.
    """
    return self.call(self.PAUSE, [gid])  # type: ignore

def pause_all(self) -> str:
    """Pause all active/waiting downloads.

    This method is equal to calling [`pause()`][aria2p.client.Client.pause] for every active/waiting download.

    Original signature:

        aria2.pauseAll([secret])

    Returns:
        `"OK"`.
    """
    return self.call(self.PAUSE_ALL)  # type: ignore

def post(self, payload: str) -> dict:
    """Send a POST request to the server.

    The response is a JSON string, which we then load as a Python object.

    Parameters:
        payload: The payload / data to send to the remote process. It contains the following key-value pairs:
            "jsonrpc": "2.0", "method": method, "id": id, "params": params (optional).

    Returns:
        The answer from the server, as a Python dictionary.
    """
    return requests.post(self.server, data=payload, timeout=self.timeout).json()

def purge_download_result(self) -> str:
    """Purge completed/error/removed downloads from memory.

    Original signature:

        aria2.purgeDownloadResult([secret])

    Returns:
        `"OK"`.
    """
    return self.call(self.PURGE_DOWNLOAD_RESULT)  # type: ignore