mithwire 0.50.3__py3-none-any.whl

mithwire/cdp/profiler.py

@@ -0,0 +1,420 @@
+# DO NOT EDIT THIS FILE!
+#
+# This file is generated from the CDP specification. If you need to make
+# changes, edit the generator and regenerate all of the modules.
+#
+# CDP domain: Profiler
+
+from __future__ import annotations
+import enum
+import typing
+from dataclasses import dataclass
+from .util import event_class, T_JSON_DICT
+
+from . import debugger
+from . import runtime
+
+
+@dataclass
+class ProfileNode:
+    '''
+    Profile node. Holds callsite information, execution statistics and child nodes.
+    '''
+    #: Unique id of the node.
+    id_: int
+
+    #: Function location.
+    call_frame: runtime.CallFrame
+
+    #: Number of samples where this node was on top of the call stack.
+    hit_count: typing.Optional[int] = None
+
+    #: Child node ids.
+    children: typing.Optional[typing.List[int]] = None
+
+    #: The reason of being not optimized. The function may be deoptimized or marked as don't
+    #: optimize.
+    deopt_reason: typing.Optional[str] = None
+
+    #: An array of source position ticks.
+    position_ticks: typing.Optional[typing.List[PositionTickInfo]] = None
+
+    def to_json(self) -> T_JSON_DICT:
+        json: T_JSON_DICT = dict()
+        json['id'] = self.id_
+        json['callFrame'] = self.call_frame.to_json()
+        if self.hit_count is not None:
+            json['hitCount'] = self.hit_count
+        if self.children is not None:
+            json['children'] = [i for i in self.children]
+        if self.deopt_reason is not None:
+            json['deoptReason'] = self.deopt_reason
+        if self.position_ticks is not None:
+            json['positionTicks'] = [i.to_json() for i in self.position_ticks]
+        return json
+
+    @classmethod
+    def from_json(cls, json: T_JSON_DICT) -> ProfileNode:
+        return cls(
+            id_=int(json['id']),
+            call_frame=runtime.CallFrame.from_json(json['callFrame']),
+            hit_count=int(json['hitCount']) if json.get('hitCount', None) is not None else None,
+            children=[int(i) for i in json['children']] if json.get('children', None) is not None else None,
+            deopt_reason=str(json['deoptReason']) if json.get('deoptReason', None) is not None else None,
+            position_ticks=[PositionTickInfo.from_json(i) for i in json['positionTicks']] if json.get('positionTicks', None) is not None else None,
+        )
+
+
+@dataclass
+class Profile:
+    '''
+    Profile.
+    '''
+    #: The list of profile nodes. First item is the root node.
+    nodes: typing.List[ProfileNode]
+
+    #: Profiling start timestamp in microseconds.
+    start_time: float
+
+    #: Profiling end timestamp in microseconds.
+    end_time: float
+
+    #: Ids of samples top nodes.
+    samples: typing.Optional[typing.List[int]] = None
+
+    #: Time intervals between adjacent samples in microseconds. The first delta is relative to the
+    #: profile startTime.
+    time_deltas: typing.Optional[typing.List[int]] = None
+
+    def to_json(self) -> T_JSON_DICT:
+        json: T_JSON_DICT = dict()
+        json['nodes'] = [i.to_json() for i in self.nodes]
+        json['startTime'] = self.start_time
+        json['endTime'] = self.end_time
+        if self.samples is not None:
+            json['samples'] = [i for i in self.samples]
+        if self.time_deltas is not None:
+            json['timeDeltas'] = [i for i in self.time_deltas]
+        return json
+
+    @classmethod
+    def from_json(cls, json: T_JSON_DICT) -> Profile:
+        return cls(
+            nodes=[ProfileNode.from_json(i) for i in json['nodes']],
+            start_time=float(json['startTime']),
+            end_time=float(json['endTime']),
+            samples=[int(i) for i in json['samples']] if json.get('samples', None) is not None else None,
+            time_deltas=[int(i) for i in json['timeDeltas']] if json.get('timeDeltas', None) is not None else None,
+        )
+
+
+@dataclass
+class PositionTickInfo:
+    '''
+    Specifies a number of samples attributed to a certain source position.
+    '''
+    #: Source line number (1-based).
+    line: int
+
+    #: Number of samples attributed to the source line.
+    ticks: int
+
+    def to_json(self) -> T_JSON_DICT:
+        json: T_JSON_DICT = dict()
+        json['line'] = self.line
+        json['ticks'] = self.ticks
+        return json
+
+    @classmethod
+    def from_json(cls, json: T_JSON_DICT) -> PositionTickInfo:
+        return cls(
+            line=int(json['line']),
+            ticks=int(json['ticks']),
+        )
+
+
+@dataclass
+class CoverageRange:
+    '''
+    Coverage data for a source range.
+    '''
+    #: JavaScript script source offset for the range start.
+    start_offset: int
+
+    #: JavaScript script source offset for the range end.
+    end_offset: int
+
+    #: Collected execution count of the source range.
+    count: int
+
+    def to_json(self) -> T_JSON_DICT:
+        json: T_JSON_DICT = dict()
+        json['startOffset'] = self.start_offset
+        json['endOffset'] = self.end_offset
+        json['count'] = self.count
+        return json
+
+    @classmethod
+    def from_json(cls, json: T_JSON_DICT) -> CoverageRange:
+        return cls(
+            start_offset=int(json['startOffset']),
+            end_offset=int(json['endOffset']),
+            count=int(json['count']),
+        )
+
+
+@dataclass
+class FunctionCoverage:
+    '''
+    Coverage data for a JavaScript function.
+    '''
+    #: JavaScript function name.
+    function_name: str
+
+    #: Source ranges inside the function with coverage data.
+    ranges: typing.List[CoverageRange]
+
+    #: Whether coverage data for this function has block granularity.
+    is_block_coverage: bool
+
+    def to_json(self) -> T_JSON_DICT:
+        json: T_JSON_DICT = dict()
+        json['functionName'] = self.function_name
+        json['ranges'] = [i.to_json() for i in self.ranges]
+        json['isBlockCoverage'] = self.is_block_coverage
+        return json
+
+    @classmethod
+    def from_json(cls, json: T_JSON_DICT) -> FunctionCoverage:
+        return cls(
+            function_name=str(json['functionName']),
+            ranges=[CoverageRange.from_json(i) for i in json['ranges']],
+            is_block_coverage=bool(json['isBlockCoverage']),
+        )
+
+
+@dataclass
+class ScriptCoverage:
+    '''
+    Coverage data for a JavaScript script.
+    '''
+    #: JavaScript script id.
+    script_id: runtime.ScriptId
+
+    #: JavaScript script name or url.
+    url: str
+
+    #: Functions contained in the script that has coverage data.
+    functions: typing.List[FunctionCoverage]
+
+    def to_json(self) -> T_JSON_DICT:
+        json: T_JSON_DICT = dict()
+        json['scriptId'] = self.script_id.to_json()
+        json['url'] = self.url
+        json['functions'] = [i.to_json() for i in self.functions]
+        return json
+
+    @classmethod
+    def from_json(cls, json: T_JSON_DICT) -> ScriptCoverage:
+        return cls(
+            script_id=runtime.ScriptId.from_json(json['scriptId']),
+            url=str(json['url']),
+            functions=[FunctionCoverage.from_json(i) for i in json['functions']],
+        )
+
+
+def disable() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
+
+    cmd_dict: T_JSON_DICT = {
+        'method': 'Profiler.disable',
+    }
+    json = yield cmd_dict
+
+
+def enable() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
+
+    cmd_dict: T_JSON_DICT = {
+        'method': 'Profiler.enable',
+    }
+    json = yield cmd_dict
+
+
+def get_best_effort_coverage() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List[ScriptCoverage]]:
+    '''
+    Collect coverage data for the current isolate. The coverage data may be incomplete due to
+    garbage collection.
+
+    :returns: Coverage data for the current isolate.
+    '''
+    cmd_dict: T_JSON_DICT = {
+        'method': 'Profiler.getBestEffortCoverage',
+    }
+    json = yield cmd_dict
+    return [ScriptCoverage.from_json(i) for i in json['result']]
+
+
+def set_sampling_interval(
+        interval: int
+    ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
+    '''
+    Changes CPU profiler sampling interval. Must be called before CPU profiles recording started.
+
+    :param interval: New sampling interval in microseconds.
+    '''
+    params: T_JSON_DICT = dict()
+    params['interval'] = interval
+    cmd_dict: T_JSON_DICT = {
+        'method': 'Profiler.setSamplingInterval',
+        'params': params,
+    }
+    json = yield cmd_dict
+
+
+def start() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
+
+    cmd_dict: T_JSON_DICT = {
+        'method': 'Profiler.start',
+    }
+    json = yield cmd_dict
+
+
+def start_precise_coverage(
+        call_count: typing.Optional[bool] = None,
+        detailed: typing.Optional[bool] = None,
+        allow_triggered_updates: typing.Optional[bool] = None
+    ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,float]:
+    '''
+    Enable precise code coverage. Coverage data for JavaScript executed before enabling precise code
+    coverage may be incomplete. Enabling prevents running optimized code and resets execution
+    counters.
+
+    :param call_count: *(Optional)* Collect accurate call counts beyond simple 'covered' or 'not covered'.
+    :param detailed: *(Optional)* Collect block-based coverage.
+    :param allow_triggered_updates: *(Optional)* Allow the backend to send updates on its own initiative
+    :returns: Monotonically increasing time (in seconds) when the coverage update was taken in the backend.
+    '''
+    params: T_JSON_DICT = dict()
+    if call_count is not None:
+        params['callCount'] = call_count
+    if detailed is not None:
+        params['detailed'] = detailed
+    if allow_triggered_updates is not None:
+        params['allowTriggeredUpdates'] = allow_triggered_updates
+    cmd_dict: T_JSON_DICT = {
+        'method': 'Profiler.startPreciseCoverage',
+        'params': params,
+    }
+    json = yield cmd_dict
+    return float(json['timestamp'])
+
+
+def stop() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,Profile]:
+    '''
+
+
+    :returns: Recorded profile.
+    '''
+    cmd_dict: T_JSON_DICT = {
+        'method': 'Profiler.stop',
+    }
+    json = yield cmd_dict
+    return Profile.from_json(json['profile'])
+
+
+def stop_precise_coverage() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
+    '''
+    Disable precise code coverage. Disabling releases unnecessary execution count records and allows
+    executing optimized code.
+    '''
+    cmd_dict: T_JSON_DICT = {
+        'method': 'Profiler.stopPreciseCoverage',
+    }
+    json = yield cmd_dict
+
+
+def take_precise_coverage() -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.Tuple[typing.List[ScriptCoverage], float]]:
+    '''
+    Collect coverage data for the current isolate, and resets execution counters. Precise code
+    coverage needs to have started.
+
+    :returns: A tuple with the following items:
+
+        0. **result** - Coverage data for the current isolate.
+        1. **timestamp** - Monotonically increasing time (in seconds) when the coverage update was taken in the backend.
+    '''
+    cmd_dict: T_JSON_DICT = {
+        'method': 'Profiler.takePreciseCoverage',
+    }
+    json = yield cmd_dict
+    return (
+        [ScriptCoverage.from_json(i) for i in json['result']],
+        float(json['timestamp'])
+    )
+
+
+@event_class('Profiler.consoleProfileFinished')
+@dataclass
+class ConsoleProfileFinished:
+    id_: str
+    #: Location of console.profileEnd().
+    location: debugger.Location
+    profile: Profile
+    #: Profile title passed as an argument to console.profile().
+    title: typing.Optional[str]
+
+    @classmethod
+    def from_json(cls, json: T_JSON_DICT) -> ConsoleProfileFinished:
+        return cls(
+            id_=str(json['id']),
+            location=debugger.Location.from_json(json['location']),
+            profile=Profile.from_json(json['profile']),
+            title=str(json['title']) if json.get('title', None) is not None else None
+        )
+
+
+@event_class('Profiler.consoleProfileStarted')
+@dataclass
+class ConsoleProfileStarted:
+    '''
+    Sent when new profile recording is started using console.profile() call.
+    '''
+    id_: str
+    #: Location of console.profile().
+    location: debugger.Location
+    #: Profile title passed as an argument to console.profile().
+    title: typing.Optional[str]
+
+    @classmethod
+    def from_json(cls, json: T_JSON_DICT) -> ConsoleProfileStarted:
+        return cls(
+            id_=str(json['id']),
+            location=debugger.Location.from_json(json['location']),
+            title=str(json['title']) if json.get('title', None) is not None else None
+        )
+
+
+@event_class('Profiler.preciseCoverageDeltaUpdate')
+@dataclass
+class PreciseCoverageDeltaUpdate:
+    '''
+    **EXPERIMENTAL**
+
+    Reports coverage delta since the last poll (either from an event like this, or from
+    ``takePreciseCoverage`` for the current isolate. May only be sent if precise code
+    coverage has been started. This event can be trigged by the embedder to, for example,
+    trigger collection of coverage data immediately at a certain point in time.
+    '''
+    #: Monotonically increasing time (in seconds) when the coverage update was taken in the backend.
+    timestamp: float
+    #: Identifier for distinguishing coverage events.
+    occasion: str
+    #: Coverage data for the current isolate.
+    result: typing.List[ScriptCoverage]
+
+    @classmethod
+    def from_json(cls, json: T_JSON_DICT) -> PreciseCoverageDeltaUpdate:
+        return cls(
+            timestamp=float(json['timestamp']),
+            occasion=str(json['occasion']),
+            result=[ScriptCoverage.from_json(i) for i in json['result']]
+        )

