parsek-cdp 0.1.0__tar.gz

parsek_cdp-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

parsek_cdp-0.1.0/PKG-INFO

@@ -0,0 +1,277 @@
+Metadata-Version: 2.4
+Name: parsek-cdp
+Version: 0.1.0
+Summary: Chrome DevTools Protocol client — generated protocol layer + async runtime (client scope).
+Author: xa1era
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/xa1era/parsek-cdp
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: websockets>=12
+Provides-Extra: server
+Requires-Dist: parsek-cdp-server~=0.1.0; extra == "server"
+Dynamic: license-file
+
+# parsek-cdp
+
+An async [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/)
+client for driving Chromium-based browsers from Python.
+
+The protocol layer (`cdp/`) is **fully generated** from the official
+[devtools-protocol](https://github.com/ChromeDevTools/devtools-protocol) JSON
+definitions — one typed module per domain. The runtime (`core/`) is
+hand-written: one websocket per target, typed command calls, event handlers and
+an opt-in feature system. No `sessionId` multiplexing — every target (browser,
+page, worker, OOPIF) gets its own connection.
+
+Requires **Python 3.12+** (the API uses PEP 695 generics) and a running
+Chromium/Chrome with remote debugging enabled.
+
+```bash
+pip install parsek-cdp
+```
+
+> Документация на русском: [README.ru.md](README.ru.md).
+
+## Quickstart
+
+Start a browser with remote debugging:
+
+```bash
+chromium --headless=new --remote-debugging-port=9222
+```
+
+Then drive it:
+
+```python
+import asyncio
+from parsek_cdp import Browser, Page, RequestListener
+
+
+async def main():
+    # `page_class` types every page in this browser as Page[RequestListener].
+    browser = await Browser.connect_http(
+        "http://127.0.0.1:9222", page_class=Page[RequestListener]
+    )
+
+    page = await browser.new_page()
+    requests = page.get_feature(RequestListener)
+
+    await page.navigate("https://example.com", wait_load=True)
+
+    for r in requests.requests:
+        status = r.response.status_code if r.response else "(pending)"
+        print(r.method, r.url, "->", status)
+
+    await browser.close()
+
+
+asyncio.run(main())
+```
+
+## Concepts
+
+### Targets and connections
+
+A `Target` *is* a single CDP session on its own websocket. `Browser`, `Page`,
+workers and out-of-process iframes are all targets. The DevTools host is bound
+once (in a `contextvar`) when the browser is reached, so it is not threaded
+through every call.
+
+The full command surface is reached through `target.cdp`, one attribute per CDP
+domain, with typed methods and results:
+
+```python
+await page.cdp.Network.enable()
+info = await page.cdp.Target.get_target_info()
+```
+
+Domains enable/disable themselves on use, and `domain_enabled` scopes a domain
+to a block:
+
+```python
+async with page.domain_enabled(page.cdp.Page):
+    await page.cdp.Page.navigate(url="https://example.com")
+```
+
+### Events
+
+Register handlers on a specific target, or globally on the event class:
+
+```python
+from parsek_cdp.cdp import Network
+
+# per-target
+page.on(Network.RequestWillBeSent, lambda e: print(e.request.url))
+
+# globally, for every target
+@Network.RequestWillBeSent.add_handler
+async def on_request(e):
+    print(e.request.url)
+
+# await a single event
+loaded = await page.wait_for(Network.ResponseReceived, timeout=10)
+```
+
+Handlers may be sync or async; one failing handler never tears down the
+connection or stops the others.
+
+### Pages, frames and elements
+
+A `Page` *is its own main frame*, so frame methods work on the top frame
+directly:
+
+```python
+el = await page.select(selector="h1")      # query the main frame
+print(el.text)
+await el.fill("hello")
+await el.mouse_click()
+
+title = await page.evaluate("document.title")
+```
+
+The full frame tree (subframes, cross-origin OOPIFs — each transparently routed
+through its own session) lives on `page.frames`. `page.with_same_navigation()`
+guards a block against a main-frame navigation cutting it short.
+
+### Browser contexts
+
+Pages are grouped into browser contexts (incognito-like profiles). The default
+context holds pages created without an explicit one:
+
+```python
+context = await browser.create_context()        # isolated profile
+page = await context.new_page("https://example.com")
+```
+
+## Features
+
+A `Page` attaches **no** behaviour by default. A *feature* is a unit of
+behaviour you opt into, either declaratively or imperatively:
+
+```python
+from parsek_cdp import Page, RequestListener
+
+Page[RequestListener]                 # declarative — typed page class
+page.get_feature(RequestListener)     # imperative — attached on first use, typed
+```
+
+The key idea: a feature is written **once** and runs in three roles —
+
+- **local** — direct to the browser: the producers subscribe to raw CDP on the
+  page and reduce it in-process (a plain local `Page`);
+- **server** — the proxy feeds raw CDP to the producers, whose output is emitted
+  to the client as a `Parsek.*` event *and* reduced locally for snapshots;
+- **client** — only the reducers run, fed by those `Parsek.*` events off the wire.
+
+Conceptually that is two *sides* — a *producer* of `Parsek.*` events and a *view*
+of them — but the producer side exists both in-process (`local`) and over the
+wire (`server`). The reducers run in every role, so the feature's public API is
+identical whether the browser is local or behind a `parsek-cdp-server` proxy.
+
+### Writing a custom feature — domain-like structure
+
+A feature mirrors the layout of a generated CDP domain (`cdp/<domain>/` =
+*types · functions · events*). Give it its own package with the same three
+files, so the feature class doubles as its own namespace:
+
+```
+features/<feature>/
+  types.py       # wire dataclasses + view types  (@parsek_type)
+  events.py      # aggregated Parsek.* events       (@register_event)
+  __init__.py    # the Feature class itself: domains + @on/@emit handlers
+```
+
+The building blocks (all from `parsek_cdp.core.feature`):
+
+| Block | Where | What |
+| --- | --- | --- |
+| `domains = (Network, ...)` | feature class | CDP domains the feature owns — auto-enabled, and their raw events are suppressed from client passthrough |
+| `@on(Event)` | method | register a handler. A **CDP** event makes it a *producer* (runs server/local); a **`Parsek.*`** event makes it a *reducer* (runs in every role) |
+| `@emit(ParsekEvent)` | producer method | its return value is published to the client **and** reduced locally — so state is built by the same code path everywhere |
+| `@parsek_type("Parsek.<Feature>.<Type>")` | `types.py` | declare a wire dataclass; `__FIELDS__` are derived from annotations (snake_case ↔ camelCase) |
+| `@register_event("Parsek.<Feature>.<event>")` | `events.py` | declare an aggregated event class |
+| `snapshot()` | feature class | state handed to a late-joining client (the server may replay it on connect) |
+| `attach_namespace(Feat, types, events)` | end of `__init__.py` | expose the types/events as attributes on the feature class (`Feat.RequestData`, `Feat.RequestSent`, ...) |
+
+Sketch — a producer that folds a raw CDP burst into one `Parsek.*` event, plus
+the reducer that rebuilds state from it:
+
+```python
+# events.py
+@register_event("Parsek.MyFeature.thing")
+@dataclass
+class ThingHappened(Event):
+    payload: ThingData
+    __FIELDS__ = (FieldMeta("payload", "payload", False, "object",
+                            ref="Parsek.MyFeature.ThingData"),)
+
+# __init__.py
+class MyFeature(Feature):
+    domains = (SomeDomain,)                 # owned + auto-enabled
+
+    @on(SomeDomain.SomethingRaw)            # CDP event -> producer
+    @emit(ThingHappened)                    # return is sent to client + reduced
+    def _produce(self, e) -> ThingHappened:
+        return ThingHappened(payload=ThingData(...))
+
+    @on(ThingHappened)                      # Parsek event -> reducer (both roles)
+    def _reduce(self, e: ThingHappened) -> None:
+        self._things.append(e.payload)
+
+    @property
+    def things(self):                       # the ergonomic public API
+        return list(self._things)
+
+attach_namespace(MyFeature, _types, _events)
+```
+
+`RequestListener` (below) is the reference implementation of exactly this shape.
+
+### `RequestListener`
+
+The built-in feature: aggregated network observation. It records every request
+of the current document with its response, headers and timing:
+
+```python
+requests = page.get_feature(RequestListener)
+await page.navigate("https://example.com", wait_load=True)
+
+# all requests of the current document
+for r in requests.requests:
+    print(r.method, r.url, r.response.status_code)
+
+# find / await a specific one (substring or compiled regex against the URL)
+r = await requests.wait_for_response("/api/orders", timeout=30, load_body=True)
+print(r.response.status_code, await r.response.body())
+```
+
+By default the log is cleared on main-frame navigation (like DevTools with
+*Preserve log* off); pass `preserve_log=True` to keep it across documents.
+
+## Remote browsers (with `parsek-cdp-server`)
+
+Install the optional server distribution to launch and supervise browsers
+behind a proxy:
+
+```bash
+pip install parsek-cdp[server]
+```
+
+Then connect to a running server instead of a local Chrome — the API is
+identical, and the declared features are aggregated server-side:
+
+```python
+browser = await Browser[Page[RequestListener]].get_distant_browser(
+    "http://127.0.0.1:9333", headless=True
+)
+page = await browser.new_page("https://example.com")
+```
+
+See the [`parsek-cdp-server`](https://github.com/xa1era/parsek-cdp) package for
+running the server, lifecycle supervision, metrics and the zombie reaper.
+
+## License
+
+Apache-2.0.