<div align="center">
<img alt="logo" width="400" src="https://raw.githubusercontent.com/FurryCoders/Logos/main/logos/faapi-transparent.png">
# Fur Affinity API
Python library to implement API-like functionality for the [Fur Affinity](https://furaffinity.net) website.
[](https://pypi.org/project/faapi/)
[](https://www.python.org)
[](https://github.com/FurryCoders/faapi)
[](https://github.com/FurryCoders/FAAPI/issues)
[](https://github.com/FurryCoders/FAAPI/actions/workflows/test.yml)
[](https://coveralls.io/github/FurryCoders/FAAPI)
</div>
## Requirements
Python 3.9+ is necessary to run this
library. [<img src="https://python-poetry.org/images/logo-origami.svg" height="12"> Poetry](https://python-poetry.org)
is used for packaging and dependency management.
## Usage
The API comprises a main class `FAAPI`, two submission classes `Submission` and `SubmissionPartial`, a journal
class `Journal`, and a user class `User`.
Once `FAAPI` is initialized, its methods can be used to crawl FA and return parsed objects.
```python
from requests.cookies import RequestsCookieJar
import faapi
import orjson
cookies = RequestsCookieJar()
cookies.set("a", "38565475-3421-3f21-7f63-3d341339737")
cookies.set("b", "356f5962-5a60-0922-1c11-65003b70308")
api = faapi.FAAPI(cookies)
sub, sub_file = api.submission(12345678, get_file=True)
print(sub.id, sub.title, sub.author, f"{len(sub_file) / 1024:02f}KiB")
with open(f"{sub.id}.json", "wb") as f:
f.write(orjson.dumps(dict(sub)))
with open(sub.file_url.split("/")[-1], "wb") as f:
f.write(sub_file)
gallery, _ = api.gallery("user_name", 1)
with open("user_name-gallery.json", "wb") as f:
f.write(orjson.dumps(list(map(dict, gallery))))
```
### robots.txt
At init, the `FAAPI` object downloads the [robots.txt](https://www.furaffinity.net/robots.txt) file from FA to determine
the `Crawl-delay` and `disallow` values set therein. If not set in the robots.txt file, a crawl delay value of 1 second
is used.
To respect this value, the default behaviour of the `FAAPI` object is to wait when a get request is made if the last
request was performed more recently then the crawl delay value.
See under [FAAPI](#faapi) for more details on this behaviour.
Furthermore, any get operation that points to a disallowed path from robots.txt will raise an exception. This check
should not be circumvented, and the developer of this library does not take responsibility for violations of the TOS of
Fur Affinity.
### Cookies
To access protected pages, cookies from an active session are needed. These cookies can be given to the FAAPI object as
a list of dictionaries - each containing a `name` and a `value` field -, or as a `http.cookiejar.CookieJar`
object (`requests.cookies.RequestsCookieJar` and other objects inheriting from `CookieJar` are also supported). The
cookies list should look like the following example:
```python
cookies = [
{"name": "a", "value": "38565475-3421-3f21-7f63-3d3413397537"},
{"name": "b", "value": "356f5962-5a60-0922-1c11-65003b703038"},
]
```
```python
from requests.cookies import RequestsCookieJar
cookies = RequestsCookieJar()
cookies.set("a", "38565475-3421-3f21-7f63-3d3413397537")
cookies.set("b", "356f5962-5a60-0922-1c11-65003b703038")
```
To access session cookies, consult the manual of the browser used to log in.
*Note:* it is important to not logout of the session the cookies belong to, otherwise they will no longer work.<br/>
*Note:* as of April 2022 only cookies `a` and `b` are needed.
### User Agent
`FAAPI` attaches a `User-Agent` header to every request. The user agent string is generated at startup in the following
format: `faapi/{library version} Python/{python version} {system name}/{system release}`.
## Objects
### FAAPI
This is the main object that handles all the calls to scrape pages and get submissions.
It holds 6 different fields:
* `session: requests.Session` The session used for all requests.
* `robots: urllib.robotparser.RobotFileParser` robots.txt handler
* `user_agent: str` user agent used by the session (property, cannot be set)
* `crawl_delay: float` crawl delay from robots.txt (property, cannot be set)
* `last_get: float` time of last get (UNIX time)
* `raise_for_unauthorized: bool = True` if set to `True`, raises an exception if a request is made and the resulting
page is not from a login session
* `timeout: int | None = None` requests timeout in seconds for both page requests (e.g. submissions) and files
#### Init
`__init__(cookies: list[dict[str, str]] | CookieJar, session_class: Type[Session] = Session)`
A FAAPI object must be initialised with a cookies object in the format mentioned above in [#Cookies](#cookies).
An optional `session_class` argument can be given to modify the class used by `FAAPI.session`. Any class based
on `requests.Session` is accepted.
#### Methods & Properties
* `load_cookies(cookies: list[dict[str, str]] | CookieJar)`<br/>
Load new cookies and create a new session.<br/>
*Note:* This method removes any cookies currently in use, to update/add single cookies access them from the session
object.
* `handle_delay()`<br/>
Handles the crawl delay as set in the robots.txt
* `check_path(path: str, *, raise_for_disallowed: bool = False) -> bool`<br/>
Checks whether a given path is allowed by the robots.txt. If `raise_for_disallowed` is set to `True`
a `DisallowedPath` exception is raised on non-allowed paths.
* `connection_status -> bool`<br/>
Returns the status of the connection.
* `login_status -> bool`<br/>
Returns the login status.
* `get(path: str, **params) -> requests.Response`<br/>
This returns a response object containing the result of the get operation on the given URL with the
optional `**params` added to it (url provided is considered as path from 'https://www.furaffinity.net/').
* `get_parsed(path: str, *, skip_page_check: bool = False, skip_auth_check: bool = False, **params) -> bs4.BeautifulSoup`<br/>
Similar to `get()` but returns the parsed HTML from the normal get operation. If the GET request encountered an error,
an `HTTPError` exception is raised. If `skip_page_check` is set to `True`, the parsed page is not checked for errors (
e.g. non-existing submission). If `skip_auth_check` is set to `True`, the page is not checked for login status.
* `me() -> User | None`<br/>
Returns the logged-in user as a `User` object if the cookies are from a login session.
* `frontpage() -> list[SubmissionPartial]`<br/>
Fetch the latest submissions from Fur Affinity's front page.
* `submission(submission_id: int, get_file: bool = False, *, chunk_size: int = None) -> tuple[Submission, bytes | None]`<br/>
Given a submission ID, it returns a `Submission` object containing the various metadata of the submission itself and
a `bytes` object with the submission file if `get_file` is passed as `True`. The optional `chunk_size` argument is
used for the request; if left to `None` or set to 0 the download is performed directly without streaming.<br/>
*Note:* the author `UserPartial` object of the submission does not contain the `join_date` field as it does not appear
on submission pages.
* `submission_file(submission: Submission, *, chunk_size: int = None) -> bytes`<br/>
Given a submission object, it downloads its file and returns it as a `bytes` object. The optional `chunk_size`
argument is used for the request; if left to `None` or set to 0 the download is performed directly without streaming.
* `journal(journal_id: int) -> Journal`<br/>
Given a journal ID, it returns a `Journal` object containing the various metadata of the journal.
* `user(user: str) -> User`<br/>
Given a username, it returns a `User` object containing information regarding the user.
* `gallery(user: str, page: int = 1) -> tuple[list[SubmissionPartial], int | None]`<br/>
Returns the list of submissions found on a specific gallery page, and the number of the next page. The returned page
number is set to `None` if it is the last page.
* `scraps(user: str, page: int = 1) -> -> tuple[list[SubmissionPartial], int | None]`<br/>
Returns the list of submissions found on a specific scraps page, and the number of the next page. The returned page
number is set to `None` if it is the last page.
* `favorites(user: str, page: str = "") -> tuple[list[SubmissionPartial], str | None]`<br/>
Downloads a user's favorites page. Because of how favorites pages work on FA, the `page` argument (and the one
returned) are strings. If the favorites page is the last then a `None` is returned as next page. An empty page
value as argument is equivalent to page 1.<br/>
*Note:* favorites page "numbers" do not follow any scheme and are only generated server-side.
* `journals(user: str, page: int = 1) -> -> tuple[list[JournalPartial], int | None]`<br/>
Returns the list of submissions found on a specific journals page, and the number of the next page. The returned page
number is set to `None` if it is the last page.
* `watchlist_to(self, user: str, page:int = 1) -> tuple[list[UserPartial], int | None]`<br/>
Given a username, returns a list of `UserPartial` objects for each user that is watching the given user and the next
page, if it is not the last, in which case a `None` is returned.
* `watchlist_by(self, user: str, page:int = 1) -> tuple[list[UserPartial], int | None]`<br/>
Given a username, returns a list of `UserPartial` objects for each user that is watched by the given user and the next
page, if it is not the last, in which case a `None` is returned.
*Note:* The last page returned by the `watchlist_to` and `watchlist_by` may not be correct as Fur Affinity doesn't seem
to have a consistent behaviour when rendering the next page button, as such it is safer to use an external algorithm to
check whether the method is advancing the page but returning the same/no users.
### UserPartial
A stripped-down class that holds basic user information. It is used to hold metadata gathered when parsing a submission,
journal, gallery, scraps, etc.
* `name: str` display name with capital letters and extra characters such as "_"
* `status: str` user status (~, !, etc.)
* `title: str` the user title as it appears on their userpage
* `join_date: datetime` the date the user joined (defaults to timestamp 0)
* `avatar_url: str` the URL to the user icon (used only when available)
* `user_tag: bs4.element.Tag` the user element used to parse information (placeholder, `UserPartial` is filled
externally)
`UserPartial` objects can be directly cast to a dict object and iterated through.
Comparison with `UserPartial` can be made with either another `UserPartial` or `User` object (the URL names are
compared), or a string (the URL name is compared to the given string).
#### Init
`__init__(user_tag: bs4.element.Tag = None)`
To initialise the object, an optional `bs4.element.Tag` object is needed containing the user element from a user page or
user folder.
If no `user_tag` is passed then the object fields will remain at their default - empty - value.
#### Methods
* `name_url -> str`<br/>
Property method that returns the URL-safe username
* `url -> str`<br/>
Property method that returns the Fur Affinity URL to the user (`https://www.furaffinity.net/user/{name_url}`).
* `generate_avatar_url() -> str`<br/>
Generates the URl for the current user icon.
* `parse(user_page: bs4.BeautifulSoup = None)`<br/>
Parses the stored user page for metadata. If `user_page` is passed, it overwrites the existing `user_page` value.
### User
The main class storing all of a user's metadata.
* `name: str` display name with capital letters and extra characters such as "_"
* `status: str` user status (~, !, etc.)
* `title: str` the user title as it appears on their userpage
* `join_date: datetime` the date the user joined (defaults to timestamp 0)
* `profile: str` profile text in HTML format
* `profile_bbcode: str` profile text in BBCode format
* `stats: UserStats` user statistics sorted in a `namedtuple` (`views`, `submissions`, `favorites`, `comments_earned`
, `comments_made`, `journals`, `watched_by`, `watching`)
* `info: dict[str, str]` profile information (e.g. "Accepting Trades", "Accepting Commissions", "Character Species",
etc.)
* `contacts: dict[str, str]` contact links (e.g. Twitter, Steam, etc.)
* `avatar_url: str` the URL to the user icon
* `banner_url: str | None` the URL to the user banner (if any is set, otherwise `None`)
* `watched: bool` `True` if the user is watched, `False` otherwise
* `watched_toggle_link: str | None` The link to toggle the watch status (`/watch/` or `/unwatch/` type link)
* `blocked: bool` `True` if the user is blocked, `False` otherwise
* `blocked_toggle_link: str | None` The link to toggle the block status (`/block/` or `/unblock/` type link)
* `user_page: bs4.BeautifulSoup` the user page used to parse the object fields
`User` objects can be directly cast to a dict object and iterated through.
Comparison with `User` can be made with either another `User` or `UserPartial` object (the URL names are compared), or a
string (the URL name is compared to the given string).
#### Init
`__init__(user_page: bs4.BeautifulSoup = None)`
To initialise the object, an optional `bs4.BeautifulSoup` object is needed containing the parsed HTML of a submission
page.
If no `user_page` is passed then the object fields will remain at their default - empty - value.
#### Methods
* `name_url -> str`<br/>
Property method that returns the URL-safe username
* `url -> str`<br/>
Property method that returns the Fur Affinity URL to the user (`https://www.furaffinity.net/user/{name_url}`).
* `generate_avatar_url() -> str`<br/>
Generates the URl for the current user icon.
* `parse(user_page: bs4.BeautifulSoup = None)`<br/>
Parses the stored user page for metadata. If `user_page` is passed, it overwrites the existing `user_page` value.
### JournalPartial
This object contains partial information gathered when parsing a journals folder. It contains the following fields:
* `id: int` journal ID
* `title: str` journal title
* `date: datetime` upload date as a [`datetime` object](https://docs.python.org/3/library/datetime.html) (defaults to
timestamp 0)
* `author: UserPartial` journal author (filled only if the journal is parsed from a `bs4.BeautifulSoup` page)
* `stats: JournalStats` journal statistics stored in a named tuple (`comments` (count))
* `content: str` journal content in HTML format
* `content_bbcode: str` journal content in BBCode format
* `mentions: list[str]` the users mentioned in the content (if they were mentioned as links, e.g. `:iconusername:`,
`@username`, etc.)
* `journal_tag: bs4.element.Tag` the journal tag used to parse the object fields
`JournalPartial` objects can be directly cast to a dict object or iterated through.
Comparison with `JournalPartial` can be made with either another `JournalPartial` or `Journal` object (the IDs are
compared), or an integer (the `JournalPartial.id` value is compared to the given integer).
#### Init
`__init__(journal_tag: bs4.element.Tag = None)`
`Journal` takes one optional parameters: a journal section tag from a journals page.
If no `journal_tag` is passed then the object fields will remain at their default - empty - value.
#### Methods
* `url -> str`<br/>
Property method that returns the Fur Affinity URL to the journal (`https://www.furaffinity.net/journal/{id}`).
* `parse(journal_item: bs4.element.Tag = None)`<br/>
Parses the stored journal tag for information. If `journal_tag` is passed, it overwrites the existing `journal_tag`
value.
### Journal
This object contains full information gathered when parsing a journal page. It contains the same fields
as `JournalPartial` with the addition of comments:
* `id: int` journal ID
* `title: str` journal title
* `date: datetime` upload date as a [`datetime` object](https://docs.python.org/3/library/datetime.html) (defaults to
timestamp 0)
* `author: UserPartial` journal author (filled only if the journal is parsed from a `bs4.BeautifulSoup` page)
* `stats: JournalStats` journal statistics stored in a named tuple (`comments` (count))
* `content: str` journal content in HTML format
* `content_bbcode: str` journal content in BBCode format
* `header: str` journal header in HTML format (if present)
* `footer: str` journal footer in HTML format (if present)
* `mentions: list[str]` the users mentioned in the content (if they were mentioned as links, e.g. `:iconusername:`,
`@username`, etc.)
* `comments: list[Comments]` the comments to the journal, organised in a tree structure
* `journal_page: bs4.BeautifulSoup` the journal page used to parse the object fields
`Journal` objects can be directly cast to a dict object or iterated through.
Comparison with `Journal` can be made with either another `Journal` or `JournalPartial` object (the IDs are compared),
or an integer (the `Journal.id` value is compared to the given integer).
#### Init
`__init__(journal_page: bs4.BeautifulSoup = None)`
`Journal` takes one optional journal page argument.
If no `journal_page` is passed then the object fields will remain at their default - empty - value.
#### Methods
* `url -> str`<br/>
Property method that returns the Fur Affinity URL to the journal (`https://www.furaffinity.net/journal/{id}`).
* `parse(journal_page: bs4.BeautifulSoup = None)`<br/>
Parses the stored journal tag for information. If `journal_tag` is passed, it overwrites the existing `journal_tag`
value.
### SubmissionPartial
This lightweight submission object is used to contain the information gathered when parsing gallery, scraps, and
favorites pages. It contains only the following fields:
* `id: int` submission ID
* `title: str` submission title
* `author: UserPartial` submission author (only the `name` field is filled)
* `rating: str` submission rating [general, mature, adult]
* `type: str` submission type [text, image, etc...]
* `thumbnail_url: str` the URL to the submission thumbnail
* `submission_figure: bs4.element.Tag` the figure tag used to parse the object fields
`SubmissionPartial` objects can be directly cast to a dict object or iterated through.
Comparison with `Submission` can be made with either another `SubmissionPartial` or `Submission` object (the IDs are
compared), or an integer (the `Submission.id` value is compared to the given integer).
#### Init
`__init__(submission_figure: bs4.element.Tag = None)`
To initialise the object, an optional `bs4.element.Tag` object is needed containing the parsed HTML of a submission
figure tag.
If no `submission_figure` is passed then the object fields will remain at their default - empty - value.
#### Methods
* `url -> str`<br/>
Property method that returns the Fur Affinity URL to the submission (`https://www.furaffinity.net/view/{id}`).
* `parse(submission_figure: bs4.element.Tag = None)`<br/>
Parses the stored submission figure tag for information. If `submission_figure` is passed, it overwrites the
existing `submission_figure` value.
### Submission
The main class that parses and holds submission metadata.
* `id: int` submission ID
* `title: str` submission title
* `author: UserPartial` submission author (only the `name`, `title`, and `avatar_url` fields are filled)
* `date: datetime` upload date as a [`datetime` object](https://docs.python.org/3/library/datetime.html) (defaults to
timestamp 0)
* `tags: list[str]` tags list
* `category: str` category
* `species: str` species
* `gender: str` gender
* `rating: str` rating
* `stats: SubmissionStats` submission statistics stored in a named tuple (`views`, `comments` (count), `favorites`)
* `type: str` submission type (text, image, etc...)
* `description: str` description in HTML format
* `description_bbcode: str` description in BBCode format
* `footer: str` footer in HTML format
* `mentions: list[str]` the users mentioned in the description (if they were mentioned as links, e.g. `:iconusername:`,
`@username`, etc.)
* `folder: str` the submission folder (gallery or scraps)
* `user_folders: list[SubmissionUserFolder]` user folders stored in a list of named tuples (`name`, `url`, `group` (
if any))
* `file_url: str` the URL to the submission file
* `thumbnail_url: str` the URL to the submission thumbnail
* `prev: int` the ID of the previous submission (if any)
* `next: int` the ID of the next submission (if any)
* `favorite: bool` `True` if the submission is a favorite, `False` otherwise
* `favorite_toggle_link: str` the link to toggle the favorite status (`/fav/` or `/unfav/` type URL)
* `comments: list[Comments]` the comments to the submission, organised in a tree structure
* `submission_page: bs4.BeautifulSoup` the submission page used to parse the object fields
`Submission` objects can be directly cast to a dict object and iterated through.
Comparison with `Submission` can be made with either another `Submission` or `SubmissionPartial` object (the IDs are
compared), or an integer (the `Submission.id` value is compared to the given integer).
#### Init
`__init__(submission_page: bs4.BeautifulSoup = None)`
To initialise the object, an optional `bs4.BeautifulSoup` object is needed containing the parsed HTML of a submission
page.
If no `submission_page` is passed then the object fields will remain at their default - empty - value.
#### Methods
* `url -> str`<br/>
Property method that returns the Fur Affinity URL to the submission (`https://www.furaffinity.net/view/{id}`).
* `parse(submission_page: bs4.BeautifulSoup = None)`<br/>
Parses the stored submission page for metadata. If `submission_page` is passed, it overwrites the
existing `submission_page` value.
### Comment
This object class contains comment metadata and is used to build a tree structure with the comments and their replies.
* `id: int` the comment ID
* `author: UserPartial` the user who posted the comment
* `date: datetime` the date the comment was posted
* `text: str` the comment text in HTML format
* `text_bbcode: str` the comment text in BBCode format
* `replies: list[Comment]` list of replies to the comment
* `reply_to: Comment | int | None` the parent comment, if the comment is a reply. The variable type is `int` only if the
comment is parsed outside the parse method of a `Submission` or `Journal` (e.g. by creating a new comment with a
comment tag), and when iterating over the parent object (to avoid infinite recursion errors), be it `Submission`
, `Journal` or another `Comment`.
* `edited: bool` `True` if the comment was edited, `False` otherwise
* `hidden: bool` `True` if the comment was hidden, `False` otherwise (if the comment was hidden, the author and date
fields will default to their empty values)
* `parent: Submission | Journal | None` the `Submission` or `Journal` object the comments are connected to
* `comment_tag: bs4.element.Tag` the comment tag used to parse the object fields
`Comment` objects can be directly cast to a dict object and iterated through.
Comparison with `Comment` can be made with either another comment (the IDs are compared), or an integer (
the `Comment.id` value is compared to the given integer).
*Note:* The `__iter__` method of `Comment` objects automatically removes recursion. The `parent` variable is set
to `None` and `reply_to` is set to the comment's ID.<br/>
*Note:* Because each comment contains the parent `Submission` or `Journal` object (which contains the comment itself)
and the replied comment object, some iterations may cause infinite recursion errors, for example when using
the `copy.deepcopy` function. If such iterations are needed, simply set the `parent` variable to `None` and
the `reply_to` variable to `None` or the comment's ID (this can be done easily after flattening the comments list
with `faapi.comment.flatten_comments`, the comments can then be sorted again with `faapi.comment.sort_comments` which
will also restore the `reply_to` values to `Comment` objects).
#### Init
`__init__(self, tag: bs4.element.Tag = None, parent: Submission | Journal = None)`
To initialise the object, an optional `bs4.element.Tag` object is needed containing the comment tag as taken from a
submission/journal page.
The optional `parent` argument sets the `parent` variable described above.
If no `tag` is passed then the object fields will remain at their default - empty - value.
#### Methods
* `url -> str`<br/>
Property method that returns the Fur Affinity URL to the comment (
e.g. `https://www.furaffinity.net/view/12345678#cid:1234567890`). If the `parent` variable is `None`, the property
returns an empty string.
* `parse(tag: bs4.element.Tag = None)`<br/>
Parses the stored tag for metadata. If `tag` is passed, it overwrites the existing `tag` value.
#### Extra Functions
These extra functions can be used to operate on a list of comments. They only alter the order and structure, but they do
not touch any of the metadata.
* `faapi.comment.sort_comments(comments: list[Comment]) -> list[Comment]`<br/>
Sorts a list of comments into a tree structure. Replies are overwritten.
* `faapi.comment.flatten_comments(comments: list[Comment]) -> list[Comment]`<br/>
Flattens a list of comments. Replies are not modified.
#### Comment Tree Graphs
Using the tree structure generated by the library, it is trivial to build a graph visualisation of the comment tree
using the [DOT](https://www.graphviz.org/doc/info/lang.html) language.
```python
submission, _ = api.submission(12345678)
comments = faapi.comment.flatten_comments(submission.comments)
with open("comments.dot", "w") as f:
f.write("digraph {\n")
for comment in [c for c in comments if c.reply_to is None]:
f.write(f" parent -> {comment.id}\n")
for comment in comments:
for reply in comment.replies:
f.write(f" {comment.id} -> {reply.id}\n")
f.write("}")
```
```dot
digraph {
parent -> 157990848
parent -> 157993838
parent -> 157997294
157990848 -> 158014077
158014077 -> 158014816
158014816 -> 158093180
158093180 -> 158097024
157993838 -> 157998464
157993838 -> 158014126
157997294 -> 158014135
158014135 -> 158014470
158014135 -> 158030074
158014470 -> 158093185
158030074 -> 158093199
}
```
<img alt="comments tree graph" width="400" src="https://quickchart.io/graphviz?graph=digraph%7B%0Aparent-%3E157990848%0Aparent-%3E157993838%0Aparent-%3E157997294%0A157990848-%3E158014077%0A158014077-%3E158014816%0A158014816-%3E158093180%0A158093180-%3E158097024%0A157993838-%3E157998464%0A157993838-%3E158014126%0A157997294-%3E158014135%0A158014135-%3E158014470%0A158014135-%3E158030074%0A158014470-%3E158093185%0A158030074-%3E158093199%0A%7D">
_The graph above was generated with [quickchart.io](https://quickchart.io/documentation/graphviz-api/)_
## BBCode Conversion
Using the BBCode fields allows to convert between the raw HTMl recovered from Fur Affinity and BBCode tags that follow
FA's guidelines. Conversion from HTML to BBCode covers all known tags and preserves all newlines and spacing.
BBCode text can be converted to Fur Affinity's HTMl using the `faapi.parse.bbcode_to_html()` function. The majority of
submissions can be converted back and forth between HTML and BBCode without any information loss, however, the parser
rules are still a work in progress and there are many edge cases where unusual text and formatting cause the parser to
generate incorrect HTML.
## Exceptions
The following are the exceptions explicitly raised by the FAAPI functions. The exceptions deriving from `ParsingError`
are chosen depending on the content of the page. Because Fur Affinity doesn't use HTTP status codes besides 404, the
page is checked against a static list of known error messages/page titles in order to determine the specific error to be
used. If no match is found, then the `ServerError` (if the page has the "Server Error" title) or the more
general `NoticeMessage` exceptions are used instead. The actual error message parsed from the page is used as argument
for the exceptions, so that it can be analysed when caught.
* `DisallowedPath(Exception)` The path is not allowed by the robots.txt.
* `Unauthorized(Exception)` The user is not logged-in.
* `ParsingError(Exception)` An error occurred while parsing the page.
* `NonePage(ParsingError)` The parsed page is `None`.
* `NotFound(ParsingError)` The resource could not be found (general 404 page or non-existing submission, user, or
journal).
* `NoTitle(ParsingError)` The parsed paged is missing a title.
* `DisabledAccount(ParsingError)` The resource belongs to a disabled account.
* `ServerError(ParsingError)` The page contains a server error notice.
* `NoticeMessage(ParsingError)` A notice of unknown type was found in the page.
## Beautiful Soup Warnings
When parsing some pages or converting HTML to BBCode, the [Beautiful Soup](https://pypi.org/project/beautifulsoup4/)
library may give some warnings, for example `MarkupResemblesLocatorWarning`. These warnings are left enabled for
clarity, but can be disabled manually using the `warnings.filterwarnings` function.
## Contributing
All contributions and suggestions are welcome!
If you have suggestions for fixes or improvements, you can open an issue with your idea, see [#Issues](#issues) for
details.
## Issues
If any problem is encountered during usage of the program, an issue can be opened
on [GitHub](https://github.com/FurryCoders/FAAPI/issues).
Issues can also be used to suggest improvements and features.
When opening an issue for a problem, please copy the error message and describe the operation in progress when the error
occurred.
Raw data
{
"_id": null,
"home_page": "https://github.com/FurryCoders/FAAPI",
"name": "faapi",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Matteo Campinoti",
"author_email": "matteo.campinoti94@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/31/89/bc8bcd8548d3bdbcba536cb53bcee163b9c918b1d25499c29fce7d2ec6e3/faapi-3.11.5.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n<img alt=\"logo\" width=\"400\" src=\"https://raw.githubusercontent.com/FurryCoders/Logos/main/logos/faapi-transparent.png\">\n\n# Fur Affinity API\n\nPython library to implement API-like functionality for the [Fur Affinity](https://furaffinity.net) website.\n\n[](https://pypi.org/project/faapi/)\n[](https://www.python.org)\n\n[](https://github.com/FurryCoders/faapi)\n[](https://github.com/FurryCoders/FAAPI/issues)\n[](https://github.com/FurryCoders/FAAPI/actions/workflows/test.yml)\n[](https://coveralls.io/github/FurryCoders/FAAPI)\n\n</div>\n\n## Requirements\n\nPython 3.9+ is necessary to run this\nlibrary. [<img src=\"https://python-poetry.org/images/logo-origami.svg\" height=\"12\"> Poetry](https://python-poetry.org)\nis used for packaging and dependency management.\n\n## Usage\n\nThe API comprises a main class `FAAPI`, two submission classes `Submission` and `SubmissionPartial`, a journal\nclass `Journal`, and a user class `User`.\n\nOnce `FAAPI` is initialized, its methods can be used to crawl FA and return parsed objects.\n\n```python\nfrom requests.cookies import RequestsCookieJar\nimport faapi\nimport orjson\n\ncookies = RequestsCookieJar()\ncookies.set(\"a\", \"38565475-3421-3f21-7f63-3d341339737\")\ncookies.set(\"b\", \"356f5962-5a60-0922-1c11-65003b70308\")\n\napi = faapi.FAAPI(cookies)\nsub, sub_file = api.submission(12345678, get_file=True)\n\nprint(sub.id, sub.title, sub.author, f\"{len(sub_file) / 1024:02f}KiB\")\n\nwith open(f\"{sub.id}.json\", \"wb\") as f:\n f.write(orjson.dumps(dict(sub)))\n\nwith open(sub.file_url.split(\"/\")[-1], \"wb\") as f:\n f.write(sub_file)\n\ngallery, _ = api.gallery(\"user_name\", 1)\nwith open(\"user_name-gallery.json\", \"wb\") as f:\n f.write(orjson.dumps(list(map(dict, gallery))))\n```\n\n### robots.txt\n\nAt init, the `FAAPI` object downloads the [robots.txt](https://www.furaffinity.net/robots.txt) file from FA to determine\nthe `Crawl-delay` and `disallow` values set therein. If not set in the robots.txt file, a crawl delay value of 1 second\nis used.\n\nTo respect this value, the default behaviour of the `FAAPI` object is to wait when a get request is made if the last\nrequest was performed more recently then the crawl delay value.\n\nSee under [FAAPI](#faapi) for more details on this behaviour.\n\nFurthermore, any get operation that points to a disallowed path from robots.txt will raise an exception. This check\nshould not be circumvented, and the developer of this library does not take responsibility for violations of the TOS of\nFur Affinity.\n\n### Cookies\n\nTo access protected pages, cookies from an active session are needed. These cookies can be given to the FAAPI object as\na list of dictionaries - each containing a `name` and a `value` field -, or as a `http.cookiejar.CookieJar`\nobject (`requests.cookies.RequestsCookieJar` and other objects inheriting from `CookieJar` are also supported). The\ncookies list should look like the following example:\n\n```python\ncookies = [\n {\"name\": \"a\", \"value\": \"38565475-3421-3f21-7f63-3d3413397537\"},\n {\"name\": \"b\", \"value\": \"356f5962-5a60-0922-1c11-65003b703038\"},\n]\n```\n\n```python\nfrom requests.cookies import RequestsCookieJar\n\ncookies = RequestsCookieJar()\ncookies.set(\"a\", \"38565475-3421-3f21-7f63-3d3413397537\")\ncookies.set(\"b\", \"356f5962-5a60-0922-1c11-65003b703038\")\n```\n\nTo access session cookies, consult the manual of the browser used to log in.\n\n*Note:* it is important to not logout of the session the cookies belong to, otherwise they will no longer work.<br/>\n*Note:* as of April 2022 only cookies `a` and `b` are needed.\n\n### User Agent\n\n`FAAPI` attaches a `User-Agent` header to every request. The user agent string is generated at startup in the following\nformat: `faapi/{library version} Python/{python version} {system name}/{system release}`.\n\n## Objects\n\n### FAAPI\n\nThis is the main object that handles all the calls to scrape pages and get submissions.\n\nIt holds 6 different fields:\n\n* `session: requests.Session` The session used for all requests.\n* `robots: urllib.robotparser.RobotFileParser` robots.txt handler\n* `user_agent: str` user agent used by the session (property, cannot be set)\n* `crawl_delay: float` crawl delay from robots.txt (property, cannot be set)\n* `last_get: float` time of last get (UNIX time)\n* `raise_for_unauthorized: bool = True` if set to `True`, raises an exception if a request is made and the resulting\n page is not from a login session\n* `timeout: int | None = None` requests timeout in seconds for both page requests (e.g. submissions) and files\n\n#### Init\n\n`__init__(cookies: list[dict[str, str]] | CookieJar, session_class: Type[Session] = Session)`\n\nA FAAPI object must be initialised with a cookies object in the format mentioned above in [#Cookies](#cookies).\n\nAn optional `session_class` argument can be given to modify the class used by `FAAPI.session`. Any class based\non `requests.Session` is accepted.\n\n#### Methods & Properties\n\n* `load_cookies(cookies: list[dict[str, str]] | CookieJar)`<br/>\n Load new cookies and create a new session.<br/>\n *Note:* This method removes any cookies currently in use, to update/add single cookies access them from the session\n object.\n* `handle_delay()`<br/>\n Handles the crawl delay as set in the robots.txt\n* `check_path(path: str, *, raise_for_disallowed: bool = False) -> bool`<br/>\n Checks whether a given path is allowed by the robots.txt. If `raise_for_disallowed` is set to `True`\n a `DisallowedPath` exception is raised on non-allowed paths.\n* `connection_status -> bool`<br/>\n Returns the status of the connection.\n* `login_status -> bool`<br/>\n Returns the login status.\n* `get(path: str, **params) -> requests.Response`<br/>\n This returns a response object containing the result of the get operation on the given URL with the\n optional `**params` added to it (url provided is considered as path from 'https://www.furaffinity.net/').\n* `get_parsed(path: str, *, skip_page_check: bool = False, skip_auth_check: bool = False, **params) -> bs4.BeautifulSoup`<br/>\n Similar to `get()` but returns the parsed HTML from the normal get operation. If the GET request encountered an error,\n an `HTTPError` exception is raised. If `skip_page_check` is set to `True`, the parsed page is not checked for errors (\n e.g. non-existing submission). If `skip_auth_check` is set to `True`, the page is not checked for login status.\n* `me() -> User | None`<br/>\n Returns the logged-in user as a `User` object if the cookies are from a login session.\n* `frontpage() -> list[SubmissionPartial]`<br/>\n Fetch the latest submissions from Fur Affinity's front page.\n* `submission(submission_id: int, get_file: bool = False, *, chunk_size: int = None) -> tuple[Submission, bytes | None]`<br/>\n Given a submission ID, it returns a `Submission` object containing the various metadata of the submission itself and\n a `bytes` object with the submission file if `get_file` is passed as `True`. The optional `chunk_size` argument is\n used for the request; if left to `None` or set to 0 the download is performed directly without streaming.<br/>\n *Note:* the author `UserPartial` object of the submission does not contain the `join_date` field as it does not appear\n on submission pages.\n* `submission_file(submission: Submission, *, chunk_size: int = None) -> bytes`<br/>\n Given a submission object, it downloads its file and returns it as a `bytes` object. The optional `chunk_size`\n argument is used for the request; if left to `None` or set to 0 the download is performed directly without streaming.\n* `journal(journal_id: int) -> Journal`<br/>\n Given a journal ID, it returns a `Journal` object containing the various metadata of the journal.\n* `user(user: str) -> User`<br/>\n Given a username, it returns a `User` object containing information regarding the user.\n* `gallery(user: str, page: int = 1) -> tuple[list[SubmissionPartial], int | None]`<br/>\n Returns the list of submissions found on a specific gallery page, and the number of the next page. The returned page\n number is set to `None` if it is the last page.\n* `scraps(user: str, page: int = 1) -> -> tuple[list[SubmissionPartial], int | None]`<br/>\n Returns the list of submissions found on a specific scraps page, and the number of the next page. The returned page\n number is set to `None` if it is the last page.\n* `favorites(user: str, page: str = \"\") -> tuple[list[SubmissionPartial], str | None]`<br/>\n Downloads a user's favorites page. Because of how favorites pages work on FA, the `page` argument (and the one\n returned) are strings. If the favorites page is the last then a `None` is returned as next page. An empty page\n value as argument is equivalent to page 1.<br/>\n *Note:* favorites page \"numbers\" do not follow any scheme and are only generated server-side.\n* `journals(user: str, page: int = 1) -> -> tuple[list[JournalPartial], int | None]`<br/>\n Returns the list of submissions found on a specific journals page, and the number of the next page. The returned page\n number is set to `None` if it is the last page.\n* `watchlist_to(self, user: str, page:int = 1) -> tuple[list[UserPartial], int | None]`<br/>\n Given a username, returns a list of `UserPartial` objects for each user that is watching the given user and the next\n page, if it is not the last, in which case a `None` is returned.\n* `watchlist_by(self, user: str, page:int = 1) -> tuple[list[UserPartial], int | None]`<br/>\n Given a username, returns a list of `UserPartial` objects for each user that is watched by the given user and the next\n page, if it is not the last, in which case a `None` is returned.\n\n*Note:* The last page returned by the `watchlist_to` and `watchlist_by` may not be correct as Fur Affinity doesn't seem\nto have a consistent behaviour when rendering the next page button, as such it is safer to use an external algorithm to\ncheck whether the method is advancing the page but returning the same/no users.\n\n### UserPartial\n\nA stripped-down class that holds basic user information. It is used to hold metadata gathered when parsing a submission,\njournal, gallery, scraps, etc.\n\n* `name: str` display name with capital letters and extra characters such as \"_\"\n* `status: str` user status (~, !, etc.)\n* `title: str` the user title as it appears on their userpage\n* `join_date: datetime` the date the user joined (defaults to timestamp 0)\n* `avatar_url: str` the URL to the user icon (used only when available)\n* `user_tag: bs4.element.Tag` the user element used to parse information (placeholder, `UserPartial` is filled\n externally)\n\n`UserPartial` objects can be directly cast to a dict object and iterated through.\n\nComparison with `UserPartial` can be made with either another `UserPartial` or `User` object (the URL names are\ncompared), or a string (the URL name is compared to the given string).\n\n#### Init\n\n`__init__(user_tag: bs4.element.Tag = None)`\n\nTo initialise the object, an optional `bs4.element.Tag` object is needed containing the user element from a user page or\nuser folder.\n\nIf no `user_tag` is passed then the object fields will remain at their default - empty - value.\n\n#### Methods\n\n* `name_url -> str`<br/>\n Property method that returns the URL-safe username\n* `url -> str`<br/>\n Property method that returns the Fur Affinity URL to the user (`https://www.furaffinity.net/user/{name_url}`).\n* `generate_avatar_url() -> str`<br/>\n Generates the URl for the current user icon.\n* `parse(user_page: bs4.BeautifulSoup = None)`<br/>\n Parses the stored user page for metadata. If `user_page` is passed, it overwrites the existing `user_page` value.\n\n### User\n\nThe main class storing all of a user's metadata.\n\n* `name: str` display name with capital letters and extra characters such as \"_\"\n* `status: str` user status (~, !, etc.)\n* `title: str` the user title as it appears on their userpage\n* `join_date: datetime` the date the user joined (defaults to timestamp 0)\n* `profile: str` profile text in HTML format\n* `profile_bbcode: str` profile text in BBCode format\n* `stats: UserStats` user statistics sorted in a `namedtuple` (`views`, `submissions`, `favorites`, `comments_earned`\n , `comments_made`, `journals`, `watched_by`, `watching`)\n* `info: dict[str, str]` profile information (e.g. \"Accepting Trades\", \"Accepting Commissions\", \"Character Species\",\n etc.)\n* `contacts: dict[str, str]` contact links (e.g. Twitter, Steam, etc.)\n* `avatar_url: str` the URL to the user icon\n* `banner_url: str | None` the URL to the user banner (if any is set, otherwise `None`)\n* `watched: bool` `True` if the user is watched, `False` otherwise\n* `watched_toggle_link: str | None` The link to toggle the watch status (`/watch/` or `/unwatch/` type link)\n* `blocked: bool` `True` if the user is blocked, `False` otherwise\n* `blocked_toggle_link: str | None` The link to toggle the block status (`/block/` or `/unblock/` type link)\n* `user_page: bs4.BeautifulSoup` the user page used to parse the object fields\n\n`User` objects can be directly cast to a dict object and iterated through.\n\nComparison with `User` can be made with either another `User` or `UserPartial` object (the URL names are compared), or a\nstring (the URL name is compared to the given string).\n\n#### Init\n\n`__init__(user_page: bs4.BeautifulSoup = None)`\n\nTo initialise the object, an optional `bs4.BeautifulSoup` object is needed containing the parsed HTML of a submission\npage.\n\nIf no `user_page` is passed then the object fields will remain at their default - empty - value.\n\n#### Methods\n\n* `name_url -> str`<br/>\n Property method that returns the URL-safe username\n* `url -> str`<br/>\n Property method that returns the Fur Affinity URL to the user (`https://www.furaffinity.net/user/{name_url}`).\n* `generate_avatar_url() -> str`<br/>\n Generates the URl for the current user icon.\n* `parse(user_page: bs4.BeautifulSoup = None)`<br/>\n Parses the stored user page for metadata. If `user_page` is passed, it overwrites the existing `user_page` value.\n\n### JournalPartial\n\nThis object contains partial information gathered when parsing a journals folder. It contains the following fields:\n\n* `id: int` journal ID\n* `title: str` journal title\n* `date: datetime` upload date as a [`datetime` object](https://docs.python.org/3/library/datetime.html) (defaults to\n timestamp 0)\n* `author: UserPartial` journal author (filled only if the journal is parsed from a `bs4.BeautifulSoup` page)\n* `stats: JournalStats` journal statistics stored in a named tuple (`comments` (count))\n* `content: str` journal content in HTML format\n* `content_bbcode: str` journal content in BBCode format\n* `mentions: list[str]` the users mentioned in the content (if they were mentioned as links, e.g. `:iconusername:`,\n `@username`, etc.)\n* `journal_tag: bs4.element.Tag` the journal tag used to parse the object fields\n\n`JournalPartial` objects can be directly cast to a dict object or iterated through.\n\nComparison with `JournalPartial` can be made with either another `JournalPartial` or `Journal` object (the IDs are\ncompared), or an integer (the `JournalPartial.id` value is compared to the given integer).\n\n#### Init\n\n`__init__(journal_tag: bs4.element.Tag = None)`\n\n`Journal` takes one optional parameters: a journal section tag from a journals page.\n\nIf no `journal_tag` is passed then the object fields will remain at their default - empty - value.\n\n#### Methods\n\n* `url -> str`<br/>\n Property method that returns the Fur Affinity URL to the journal (`https://www.furaffinity.net/journal/{id}`).\n* `parse(journal_item: bs4.element.Tag = None)`<br/>\n Parses the stored journal tag for information. If `journal_tag` is passed, it overwrites the existing `journal_tag`\n value.\n\n### Journal\n\nThis object contains full information gathered when parsing a journal page. It contains the same fields\nas `JournalPartial` with the addition of comments:\n\n* `id: int` journal ID\n* `title: str` journal title\n* `date: datetime` upload date as a [`datetime` object](https://docs.python.org/3/library/datetime.html) (defaults to\n timestamp 0)\n* `author: UserPartial` journal author (filled only if the journal is parsed from a `bs4.BeautifulSoup` page)\n* `stats: JournalStats` journal statistics stored in a named tuple (`comments` (count))\n* `content: str` journal content in HTML format\n* `content_bbcode: str` journal content in BBCode format\n* `header: str` journal header in HTML format (if present)\n* `footer: str` journal footer in HTML format (if present)\n* `mentions: list[str]` the users mentioned in the content (if they were mentioned as links, e.g. `:iconusername:`,\n `@username`, etc.)\n* `comments: list[Comments]` the comments to the journal, organised in a tree structure\n* `journal_page: bs4.BeautifulSoup` the journal page used to parse the object fields\n\n`Journal` objects can be directly cast to a dict object or iterated through.\n\nComparison with `Journal` can be made with either another `Journal` or `JournalPartial` object (the IDs are compared),\nor an integer (the `Journal.id` value is compared to the given integer).\n\n#### Init\n\n`__init__(journal_page: bs4.BeautifulSoup = None)`\n\n`Journal` takes one optional journal page argument.\n\nIf no `journal_page` is passed then the object fields will remain at their default - empty - value.\n\n#### Methods\n\n* `url -> str`<br/>\n Property method that returns the Fur Affinity URL to the journal (`https://www.furaffinity.net/journal/{id}`).\n* `parse(journal_page: bs4.BeautifulSoup = None)`<br/>\n Parses the stored journal tag for information. If `journal_tag` is passed, it overwrites the existing `journal_tag`\n value.\n\n### SubmissionPartial\n\nThis lightweight submission object is used to contain the information gathered when parsing gallery, scraps, and\nfavorites pages. It contains only the following fields:\n\n* `id: int` submission ID\n* `title: str` submission title\n* `author: UserPartial` submission author (only the `name` field is filled)\n* `rating: str` submission rating [general, mature, adult]\n* `type: str` submission type [text, image, etc...]\n* `thumbnail_url: str` the URL to the submission thumbnail\n* `submission_figure: bs4.element.Tag` the figure tag used to parse the object fields\n\n`SubmissionPartial` objects can be directly cast to a dict object or iterated through.\n\nComparison with `Submission` can be made with either another `SubmissionPartial` or `Submission` object (the IDs are\ncompared), or an integer (the `Submission.id` value is compared to the given integer).\n\n#### Init\n\n`__init__(submission_figure: bs4.element.Tag = None)`\n\nTo initialise the object, an optional `bs4.element.Tag` object is needed containing the parsed HTML of a submission\nfigure tag.\n\nIf no `submission_figure` is passed then the object fields will remain at their default - empty - value.\n\n#### Methods\n\n* `url -> str`<br/>\n Property method that returns the Fur Affinity URL to the submission (`https://www.furaffinity.net/view/{id}`).\n* `parse(submission_figure: bs4.element.Tag = None)`<br/>\n Parses the stored submission figure tag for information. If `submission_figure` is passed, it overwrites the\n existing `submission_figure` value.\n\n### Submission\n\nThe main class that parses and holds submission metadata.\n\n* `id: int` submission ID\n* `title: str` submission title\n* `author: UserPartial` submission author (only the `name`, `title`, and `avatar_url` fields are filled)\n* `date: datetime` upload date as a [`datetime` object](https://docs.python.org/3/library/datetime.html) (defaults to\n timestamp 0)\n* `tags: list[str]` tags list\n* `category: str` category\n* `species: str` species\n* `gender: str` gender\n* `rating: str` rating\n* `stats: SubmissionStats` submission statistics stored in a named tuple (`views`, `comments` (count), `favorites`)\n* `type: str` submission type (text, image, etc...)\n* `description: str` description in HTML format\n* `description_bbcode: str` description in BBCode format\n* `footer: str` footer in HTML format\n* `mentions: list[str]` the users mentioned in the description (if they were mentioned as links, e.g. `:iconusername:`,\n `@username`, etc.)\n* `folder: str` the submission folder (gallery or scraps)\n* `user_folders: list[SubmissionUserFolder]` user folders stored in a list of named tuples (`name`, `url`, `group` (\n if any))\n* `file_url: str` the URL to the submission file\n* `thumbnail_url: str` the URL to the submission thumbnail\n* `prev: int` the ID of the previous submission (if any)\n* `next: int` the ID of the next submission (if any)\n* `favorite: bool` `True` if the submission is a favorite, `False` otherwise\n* `favorite_toggle_link: str` the link to toggle the favorite status (`/fav/` or `/unfav/` type URL)\n* `comments: list[Comments]` the comments to the submission, organised in a tree structure\n* `submission_page: bs4.BeautifulSoup` the submission page used to parse the object fields\n\n`Submission` objects can be directly cast to a dict object and iterated through.\n\nComparison with `Submission` can be made with either another `Submission` or `SubmissionPartial` object (the IDs are\ncompared), or an integer (the `Submission.id` value is compared to the given integer).\n\n#### Init\n\n`__init__(submission_page: bs4.BeautifulSoup = None)`\n\nTo initialise the object, an optional `bs4.BeautifulSoup` object is needed containing the parsed HTML of a submission\npage.\n\nIf no `submission_page` is passed then the object fields will remain at their default - empty - value.\n\n#### Methods\n\n* `url -> str`<br/>\n Property method that returns the Fur Affinity URL to the submission (`https://www.furaffinity.net/view/{id}`).\n* `parse(submission_page: bs4.BeautifulSoup = None)`<br/>\n Parses the stored submission page for metadata. If `submission_page` is passed, it overwrites the\n existing `submission_page` value.\n\n### Comment\n\nThis object class contains comment metadata and is used to build a tree structure with the comments and their replies.\n\n* `id: int` the comment ID\n* `author: UserPartial` the user who posted the comment\n* `date: datetime` the date the comment was posted\n* `text: str` the comment text in HTML format\n* `text_bbcode: str` the comment text in BBCode format\n* `replies: list[Comment]` list of replies to the comment\n* `reply_to: Comment | int | None` the parent comment, if the comment is a reply. The variable type is `int` only if the\n comment is parsed outside the parse method of a `Submission` or `Journal` (e.g. by creating a new comment with a\n comment tag), and when iterating over the parent object (to avoid infinite recursion errors), be it `Submission`\n , `Journal` or another `Comment`.\n* `edited: bool` `True` if the comment was edited, `False` otherwise\n* `hidden: bool` `True` if the comment was hidden, `False` otherwise (if the comment was hidden, the author and date\n fields will default to their empty values)\n* `parent: Submission | Journal | None` the `Submission` or `Journal` object the comments are connected to\n* `comment_tag: bs4.element.Tag` the comment tag used to parse the object fields\n\n`Comment` objects can be directly cast to a dict object and iterated through.\n\nComparison with `Comment` can be made with either another comment (the IDs are compared), or an integer (\nthe `Comment.id` value is compared to the given integer).\n\n*Note:* The `__iter__` method of `Comment` objects automatically removes recursion. The `parent` variable is set\nto `None` and `reply_to` is set to the comment's ID.<br/>\n*Note:* Because each comment contains the parent `Submission` or `Journal` object (which contains the comment itself)\nand the replied comment object, some iterations may cause infinite recursion errors, for example when using\nthe `copy.deepcopy` function. If such iterations are needed, simply set the `parent` variable to `None` and\nthe `reply_to` variable to `None` or the comment's ID (this can be done easily after flattening the comments list\nwith `faapi.comment.flatten_comments`, the comments can then be sorted again with `faapi.comment.sort_comments` which\nwill also restore the `reply_to` values to `Comment` objects).\n\n#### Init\n\n`__init__(self, tag: bs4.element.Tag = None, parent: Submission | Journal = None)`\n\nTo initialise the object, an optional `bs4.element.Tag` object is needed containing the comment tag as taken from a\nsubmission/journal page.\n\nThe optional `parent` argument sets the `parent` variable described above.\n\nIf no `tag` is passed then the object fields will remain at their default - empty - value.\n\n#### Methods\n\n* `url -> str`<br/>\n Property method that returns the Fur Affinity URL to the comment (\n e.g. `https://www.furaffinity.net/view/12345678#cid:1234567890`). If the `parent` variable is `None`, the property\n returns an empty string.\n* `parse(tag: bs4.element.Tag = None)`<br/>\n Parses the stored tag for metadata. If `tag` is passed, it overwrites the existing `tag` value.\n\n#### Extra Functions\n\nThese extra functions can be used to operate on a list of comments. They only alter the order and structure, but they do\nnot touch any of the metadata.\n\n* `faapi.comment.sort_comments(comments: list[Comment]) -> list[Comment]`<br/>\n Sorts a list of comments into a tree structure. Replies are overwritten.\n* `faapi.comment.flatten_comments(comments: list[Comment]) -> list[Comment]`<br/>\n Flattens a list of comments. Replies are not modified.\n\n#### Comment Tree Graphs\n\nUsing the tree structure generated by the library, it is trivial to build a graph visualisation of the comment tree\nusing the [DOT](https://www.graphviz.org/doc/info/lang.html) language.\n\n```python\nsubmission, _ = api.submission(12345678)\ncomments = faapi.comment.flatten_comments(submission.comments)\nwith open(\"comments.dot\", \"w\") as f:\n f.write(\"digraph {\\n\")\n for comment in [c for c in comments if c.reply_to is None]:\n f.write(f\" parent -> {comment.id}\\n\")\n for comment in comments:\n for reply in comment.replies:\n f.write(f\" {comment.id} -> {reply.id}\\n\")\n f.write(\"}\")\n```\n\n```dot\ndigraph {\n parent -> 157990848\n parent -> 157993838\n parent -> 157997294\n 157990848 -> 158014077\n 158014077 -> 158014816\n 158014816 -> 158093180\n 158093180 -> 158097024\n 157993838 -> 157998464\n 157993838 -> 158014126\n 157997294 -> 158014135\n 158014135 -> 158014470\n 158014135 -> 158030074\n 158014470 -> 158093185\n 158030074 -> 158093199\n}\n```\n\n<img alt=\"comments tree graph\" width=\"400\" src=\"https://quickchart.io/graphviz?graph=digraph%7B%0Aparent-%3E157990848%0Aparent-%3E157993838%0Aparent-%3E157997294%0A157990848-%3E158014077%0A158014077-%3E158014816%0A158014816-%3E158093180%0A158093180-%3E158097024%0A157993838-%3E157998464%0A157993838-%3E158014126%0A157997294-%3E158014135%0A158014135-%3E158014470%0A158014135-%3E158030074%0A158014470-%3E158093185%0A158030074-%3E158093199%0A%7D\">\n\n_The graph above was generated with [quickchart.io](https://quickchart.io/documentation/graphviz-api/)_\n\n## BBCode Conversion\n\nUsing the BBCode fields allows to convert between the raw HTMl recovered from Fur Affinity and BBCode tags that follow\nFA's guidelines. Conversion from HTML to BBCode covers all known tags and preserves all newlines and spacing.\n\nBBCode text can be converted to Fur Affinity's HTMl using the `faapi.parse.bbcode_to_html()` function. The majority of\nsubmissions can be converted back and forth between HTML and BBCode without any information loss, however, the parser\nrules are still a work in progress and there are many edge cases where unusual text and formatting cause the parser to\ngenerate incorrect HTML.\n\n## Exceptions\n\nThe following are the exceptions explicitly raised by the FAAPI functions. The exceptions deriving from `ParsingError`\nare chosen depending on the content of the page. Because Fur Affinity doesn't use HTTP status codes besides 404, the\npage is checked against a static list of known error messages/page titles in order to determine the specific error to be\nused. If no match is found, then the `ServerError` (if the page has the \"Server Error\" title) or the more\ngeneral `NoticeMessage` exceptions are used instead. The actual error message parsed from the page is used as argument\nfor the exceptions, so that it can be analysed when caught.\n\n* `DisallowedPath(Exception)` The path is not allowed by the robots.txt.\n* `Unauthorized(Exception)` The user is not logged-in.\n* `ParsingError(Exception)` An error occurred while parsing the page.\n * `NonePage(ParsingError)` The parsed page is `None`.\n * `NotFound(ParsingError)` The resource could not be found (general 404 page or non-existing submission, user, or\n journal).\n * `NoTitle(ParsingError)` The parsed paged is missing a title.\n * `DisabledAccount(ParsingError)` The resource belongs to a disabled account.\n * `ServerError(ParsingError)` The page contains a server error notice.\n * `NoticeMessage(ParsingError)` A notice of unknown type was found in the page.\n\n## Beautiful Soup Warnings\n\nWhen parsing some pages or converting HTML to BBCode, the [Beautiful Soup](https://pypi.org/project/beautifulsoup4/)\nlibrary may give some warnings, for example `MarkupResemblesLocatorWarning`. These warnings are left enabled for\nclarity, but can be disabled manually using the `warnings.filterwarnings` function.\n\n## Contributing\n\nAll contributions and suggestions are welcome!\n\nIf you have suggestions for fixes or improvements, you can open an issue with your idea, see [#Issues](#issues) for\ndetails.\n\n## Issues\n\nIf any problem is encountered during usage of the program, an issue can be opened\non [GitHub](https://github.com/FurryCoders/FAAPI/issues).\n\nIssues can also be used to suggest improvements and features.\n\nWhen opening an issue for a problem, please copy the error message and describe the operation in progress when the error\noccurred.\n",
"bugtrack_url": null,
"license": "EUPL-1.2",
"summary": "Python module to implement API-like functionality for the FurAffinity.net website.",
"version": "3.11.5",
"project_urls": {
"Bug Reports": "https://github.com/FurryCoders/FAAPI/issues",
"Changelog": "https://github.com/FurryCoders/FAAPI/blob/main/CHANGELOG.md",
"Download": "https://pypi.org/project/faapi/#files",
"Homepage": "https://github.com/FurryCoders/FAAPI",
"Repository": "https://github.com/FurryCoders/FAAPI",
"Source": "https://github.com/FurryCoders/FAAPI"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5f5c8b2e29e14e6f9399e7f315836b29f2cc5e7cb9c94b1ca4c131cef8025acf",
"md5": "1501def79edeed50afeb2ca4c9556b91",
"sha256": "7c387fc402d96f6a2b6e4bc860e8458cdc3e9595c8845d33a198c14ebf1ab9bc"
},
"downloads": -1,
"filename": "faapi-3.11.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1501def79edeed50afeb2ca4c9556b91",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 35914,
"upload_time": "2024-08-22T21:47:37",
"upload_time_iso_8601": "2024-08-22T21:47:37.871493Z",
"url": "https://files.pythonhosted.org/packages/5f/5c/8b2e29e14e6f9399e7f315836b29f2cc5e7cb9c94b1ca4c131cef8025acf/faapi-3.11.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3189bc8bcd8548d3bdbcba536cb53bcee163b9c918b1d25499c29fce7d2ec6e3",
"md5": "a7db76b665c884327672ea7ad7ea4e62",
"sha256": "91d4bc1c51ad64dc6e8d3eab58e8fcbf9e984dad5232a1aee8f09c6656db5359"
},
"downloads": -1,
"filename": "faapi-3.11.5.tar.gz",
"has_sig": false,
"md5_digest": "a7db76b665c884327672ea7ad7ea4e62",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 46840,
"upload_time": "2024-08-22T21:47:39",
"upload_time_iso_8601": "2024-08-22T21:47:39.171561Z",
"url": "https://files.pythonhosted.org/packages/31/89/bc8bcd8548d3bdbcba536cb53bcee163b9c918b1d25499c29fce7d2ec6e3/faapi-3.11.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 21:47:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FurryCoders",
"github_project": "FAAPI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "faapi"
}
JSON
