danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs updated

Browse source
This commit is contained in:
Jesse Bannon 2022-08-28 00:16:15 -07:00
parent 7f8fc5903b
commit 23d0f082c2
2 changed files with 47 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

80
src/ytdl_sub/plugins/nfo_tags.py
View file

@ -61,45 +61,14 @@ class SharedNfoTagsOptions(
@property
def nfo_root(self) -> StringFormatterValidator:
"""
The root tag of the NFO's XML. In the usage above, it would look like
.. code-block:: xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<episodedetails>
</episodedetails>
OVERRIDE DOC IN CHILD CLASSES
"""
return self._nfo_root
@property
def tags(self) -> TSharedNfoTagsValidator:
"""
Tags within the nfo_root tag. In the usage above, it would look like
.. code-block:: xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<episodedetails>
<title>Awesome Youtube Video</title>
<season>2022</season>
<episode>502</episode>
</episodedetails>
Also supports xml attributes:
.. code-block:: yaml
tags:
season:
attributes:
name: "Best Year"
tag: "{upload_year}"
Which translates to
.. code-block:: xml
<season name="Best Year">2022</season>
OVERRIDE DOC IN CHILD CLASSES
"""
return self._tags
@ -214,6 +183,51 @@ class NfoTagsOptions(
_dict_formatter_validator = DictFormatterValidator
_tags_validator = NfoTagsValidator
@property
def nfo_root(self) -> StringFormatterValidator:
"""
The root tag of the NFO's XML. In the usage above, it would look like
.. code-block:: xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<episodedetails>
</episodedetails>
"""
return self._nfo_root
@property
def tags(self) -> NfoTagsValidator:
"""
Tags within the nfo_root tag. In the usage above, it would look like
.. code-block:: xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<episodedetails>
<title>Awesome Youtube Video</title>
<season>2022</season>
<episode>502</episode>
</episodedetails>
Also supports xml attributes:
.. code-block:: yaml
tags:
season:
attributes:
name: "Best Year"
tag: "{upload_year}"
Which translates to
.. code-block:: xml
<season name="Best Year">2022</season>
"""
return self._tags
class NfoTagsPlugin(
SharedNfoTagsPlugin[StringFormatterValidator, DictFormatterValidator, NfoTagsValidator]

16
src/ytdl_sub/plugins/output_directory_nfo_tags.py
View file

@ -37,13 +37,6 @@ class OutputDirectoryNfoTagsOptions(
_dict_formatter_validator = OverridesDictFormatterValidator
_tags_validator = NfoOverrideTagsValidator
@property
def nfo_name(self) -> OverridesStringFormatterValidator:
"""
The NFO file name.
"""
return self._nfo_name
@property
def nfo_root(self) -> OverridesStringFormatterValidator:
"""
@ -89,15 +82,6 @@ class OutputDirectoryNfoTagsOptions(
"""
return self._tags
@property
def kodi_safe(self) -> Optional[bool]:
"""
Optional. Kodi does not support > 3-byte unicode characters, which include emojis and some
foreign language characters. Setting this to True will replace those characters with '□'.
Defaults to False.
"""
return self._kodi_safe
class OutputDirectoryNfoTagsPlugin(
SharedNfoTagsPlugin[