pymal-ng 1.0.0__tar.gz

pymal_ng-1.0.0/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2014, tomergelber
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the {organization} nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pymal_ng-1.0.0/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: pymal-ng
+Version: 1.0.0
+Summary: A python api for the website MyAnimeList (or MAL).
+Keywords: myanimelist,mal,anime,manga,api
+Author: varyg
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: niquests[socks,utls]>=3.13.1,<4.0.0
+Requires-Dist: beautifulsoup4>=4.12.3,<5.0.0
+Requires-Dist: lxml>=6.0.0,<7.0.0
+Requires-Dist: pillow>=12.3.0
+Requires-Dist: singleton-factory>=0.1
+Requires-Python: >=3.10, <3.15
+Project-URL: Homepage, https://github.com/varyg1001/pymal
+Project-URL: Source, https://github.com/varyg1001/pymal
+Project-URL: Upstream, https://github.com/pymal-developers/pymal
+Description-Content-Type: text/markdown
+
+# pymal
+
+Programmatic access to [MyAnimeList](https://myanimelist.net) data in Python.
+Objects are **lazy-loading** — MAL is only contacted when you first access a property.
+
+---
+
+## Quick start
+
+```python
+from pymal import anime
+
+# Lazy — no network call yet
+a = anime.Anime(52991)
+
+# First property access triggers the MAL fetch
+print(a.title)    # "Sousou no Frieren"
+print(a.score)    # 9.07
+print(a.episodes) # 28
+print(a.genres)   # {'Adventure': '...', 'Drama': '...', 'Fantasy': '...'}
+print(a.english)  # "Frieren: Beyond Journey's End"
+print(a.japanese) # "葬送のフリーレン"
+```
+
+---
+
+## Installation
+
+### With uv (recommended)
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh   # install uv once
+
+git clone https://github.com/varyg1001/pymal
+cd pymal
+uv sync
+```
+
+### With pip
+
+```bash
+git clone https://github.com/varyg1001/pymal
+cd pymal
+pip install -e .
+```
+
+---
+
+## Requirements
+
+- Python `>=3.10, <3.15`
+- [`uv`](https://github.com/astral-sh/uv) (recommended) or pip
+
+Key runtime dependencies (full list in `pyproject.toml`):
+
+| Package | Purpose |
+|---------|---------|
+| `niquests[socks,utls]` | HTTP client (modern drop-in for `requests`) |
+| `beautifulsoup4` + `lxml` | HTML parsing |
+| `singleton-factory` | Object singleton lifecycle |
+
+---
+
+## Search & Endpoint Features
+
+- **Search API**: Search providers (`SearchAnimesProvider`, `SearchMangasProvider`) automatically query MyAnimeList's modern `prefix.json` API endpoint (`/search/prefix.json`), falling back gracefully if needed.
+- **Seasons**: Seasonal anime lookups (`Season`, `Seasons`) scrape directly from native MyAnimeList season pages (`/anime/season/<year>/<season>`) and the archive listing (`/anime/season/archive`).
+- **User Lists**: Account anime and manga lists (`AccountAnimes`, `AccountMangas`) utilize MAL's modern JSON list endpoints (`load.json`).
+
+---
+
+## Running tests
+
+```bash
+# Offline suite — no network or account needed (40 tests)
+uv run pytest tests/test_fixes.py -v
+
+# Full suite — account tests auto-skip unless credentials are set
+MAL_USERNAME=you MAL_PASSWORD=secret uv run pytest -v
+```
+
+---
+
+## Project structure
+
+```
+pymal/
+├── pymal/
+│   ├── anime.py                  # Anime object
+│   ├── manga.py                  # Manga object
+│   ├── account.py                # MAL account & auth
+│   ├── global_functions.py       # HTTP + HTML parsing helpers
+│   ├── account_objects/          # MyAnime, MyManga, lists, friends
+│   ├── searches/                 # Search providers
+│   └── inner_objects/            # Season, recommendation, etc.
+├── tests/
+│   ├── test_fixes.py             # Offline test suite (40 tests)
+│   └── account_objects/          # Live account tests (skipped without creds)
+├── docs/                         # MkDocs documentation source
+├── mkdocs.yml                    # Docs config (GitHub Pages)
+├── pyproject.toml                # Build config & pinned deps (uv_build)
+└── uv.lock                       # Lockfile — commit this
+```
+
+---
+
+## What changed in v1.0.0
+
+The original project (v0.5b4–v0.6) had broken against MAL's HTML updates and
+modern Python. v1.0.0 brings it back to life:
+
+| # | Area | Fix |
+|---|------|-----|
+| 1 | Parser | `html5lib` → `lxml` (no more `six` conflict) |
+| 2 | HTTP | `requests` → `niquests[socks,utls]` (HTTP/2, QUIC, modern TLS) |
+| 3 | Sidebar | Full rewrite from brittle index-based to label-based lookup (`span.dark_text`) |
+| 4 | Title | Fixed `IndexError` — MAL now wraps `<h1>` content in `<strong>` |
+| 5 | Table | Fixed `AttributeError` — MAL removed `<tbody>` from tables |
+| 6 | Search | Migrated from legacy `anime.php` to MAL's modern `prefix.json` API |
+| 7 | Seasons | Migrated from dead `malupdater.com` to native MAL `/anime/season` pages |
+| 8 | User Lists | Updated `AccountAnimes` & `AccountMangas` to MAL's `load.json` API |
+| 9 | Build | `setup.py` → `uv_build` + `pyproject.toml` |
+| 10 | Tests | New offline suite with 40 tests; account tests skip without credentials |
+| 11 | Docs | Migrated from Sphinx/RST to MkDocs Material (GitHub Pages) |
+| 12 | Cleanup | Removed `.travis.yml`, `MANIFEST.in`, `upload_new_version.bat`, dead HTML fixtures |
+
+Also fixed latent bugs: `==` used instead of `=` in `my_anime.py` and
+`my_manga.py` meant `download_episodes` and `times_rewatched` were never
+actually stored.
+
+---
+
+## Credits
+
+### Original authors
+
+pymal was created and developed by:
+
+- **tomer gelber** — [tomergelber@gmail.com](mailto:tomergelber@gmail.com)
+- **Aur Saraf** — [sonoflilit@gmail.com](mailto:sonoflilit@gmail.com)
+
+Original repository: [pymal-developers/pymal](https://github.com/pymal-developers/pymal)
+
+### v1.0.0
+
+The update was made with mostly AI. The main reason for the update is the errors cause by the old things used in the last released version. I still feel that this is the easiest way to get info from MAL, even with the original version, since MAL has not changed much.
+
+---
+
+## License
+
+BSD License — see original repository for full text.

pymal_ng-1.0.0/README.md

@@ -0,0 +1,152 @@
+# pymal
+
+Programmatic access to [MyAnimeList](https://myanimelist.net) data in Python.
+Objects are **lazy-loading** — MAL is only contacted when you first access a property.
+
+---
+
+## Quick start
+
+```python
+from pymal import anime
+
+# Lazy — no network call yet
+a = anime.Anime(52991)
+
+# First property access triggers the MAL fetch
+print(a.title)    # "Sousou no Frieren"
+print(a.score)    # 9.07
+print(a.episodes) # 28
+print(a.genres)   # {'Adventure': '...', 'Drama': '...', 'Fantasy': '...'}
+print(a.english)  # "Frieren: Beyond Journey's End"
+print(a.japanese) # "葬送のフリーレン"
+```
+
+---
+
+## Installation
+
+### With uv (recommended)
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh   # install uv once
+
+git clone https://github.com/varyg1001/pymal
+cd pymal
+uv sync
+```
+
+### With pip
+
+```bash
+git clone https://github.com/varyg1001/pymal
+cd pymal
+pip install -e .
+```
+
+---
+
+## Requirements
+
+- Python `>=3.10, <3.15`
+- [`uv`](https://github.com/astral-sh/uv) (recommended) or pip
+
+Key runtime dependencies (full list in `pyproject.toml`):
+
+| Package | Purpose |
+|---------|---------|
+| `niquests[socks,utls]` | HTTP client (modern drop-in for `requests`) |
+| `beautifulsoup4` + `lxml` | HTML parsing |
+| `singleton-factory` | Object singleton lifecycle |
+
+---
+
+## Search & Endpoint Features
+
+- **Search API**: Search providers (`SearchAnimesProvider`, `SearchMangasProvider`) automatically query MyAnimeList's modern `prefix.json` API endpoint (`/search/prefix.json`), falling back gracefully if needed.
+- **Seasons**: Seasonal anime lookups (`Season`, `Seasons`) scrape directly from native MyAnimeList season pages (`/anime/season/<year>/<season>`) and the archive listing (`/anime/season/archive`).
+- **User Lists**: Account anime and manga lists (`AccountAnimes`, `AccountMangas`) utilize MAL's modern JSON list endpoints (`load.json`).
+
+---
+
+## Running tests
+
+```bash
+# Offline suite — no network or account needed (40 tests)
+uv run pytest tests/test_fixes.py -v
+
+# Full suite — account tests auto-skip unless credentials are set
+MAL_USERNAME=you MAL_PASSWORD=secret uv run pytest -v
+```
+
+---
+
+## Project structure
+
+```
+pymal/
+├── pymal/
+│   ├── anime.py                  # Anime object
+│   ├── manga.py                  # Manga object
+│   ├── account.py                # MAL account & auth
+│   ├── global_functions.py       # HTTP + HTML parsing helpers
+│   ├── account_objects/          # MyAnime, MyManga, lists, friends
+│   ├── searches/                 # Search providers
+│   └── inner_objects/            # Season, recommendation, etc.
+├── tests/
+│   ├── test_fixes.py             # Offline test suite (40 tests)
+│   └── account_objects/          # Live account tests (skipped without creds)
+├── docs/                         # MkDocs documentation source
+├── mkdocs.yml                    # Docs config (GitHub Pages)
+├── pyproject.toml                # Build config & pinned deps (uv_build)
+└── uv.lock                       # Lockfile — commit this
+```
+
+---
+
+## What changed in v1.0.0
+
+The original project (v0.5b4–v0.6) had broken against MAL's HTML updates and
+modern Python. v1.0.0 brings it back to life:
+
+| # | Area | Fix |
+|---|------|-----|
+| 1 | Parser | `html5lib` → `lxml` (no more `six` conflict) |
+| 2 | HTTP | `requests` → `niquests[socks,utls]` (HTTP/2, QUIC, modern TLS) |
+| 3 | Sidebar | Full rewrite from brittle index-based to label-based lookup (`span.dark_text`) |
+| 4 | Title | Fixed `IndexError` — MAL now wraps `<h1>` content in `<strong>` |
+| 5 | Table | Fixed `AttributeError` — MAL removed `<tbody>` from tables |
+| 6 | Search | Migrated from legacy `anime.php` to MAL's modern `prefix.json` API |
+| 7 | Seasons | Migrated from dead `malupdater.com` to native MAL `/anime/season` pages |
+| 8 | User Lists | Updated `AccountAnimes` & `AccountMangas` to MAL's `load.json` API |
+| 9 | Build | `setup.py` → `uv_build` + `pyproject.toml` |
+| 10 | Tests | New offline suite with 40 tests; account tests skip without credentials |
+| 11 | Docs | Migrated from Sphinx/RST to MkDocs Material (GitHub Pages) |
+| 12 | Cleanup | Removed `.travis.yml`, `MANIFEST.in`, `upload_new_version.bat`, dead HTML fixtures |
+
+Also fixed latent bugs: `==` used instead of `=` in `my_anime.py` and
+`my_manga.py` meant `download_episodes` and `times_rewatched` were never
+actually stored.
+
+---
+
+## Credits
+
+### Original authors
+
+pymal was created and developed by:
+
+- **tomer gelber** — [tomergelber@gmail.com](mailto:tomergelber@gmail.com)
+- **Aur Saraf** — [sonoflilit@gmail.com](mailto:sonoflilit@gmail.com)
+
+Original repository: [pymal-developers/pymal](https://github.com/pymal-developers/pymal)
+
+### v1.0.0
+
+The update was made with mostly AI. The main reason for the update is the errors cause by the old things used in the last released version. I still feel that this is the easiest way to get info from MAL, even with the original version, since MAL has not changed much.
+
+---
+
+## License
+
+BSD License — see original repository for full text.

pymal_ng-1.0.0/pymal/__init__.py

@@ -0,0 +1,9 @@
+__authors__ = ""
+__copyright__ = "(c) 2014, pymal"
+__license__ = "BSD License"
+__contact__ = "Name Of Current Guardian of this file <email@address>"
+
+__all__ = ["account", "anime", "manga", "seasons"]
+
+
+__version__ = "1.0.0"

pymal_ng-1.0.0/pymal/account.py

@@ -0,0 +1,270 @@
+__authors__ = ""
+__copyright__ = "(c) 2014, pymal"
+__license__ = "BSD License"
+__contact__ = "Name Of Current Guardian of this file <email@address>"
+
+from urllib import request
+
+import niquests
+import singleton_factory
+
+from pymal import global_functions
+from pymal.consts import HOST_NAME
+from pymal.decorators import load
+
+
+__all__ = ["Account"]
+
+
+class Account(metaclass=singleton_factory.SingletonFactory):
+    """
+    Object that keeps all the account data in MAL.
+    """
+
+    __AUTH_CHECKER_URL = request.urljoin(HOST_NAME, r"api/account/verify_credentials.xml")
+
+    __MY_LOGIN_URL = request.urljoin(HOST_NAME, "login.php")
+    __DATA_FORM = "user_name={0:s}&password={1:s}&cookie=1&sublogin=Login&submit=1"
+
+    def __init__(self, username: str, password: str | None = None):
+        """
+        :param username: The account username.
+        :type username: str
+        :param password: Required for quick connection, instead of calling later change_password.
+        :type password: str or None
+        """
+        from pymal.account_objects import account_animes, account_mangas
+
+        self.__username = username
+        self.__password = password
+        self.connect = global_functions.connect
+        self.__user_id = None
+        self.__auth_object = None
+
+        self._main_profile_url = request.urljoin(HOST_NAME, f"profile/{self.username:s}")
+
+        self.__animes = account_animes.AccountAnimes(self)
+        self.__mangas = account_mangas.AccountMangas(self)
+        self.__friends = None
+        self.__image_url = ""
+
+        self.__session = global_functions.generate_session()
+
+        self._is_loaded = False
+
+        if password is not None:
+            self.change_password(password)
+
+    @property
+    def username(self) -> str:
+        """
+
+        :returns: the user name.
+        :rtype: str
+        """
+        return self.__username
+
+    @property
+    def user_id(self) -> int:
+        """
+        :returns: the user id. If unknown loading it.
+        :rtype: int
+        """
+        if self.__user_id is None:
+            import bs4
+
+            ret = self.connect(self._main_profile_url)
+            html = bs4.BeautifulSoup(ret)
+            bla = html.find(name="input", attrs={"name": "profileMemId"})
+            self.__user_id = int(bla["value"])
+        return self.__user_id
+
+    @property
+    def mangas(self):
+        """
+        :returns: list of account's mangas.
+        :rtype: :class:`account_objects.account_mangas.AccountMangas`
+        """
+        return self.__mangas
+
+    @property
+    def animes(self):
+        """
+        :returns: list of account's animes.
+        :rtype: :class:`account_objects.account_animes.AccountAnimes`
+        """
+        return self.__animes
+
+    @property
+    def friends(self) -> set:
+        """
+        :returns: list of account's friends.
+        :rtype: :class:`account_objects.account_friends.AccountFriends`
+        """
+        from pymal.account_objects import account_friends
+
+        if self.__friends is None:
+            self.__friends = account_friends.AccountFriends(self)
+        return self.__friends
+
+    def search(self, search_line: str, is_anime: bool = True) -> map:
+        """
+        Searching like regular search but switching all the object in "my" lists to the "my" objects.
+
+        :param search_line: the search line.
+        :type search_line: str
+        :param is_anime: True is searching for anime, False for manga.
+        :type is_anime: bool
+        :returns: searched objects
+        :rtype: map
+        """
+        from pymal import searches
+
+        if is_anime:
+            results = searches.search_animes(search_line)
+            account_object_list = self.animes
+        else:
+            results = searches.search_mangas(search_line)
+            account_object_list = self.mangas
+
+        def get_object(result):
+            if result not in account_object_list:
+                return result
+            # if account_object_list was set:
+            #     return account_object_list.intersection([result]).pop()
+            return list(filter(lambda x: x == result, account_object_list))[0]
+
+        return map(get_object, results)
+
+    def change_password(self, password: str) -> bool:
+        """
+        Checking if the new password is valid
+
+        :param password: password
+        :type password: str
+        :returns: True if password is right.
+        :rtype: bool
+        :exception exceptions.FailedToParseError: when failed
+        """
+        from xml.etree import ElementTree
+
+        from niquests.auth import HTTPBasicAuth
+
+        from pymal import exceptions
+
+        self.__auth_object = HTTPBasicAuth(self.username, password)
+        data = self.auth_connect(self.__AUTH_CHECKER_URL)
+        if data == "Invalid credentials":
+            self.__auth_object = None
+            self.__password = None
+            return False
+        xml_user = ElementTree.fromstring(data)
+
+        if xml_user.tag != "user":
+            raise exceptions.FailedToParseError(f"user == {xml_user.tag:s}")
+        xml_children = list(xml_user)
+        xml_username = xml_children[1]
+        if xml_username.tag != "username":
+            raise exceptions.FailedToParseError(f"username == {xml_username.tag:s}")
+        if self.username != xml_username.text.strip():
+            raise exceptions.FailedToParseError(
+                f"username = {xml_username.text.strip():s}"
+            )
+
+        xml_id = xml_children[0]
+        if xml_id.tag != "id":
+            raise exceptions.FailedToParseError(f"id == {xml_id.tag:s}")
+        if self.user_id != int(xml_id.text):
+            raise exceptions.FailedToParseError()
+
+        self.__password = password
+
+        data_form = self.__DATA_FORM.format(self.username, password).encode("utf-8")
+        headers = {
+            "content-type": "application/x-www-form-urlencoded",
+            "name": "loginForm",
+        }
+
+        self.auth_connect(self.__MY_LOGIN_URL, data=data_form, headers=headers)
+
+        return True
+
+    def auth_connect(
+        self, url: str, data: str | None = None, headers: dict | None = None
+    ) -> str:
+        """
+        :param url: The url to get.
+        :type url: str
+        :param data: The data to pass (will change the request to "POST")
+        :type data: str or None
+        :param headers: Headers for the request.
+        :type headers: dict or None
+        :returns: data after using the account authenticate to get the data.
+        :rtype: str
+        """
+        from pymal import exceptions
+
+        if not self.is_auth:
+            raise exceptions.UnauthenticatedAccountError(self.username)
+        return global_functions._connect(
+            url,
+            data=data,
+            headers=headers,
+            auth=self.__auth_object,
+            session=self.__session,
+        ).text.strip()
+
+    @property
+    @load
+    def image_url(self):
+        """
+        :return: path for the image of the avatar of the account.
+        :rtype: str
+        """
+        return self.__image_url
+
+    def get_image(self):
+        """
+        :return: image of the account's avatar
+        :rtype: :class:`PIL.Image.Image`
+        """
+        import io
+
+        from PIL import Image
+
+        sock = niquests.get(self.image_url)
+        data = io.BytesIO(sock.content)
+        return Image.open(data)
+
+    def reload(self):
+        """
+        reloading account image (all the other things are already lazy load!
+        """
+        div = global_functions.get_content_wrapper_div(
+            self._main_profile_url, self.connect
+        )
+        profile_leftcell = div.table.tbody.tr.find(
+            name="td", attrs={"class": "profile_leftcell"}, recursive=False
+        )
+        self.__image_url = profile_leftcell.div.img["src"]
+
+    @property
+    def is_auth(self) -> bool:
+        """
+        :returns: True if the password is right (and able to authenticate).
+        :rtype: bool
+        """
+        return self.__auth_object is not None
+
+    def __repr__(self):
+        return f"<Account username: {self.username:s}>"
+
+    def __hash__(self):
+        import hashlib
+
+        hash_md5 = hashlib.md5()
+        hash_md5.update(self.username.encode())
+        return int(hash_md5.hexdigest(), 16)
+
+    def __format__(self, format_spec):
+        return str(self).__format__(format_spec)

pymal_ng-1.0.0/pymal/account_objects/__init__.py

@@ -0,0 +1 @@
+__author__ = "user"