github/gallery-dl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs/configuration] move notes to definition lists

Browse Source
This commit is contained in:
Mike Fährmann
2025-09-26 18:47:07 +02:00
parent a2de94b4aa
commit 9c4d20e926
1 changed files with 150 additions and 154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

304
docs/configuration.rst
View File

@@ -106,8 +106,8 @@ Description
5977527 5977527
subcategory subcategory
image image
Note
Note: Even if the value of the ``extension`` key is missing or Even if the value of the ``extension`` key is missing or
``None``, it will be filled in later when the file download is ``None``, it will be filled in later when the file download is
starting. This key is therefore always available to provide starting. This key is therefore always available to provide
a valid filename extension. a valid filename extension.
@@ -254,8 +254,8 @@ Default
``"\u0000-\u001f\u007f"`` (ASCII control characters) ``"\u0000-\u001f\u007f"`` (ASCII control characters)
Description Description
Set of characters to remove from generated path names. Set of characters to remove from generated path names.
Note
Note: In a string with 2 or more characters, ``[]^-\`` need to be In a string with 2 or more characters, ``[]^-\`` need to be
escaped with backslashes, e.g. ``"\\[\\]"`` escaped with backslashes, e.g. ``"\\[\\]"``
@@ -535,8 +535,8 @@ Description
(R) Login with username & password or supplying logged-in (R) Login with username & password or supplying logged-in
`cookies <extractor.*.cookies_>`__ is required `cookies <extractor.*.cookies_>`__ is required
Note
Note: Leave the ``password`` value empty or undefined Leave the ``password`` value empty or undefined
to be prompted for a password when performing a login to be prompted for a password when performing a login
(see `getpass() <https://docs.python.org/3/library/getpass.html#getpass.getpass>`__). (see `getpass() <https://docs.python.org/3/library/getpass.html#getpass.getpass>`__).
@@ -669,9 +669,8 @@ Description
It is also possible to set a proxy for a specific host by using It is also possible to set a proxy for a specific host by using
``scheme://host`` as key. ``scheme://host`` as key.
See `Requests' proxy documentation`_ for more details. See `Requests' proxy documentation`_ for more details.
Note
Note: If a proxy URL does not include a scheme, If a proxy URL does not include a scheme, ``http://`` is assumed.
``http://`` is assumed.
extractor.*.proxy-env extractor.*.proxy-env
@@ -984,8 +983,8 @@ Description
* A category or basecategory name (``"imgur"``, ``"mastodon"``) * A category or basecategory name (``"imgur"``, ``"mastodon"``)
* | A (base)category-subcategory pair, where both names are separated by a colon (``"redgifs:user"``). * | A (base)category-subcategory pair, where both names are separated by a colon (``"redgifs:user"``).
| Both names can be a `*` or left empty, matching all possible names (``"*:image"``, ``":user"``). | Both names can be a `*` or left empty, matching all possible names (``"*:image"``, ``":user"``).
Note
Note: Any ``blacklist`` setting will automatically include Any ``blacklist`` setting will automatically include
``"oauth"``, ``"recursive"``, and ``"test"``. ``"oauth"``, ``"recursive"``, and ``"test"``.
@@ -1013,10 +1012,10 @@ Description
`PostgreSQL Connection URI <https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS>`__, `PostgreSQL Connection URI <https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS>`__,
the archive will use this PostgreSQL database as backend (requires the archive will use this PostgreSQL database as backend (requires
`Psycopg <https://www.psycopg.org/>`__). `Psycopg <https://www.psycopg.org/>`__).
Note
Archive files that do not already exist get generated automatically.
Note: Archive files that do not already exist get generated automatically. Archive paths support basic `format string`_ replacements,
Note: Archive paths support regular `format string`_ replacements,
but be aware that using external inputs for building local paths but be aware that using external inputs for building local paths
may pose a security risk. may pose a security risk.
@@ -1325,8 +1324,8 @@ Description
| Arguments for range and slice notation are optional | Arguments for range and slice notation are optional
and will default to begin (``1``) or end (``sys.maxsize``) if omitted. and will default to begin (``1``) or end (``sys.maxsize``) if omitted.
| For example ``5-``, ``5:``, and ``5::`` all mean "Start at file number 5". | For example ``5-``, ``5:``, and ``5::`` all mean "Start at file number 5".
Note
Note: The index of the first file is ``1``. The index of the first file is ``1``.
extractor.*.chapter-range extractor.*.chapter-range
@@ -1400,8 +1399,8 @@ Description
`date-min` and `date-max`. `date-min` and `date-max`.
See |strptime|_ for a list of formatting directives. See |strptime|_ for a list of formatting directives.
Note
Note: Despite its name, this option does **not** control how Despite its name, this option does **not** control how
``{date}`` metadata fields are formatted. ``{date}`` metadata fields are formatted.
To use a different formatting for those values other than the default To use a different formatting for those values other than the default
``%Y-%m-%d %H:%M:%S``, put |strptime|_ formatting directives ``%Y-%m-%d %H:%M:%S``, put |strptime|_ formatting directives
@@ -1956,8 +1955,8 @@ Example
* ``["version", "generation"]`` * ``["version", "generation"]``
Description Description
Extract additional ``generation``, ``version``, and ``post`` metadata. Extract additional ``generation``, ``version``, and ``post`` metadata.
Note
Note: This requires 1 or more additional API requests per image or video. This requires 1 or more additional API requests per image or video.
extractor.civitai.nsfw extractor.civitai.nsfw
@@ -1999,8 +1998,8 @@ Description
to pass with every image URL. to pass with every image URL.
Known available options include ``original``, ``quality``, ``width`` Known available options include ``original``, ``quality``, ``width``
Note
Note: Set this option to an arbitrary letter, e.g., ``"w"``, Set this option to an arbitrary letter, e.g., ``"w"``,
to download images in JPEG format at their original resolution. to download images in JPEG format at their original resolution.
@@ -2073,7 +2072,7 @@ Default
Description Description
Password value used to access protected files and folders. Password value used to access protected files and folders.
Note: Leave this value empty or undefined Leave this value empty or undefined
to be interactively prompted for a password when needed to be interactively prompted for a password when needed
(see `getpass() <https://docs.python.org/3/library/getpass.html#getpass.getpass>`__). (see `getpass() <https://docs.python.org/3/library/getpass.html#getpass.getpass>`__).
@@ -2141,8 +2140,8 @@ Description
It is possible to specify a custom list of metadata includes. It is possible to specify a custom list of metadata includes.
See `available_includes <https://github.com/danbooru/danbooru/blob/2cf7baaf6c5003c1a174a8f2d53db010cf05dca7/app/models/post.rb#L1842-L1849>`__ See `available_includes <https://github.com/danbooru/danbooru/blob/2cf7baaf6c5003c1a174a8f2d53db010cf05dca7/app/models/post.rb#L1842-L1849>`__
for possible field names. ``aibooru`` also supports ``ai_metadata``. for possible field names. ``aibooru`` also supports ``ai_metadata``.
Note
Note: This requires 1 additional HTTP request per 200-post batch. This requires 1 additional HTTP request per 200-post batch.
extractor.[Danbooru].threshold extractor.[Danbooru].threshold
@@ -2156,8 +2155,8 @@ Description
Stop paginating over API results if the length of a batch of returned Stop paginating over API results if the length of a batch of returned
posts is less than the specified number. Defaults to the per-page limit posts is less than the specified number. Defaults to the per-page limit
of the current instance, which is 200. of the current instance, which is 200.
Note
Note: Changing this setting is normally not necessary. When the value is Changing this setting is normally not necessary. When the value is
greater than the per-page limit, gallery-dl will stop after the first greater than the per-page limit, gallery-dl will stop after the first
batch. The value cannot be less than 1. batch. The value cannot be less than 1.
@@ -2212,8 +2211,8 @@ Default
``false`` ``false``
Description Description
Download the avatar of each commenting user. Download the avatar of each commenting user.
Note
Note: Enabling this option also enables deviantart.comments_. Enabling this option also enables deviantart.comments_.
extractor.deviantart.extra extractor.deviantart.extra
@@ -2225,8 +2224,8 @@ Default
Description Description
Download extra Sta.sh resources from Download extra Sta.sh resources from
description texts and journals. description texts and journals.
Note
Note: Enabling this option also enables deviantart.metadata_. Enabling this option also enables deviantart.metadata_.
extractor.deviantart.flat extractor.deviantart.flat
@@ -2244,9 +2243,9 @@ Description
favorites-collections and transfer any further work to other favorites-collections and transfer any further work to other
extractors (``folder`` or ``collection``), which will then extractors (``folder`` or ``collection``), which will then
create individual subdirectories for each of them. create individual subdirectories for each of them.
Note
Note: Going through all gallery folders will not be able to Going through all gallery folders will not
fetch deviations which aren't in any folder. fetch deviations not contained in any folder.
extractor.deviantart.folders extractor.deviantart.folders
@@ -2258,8 +2257,8 @@ Default
Description Description
Provide a ``folders`` metadata field that contains the names of all Provide a ``folders`` metadata field that contains the names of all
folders a deviation is present in. folders a deviation is present in.
Note
Note: Gathering this information requires a lot of API calls. Gathering this information requires a lot of API calls.
Use with caution. Use with caution.
@@ -2344,8 +2343,8 @@ Description
Update `JSON Web Tokens <https://jwt.io/>`__ (the ``token`` URL parameter) Update `JSON Web Tokens <https://jwt.io/>`__ (the ``token`` URL parameter)
of otherwise non-downloadable, low-resolution images of otherwise non-downloadable, low-resolution images
to be able to download them in full resolution. to be able to download them in full resolution.
Note
Note: No longer functional as of 2023-10-11 No longer functional as of 2023-10-11
extractor.deviantart.mature extractor.deviantart.mature
@@ -2474,8 +2473,8 @@ Description
Using a ``refresh-token`` allows you to access private or otherwise Using a ``refresh-token`` allows you to access private or otherwise
not publicly available deviations. not publicly available deviations.
Note
Note: The ``refresh-token`` becomes invalid The ``refresh-token`` becomes invalid
`after 3 months <https://www.deviantart.com/developers/authentication#refresh>`__ `after 3 months <https://www.deviantart.com/developers/authentication#refresh>`__
or whenever your `cache file <cache.file_>`__ is deleted or cleared. or whenever your `cache file <cache.file_>`__ is deleted or cleared.
@@ -2578,8 +2577,8 @@ Example
* ``["notes", "pools"]`` * ``["notes", "pools"]``
Description Description
Extract additional metadata (notes, pool metadata) if available. Extract additional metadata (notes, pool metadata) if available.
Note
Note: This requires 0-2 additional HTTP requests per post. This requires 0-2 additional HTTP requests per post.
extractor.[E621].threshold extractor.[E621].threshold
@@ -2593,8 +2592,8 @@ Description
Stop paginating over API results if the length of a batch of returned Stop paginating over API results if the length of a batch of returned
posts is less than the specified number. Defaults to the per-page limit posts is less than the specified number. Defaults to the per-page limit
of the current instance, which is 320. of the current instance, which is 320.
Note
Note: Changing this setting is normally not necessary. When the value is Changing this setting is normally not necessary. When the value is
greater than the per-page limit, gallery-dl will stop after the first greater than the per-page limit, gallery-dl will stop after the first
batch. The value cannot be less than 1. batch. The value cannot be less than 1.
@@ -2642,10 +2641,10 @@ Example
Description Description
After downloading a gallery, After downloading a gallery,
add it to your account's favorites as the given category number. add it to your account's favorites as the given category number.
Note
Set this to `"favdel"` to remove galleries from your favorites.
Note: Set this to `"favdel"` to remove galleries from your favorites. This will remove any Favorite Notes when applied
Note: This will remove any Favorite Notes when applied
to already favorited galleries. to already favorited galleries.
@@ -2796,8 +2795,8 @@ Default
``false`` ``false``
Description Description
Extract ``comments`` metadata. Extract ``comments`` metadata.
Note
Note: This requires 1 or more additional API requests per post, This requires 1 or more additional API requests per post,
depending on the number of comments. depending on the number of comments.
@@ -2825,8 +2824,8 @@ Type
Description Description
Do not request API data or extract files from posts Do not request API data or extract files from posts
that require a fee (``feeRequired``) greater than the specified amount. that require a fee (``feeRequired``) greater than the specified amount.
Note
Note: This option has no effect on individual post URLs. This option has no effect on individual post URLs.
extractor.fanbox.metadata extractor.fanbox.metadata
@@ -2848,8 +2847,8 @@ Description
* ``comments`` * ``comments``
* ``plan`` * ``plan``
* ``user`` * ``user``
Note
Note: ``comments`` can also be enabled via ``comments`` can also be enabled via
`fanbox.comments <extractor.fanbox.comments_>`__ `fanbox.comments <extractor.fanbox.comments_>`__
@@ -2895,8 +2894,8 @@ Default
Description Description
For each photo, return the albums and pools it belongs to For each photo, return the albums and pools it belongs to
as ``set`` and ``pool`` metadata. as ``set`` and ``pool`` metadata.
Note
Note: This requires 1 additional API call per photo. This requires 1 additional API call per photo.
See `flickr.photos.getAllContexts <https://www.flickr.com/services/api/flickr.photos.getAllContexts.html>`__ for details. See `flickr.photos.getAllContexts <https://www.flickr.com/services/api/flickr.photos.getAllContexts.html>`__ for details.
@@ -2909,8 +2908,8 @@ Default
Description Description
For each photo, return its EXIF/TIFF/GPS tags For each photo, return its EXIF/TIFF/GPS tags
as ``exif`` and ``camera`` metadata. as ``exif`` and ``camera`` metadata.
Note
Note: This requires 1 additional API call per photo. This requires 1 additional API call per photo.
See `flickr.photos.getExif <https://www.flickr.com/services/api/flickr.photos.getExif.html>`__ for details. See `flickr.photos.getExif <https://www.flickr.com/services/api/flickr.photos.getExif.html>`__ for details.
@@ -2923,8 +2922,8 @@ Default
Description Description
For each photo, retrieve its "full" metadata as provided by For each photo, retrieve its "full" metadata as provided by
`flickr.photos.getInfo <https://www.flickr.com/services/api/flickr.photos.getInfo.html>`__ `flickr.photos.getInfo <https://www.flickr.com/services/api/flickr.photos.getInfo.html>`__
Note
Note: This requires 1 additional API call per photo. This requires 1 additional API call per photo.
extractor.flickr.metadata extractor.flickr.metadata
@@ -2956,8 +2955,8 @@ Default
``false`` ``false``
Description Description
Extract additional ``user`` profile metadata. Extract additional ``user`` profile metadata.
Note
Note: This requires 1 additional API call per user profile. This requires 1 additional API call per user profile.
See `flickr.people.getInfo <https://www.flickr.com/services/api/flickr.people.getInfo.html>`__ for details. See `flickr.people.getInfo <https://www.flickr.com/services/api/flickr.people.getInfo.html>`__ for details.
@@ -3136,8 +3135,8 @@ Description
* Select `Network` -> `XHR` * Select `Network` -> `XHR`
* Open a gallery page * Open a gallery page
* Select the last `Network` entry and copy its ``crt`` value * Select the last `Network` entry and copy its ``crt`` value
Note
Note: You will also need your browser's You will also need your browser's
`user-agent <extractor.*.user-agent_>`__ `user-agent <extractor.*.user-agent_>`__
@@ -3359,8 +3358,8 @@ Default
Description Description
Provide extended ``user`` metadata even when referring to a user by ID, Provide extended ``user`` metadata even when referring to a user by ID,
e.g. ``instagram.com/id:12345678``. e.g. ``instagram.com/id:12345678``.
Note
Note: This metadata is always available when referring to a user by name, This metadata is always available when referring to a user by name,
e.g. ``instagram.com/USERNAME``. e.g. ``instagram.com/USERNAME``.
@@ -3376,8 +3375,8 @@ Description
* ``"asc"``: Same order as displayed in a post * ``"asc"``: Same order as displayed in a post
* ``"desc"``: Reverse order as displayed in a post * ``"desc"``: Reverse order as displayed in a post
* ``"reverse"``: Same as ``"desc"`` * ``"reverse"``: Same as ``"desc"``
Note
Note: This option does *not* affect ``{num}``. This option does *not* affect ``{num}``.
To enumerate files in reverse order, use ``count - num + 1``. To enumerate files in reverse order, use ``count - num + 1``.
@@ -3395,8 +3394,8 @@ Description
* ``"id"`` or ``"id_asc"``: Ascending order by ID * ``"id"`` or ``"id_asc"``: Ascending order by ID
* ``"id_desc"``: Descending order by ID * ``"id_desc"``: Descending order by ID
* ``"reverse"``: Same as ``"desc"`` * ``"reverse"``: Same as ``"desc"``
Note
Note: This option only affects ``highlights``. This option only affects ``highlights``.
extractor.instagram.previews extractor.instagram.previews
@@ -3534,8 +3533,8 @@ Default
Description Description
Extract additional metadata for ``archives`` files, including Extract additional metadata for ``archives`` files, including
``file``, ``file_list``, and ``password``. ``file``, ``file_list``, and ``password``.
Note
Note: This requires 1 additional HTTP request per ``archives`` file. This requires 1 additional HTTP request per ``archives`` file.
extractor.kemono.comments extractor.kemono.comments
@@ -3546,8 +3545,8 @@ Default
``false`` ``false``
Description Description
Extract ``comments`` metadata. Extract ``comments`` metadata.
Note
Note: This requires 1 additional HTTP request per post. This requires 1 additional HTTP request per post.
extractor.kemono.duplicates extractor.kemono.duplicates
@@ -3664,8 +3663,8 @@ Description
Extract post revisions. Extract post revisions.
Set this to ``"unique"`` to filter out duplicate revisions. Set this to ``"unique"`` to filter out duplicate revisions.
Note
Note: This requires 1 additional HTTP request per post. This requires 1 additional HTTP request per post.
extractor.kemono.order-revisions extractor.kemono.order-revisions
@@ -3843,11 +3842,9 @@ Default
Description Description
The ``access-token`` value you get from `linking your account to The ``access-token`` value you get from `linking your account to
gallery-dl <OAuth_>`__. gallery-dl <OAuth_>`__.
Note
Note: gallery-dl comes with built-in tokens for ``mastodon.social``, gallery-dl comes with built-in tokens for
``pawoo`` and ``baraag``. For other instances, you need to obtain an ``mastodon.social``, ``pawoo``, and ``baraag``.
``access-token`` in order to use usernames in place of numerical
user IDs.
extractor.[mastodon].cards extractor.[mastodon].cards
@@ -3949,8 +3946,8 @@ Default
``false`` ``false``
Description Description
Extract extended ``pool`` metadata. Extract extended ``pool`` metadata.
Note
Note: Not supported by all ``moebooru`` instances. Not supported by all ``moebooru`` instances.
extractor.naver-blog.videos extractor.naver-blog.videos
@@ -4119,8 +4116,8 @@ Default
``6414`` ``6414``
Description Description
Port number to listen on during OAuth authorization. Port number to listen on during OAuth authorization.
Note
Note: All redirects will go to port ``6414``, regardless All redirects will go to port ``6414``, regardless
of the port specified here. You'll have to manually adjust the of the port specified here. You'll have to manually adjust the
port number in your browser's address bar when using a different port number in your browser's address bar when using a different
port than the default. port than the default.
@@ -4134,8 +4131,8 @@ Default
``false`` ``false``
Description Description
Extract additional metadata (``source``, ``uploader``) Extract additional metadata (``source``, ``uploader``)
Note
Note: This requires 1 additional HTTP request per post. This requires 1 additional HTTP request per post.
extractor.patreon.cursor extractor.patreon.cursor
@@ -4402,8 +4399,8 @@ Description
For works bookmarked by For works bookmarked by
`your own account <extractor.pixiv.refresh-token_>`__, `your own account <extractor.pixiv.refresh-token_>`__,
fetch bookmark tags as ``tags_bookmark`` metadata. fetch bookmark tags as ``tags_bookmark`` metadata.
Note
Note: This requires 1 additional API request per bookmarked post. This requires 1 additional API request per bookmarked post.
extractor.pixiv.captions extractor.pixiv.captions
@@ -4425,8 +4422,8 @@ Default
``false`` ``false``
Description Description
Fetch ``comments`` metadata. Fetch ``comments`` metadata.
Note
Note: This requires 1 or more additional API requests per post, This requires 1 or more additional API requests per post,
depending on the number of comments. depending on the number of comments.
@@ -4505,8 +4502,8 @@ Default
``false`` ``false``
Description Description
Fetch ``comments`` metadata. Fetch ``comments`` metadata.
Note
Note: This requires 1 or more additional API requests per novel, This requires 1 or more additional API requests per novel,
depending on the number of comments. depending on the number of comments.
@@ -4574,8 +4571,8 @@ Description
For novels bookmarked by For novels bookmarked by
`your own account <extractor.pixiv-novel.refresh-token_>`__, `your own account <extractor.pixiv-novel.refresh-token_>`__,
fetch bookmark tags as ``tags_bookmark`` metadata. fetch bookmark tags as ``tags_bookmark`` metadata.
Note
Note: This requires 1 additional API request per bookmarked post. This requires 1 additional API request per bookmarked post.
extractor.pixiv-novel.refresh-token extractor.pixiv-novel.refresh-token
@@ -4718,8 +4715,8 @@ Default
Description Description
Retrieve additional comments by resolving the ``more`` comment Retrieve additional comments by resolving the ``more`` comment
stubs in the base comment tree. stubs in the base comment tree.
Note
Note: This requires 1 additional API call for every 100 extra comments. This requires 1 additional API call for every 100 extra comments.
extractor.reddit.embeds extractor.reddit.embeds
@@ -4984,8 +4981,8 @@ Description
* Select `Network` -> `XHR` * Select `Network` -> `XHR`
* Open a gallery page * Open a gallery page
* Select the last `Network` entry and copy its ``crt`` value * Select the last `Network` entry and copy its ``crt`` value
Note
Note: You will also need your browser's You will also need your browser's
`user-agent <extractor.*.user-agent_>`__ `user-agent <extractor.*.user-agent_>`__
@@ -5733,8 +5730,8 @@ Description
as running ``gallery-dl https://twitter.com/i/web/status/<TweetID>`` as running ``gallery-dl https://twitter.com/i/web/status/<TweetID>``
with enabled `conversations <extractor.twitter.conversations_>`__ option with enabled `conversations <extractor.twitter.conversations_>`__ option
for each Tweet in said timeline. for each Tweet in said timeline.
Note
Note: This requires at least 1 additional API call per initial Tweet. This requires at least 1 additional API call per initial Tweet.
extractor.twitter.unavailable extractor.twitter.unavailable
@@ -5907,8 +5904,8 @@ Description
If this value is ``"self"``, only consider replies where If this value is ``"self"``, only consider replies where
reply and original Tweet are from the same user. reply and original Tweet are from the same user.
Note
Note: Twitter will automatically expand conversations if you Twitter will automatically expand conversations if you
use the ``/with_replies`` timeline while logged in. For example, use the ``/with_replies`` timeline while logged in. For example,
media from Tweets which the user replied to will also be downloaded. media from Tweets which the user replied to will also be downloaded.
@@ -6049,8 +6046,8 @@ Description
* ``"timeline"``: ``https://twitter.com/id:{rest_id}/timeline`` * ``"timeline"``: ``https://twitter.com/id:{rest_id}/timeline``
* ``"tweets"``: ``https://twitter.com/id:{rest_id}/tweets`` * ``"tweets"``: ``https://twitter.com/id:{rest_id}/tweets``
* ``"media"``: ``https://twitter.com/id:{rest_id}/media`` * ``"media"``: ``https://twitter.com/id:{rest_id}/media``
Note
Note: To allow gallery-dl to follow custom URL formats, set the blacklist__ To allow gallery-dl to follow custom URL formats, set the blacklist__
for ``twitter`` to a non-default value, e.g. an empty string ``""``. for ``twitter`` to a non-default value, e.g. an empty string ``""``.
.. __: `extractor.*.blacklist & .whitelist`_ .. __: `extractor.*.blacklist & .whitelist`_
@@ -6104,8 +6101,8 @@ Default
``false`` ``false``
Description Description
Automatically `like` posts after downloading their images. Automatically `like` posts after downloading their images.
Note
Note: Requires `login <extractor.*.username & .password_>`__ Requires `login <extractor.*.username & .password_>`__
or `cookies <extractor.*.cookies_>`__ or `cookies <extractor.*.cookies_>`__
@@ -6209,8 +6206,8 @@ Default
``false`` ``false``
Description Description
Extract additional metadata (tags, uploader) Extract additional metadata (tags, uploader)
Note
Note: This requires 1 additional HTTP request per post. This requires 1 additional HTTP request per post.
extractor.weasyl.api-key extractor.weasyl.api-key
@@ -6234,8 +6231,8 @@ Description
| Fetch extra submission metadata during gallery downloads. | Fetch extra submission metadata during gallery downloads.
| (``comments``, ``description``, ``favorites``, ``folder_name``, | (``comments``, ``description``, ``favorites``, ``folder_name``,
``tags``, ``views``) ``tags``, ``views``)
Note
Note: This requires 1 additional HTTP request per submission. This requires 1 additional HTTP request per submission.
extractor.webtoons.quality extractor.webtoons.quality
@@ -6487,8 +6484,8 @@ Default
Description Description
Route |ytdl's| output through gallery-dl's logging system. Route |ytdl's| output through gallery-dl's logging system.
Otherwise it will be written directly to stdout/stderr. Otherwise it will be written directly to stdout/stderr.
Note
Note: Set ``quiet`` and ``no_warnings`` in Set ``quiet`` and ``no_warnings`` in
`extractor.ytdl.raw-options`_ to ``true`` to suppress all output. `extractor.ytdl.raw-options`_ to ``true`` to suppress all output.
@@ -6553,8 +6550,8 @@ Default
``false`` ``false``
Description Description
Extract additional metadata (date, md5, tags, ...) Extract additional metadata (date, md5, tags, ...)
Note
Note: This requires 1-2 additional HTTP requests per post. This requires 1-2 additional HTTP requests per post.
extractor.zerochan.pagination extractor.zerochan.pagination
@@ -6592,8 +6589,8 @@ Description
Group ``tags`` by type and Group ``tags`` by type and
provide them as ``tags_<type>`` metadata fields, provide them as ``tags_<type>`` metadata fields,
for example ``tags_artist`` or ``tags_character``. for example ``tags_artist`` or ``tags_character``.
Note
Note: This requires 1 additional HTTP request per post. This requires 1 additional HTTP request per post.
extractor.[booru].notes extractor.[booru].notes
@@ -6604,8 +6601,8 @@ Default
``false`` ``false``
Description Description
Extract overlay notes (position and text). Extract overlay notes (position and text).
Note
Note: This requires 1 additional HTTP request per post. This requires 1 additional HTTP request per post.
extractor.[booru].url extractor.[booru].url
@@ -6890,8 +6887,8 @@ Default
Description Description
Number of seconds to sleep when receiving a `429 Too Many Requests` Number of seconds to sleep when receiving a `429 Too Many Requests`
response before `retrying <downloader.*.retries_>`__ the request. response before `retrying <downloader.*.retries_>`__ the request.
Note
Note: Requires Requires
`retry-codes <downloader.http.retry-codes_>`__ `retry-codes <downloader.http.retry-codes_>`__
to include ``429``. to include ``429``.
@@ -6996,8 +6993,8 @@ Default
Description Description
Route |ytdl's| output through gallery-dl's logging system. Route |ytdl's| output through gallery-dl's logging system.
Otherwise it will be written directly to stdout/stderr. Otherwise it will be written directly to stdout/stderr.
Note
Note: Set ``quiet`` and ``no_warnings`` in Set ``quiet`` and ``no_warnings`` in
`downloader.ytdl.raw-options`_ to ``true`` to suppress all output. `downloader.ytdl.raw-options`_ to ``true`` to suppress all output.
@@ -7038,8 +7035,8 @@ Description
* ``"default"``: use |ytdl's| default, currently * ``"default"``: use |ytdl's| default, currently
``"%(title)s [%(id)s].%(ext)s"`` for yt-dlp_ / ``"%(title)s [%(id)s].%(ext)s"`` for yt-dlp_ /
``"%(title)s-%(id)s.%(ext)s"`` for youtube-dl_ ``"%(title)s-%(id)s.%(ext)s"`` for youtube-dl_
Note
Note: An output template other than ``null`` might An output template other than ``null`` might
cause unexpected results in combination with certain options cause unexpected results in combination with certain options
(e.g. ``"skip": "enumerate"``) (e.g. ``"skip": "enumerate"``)
@@ -7159,8 +7156,8 @@ Description
When this option is specified as a simple ``string``, When this option is specified as a simple ``string``,
it is interpreted as ``{"encoding": "<string-value>", "errors": "replace"}`` it is interpreted as ``{"encoding": "<string-value>", "errors": "replace"}``
Note
Note: ``errors`` always defaults to ``"replace"`` ``errors`` always defaults to ``"replace"``
output.shorten output.shorten
@@ -7714,8 +7711,8 @@ Example
Description Description
Custom format string to build filename extensions for metadata Custom format string to build filename extensions for metadata
files with, which will replace the original filename extensions. files with, which will replace the original filename extensions.
Note
Note: `metadata.extension`_ is ignored if this option is set. When this option is set, `metadata.extension`_ is ignored.
metadata.metadata-path metadata.metadata-path
@@ -7782,8 +7779,8 @@ Example
``["id", "width", "height", "description"]`` ``["id", "width", "height", "description"]``
Description Description
Include only the given top-level keys when writing JSON data. Include only the given top-level keys when writing JSON data.
Note
Note: Missing or undefined fields will be silently ignored. Missing or undefined fields will be silently ignored.
metadata.exclude metadata.exclude
@@ -7794,8 +7791,8 @@ Example
``["blocked", "watching", "status"]`` ``["blocked", "watching", "status"]``
Description Description
Exclude all given keys from written JSON data. Exclude all given keys from written JSON data.
Note
Note: Cannot be used with `metadata.include`_. Cannot be used with `metadata.include`_.
metadata.fields metadata.fields
@@ -7834,8 +7831,8 @@ Example
* ``["tags:", "", "{tags:J\n}"]`` * ``["tags:", "", "{tags:J\n}"]``
Description Description
Custom format string to build the content of metadata files with. Custom format string to build the content of metadata files with.
Note
Note: Only applies for ``"mode": "custom"``. Only applies to ``"mode": "custom"``.
metadata.ascii metadata.ascii
@@ -7848,8 +7845,8 @@ Description
Escape all non-ASCII characters. Escape all non-ASCII characters.
See the ``ensure_ascii`` argument of |json.dump()|_ for further details. See the ``ensure_ascii`` argument of |json.dump()|_ for further details.
Note
Note: Only applies for ``"mode": "json"`` and ``"jsonl"``. Only applies to ``"mode": "json"`` and ``"jsonl"``.
metadata.indent metadata.indent
@@ -7863,8 +7860,8 @@ Description
Indentation level of JSON output. Indentation level of JSON output.
See the ``indent`` argument of |json.dump()|_ for further details. See the ``indent`` argument of |json.dump()|_ for further details.
Note
Note: Only applies for ``"mode": "json"``. Only applies to ``"mode": "json"``.
metadata.separators metadata.separators
@@ -7878,8 +7875,8 @@ Description
to separate JSON keys and values with. to separate JSON keys and values with.
See the ``separators`` argument of |json.dump()|_ for further details. See the ``separators`` argument of |json.dump()|_ for further details.
Note
Note: Only applies for ``"mode": "json"`` and ``"jsonl"``. Only applies to ``"mode": "json"`` and ``"jsonl"``.
metadata.sort metadata.sort
@@ -7892,8 +7889,8 @@ Description
Sort output by `key`. Sort output by `key`.
See the ``sort_keys`` argument of |json.dump()|_ for further details. See the ``sort_keys`` argument of |json.dump()|_ for further details.
Note
Note: Only applies for ``"mode": "json"`` and ``"jsonl"``. Only applies to ``"mode": "json"`` and ``"jsonl"``.
metadata.open metadata.open
@@ -8007,8 +8004,8 @@ Description
This value must be either a UNIX timestamp or a This value must be either a UNIX timestamp or a
|datetime|_ object. |datetime|_ object.
Note
Note: This option gets ignored if `mtime.value`_ is set. This option is ignored if `mtime.value`_ is set.
mtime.value mtime.value
@@ -8069,9 +8066,8 @@ Description
`Python expression <https://docs.python.org/3/glossary.html#term-expression>`__ `Python expression <https://docs.python.org/3/glossary.html#term-expression>`__
to to
`evaluate <https://docs.python.org/3/library/functions.html#eval>`__. `evaluate <https://docs.python.org/3/library/functions.html#eval>`__.
Note
Note: Only used with Only used with `"mode": "eval" <python.mode_>`__
`"mode": "eval" <python.mode_>`__
python.function python.function
@@ -8350,8 +8346,8 @@ Example
``["info.json"]`` ``["info.json"]``
Description Description
List of extra files to be added to a ZIP archive. List of extra files to be added to a ZIP archive.
Note
Note: Relative paths are relative to the current Relative paths are relative to the current
`download directory <extractor.*.directory_>`__. `download directory <extractor.*.directory_>`__.
@@ -8415,8 +8411,8 @@ Description
gets `imported <https://docs.python.org/3/reference/import.html>`__ gets `imported <https://docs.python.org/3/reference/import.html>`__
and searched for potential extractors, and searched for potential extractors,
i.e. classes with a ``pattern`` attribute. i.e. classes with a ``pattern`` attribute.
Note
Note: ``null`` references internal extractors defined in ``null`` references internal extractors defined in
`extractor/__init__.py <https://github.com/mikf/gallery-dl/blob/master/gallery_dl/extractor/__init__.py#L12>`__ `extractor/__init__.py <https://github.com/mikf/gallery-dl/blob/master/gallery_dl/extractor/__init__.py#L12>`__
or by `extractor.modules`_. or by `extractor.modules`_.
@@ -8883,7 +8879,7 @@ Description
Simple `tilde expansion <https://docs.python.org/3/library/os.path.html#os.path.expanduser>`__ Simple `tilde expansion <https://docs.python.org/3/library/os.path.html#os.path.expanduser>`__
and `environment variable expansion <https://docs.python.org/3/library/os.path.html#os.path.expandvars>`__ and `environment variable expansion <https://docs.python.org/3/library/os.path.html#os.path.expandvars>`__
is supported. is supported.
Note: Note
In Windows environments, In Windows environments,
both backslashes ``\`` as well as forward slashes ``/`` both backslashes ``\`` as well as forward slashes ``/``
can be used as path separators. can be used as path separators.
@@ -8959,8 +8955,8 @@ Description
* encoding * encoding
* File encoding * File encoding
* Default: ``"utf-8"`` * Default: ``"utf-8"``
Note
Note: path, mode, and encoding are only applied when configuring path, mode, and encoding are only applied when configuring
logging output to a file. logging output to a file.