Merge pull request #37 from b3yc0d3/feature/ai-filter

AI generated content can now be excluded from the search, by setting the ``exclude_ai`` parameter to **True** at the `rule34Py.search` method.

Author: b3yc0d3

CHANGELOG.md

@@ -6,16 +6,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
-## [unreleased] - 2025-08-24
+## [unreleased] - 2025-08-30
 
 ### Added
- - Added a `rule34.autocomplete` method.
+ - Added a `rule34Py.autocomplete` method.
  - Added `AutocompleteTag` class.
+ - Added parameter to `rule34Py.search` method for excluding ai generated content.
+ 	- Added unit test
 
 ### Changed
  - Updated API wrapper to support website’s new authentication system.
  - The underlying website API now **requires authentication** (`api_key` and `user_id`) for all requests.
- - Updated unit tests
+ - Updated unit tests.
 
 ## [3.0.0] - 2025-06-09
 

rule34Py/rule34.py

@@ -146,7 +146,9 @@ def _get(self, *args, **kwargs) -> requests.Response:
 
         # check if api credentials are set
         if is_api_request and self.user_id == None and self.api_key == None:
-            raise ValueError("API credentials must be supplied, api_key and user_id can not be None!\nSee https://api.rule34.xxx/ for more information.")
+            raise ValueError(
+                "API credentials must be supplied, api_key and user_id can not be None!\nSee https://api.rule34.xxx/ for more information."
+            )
 
         # headers
         kwargs.setdefault("headers", {})
@@ -361,13 +363,16 @@ def random_post_id(self) -> int:
     def search(
         self,
         tags: list[str] = [],
+        exclude_ai: bool = False,
         page_id: Union[int, None] = None,
         limit: int = SEARCH_RESULT_MAX,
     ) -> list[Post]:
         """Search for posts.
 
         Args:
             tags: A list of tags to search for.
+            exclude_ai: Exclude ai generated content from the results.
+                Default is False.
             page_id: The search page number to request, or None.
                 If None, search will eventually return all pages.
             limit: The maximum number of post results to return per page.
@@ -386,6 +391,12 @@ def search(
         if limit < 0 or limit > SEARCH_RESULT_MAX:
             raise ValueError(f"Search limit must be between 0 and {SEARCH_RESULT_MAX}.")
 
+        # exclude all tags starting with ai if user whishes so
+        if exclude_ai == True:
+            # filter out any ai tag
+            tags = [tag for tag in tags if not tag.lower().startswith("ai")]
+            tags.append("-ai*")
+
         params = [
             ["TAGS", "+".join(tags)],
             ["LIMIT", str(limit)],

tests/fixtures/mock34/responses.yml

@@ -207,6 +207,17 @@ def test_rule34Py_search(rule34):
     with pytest.raises(ValueError):
         rule34.search([], limit=SEARCH_RESULT_MAX + 1)
 
+def test_rule34Py_search_exclude_ai(rule34):
+    """The client can search for posts by tags, with excluding ai generated content."""
+    # search by single tag
+    results1 = rule34.search(["neko"], exclude_ai=True)
+    ids1 = [post.id for post in results1]
+    print(f"ids1={ids1[:10]}...")
+    assert isinstance(results1, list)  # return type is list
+    
+    assert len(results1) == SEARCH_RESULT_MAX
+    assert isinstance(results1[0], Post)  # return list contains Post objects
+
 
 def test_rule34Py_tag_map(rule34):
     """The client tag_map() method should return a map of tags.