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

undo changes to variable_definitions

Browse source
This commit is contained in:
Qualis Svagtlys 2023-12-20 14:31:20 -06:00
parent 5773a73183
commit ed0a69561e
1 changed files with 330 additions and 81 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

285
src/ytdl_sub/entries/script/variable_definitions.py
View file

@ -146,6 +146,9 @@ class VariableDefinitions:
@property @property
def webpage_url(self) -> MetadataVariable: def webpage_url(self) -> MetadataVariable:
""" """
Returns
-------
str
The url to the webpage. The url to the webpage.
""" """
return MetadataVariable(metadata_key="webpage_url", variable_name="webpage_url") return MetadataVariable(metadata_key="webpage_url", variable_name="webpage_url")
@ -153,6 +156,9 @@ class VariableDefinitions:
@property @property
def info_json_ext(self) -> Variable: def info_json_ext(self) -> Variable:
""" """
Returns
-------
str
The "info.json" extension The "info.json" extension
""" """
return Variable("info_json_ext") return Variable("info_json_ext")
@ -160,6 +166,9 @@ class VariableDefinitions:
@property @property
def description(self) -> MetadataVariable: def description(self) -> MetadataVariable:
""" """
Returns
-------
str
The description if it exists. Otherwise, returns an emtpy string. The description if it exists. Otherwise, returns an emtpy string.
""" """
return MetadataVariable(variable_name="description", metadata_key="description") return MetadataVariable(variable_name="description", metadata_key="description")
@ -167,6 +176,9 @@ class VariableDefinitions:
@property @property
def uploader_id(self) -> MetadataVariable: def uploader_id(self) -> MetadataVariable:
""" """
Returns
-------
str
The uploader id if it exists, otherwise return the unique ID. The uploader id if it exists, otherwise return the unique ID.
""" """
return MetadataVariable(variable_name="uploader_id", metadata_key="uploader_id") return MetadataVariable(variable_name="uploader_id", metadata_key="uploader_id")
@ -174,6 +186,9 @@ class VariableDefinitions:
@property @property
def uploader(self) -> MetadataVariable: def uploader(self) -> MetadataVariable:
""" """
Returns
-------
str
The uploader if it exists, otherwise return the uploader ID. The uploader if it exists, otherwise return the uploader ID.
""" """
return MetadataVariable(variable_name="uploader", metadata_key="uploader") return MetadataVariable(variable_name="uploader", metadata_key="uploader")
@ -181,6 +196,9 @@ class VariableDefinitions:
@property @property
def uploader_url(self) -> MetadataVariable: def uploader_url(self) -> MetadataVariable:
""" """
Returns
-------
str
The uploader url if it exists, otherwise returns the webpage_url. The uploader url if it exists, otherwise returns the webpage_url.
""" """
return MetadataVariable("uploader_url", metadata_key="uploader_url") return MetadataVariable("uploader_url", metadata_key="uploader_url")
@ -188,13 +206,20 @@ class VariableDefinitions:
@property @property
def source_title(self) -> MetadataVariable: def source_title(self) -> MetadataVariable:
""" """
Name of the source (i.e. channel with multiple playlists) if it exists, otherwise returns its playlist_title. Returns
-------
str
Name of the source (i.e. channel with multiple playlists) if it exists, otherwise
returns its playlist_title.
""" """
return MetadataVariable("source_title", metadata_key=self.title.metadata_key) return MetadataVariable("source_title", metadata_key=self.title.metadata_key)
@property @property
def source_uid(self) -> MetadataVariable: def source_uid(self) -> MetadataVariable:
""" """
Returns
-------
str
The source unique id if it exists, otherwise returns the playlist unique ID. The source unique id if it exists, otherwise returns the playlist unique ID.
""" """
return MetadataVariable("source_uid", metadata_key=self.uid.metadata_key) return MetadataVariable("source_uid", metadata_key=self.uid.metadata_key)
@ -202,15 +227,22 @@ class VariableDefinitions:
@property @property
def source_index(self) -> MetadataVariable: def source_index(self) -> MetadataVariable:
""" """
Returns
-------
int
Source index if it exists, otherwise returns ``1``. Source index if it exists, otherwise returns ``1``.
It is recommended to not use this unless you know the source will never add new content (it is easy for this value to change). It is recommended to not use this unless you know the source will never add new content
(it is easy for this value to change).
""" """
return MetadataVariable("source_index", metadata_key=self.playlist_index.metadata_key) return MetadataVariable("source_index", metadata_key=self.playlist_index.metadata_key)
@property @property
def source_index_padded(self) -> Variable: def source_index_padded(self) -> Variable:
""" """
Returns
-------
int
The source index, padded. The source index, padded.
""" """
return Variable("source_index_padded") return Variable("source_index_padded")
@ -218,6 +250,9 @@ class VariableDefinitions:
@property @property
def source_count(self) -> MetadataVariable: def source_count(self) -> MetadataVariable:
""" """
Returns
-------
int
The source count if it exists, otherwise returns the playlist count. The source count if it exists, otherwise returns the playlist count.
""" """
return MetadataVariable("source_count", metadata_key=self.playlist_count.metadata_key) return MetadataVariable("source_count", metadata_key=self.playlist_count.metadata_key)
@ -225,6 +260,9 @@ class VariableDefinitions:
@property @property
def source_webpage_url(self) -> MetadataVariable: def source_webpage_url(self) -> MetadataVariable:
""" """
Returns
-------
str
The source webpage url if it exists, otherwise returns the playlist webpage url. The source webpage url if it exists, otherwise returns the playlist webpage url.
""" """
return MetadataVariable("source_webpage_url", metadata_key=self.webpage_url.metadata_key) return MetadataVariable("source_webpage_url", metadata_key=self.webpage_url.metadata_key)
@ -232,6 +270,9 @@ class VariableDefinitions:
@property @property
def source_description(self) -> MetadataVariable: def source_description(self) -> MetadataVariable:
""" """
Returns
-------
str
The source description if it exists, otherwise returns the playlist description. The source description if it exists, otherwise returns the playlist description.
""" """
return MetadataVariable("source_description", metadata_key=self.description.metadata_key) return MetadataVariable("source_description", metadata_key=self.description.metadata_key)
@ -239,6 +280,9 @@ class VariableDefinitions:
@property @property
def playlist_uid(self) -> MetadataVariable: def playlist_uid(self) -> MetadataVariable:
""" """
Returns
-------
str
The playlist unique ID if it exists, otherwise return the entry unique ID. The playlist unique ID if it exists, otherwise return the entry unique ID.
""" """
return MetadataVariable(variable_name="playlist_uid", metadata_key="playlist_id") return MetadataVariable(variable_name="playlist_uid", metadata_key="playlist_id")
@ -246,6 +290,9 @@ class VariableDefinitions:
@property @property
def playlist_title(self) -> MetadataVariable: def playlist_title(self) -> MetadataVariable:
""" """
Returns
-------
str
Name of its parent playlist/channel if it exists, otherwise returns its title. Name of its parent playlist/channel if it exists, otherwise returns its title.
""" """
return MetadataVariable(variable_name="playlist_title", metadata_key="playlist_title") return MetadataVariable(variable_name="playlist_title", metadata_key="playlist_title")
@ -253,15 +300,22 @@ class VariableDefinitions:
@property @property
def playlist_index(self) -> MetadataVariable: def playlist_index(self) -> MetadataVariable:
""" """
Returns
-------
int
Playlist index if it exists, otherwise returns ``1``. Playlist index if it exists, otherwise returns ``1``.
Note that for channels/playlists, any change (i.e. adding or removing a video) will make this value change. Use with caution. Note that for channels/playlists, any change (i.e. adding or removing a video) will make
this value change. Use with caution.
""" """
return MetadataVariable(metadata_key="playlist_index", variable_name="playlist_index") return MetadataVariable(metadata_key="playlist_index", variable_name="playlist_index")
@property @property
def playlist_index_reversed(self) -> Variable: def playlist_index_reversed(self) -> Variable:
""" """
Returns
-------
int
Playlist index reversed via ``playlist_count - playlist_index + 1`` Playlist index reversed via ``playlist_count - playlist_index + 1``
""" """
return Variable("playlist_index_reversed") return Variable("playlist_index_reversed")
@ -269,6 +323,9 @@ class VariableDefinitions:
@property @property
def playlist_index_padded(self) -> Variable: def playlist_index_padded(self) -> Variable:
""" """
Returns
-------
str
playlist_index padded two digits playlist_index padded two digits
""" """
return Variable("playlist_index_padded") return Variable("playlist_index_padded")
@ -276,6 +333,9 @@ class VariableDefinitions:
@property @property
def playlist_index_reversed_padded(self) -> Variable: def playlist_index_reversed_padded(self) -> Variable:
""" """
Returns
-------
str
playlist_index_reversed padded two digits playlist_index_reversed padded two digits
""" """
return Variable("playlist_index_reversed_padded") return Variable("playlist_index_reversed_padded")
@ -283,6 +343,9 @@ class VariableDefinitions:
@property @property
def playlist_index_padded6(self) -> Variable: def playlist_index_padded6(self) -> Variable:
""" """
Returns
-------
str
playlist_index padded six digits. playlist_index padded six digits.
""" """
return Variable("playlist_index_padded6") return Variable("playlist_index_padded6")
@ -290,6 +353,9 @@ class VariableDefinitions:
@property @property
def playlist_index_reversed_padded6(self) -> Variable: def playlist_index_reversed_padded6(self) -> Variable:
""" """
Returns
-------
str
playlist_index_reversed padded six digits. playlist_index_reversed padded six digits.
""" """
return Variable("playlist_index_reversed_padded6") return Variable("playlist_index_reversed_padded6")
@ -297,15 +363,22 @@ class VariableDefinitions:
@property @property
def playlist_count(self) -> MetadataVariable: def playlist_count(self) -> MetadataVariable:
""" """
Returns
-------
int
Playlist count if it exists, otherwise returns ``1``. Playlist count if it exists, otherwise returns ``1``.
Note that for channels/playlists, any change (i.e. adding or removing a video) will make this value change. Use with caution. Note that for channels/playlists, any change (i.e. adding or removing a video) will make
this value change. Use with caution.
""" """
return MetadataVariable(variable_name="playlist_count", metadata_key="playlist_count") return MetadataVariable(variable_name="playlist_count", metadata_key="playlist_count")
@property @property
def playlist_description(self) -> MetadataVariable: def playlist_description(self) -> MetadataVariable:
""" """
Returns
-------
str
The playlist description if it exists, otherwise returns the entry's description. The playlist description if it exists, otherwise returns the entry's description.
""" """
return MetadataVariable( return MetadataVariable(
@ -315,6 +388,9 @@ class VariableDefinitions:
@property @property
def playlist_webpage_url(self) -> MetadataVariable: def playlist_webpage_url(self) -> MetadataVariable:
""" """
Returns
-------
str
The playlist webpage url if it exists. Otherwise, returns the entry webpage url. The playlist webpage url if it exists. Otherwise, returns the entry webpage url.
""" """
return MetadataVariable( return MetadataVariable(
@ -324,14 +400,21 @@ class VariableDefinitions:
@property @property
def playlist_max_upload_date(self) -> Variable: def playlist_max_upload_date(self) -> Variable:
""" """
Max upload_date for all entries in this entry's playlist if it exists, otherwise returns ``upload_date`` Returns
-------
Max upload_date for all entries in this entry's playlist if it exists, otherwise returns
``upload_date``
""" """
return Variable("playlist_max_upload_date") return Variable("playlist_max_upload_date")
@property @property
def playlist_max_upload_year(self) -> Variable: def playlist_max_upload_year(self) -> Variable:
""" """
Max upload_year for all entries in this entry's playlist if it exists, otherwise returns ``upload_year`` Returns
-------
int
Max upload_year for all entries in this entry's playlist if it exists, otherwise returns
``upload_year``
""" """
# override in EntryParent # override in EntryParent
return Variable("playlist_max_upload_year") return Variable("playlist_max_upload_year")
@ -339,13 +422,20 @@ class VariableDefinitions:
@property @property
def playlist_max_upload_year_truncated(self) -> Variable: def playlist_max_upload_year_truncated(self) -> Variable:
""" """
The max playlist truncated upload year for all entries in this entry's playlist if it exists, otherwise returns ``upload_year_truncated``. Returns
-------
int
The max playlist truncated upload year for all entries in this entry's playlist if it
exists, otherwise returns ``upload_year_truncated``.
""" """
return Variable("playlist_max_upload_year_truncated") return Variable("playlist_max_upload_year_truncated")
@property @property
def playlist_uploader_id(self) -> MetadataVariable: def playlist_uploader_id(self) -> MetadataVariable:
""" """
Returns
-------
str
The playlist uploader id if it exists, otherwise returns the entry uploader ID. The playlist uploader id if it exists, otherwise returns the entry uploader ID.
""" """
return MetadataVariable("playlist_uploader_id", metadata_key="playlist_uploader_id") return MetadataVariable("playlist_uploader_id", metadata_key="playlist_uploader_id")
@ -353,6 +443,9 @@ class VariableDefinitions:
@property @property
def playlist_uploader(self) -> MetadataVariable: def playlist_uploader(self) -> MetadataVariable:
""" """
Returns
-------
str
The playlist uploader if it exists, otherwise return the entry uploader. The playlist uploader if it exists, otherwise return the entry uploader.
""" """
return MetadataVariable("playlist_uploader", metadata_key=self.uploader.metadata_key) return MetadataVariable("playlist_uploader", metadata_key=self.uploader.metadata_key)
@ -360,6 +453,9 @@ class VariableDefinitions:
@property @property
def playlist_uploader_url(self) -> MetadataVariable: def playlist_uploader_url(self) -> MetadataVariable:
""" """
Returns
-------
str
The playlist uploader url if it exists, otherwise returns the playlist webpage_url. The playlist uploader url if it exists, otherwise returns the playlist webpage_url.
""" """
return MetadataVariable( return MetadataVariable(
@ -369,6 +465,9 @@ class VariableDefinitions:
@property @property
def source_uploader_id(self) -> MetadataVariable: def source_uploader_id(self) -> MetadataVariable:
""" """
Returns
-------
str
The source uploader id if it exists, otherwise returns the playlist_uploader_id The source uploader id if it exists, otherwise returns the playlist_uploader_id
""" """
return MetadataVariable("source_uploader_id", metadata_key=self.uploader_id.metadata_key) return MetadataVariable("source_uploader_id", metadata_key=self.uploader_id.metadata_key)
@ -376,6 +475,9 @@ class VariableDefinitions:
@property @property
def source_uploader(self) -> MetadataVariable: def source_uploader(self) -> MetadataVariable:
""" """
Returns
-------
str
The source uploader if it exists, otherwise return the playlist_uploader The source uploader if it exists, otherwise return the playlist_uploader
""" """
return MetadataVariable("source_uploader", metadata_key=self.uploader.metadata_key) return MetadataVariable("source_uploader", metadata_key=self.uploader.metadata_key)
@ -383,6 +485,9 @@ class VariableDefinitions:
@property @property
def source_uploader_url(self) -> MetadataVariable: def source_uploader_url(self) -> MetadataVariable:
""" """
Returns
-------
str
The source uploader url if it exists, otherwise returns the source webpage_url. The source uploader url if it exists, otherwise returns the source webpage_url.
""" """
return MetadataVariable("source_uploader_url", metadata_key=self.uploader_url.metadata_key) return MetadataVariable("source_uploader_url", metadata_key=self.uploader_url.metadata_key)
@ -390,6 +495,9 @@ class VariableDefinitions:
@property @property
def creator(self) -> MetadataVariable: def creator(self) -> MetadataVariable:
""" """
Returns
-------
str
The creator name if it exists, otherwise returns the channel. The creator name if it exists, otherwise returns the channel.
""" """
return MetadataVariable(variable_name="creator", metadata_key="creator") return MetadataVariable(variable_name="creator", metadata_key="creator")
@ -397,6 +505,9 @@ class VariableDefinitions:
@property @property
def channel(self) -> MetadataVariable: def channel(self) -> MetadataVariable:
""" """
Returns
-------
str
The channel name if it exists, otherwise returns the uploader. The channel name if it exists, otherwise returns the uploader.
""" """
return MetadataVariable(variable_name="channel", metadata_key="channel") return MetadataVariable(variable_name="channel", metadata_key="channel")
@ -404,6 +515,9 @@ class VariableDefinitions:
@property @property
def channel_id(self) -> MetadataVariable: def channel_id(self) -> MetadataVariable:
""" """
Returns
-------
str
The channel id if it exists, otherwise returns the entry uploader ID. The channel id if it exists, otherwise returns the entry uploader ID.
""" """
return MetadataVariable(variable_name="channel_id", metadata_key="channel_id") return MetadataVariable(variable_name="channel_id", metadata_key="channel_id")
@ -411,6 +525,9 @@ class VariableDefinitions:
@property @property
def ext(self) -> MetadataVariable: def ext(self) -> MetadataVariable:
""" """
Returns
-------
str
The downloaded entry's file extension The downloaded entry's file extension
""" """
return MetadataVariable(variable_name="ext", metadata_key="ext") return MetadataVariable(variable_name="ext", metadata_key="ext")
@ -418,7 +535,11 @@ class VariableDefinitions:
@property @property
def thumbnail_ext(self) -> Variable: def thumbnail_ext(self) -> Variable:
""" """
The download entry's thumbnail extension. Will always return 'jpg'. Until there is a need to support other image types, we always convert to jpg. Returns
-------
str
The download entry's thumbnail extension. Will always return 'jpg'. Until there is a
need to support other image types, we always convert to jpg.
""" """
return Variable("thumbnail_ext") return Variable("thumbnail_ext")
@ -460,13 +581,20 @@ class VariableDefinitions:
@property @property
def download_index(self) -> Variable: def download_index(self) -> Variable:
""" """
The i'th entry downloaded. NOTE that this is fetched dynamically from the download archive. Returns
-------
int
The i'th entry downloaded. NOTE that this is fetched dynamically from the download
archive.
""" """
return Variable(variable_name="download_index") return Variable(variable_name="download_index")
@property @property
def download_index_padded6(self) -> Variable: def download_index_padded6(self) -> Variable:
""" """
Returns
-------
str
The download_index padded six digits The download_index padded six digits
""" """
return Variable("download_index_padded6") return Variable("download_index_padded6")
@ -474,6 +602,9 @@ class VariableDefinitions:
@property @property
def upload_date_index(self) -> Variable: def upload_date_index(self) -> Variable:
""" """
Returns
-------
int
The i'th entry downloaded with this upload date. The i'th entry downloaded with this upload date.
""" """
return Variable(variable_name="upload_date_index") return Variable(variable_name="upload_date_index")
@ -481,6 +612,9 @@ class VariableDefinitions:
@property @property
def upload_date_index_padded(self) -> Variable: def upload_date_index_padded(self) -> Variable:
""" """
Returns
-------
int
The upload_date_index padded two digits The upload_date_index padded two digits
""" """
return Variable("upload_date_index_padded") return Variable("upload_date_index_padded")
@ -488,6 +622,9 @@ class VariableDefinitions:
@property @property
def upload_date_index_reversed(self) -> Variable: def upload_date_index_reversed(self) -> Variable:
""" """
Returns
-------
int
100 - upload_date_index 100 - upload_date_index
""" """
return Variable("upload_date_index_reversed") return Variable("upload_date_index_reversed")
@ -495,6 +632,9 @@ class VariableDefinitions:
@property @property
def upload_date_index_reversed_padded(self) -> Variable: def upload_date_index_reversed_padded(self) -> Variable:
""" """
Returns
-------
int
The upload_date_index padded two digits The upload_date_index padded two digits
""" """
return Variable("upload_date_index_reversed_padded") return Variable("upload_date_index_reversed_padded")
@ -502,13 +642,19 @@ class VariableDefinitions:
@property @property
def upload_date(self) -> MetadataVariable: def upload_date(self) -> MetadataVariable:
""" """
The entry's uploaded date, in YYYYMMDD format. If not present, return today's date. Returns
-------
str
The entry’s uploaded date, in YYYYMMDD format. If not present, return today’s date.
""" """
return MetadataVariable(variable_name="upload_date", metadata_key="upload_date") return MetadataVariable(variable_name="upload_date", metadata_key="upload_date")
@property @property
def upload_year(self) -> Variable: def upload_year(self) -> Variable:
""" """
Returns
-------
int
The entry's upload year The entry's upload year
""" """
return Variable("upload_year") return Variable("upload_year")
@ -516,6 +662,9 @@ class VariableDefinitions:
@property @property
def upload_year_truncated(self) -> Variable: def upload_year_truncated(self) -> Variable:
""" """
Returns
-------
int
The last two digits of the upload year, i.e. 22 in 2022 The last two digits of the upload year, i.e. 22 in 2022
""" """
return Variable("upload_year_truncated") return Variable("upload_year_truncated")
@ -523,13 +672,20 @@ class VariableDefinitions:
@property @property
def upload_year_truncated_reversed(self) -> Variable: def upload_year_truncated_reversed(self) -> Variable:
""" """
The upload year truncated, but reversed using ``100 - {upload_year_truncated}``, i.e. 2022 returns ``100 - 22`` = ``78`` Returns
-------
int
The upload year truncated, but reversed using ``100 - {upload_year_truncated}``, i.e.
2022 returns ``100 - 22`` = ``78``
""" """
return Variable("upload_year_truncated_reversed") return Variable("upload_year_truncated_reversed")
@property @property
def upload_month_reversed(self) -> Variable: def upload_month_reversed(self) -> Variable:
""" """
Returns
-------
int
The upload month, but reversed using ``13 - {upload_month}``, i.e. March returns ``10`` The upload month, but reversed using ``13 - {upload_month}``, i.e. March returns ``10``
""" """
return Variable("upload_month_reversed") return Variable("upload_month_reversed")
@ -537,6 +693,9 @@ class VariableDefinitions:
@property @property
def upload_month_reversed_padded(self) -> Variable: def upload_month_reversed_padded(self) -> Variable:
""" """
Returns
-------
str
The reversed upload month, but padded. i.e. November returns "02" The reversed upload month, but padded. i.e. November returns "02"
""" """
return Variable("upload_month_reversed_padded") return Variable("upload_month_reversed_padded")
@ -544,6 +703,9 @@ class VariableDefinitions:
@property @property
def upload_month_padded(self) -> Variable: def upload_month_padded(self) -> Variable:
""" """
Returns
-------
str
The entry's upload month padded to two digits, i.e. March returns "03" The entry's upload month padded to two digits, i.e. March returns "03"
""" """
return Variable("upload_month_padded") return Variable("upload_month_padded")
@ -551,6 +713,9 @@ class VariableDefinitions:
@property @property
def upload_day_padded(self) -> Variable: def upload_day_padded(self) -> Variable:
""" """
Returns
-------
str
The entry's upload day padded to two digits, i.e. the fifth returns "05" The entry's upload day padded to two digits, i.e. the fifth returns "05"
""" """
return Variable("upload_day_padded") return Variable("upload_day_padded")
@ -558,6 +723,9 @@ class VariableDefinitions:
@property @property
def upload_month(self) -> Variable: def upload_month(self) -> Variable:
""" """
Returns
-------
int
The upload month as an integer (no padding). The upload month as an integer (no padding).
""" """
return Variable("upload_month") return Variable("upload_month")
@ -565,6 +733,9 @@ class VariableDefinitions:
@property @property
def upload_day(self) -> Variable: def upload_day(self) -> Variable:
""" """
Returns
-------
int
The upload day as an integer (no padding). The upload day as an integer (no padding).
""" """
return Variable("upload_day") return Variable("upload_day")
@ -572,13 +743,20 @@ class VariableDefinitions:
@property @property
def upload_day_reversed(self) -> Variable: def upload_day_reversed(self) -> Variable:
""" """
The upload day, but reversed using ``{total_days_in_month} + 1 - {upload_day}``, i.e. August 8th would have upload_day_reversed of ``31 + 1 - 8`` = ``24`` Returns
-------
int
The upload day, but reversed using ``{total_days_in_month} + 1 - {upload_day}``,
i.e. August 8th would have upload_day_reversed of ``31 + 1 - 8`` = ``24``
""" """
return Variable("upload_day_reversed") return Variable("upload_day_reversed")
@property @property
def upload_day_reversed_padded(self) -> Variable: def upload_day_reversed_padded(self) -> Variable:
""" """
Returns
-------
str
The reversed upload day, but padded. i.e. August 30th returns "02". The reversed upload day, but padded. i.e. August 30th returns "02".
""" """
return Variable("upload_day_reversed_padded") return Variable("upload_day_reversed_padded")
@ -586,6 +764,9 @@ class VariableDefinitions:
@property @property
def upload_day_of_year(self) -> Variable: def upload_day_of_year(self) -> Variable:
""" """
Returns
-------
int
The day of the year, i.e. February 1st returns ``32`` The day of the year, i.e. February 1st returns ``32``
""" """
return Variable("upload_day_of_year") return Variable("upload_day_of_year")
@ -593,6 +774,9 @@ class VariableDefinitions:
@property @property
def upload_day_of_year_padded(self) -> Variable: def upload_day_of_year_padded(self) -> Variable:
""" """
Returns
-------
str
The upload day of year, but padded i.e. February 1st returns "032" The upload day of year, but padded i.e. February 1st returns "032"
""" """
return Variable("upload_day_of_year_padded") return Variable("upload_day_of_year_padded")
@ -600,13 +784,20 @@ class VariableDefinitions:
@property @property
def upload_day_of_year_reversed(self) -> Variable: def upload_day_of_year_reversed(self) -> Variable:
""" """
The upload day, but reversed using ``{total_days_in_year} + 1 - {upload_day}``, i.e. February 2nd would have upload_day_of_year_reversed of ``365 + 1 - 32`` = ``334`` Returns
-------
int
The upload day, but reversed using ``{total_days_in_year} + 1 - {upload_day}``,
i.e. February 2nd would have upload_day_of_year_reversed of ``365 + 1 - 32`` = ``334``
""" """
return Variable("upload_day_of_year_reversed") return Variable("upload_day_of_year_reversed")
@property @property
def upload_day_of_year_reversed_padded(self) -> Variable: def upload_day_of_year_reversed_padded(self) -> Variable:
""" """
Returns
-------
str
The reversed upload day of year, but padded i.e. December 31st returns "001" The reversed upload day of year, but padded i.e. December 31st returns "001"
""" """
return Variable("upload_day_of_year_reversed_padded") return Variable("upload_day_of_year_reversed_padded")
@ -614,6 +805,9 @@ class VariableDefinitions:
@property @property
def upload_date_standardized(self) -> Variable: def upload_date_standardized(self) -> Variable:
""" """
Returns
-------
str
The uploaded date formatted as YYYY-MM-DD The uploaded date formatted as YYYY-MM-DD
""" """
return Variable("upload_date_standardized") return Variable("upload_date_standardized")
@ -621,13 +815,19 @@ class VariableDefinitions:
@property @property
def release_date(self) -> MetadataVariable: def release_date(self) -> MetadataVariable:
""" """
The entry's release date, in YYYYMMDD format. If not present, return the upload date. Returns
-------
str
The entry’s release date, in YYYYMMDD format. If not present, return the upload date.
""" """
return MetadataVariable(variable_name="release_date", metadata_key="release_date") return MetadataVariable(variable_name="release_date", metadata_key="release_date")
@property @property
def release_year(self) -> Variable: def release_year(self) -> Variable:
""" """
Returns
-------
int
The entry's release year The entry's release year
""" """
return Variable("release_year") return Variable("release_year")
@ -635,6 +835,9 @@ class VariableDefinitions:
@property @property
def release_year_truncated(self) -> Variable: def release_year_truncated(self) -> Variable:
""" """
Returns
-------
int
The last two digits of the release year, i.e. 22 in 2022 The last two digits of the release year, i.e. 22 in 2022
""" """
return Variable("release_year_truncated") return Variable("release_year_truncated")
@ -642,20 +845,31 @@ class VariableDefinitions:
@property @property
def release_year_truncated_reversed(self) -> Variable: def release_year_truncated_reversed(self) -> Variable:
""" """
The release year truncated, but reversed using ``100 - {release_year_truncated}``, i.e. 2022 returns ``100 - 22`` = ``78`` Returns
-------
int
The release year truncated, but reversed using ``100 - {release_year_truncated}``, i.e.
2022 returns ``100 - 22`` = ``78``
""" """
return Variable("release_year_truncated_reversed") return Variable("release_year_truncated_reversed")
@property @property
def release_month_reversed(self) -> Variable: def release_month_reversed(self) -> Variable:
""" """
The release month, but reversed using ``13 - {release_month}``, i.e. March returns ``10`` Returns
-------
int
The release month, but reversed
using ``13 - {release_month}``, i.e. March returns ``10``
""" """
return Variable("release_month_reversed") return Variable("release_month_reversed")
@property @property
def release_month_reversed_padded(self) -> Variable: def release_month_reversed_padded(self) -> Variable:
""" """
Returns
-------
str
The reversed release month, but padded. i.e. November returns "02" The reversed release month, but padded. i.e. November returns "02"
""" """
return Variable("release_month_reversed_padded") return Variable("release_month_reversed_padded")
@ -663,6 +877,9 @@ class VariableDefinitions:
@property @property
def release_month_padded(self) -> Variable: def release_month_padded(self) -> Variable:
""" """
Returns
-------
str
The entry's release month padded to two digits, i.e. March returns "03" The entry's release month padded to two digits, i.e. March returns "03"
""" """
return Variable("release_month_padded") return Variable("release_month_padded")
@ -670,6 +887,9 @@ class VariableDefinitions:
@property @property
def release_day_padded(self) -> Variable: def release_day_padded(self) -> Variable:
""" """
Returns
-------
str
The entry's release day padded to two digits, i.e. the fifth returns "05" The entry's release day padded to two digits, i.e. the fifth returns "05"
""" """
return Variable("release_day_padded") return Variable("release_day_padded")
@ -677,6 +897,9 @@ class VariableDefinitions:
@property @property
def release_month(self) -> Variable: def release_month(self) -> Variable:
""" """
Returns
-------
int
The release month as an integer (no padding). The release month as an integer (no padding).
""" """
return Variable("release_month") return Variable("release_month")
@ -684,6 +907,9 @@ class VariableDefinitions:
@property @property
def release_day(self) -> Variable: def release_day(self) -> Variable:
""" """
Returns
-------
int
The release day as an integer (no padding). The release day as an integer (no padding).
""" """
return Variable("release_day") return Variable("release_day")
@ -691,13 +917,20 @@ class VariableDefinitions:
@property @property
def release_day_reversed(self) -> Variable: def release_day_reversed(self) -> Variable:
""" """
The release day, but reversed using ``{total_days_in_month} + 1 - {release_day}``, i.e. August 8th would have release_day_reversed of ``31 + 1 - 8`` = ``24`` Returns
-------
int
The release day, but reversed using ``{total_days_in_month} + 1 - {release_day}``,
i.e. August 8th would have release_day_reversed of ``31 + 1 - 8`` = ``24``
""" """
return Variable("release_day_reversed") return Variable("release_day_reversed")
@property @property
def release_day_reversed_padded(self) -> Variable: def release_day_reversed_padded(self) -> Variable:
""" """
Returns
-------
str
The reversed release day, but padded. i.e. August 30th returns "02". The reversed release day, but padded. i.e. August 30th returns "02".
""" """
return Variable("release_day_reversed_padded") return Variable("release_day_reversed_padded")
@ -705,6 +938,9 @@ class VariableDefinitions:
@property @property
def release_day_of_year(self) -> Variable: def release_day_of_year(self) -> Variable:
""" """
Returns
-------
int
The day of the year, i.e. February 1st returns ``32`` The day of the year, i.e. February 1st returns ``32``
""" """
return Variable("release_day_of_year") return Variable("release_day_of_year")
@ -712,6 +948,9 @@ class VariableDefinitions:
@property @property
def release_day_of_year_padded(self) -> Variable: def release_day_of_year_padded(self) -> Variable:
""" """
Returns
-------
str
The release day of year, but padded i.e. February 1st returns "032" The release day of year, but padded i.e. February 1st returns "032"
""" """
return Variable("release_day_of_year_padded") return Variable("release_day_of_year_padded")
@ -719,13 +958,20 @@ class VariableDefinitions:
@property @property
def release_day_of_year_reversed(self) -> Variable: def release_day_of_year_reversed(self) -> Variable:
""" """
The release day, but reversed using ``{total_days_in_year} + 1 - {release_day}``, i.e. February 2nd would have release_day_of_year_reversed of ``365 + 1 - 32`` = ``334`` Returns
-------
int
The release day, but reversed using ``{total_days_in_year} + 1 - {release_day}``,
i.e. February 2nd would have release_day_of_year_reversed of ``365 + 1 - 32`` = ``334``
""" """
return Variable("release_day_of_year_reversed") return Variable("release_day_of_year_reversed")
@property @property
def release_day_of_year_reversed_padded(self) -> Variable: def release_day_of_year_reversed_padded(self) -> Variable:
""" """
Returns
-------
str
The reversed release day of year, but padded i.e. December 31st returns "001" The reversed release day of year, but padded i.e. December 31st returns "001"
""" """
return Variable("release_day_of_year_reversed_padded") return Variable("release_day_of_year_reversed_padded")
@ -733,6 +979,9 @@ class VariableDefinitions:
@property @property
def release_date_standardized(self) -> Variable: def release_date_standardized(self) -> Variable:
""" """
Returns
-------
str
The release date formatted as YYYY-MM-DD The release date formatted as YYYY-MM-DD
""" """
return Variable("release_date_standardized") return Variable("release_date_standardized")