browserfetch 0.9.0__tar.gz → 0.10.1__tar.gz

{browserfetch-0.9.0 → browserfetch-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: browserfetch
-Version: 0.9.0
+Version: 0.10.1
 Summary: fetch in Python using your browser! 
 Keywords: browser,fetch,python,cookies
 Requires-Python: >=3.11
@@ -8,6 +8,7 @@ Description-Content-Type: text/x-rst
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Requires-Dist: aiohttp
 Requires-Dist: pyperclip
+Requires-Dist: cyclopts
 Project-URL: Homepage, https://github.com/5j9/browserfetch
 
 Fetch using your browser.

{browserfetch-0.9.0 → browserfetch-0.10.1}/browserfetch/__init__.py

@@ -1,5 +1,13 @@
-__version__ = '0.9.0'
-
+__version__ = '0.10.1'
+__all__ = [
+    'BrowserError',
+    'evaluate',
+    'fetch',
+    'get',
+    'post',
+    'Response',
+    'start_server',
+]
 import atexit
 from asyncio import (
     AbstractEventLoop,
@@ -11,20 +19,27 @@ from asyncio import (
 )
 from collections import defaultdict
 from dataclasses import dataclass
+from html import escape
 from json import dumps, loads
 from logging import getLogger
-from typing import Any
-from urllib.parse import urlencode
+from urllib.parse import parse_qsl, urlencode, urlparse, urlunparse
 
 from aiohttp import ClientSession, ClientWebSocketResponse
-from aiohttp.web import Application, RouteTableDef, WebSocketResponse
+from aiohttp.web import (
+    Application,
+    Request,
+    Response as _Response,
+    RouteTableDef,
+    WebSocketResponse,
+)
 from aiohttp.web_runner import AppRunner, TCPSite
 
 logger = getLogger(__name__)
 # maps host to its host_ready event or its websocket
-hosts: dict[str, Event | WebSocketResponse | ClientWebSocketResponse] = (
-    defaultdict(Event)
-)
+hosts: defaultdict[
+    str, Event | WebSocketResponse | ClientWebSocketResponse
+] = defaultdict(Event)
+
 # maps response event id to its response event or response dict
 responses: dict[int, Event | dict] = {}
 
@@ -81,12 +96,15 @@ async def _request(
     if body is not None:
         bytes_ += b'\0' + body
 
-    ws = hosts[host]
-    if isinstance(ws, Event):
-        await ws.wait()
-        ws = hosts[host]
-
-    await ws.send_bytes(bytes_)
+    value = hosts[host]
+    match value:
+        case Event():
+            # wait for the Event to be turned into a websocket response
+            await value.wait()
+            ws = hosts[host]
+            await ws.send_bytes(bytes_)  # type: ignore
+        case WebSocketResponse() | ClientWebSocketResponse():
+            await value.send_bytes(bytes_)
 
     try:
         await wait_for(response_ready.wait(), data['timeout'])
@@ -94,7 +112,8 @@ async def _request(
         responses.pop(event_id, None)
         raise
 
-    return responses.pop(event_id)
+    # this must return a dict at this point, not an Event
+    return responses.pop(event_id)  # type: ignore
 
 
 async def receive_responses(ws: WebSocketResponse | ClientWebSocketResponse):
@@ -105,15 +124,17 @@ async def receive_responses(ws: WebSocketResponse | ClientWebSocketResponse):
         j['body'] = body
         event_id = j.pop('event_id')
         try:
-            event = responses[event_id]
+            # We expect only one response to be recieved for each event,
+            # therefore this must be an Event, not a dict.
+            response_ready: Event = responses[event_id]  # type: ignore
         except KeyError:  # lock has reached timeout already
             continue
         responses[event_id] = j
-        event.set()
+        response_ready.set()
 
 
 routes = RouteTableDef()
-PROTOCOL = '2'
+PROTOCOL = '3'
 
 
 @routes.get('/ws')
@@ -121,10 +142,10 @@ async def _(request):
     ws = WebSocketResponse()
     await ws.prepare(request)
 
-    host, _, version = (await ws.receive_str()).partition(' ')
-    assert (
-        version == PROTOCOL
-    ), f'JavaScript protocol version: {version}, expected: {PROTOCOL}'
+    version, _, host = (await ws.receive_str()).partition(' ')
+    assert version == PROTOCOL, (
+        f'JavaScript protocol version: {version}, expected: {PROTOCOL}'
+    )
     logger.info('registering host %s', host)
 
     ws_or_e = hosts[host]
@@ -135,13 +156,13 @@ async def _(request):
     try:
         await receive_responses(ws)
     except TypeError:
-        logger.info('host WebSocket was closed')
+        logger.info('WebSocket was closed by browser')
         hosts[host] = Event()
     return ws
 
 
 @routes.get('/relay')
-async def _(request):
+async def _(request: Request) -> WebSocketResponse:
     ws = WebSocketResponse()
     await ws.prepare(request)
 
@@ -149,13 +170,15 @@ async def _(request):
         try:
             bytes_ = await ws.receive_bytes()
         except TypeError:  # ws closed
-            return
+            return ws
         data, null, body = bytes_.partition(b'\0')
         data = loads(data)
         relay_event_id = data['event_id']
 
         try:
-            r = await _request(data.pop('host'), data, body if null else None)
+            r: dict = await _request(
+                data.pop('host'), data, body if null else None
+            )
         except TimeoutError:
             r = {'error': 'TimeoutError in relay'}
 
@@ -164,6 +187,22 @@ async def _(request):
         await ws.send_bytes(dumps(r).encode() + b'\0' + body)
 
 
+@routes.get('/')
+async def _(_) -> _Response:
+    hosts_html = '\n'.join(
+        [f'<li>{k}: {escape(str(v))}</li>' for k, v in hosts.items()]
+    )
+    responses_html = '\n'.join(
+        [f'<li>{k}: {escape(str(v))}</li>' for k, v in responses.items()]
+    )
+    return _Response(
+        body='<meta charset="utf-8">\n<title>browserfetch</title>\n'
+        f'Hosts:\n{hosts_html}\n'
+        f'Responses:\n{responses_html}',
+        content_type='text/html',
+    )
+
+
 async def relay_client(server_host, server_port):
     async with ClientSession() as session:
         relay_url = f'ws://{server_host}:{server_port}/relay'
@@ -221,7 +260,14 @@ async def fetch(
     :return: a dict of response values.
     """
     if params is not None:
-        url += urlencode(params)
+        parsed_url = urlparse(url)
+        url = urlunparse(
+            parsed_url._replace(
+                query=urlencode(
+                    parse_qsl(parsed_url.query) + [*params.items()]
+                )
+            )
+        )
 
     d = await _request(
         host,
@@ -261,14 +307,14 @@ async def post(
     url: str,
     *,
     params: dict | None = None,
-    data: bytes | dict | str | None = None,
+    data=None,
     form: dict | None = None,
     timeout: int | float = 95,
     options: dict | None = None,
     host: str | None = None,
 ) -> Response:
     if options is None:
-        options: dict[str, Any] = {'method': 'POST'}
+        options = {'method': 'POST'}
     else:
         options['method'] = 'POST'
 
@@ -281,12 +327,12 @@ async def post(
             body = dumps(data).encode()
             headers = options.setdefault('headers', {})
             headers['Content-Type'] = 'application/json'
-
-    if form is not None:
-        assert data is None
+    elif form is not None:
         body = urlencode(form).encode()
         headers = options.setdefault('headers', {})
         headers['Content-Type'] = 'application/x-www-form-urlencoded'
+    else:
+        body = None
 
     return await fetch(
         url,

browserfetch-0.10.1/browserfetch/__main__.py

@@ -0,0 +1,36 @@
+from pathlib import Path
+
+
+def read_js(host_name_generator: str | None):
+    js = (Path(__file__).parent / 'browserfetch.js').read_bytes().decode()
+    if host_name_generator is not None:
+        return js.replace(
+            'async function generateHostName() { return location.host };',
+            host_name_generator,
+            1,
+        )
+    return js
+
+
+def copyjs(*, host_name_generator: str | None = None):
+    """Copy contents of browserfetch.js to clipboard.
+
+    `host_name_generator` should be a string containing
+    an async JavaScript function named `generateHostName()`. This file's
+    contents will be copied into the generated js script and will be used
+    to generate a host name for connections. The default
+    `generateHostName` function returns `location.host`.
+    """
+    from pyperclip import copy
+
+    copy(read_js(host_name_generator))
+
+
+if __name__ == '__main__':
+    from cyclopts import App
+
+    from browserfetch import __version__
+
+    app = App(version=__version__)
+    app.command(copyjs)
+    app()

{browserfetch-0.9.0 → browserfetch-0.10.1}/browserfetch/browserfetch.js

@@ -5,7 +5,7 @@
 // @grant       GM_registerMenuCommand
 // ==/UserScript==
 // @ts-check
-(() => {
+(async () => {
     /**
      * @param {Uint8Array | null} body 
      * @param {Object} req
@@ -93,13 +93,19 @@
         return [blob, JSON.parse(new TextDecoder().decode(jArray))]
     }
 
+    async function generateHostName() { return location.host };
+    var hostName;
+
     function connect() {
-        var protocol = '2'
+        var protocol = '3'
         var ws = new WebSocket("ws://127.0.0.1:9404/ws");
         ws.binaryType = "arraybuffer";
 
-        ws.onopen = () => {
-            ws.send(location.host + ' ' + protocol);
+        ws.onopen = async () => {
+            if (!hostName) {
+                hostName = await generateHostName();
+            }
+            ws.send(protocol + ' ' + hostName);
         }
 
         ws.onclose = () => {

{browserfetch-0.9.0 → browserfetch-0.10.1}/pyproject.toml

@@ -1,40 +1,42 @@
-[build-system]
-requires = ['flit_core >=3.2,<4']
-build-backend = 'flit_core.buildapi'
-
-[project]
-name = "browserfetch"
-description = "fetch in Python using your browser! "
-keywords = ["browser", "fetch", "python", "cookies"]
-classifiers = [
-    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
-]
-requires-python = ">=3.11"
-dynamic = ["version"]
-dependencies = [
-    "aiohttp",
-    "pyperclip",
-]
-
-[[authors]]
-name = "5j9"
-email = "5j9@users.noreply.github.com"
-
-[project.license]
-text = "GNU General Public License v3 (GPLv3)"
-
-[project.readme]
-file = "README.rst"
-content-type = "text/x-rst"
-
-[project.urls]
-Homepage = "https://github.com/5j9/browserfetch"
-
-[tool.ruff]
+[build-system]
+requires = ['flit_core >=3.2,<4']
+build-backend = 'flit_core.buildapi'
+
+[project]
+name = "browserfetch"
+description = "fetch in Python using your browser! "
+keywords = ["browser", "fetch", "python", "cookies"]
+classifiers = [
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+]
+requires-python = ">=3.11"
+dynamic = ["version"]
+dependencies = [
+    "aiohttp",
+    "pyperclip",
+    "cyclopts",
+]
+
+[[authors]]
+name = "5j9"
+email = "5j9@users.noreply.github.com"
+
+[project.license]
+text = "GNU General Public License v3 (GPLv3)"
+
+[project.readme]
+file = "README.rst"
+content-type = "text/x-rst"
+
+[project.urls]
+Homepage = "https://github.com/5j9/browserfetch"
+
+[tool.ruff]
 line-length = 79
 format.quote-style = 'single'
 lint.isort.combine-as-imports = true
 lint.extend-select = [
+    'W605', # invalid-escape-sequence
     'FA',  # flake8-future-annotations
     'I',  # isort
     'UP',  # pyupgrade
@@ -54,3 +56,7 @@ reportUnnecessaryCast = "warning"
 reportUnnecessaryContains = "warning"
 reportUnnecessaryIsInstance = "warning"
 reportUnnecessaryTypeIgnoreComment = true
+reportInvalidStringEscapeSequence = false
+reportConstantRedefinition = 'error'
+reportTypeCommentUsage = 'warning'
+reportUnnecessaryComparison = 'warning'

browserfetch-0.10.1/tests/test_init.py

@@ -0,0 +1,25 @@
+from contextlib import suppress
+from unittest.mock import Mock, patch
+
+from browserfetch import fetch
+
+request_mock = Mock()
+
+
+@patch('browserfetch._request', new=request_mock)
+async def test_params():
+    with suppress(TypeError):
+        await fetch(
+            url='http://stackoverflow.com/search?q=question',
+            params={'lang': 'en', 'tag': 'python', 'q': True},
+        )
+    request_mock.assert_called_once_with(
+        None,  # host
+        {
+            'action': 'fetch',
+            'url': 'http://stackoverflow.com/search?q=question&lang=en&tag=python&q=True',
+            'options': None,
+            'timeout': 95,
+        },  # data
+        None,  # body
+    )

browserfetch-0.9.0/browserfetch/__main__.py

@@ -1,24 +0,0 @@
-from argparse import ArgumentDefaultsHelpFormatter, ArgumentParser
-from pathlib import Path
-
-from pyperclip import copy
-
-
-def main():
-    parser = ArgumentParser(
-        description='The command-line entry for browserfetch.',
-        formatter_class=ArgumentDefaultsHelpFormatter,
-    )
-
-    parser.add_argument(
-        'copyjs', help='copy contents of browserfetch.js to clipboard'
-    )
-    args = parser.parse_args()
-
-    if args.copyjs:
-        with (Path(__file__).parent / 'browserfetch.js').open() as f:
-            copy(f.read())
-
-
-if __name__ == '__main__':
-    main()