From 049acf3e8fffa0fe3b8891b98601e8ed92ae326f Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sun, 10 Mar 2024 16:54:52 -0400 Subject: [PATCH] style: various code style and docs adjustments (#366) --- Contents/Code/general_helper.py | 2 +- Contents/Code/youtube_dl_helper.py | 8 +++++--- docs/source/code_docs/themerr_db_helper.rst | 9 +++++++++ docs/source/toc.rst | 1 + 4 files changed, 16 insertions(+), 4 deletions(-) create mode 100644 docs/source/code_docs/themerr_db_helper.rst diff --git a/Contents/Code/general_helper.py b/Contents/Code/general_helper.py index e252962c..1d938799 100644 --- a/Contents/Code/general_helper.py +++ b/Contents/Code/general_helper.py @@ -382,7 +382,7 @@ def remove_uploaded_media_error_handler(func, path, exc_info): ---------- func : any The function that caused the error. - path : str + path : any The path that caused the error. exc_info : any The exception information. diff --git a/Contents/Code/youtube_dl_helper.py b/Contents/Code/youtube_dl_helper.py index 6d8cdea9..34cc9cf0 100644 --- a/Contents/Code/youtube_dl_helper.py +++ b/Contents/Code/youtube_dl_helper.py @@ -16,10 +16,12 @@ from plexhints.prefs_kit import Prefs # prefs kit # imports from Libraries\Shared -from constants import plugin_identifier, plugin_support_data_directory from typing import Optional import youtube_dl +# local imports +from constants import plugin_identifier, plugin_support_data_directory + # get the plugin logger plugin_logger = logging.getLogger(plugin_identifier) @@ -77,11 +79,11 @@ def process_youtube(url): try: cookies = json.loads(Prefs['str_youtube_cookies']) for cookie in cookies: - include_subdom = cookie['domain'].startswith('.') + include_subdomain = cookie['domain'].startswith('.') expiry = int(cookie.get('expiry', 0)) values = [ cookie['domain'], - nsbool(include_subdom), + nsbool(include_subdomain), cookie['path'], nsbool(cookie['secure']), str(expiry), diff --git a/docs/source/code_docs/themerr_db_helper.rst b/docs/source/code_docs/themerr_db_helper.rst new file mode 100644 index 00000000..0b7567c6 --- /dev/null +++ b/docs/source/code_docs/themerr_db_helper.rst @@ -0,0 +1,9 @@ +:github_url: https://github.com/LizardByte/Themerr-plex/blob/master/Contents/Code/themerr_db_helper.py + +.. include:: ../global.rst + +:modname:`themerr_db_helper` +---------------------------- +.. automodule:: Code.themerr_db_helper + :members: + :show-inheritance: diff --git a/docs/source/toc.rst b/docs/source/toc.rst index 873f19e2..ea9ea9ce 100644 --- a/docs/source/toc.rst +++ b/docs/source/toc.rst @@ -29,6 +29,7 @@ code_docs/migration_helper code_docs/plex_api_helper code_docs/scheduled_tasks + code_docs/themerr_db_helper code_docs/tmdb_helper code_docs/webapp code_docs/youtube_dl_helper