document --list-extractors-json option and fix a minor typo

This commit is contained in:
wesson 2024-12-04 22:22:42 +01:00
parent f20148e1d7
commit 25b73a440b
2 changed files with 17 additions and 2 deletions

View file

@ -302,6 +302,7 @@ If you fork the project on GitHub, you can run your fork's [build workflow](.git
error occurs (Alias: --no-ignore-errors) error occurs (Alias: --no-ignore-errors)
--dump-user-agent Display the current user-agent and exit --dump-user-agent Display the current user-agent and exit
--list-extractors List all supported extractors and exit --list-extractors List all supported extractors and exit
--list-extractors-json List all supported extractors in json and exit
--extractor-descriptions Output descriptions of all supported --extractor-descriptions Output descriptions of all supported
extractors and exit extractors and exit
--use-extractors NAMES Extractor names to use separated by commas. --use-extractors NAMES Extractor names to use separated by commas.
@ -1875,6 +1876,20 @@ The following extractors use this feature:
<!-- MANPAGE: MOVE "INSTALLATION" SECTION HERE --> <!-- MANPAGE: MOVE "INSTALLATION" SECTION HERE -->
# EXTRACTOR INFO JSON
parameter `--list-extractors-json` output information from extractor(s) formated as JSON. If some URL(s) are specified, only the extractors matching at list one URL are listed. If none is specified, all extractors are listed. The generic extractor is always the last in the list.
### List of values returned
key | type | description
:------------|:----------------|:----------------------------
index | int | index in list, starting from 0
name | string | name of the extractor
desc | string | description of the extractor
working | bool | true if the extractor is working
enabled | bool | true if the extractor is enabled
return_type | string | type of data returned by the extractor ("video", "playlist", "any", or None)
regex_urls | array of string | list of regex used by the extractor to match a given url
matched_urls | array of string | list of url(s) passed in the command line that matched the given extractor. Present only if URL(s) are specified.
# PLUGINS # PLUGINS

View file

@ -140,7 +140,7 @@ def print_extractor_information(opts, urls):
'working': ie.working(), 'working': ie.working(),
'enabled': ie.is_enabled(), 'enabled': ie.is_enabled(),
'return_type': ie.return_type(), 'return_type': ie.return_type(),
'regex_url': ie.list_regex_url(), 'regex_urls': ie.list_regex_url(),
'matched_urls': matched_urls, 'matched_urls': matched_urls,
} }
e_index += 1 e_index += 1
@ -154,7 +154,7 @@ def print_extractor_information(opts, urls):
'working': ie.working(), 'working': ie.working(),
'enabled': ie.is_enabled(), 'enabled': ie.is_enabled(),
'return_type': ie.return_type(), 'return_type': ie.return_type(),
'regex_url': ie.list_regex_url(), 'regex_urls': ie.list_regex_url(),
} }
dicts.append(data) dicts.append(data)
e_index += 1 e_index += 1