pytafseer package

Submodules

pytafseer.settings module

Module contents

Top-level package for PyTafseer Python Package.

class pytafseer.QuranTafseer(book_id: int)[source]

Bases: object

property book_details

Get the details of the tafseer book

classmethod get_tafseer_books(language='') → list[source]

Gets the list of available tafseer

Parameters

language – filter the list of tafseer based on language, defaults, ISO 639-1 language optional.

Raises
  • ValueError – raise Value error if the JSON return form the services is invalid. #noqa

  • Timeout – if the server didn’t return any response.

  • HTTPError – if the server returned unsuccessful response.

Returns

list of dictionary with tafseer attributes [‘id’, ‘name’, ‘language’, ‘author’, ‘book_name’]

get_verse_tafseer(chapter_number: int, verse_number: int, with_verse_text: bool = False) → dict[source]

Gets the tafseer text for one verse

Parameters
  • with_verse_text – Whether to load the verse Quran text or not.

  • chapter_number – Chapter number.

  • verse_number – Verse number or a start range.

get_verses_tafseer(chapter_number: int, verse_number_from: int, verse_number_to: int, with_verse_text: bool = False) → list[source]

Gets the tafseer text for a range of verses

Parameters
  • with_verse_text – Whether to load the verse Quran text or not.

  • chapter_number – Chapter number.

  • verse_number_from – Verse number start range.

  • verse_number_to – Verse number end range.