mithwire/cdp/pwa.py

@@ -0,0 +1,278 @@
+# DO NOT EDIT THIS FILE!
+#
+# This file is generated from the CDP specification. If you need to make
+# changes, edit the generator and regenerate all of the modules.
+#
+# CDP domain: PWA (experimental)
+
+from __future__ import annotations
+import enum
+import typing
+from dataclasses import dataclass
+from .util import event_class, T_JSON_DICT
+
+from . import target
+
+
+@dataclass
+class FileHandlerAccept:
+    '''
+    The following types are the replica of
+    https://crsrc.org/c/chrome/browser/web_applications/proto/web_app_os_integration_state.proto;drc=9910d3be894c8f142c977ba1023f30a656bc13fc;l=67
+    '''
+    #: New name of the mimetype according to
+    #: https://www.iana.org/assignments/media-types/media-types.xhtml
+    media_type: str
+
+    file_extensions: typing.List[str]
+
+    def to_json(self) -> T_JSON_DICT:
+        json: T_JSON_DICT = dict()
+        json['mediaType'] = self.media_type
+        json['fileExtensions'] = [i for i in self.file_extensions]
+        return json
+
+    @classmethod
+    def from_json(cls, json: T_JSON_DICT) -> FileHandlerAccept:
+        return cls(
+            media_type=str(json['mediaType']),
+            file_extensions=[str(i) for i in json['fileExtensions']],
+        )
+
+
+@dataclass
+class FileHandler:
+    action: str
+
+    accepts: typing.List[FileHandlerAccept]
+
+    display_name: str
+
+    def to_json(self) -> T_JSON_DICT:
+        json: T_JSON_DICT = dict()
+        json['action'] = self.action
+        json['accepts'] = [i.to_json() for i in self.accepts]
+        json['displayName'] = self.display_name
+        return json
+
+    @classmethod
+    def from_json(cls, json: T_JSON_DICT) -> FileHandler:
+        return cls(
+            action=str(json['action']),
+            accepts=[FileHandlerAccept.from_json(i) for i in json['accepts']],
+            display_name=str(json['displayName']),
+        )
+
+
+class DisplayMode(enum.Enum):
+    '''
+    If user prefers opening the app in browser or an app window.
+    '''
+    STANDALONE = "standalone"
+    BROWSER = "browser"
+
+    def to_json(self) -> str:
+        return self.value
+
+    @classmethod
+    def from_json(cls, json: str) -> DisplayMode:
+        return cls(json)
+
+
+def get_os_app_state(
+        manifest_id: str
+    ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.Tuple[int, typing.List[FileHandler]]]:
+    '''
+    Returns the following OS state for the given manifest id.
+
+    :param manifest_id: The id from the webapp's manifest file, commonly it's the url of the site installing the webapp. See https://web.dev/learn/pwa/web-app-manifest.
+    :returns: A tuple with the following items:
+
+        0. **badgeCount** - 
+        1. **fileHandlers** - 
+    '''
+    params: T_JSON_DICT = dict()
+    params['manifestId'] = manifest_id
+    cmd_dict: T_JSON_DICT = {
+        'method': 'PWA.getOsAppState',
+        'params': params,
+    }
+    json = yield cmd_dict
+    return (
+        int(json['badgeCount']),
+        [FileHandler.from_json(i) for i in json['fileHandlers']]
+    )
+
+
+def install(
+        manifest_id: str,
+        install_url_or_bundle_url: typing.Optional[str] = None
+    ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
+    '''
+    Installs the given manifest identity, optionally using the given installUrlOrBundleUrl
+
+    IWA-specific install description:
+    manifestId corresponds to isolated-app:// + web_package::SignedWebBundleId
+
+    File installation mode:
+    The installUrlOrBundleUrl can be either file:// or http(s):// pointing
+    to a signed web bundle (.swbn). In this case SignedWebBundleId must correspond to
+    The .swbn file's signing key.
+
+    Dev proxy installation mode:
+    installUrlOrBundleUrl must be http(s):// that serves dev mode IWA.
+    web_package::SignedWebBundleId must be of type dev proxy.
+
+    The advantage of dev proxy mode is that all changes to IWA
+    automatically will be reflected in the running app without
+    reinstallation.
+
+    To generate bundle id for proxy mode:
+    1. Generate 32 random bytes.
+    2. Add a specific suffix at the end following the documentation
+       https://github.com/WICG/isolated-web-apps/blob/main/Scheme.md#suffix
+    3. Encode the entire sequence using Base32 without padding.
+
+    If Chrome is not in IWA dev
+    mode, the installation will fail, regardless of the state of the allowlist.
+
+    :param manifest_id:
+    :param install_url_or_bundle_url: *(Optional)* The location of the app or bundle overriding the one derived from the manifestId.
+    '''
+    params: T_JSON_DICT = dict()
+    params['manifestId'] = manifest_id
+    if install_url_or_bundle_url is not None:
+        params['installUrlOrBundleUrl'] = install_url_or_bundle_url
+    cmd_dict: T_JSON_DICT = {
+        'method': 'PWA.install',
+        'params': params,
+    }
+    json = yield cmd_dict
+
+
+def uninstall(
+        manifest_id: str
+    ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
+    '''
+    Uninstalls the given manifest_id and closes any opened app windows.
+
+    :param manifest_id:
+    '''
+    params: T_JSON_DICT = dict()
+    params['manifestId'] = manifest_id
+    cmd_dict: T_JSON_DICT = {
+        'method': 'PWA.uninstall',
+        'params': params,
+    }
+    json = yield cmd_dict
+
+
+def launch(
+        manifest_id: str,
+        url: typing.Optional[str] = None
+    ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,target.TargetID]:
+    '''
+    Launches the installed web app, or an url in the same web app instead of the
+    default start url if it is provided. Returns a page Target.TargetID which
+    can be used to attach to via Target.attachToTarget or similar APIs.
+
+    :param manifest_id:
+    :param url: *(Optional)*
+    :returns: ID of the tab target created as a result.
+    '''
+    params: T_JSON_DICT = dict()
+    params['manifestId'] = manifest_id
+    if url is not None:
+        params['url'] = url
+    cmd_dict: T_JSON_DICT = {
+        'method': 'PWA.launch',
+        'params': params,
+    }
+    json = yield cmd_dict
+    return target.TargetID.from_json(json['targetId'])
+
+
+def launch_files_in_app(
+        manifest_id: str,
+        files: typing.List[str]
+    ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,typing.List[target.TargetID]]:
+    '''
+    Opens one or more local files from an installed web app identified by its
+    manifestId. The web app needs to have file handlers registered to process
+    the files. The API returns one or more page Target.TargetIDs which can be
+    used to attach to via Target.attachToTarget or similar APIs.
+    If some files in the parameters cannot be handled by the web app, they will
+    be ignored. If none of the files can be handled, this API returns an error.
+    If no files are provided as the parameter, this API also returns an error.
+
+    According to the definition of the file handlers in the manifest file, one
+    Target.TargetID may represent a page handling one or more files. The order
+    of the returned Target.TargetIDs is not guaranteed.
+
+    TODO(crbug.com/339454034): Check the existences of the input files.
+
+    :param manifest_id:
+    :param files:
+    :returns: IDs of the tab targets created as the result.
+    '''
+    params: T_JSON_DICT = dict()
+    params['manifestId'] = manifest_id
+    params['files'] = [i for i in files]
+    cmd_dict: T_JSON_DICT = {
+        'method': 'PWA.launchFilesInApp',
+        'params': params,
+    }
+    json = yield cmd_dict
+    return [target.TargetID.from_json(i) for i in json['targetIds']]
+
+
+def open_current_page_in_app(
+        manifest_id: str
+    ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
+    '''
+    Opens the current page in its web app identified by the manifest id, needs
+    to be called on a page target. This function returns immediately without
+    waiting for the app to finish loading.
+
+    :param manifest_id:
+    '''
+    params: T_JSON_DICT = dict()
+    params['manifestId'] = manifest_id
+    cmd_dict: T_JSON_DICT = {
+        'method': 'PWA.openCurrentPageInApp',
+        'params': params,
+    }
+    json = yield cmd_dict
+
+
+def change_app_user_settings(
+        manifest_id: str,
+        link_capturing: typing.Optional[bool] = None,
+        display_mode: typing.Optional[DisplayMode] = None
+    ) -> typing.Generator[T_JSON_DICT,T_JSON_DICT,None]:
+    '''
+    Changes user settings of the web app identified by its manifestId. If the
+    app was not installed, this command returns an error. Unset parameters will
+    be ignored; unrecognized values will cause an error.
+
+    Unlike the ones defined in the manifest files of the web apps, these
+    settings are provided by the browser and controlled by the users, they
+    impact the way the browser handling the web apps.
+
+    See the comment of each parameter.
+
+    :param manifest_id:
+    :param link_capturing: *(Optional)* If user allows the links clicked on by the user in the app's scope, or extended scope if the manifest has scope extensions and the flags ```DesktopPWAsLinkCapturingWithScopeExtensions```` and ````WebAppEnableScopeExtensions``` are enabled.  Note, the API does not support resetting the linkCapturing to the initial value, uninstalling and installing the web app again will reset it.  TODO(crbug.com/339453269): Setting this value on ChromeOS is not supported yet.
+    :param display_mode: *(Optional)*
+    '''
+    params: T_JSON_DICT = dict()
+    params['manifestId'] = manifest_id
+    if link_capturing is not None:
+        params['linkCapturing'] = link_capturing
+    if display_mode is not None:
+        params['displayMode'] = display_mode.to_json()
+    cmd_dict: T_JSON_DICT = {
+        'method': 'PWA.changeAppUserSettings',
+        'params': params,
+    }
+    json = yield cmd_dict