diff --git a/poetry.lock b/poetry.lock index 3e025b2..7d64d48 100644 --- a/poetry.lock +++ b/poetry.lock @@ -586,13 +586,13 @@ mkdocs = ">=1.1" [[package]] name = "mkdocs-material" -version = "9.5.15" +version = "9.5.16" description = "Documentation that simply works" optional = false python-versions = ">=3.8" files = [ - {file = "mkdocs_material-9.5.15-py3-none-any.whl", hash = "sha256:e5c96dec3d19491de49ca643fc1dbb92b278e43cdb816c775bc47db77d9b62fb"}, - {file = "mkdocs_material-9.5.15.tar.gz", hash = "sha256:39f03cca45e82bf54eb7456b5a18bd252eabfdd67f237a229471484a0a4d4635"}, + {file = "mkdocs_material-9.5.16-py3-none-any.whl", hash = "sha256:32fce3cd8ecbd5dca6e5887cc0cf5bc78707a36f7d0f6f1bbbe9edaf428b8055"}, + {file = "mkdocs_material-9.5.16.tar.gz", hash = "sha256:8b89b639592660f24657bb058de4aff0060cd0383148f8f51711201730f17503"}, ] [package.dependencies] @@ -1474,4 +1474,4 @@ testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "p [metadata] lock-version = "2.0" python-versions = ">=3.9" -content-hash = "628a3efb2265aa4a0679ac7b36b51758bd06ee9b34046dd9aa301523a8752843" +content-hash = "f68e0ddf2f80314e95b7b178c2d192def913e73ba1fabff7a3a54d88f6adba49" diff --git a/pyproject.toml b/pyproject.toml index 3ca30f3..d0cc2b6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "pyanilist" -version = "0.3.1" +version = "0.4.0" description = "Simple AniList API wrapper to fetch media data" authors = ["Raventric "] license = "Unlicense" @@ -38,13 +38,13 @@ backports-strenum = {version = ">=1.3.1", python = "<3.11"} [tool.poetry.group.dev.dependencies] ruff = "^0.3.2" mypy = "^1.9.0" -types-boltons = "^23.1.0.20240310" +types-boltons = "^23.1.0.20240331" pytest = "^8.1.1" pytest-asyncio = "^0.23.5.post1" pre-commit = "^3.7.0" [tool.poetry.group.docs.dependencies] -mkdocs-material = "^9.5.15" +mkdocs-material = "^9.5.16" mkdocstrings = {extras = ["python"], version = "^0.24.0"} mkdocs-autorefs = "^1.0.1" @@ -59,10 +59,6 @@ fixable = ["ALL"] strict = true pretty = true -[[tool.mypy.overrides]] -module = ["markdownify"] -ignore_missing_imports = true - [tool.pytest.ini_options] asyncio_mode = "auto" diff --git a/src/pyanilist/_clients/_async.py b/src/pyanilist/_clients/_async.py index d29ec28..cad1745 100644 --- a/src/pyanilist/_clients/_async.py +++ b/src/pyanilist/_clients/_async.py @@ -115,7 +115,7 @@ async def _process_description(dictionary: dict[str, Any]) -> dict[str, Any]: So we do a bit of post processing: - Sanitize the resulting descriptions - - Introduce two more formats derived from the default, i.e, markdown and plain text + - Introduce two more formats derived from the original two, i.e, markdown and plain text - Nest our newly acquired 4 descriptions into a single parent dictionary Example: diff --git a/src/pyanilist/_clients/_sync.py b/src/pyanilist/_clients/_sync.py index 9ca295e..4f1577c 100644 --- a/src/pyanilist/_clients/_sync.py +++ b/src/pyanilist/_clients/_sync.py @@ -114,7 +114,7 @@ def _process_description(dictionary: dict[str, Any]) -> dict[str, Any]: So we do a bit of post processing: - Sanitize the resulting descriptions - - Introduce two more formats derived from the default, i.e, markdown and plain text + - Introduce two more formats derived from the original two, i.e, markdown and plain text - Nest our newly acquired 4 descriptions into a single parent dictionary Example: diff --git a/src/pyanilist/_models.py b/src/pyanilist/_models.py index c3f8b18..4f1b0aa 100644 --- a/src/pyanilist/_models.py +++ b/src/pyanilist/_models.py @@ -430,13 +430,13 @@ class MediaDescription(ParentModel): default: str | None = None """ - The default description of the media as returned by AniList. + The default description of the media. This may or may not contain HTML tags """ html: str | None = None """ - The HTML formatted description of the media as returned by AniList + The HTML formatted description of the media """ markdown: str | None = None @@ -453,7 +453,7 @@ class MediaDescription(ParentModel): Note ---- - This will be "lossy" in the sense that things like like italics, bolds, etc + This will be "lossy" in the sense that things like like hrefs, italics, bolds, etc will also be stripped """