Add NSFW Check Support to Wrapper

Author: proguy914629bot

examples/async/nsfw_check.py

@@ -0,0 +1,12 @@
+from openrobot.api_wrapper import AsyncClient
+
+client = AsyncClient(...)
+
+nsfw_check = await client.nsfw_check("<Insert URL>")
+
+for label in nsfw_check.labels:
+    label.name # ...
+    label.parent_name # ...
+    label.confidence # 0 - 100
+
+nsfw_check.score # 0 - 1

examples/sync/nsfw_check.py

@@ -0,0 +1,12 @@
+from openrobot.api_wrapper import AsyncClient
+
+client = SyncClient(...)
+
+nsfw_check = client.nsfw_check("<Insert URL>")
+
+for label in nsfw_check.labels:
+    label.name # ...
+    label.parent_name # ...
+    label.confidence # 0 - 100
+
+nsfw_check.score # 0 - 1

openrobot/api_wrapper/__init__.py

@@ -3,4 +3,4 @@
 from .error import *
 from .results import *
 
-__version__ = '0.1.0'
+__version__ = '0.2.0'

openrobot/api_wrapper/_async.py

@@ -85,6 +85,10 @@ async def lyrics(self, query: str) -> LyricResult:
         js = await self._request('GET', f'/api/lyrics/{quote(query)}')
         return LyricResult(js)
 
+    async def nsfw_check(self, url: str) -> NSFWCheckResult:
+        js = await self._request('GET', '/api/nsfw-check', params={'url': url})
+        return NSFWCheckResult(js)
+
     async def celebrity(self, url: str) -> typing.List[CelebrityResult]:
         js = await self._request('GET', '/api/celebrity', params={'url': url})
         return [CelebrityResult(data) for data in js]

openrobot/api_wrapper/_sync.py

@@ -77,12 +77,16 @@ def _request(self, method: str, url: str, **kwargs):
 
                 raise cls
 
-        # Methods to query to API:
+    # Methods to query to API:
 
     def lyrics(self, query: str) -> LyricResult:
         js = self._request('GET', f'/api/lyrics/{quote(query)}')
         return LyricResult(js)
 
+    def nsfw_check(self, url: str) -> NSFWCheckResult:
+        js = self._request('GET', '/api/nsfw-check', params={'url': url})
+        return NSFWCheckResult(js)
+
     def celebrity(self, url: str) -> typing.List[CelebrityResult]:
         js = self._request('GET', '/api/celebrity', params={'url': url})
         return [CelebrityResult(data) for data in js]

openrobot/api_wrapper/results.py

@@ -14,6 +14,21 @@ def __init__(self, js):
         self.artist = js['artist']
         self.lyrics = js['lyrics']
 
+class NSFWCheckResult(OpenRobotAPIBaseResult):
+    """The result of the /api/nsfw-check endpoint."""
+    def __init__(self, js):
+        super().__init__(js)
+
+        self.labels: typing.List[self.Label] = [self.Label(x) for x in js['labels']]
+        self.score: int = js['nsfw_score']
+
+    class Label:
+        """NSFW Label."""
+        def __init__(self, js):
+            self.confidence: int = js['Confidence']
+            self.parent_name: str = js['ParentName']
+            self.name: str = js['Name']
+
 class CelebrityResult(OpenRobotAPIBaseResult):
     """The result of the /api/celebrity endpoint."""
     def __init__(self, js):