graphsense-python 2.15.2__py3-none-any.whl → 2.17.0__py3-none-any.whl

graphsense/__init__.py

@@ -12,7 +12,7 @@
 """
 
 
-__version__ = "2.15.2"
+__version__ = "2.17.0"
 
 # Define package exports
 __all__ = [
@@ -45,8 +45,10 @@ __all__ = [
     "AddressTx",
     "AddressTxUtxo",
     "AddressTxs",
+    "AggregateCutoff",
     "Block",
     "BlockAtDate",
+    "Capabilities",
     "ChangeHeuristics",
     "Cluster",
     "ClusterAddresses",
@@ -94,6 +96,7 @@ __all__ = [
     "NeighborClusters",
     "NeighborEntities",
     "NeighborEntity",
+    "NetworkCapabilities",
     "OneTimeChangeHeuristic",
     "PerTxInner",
     "Rate",
@@ -168,8 +171,10 @@ from graphsense.models.address_tags import AddressTags as AddressTags
 from graphsense.models.address_tx import AddressTx as AddressTx
 from graphsense.models.address_tx_utxo import AddressTxUtxo as AddressTxUtxo
 from graphsense.models.address_txs import AddressTxs as AddressTxs
+from graphsense.models.aggregate_cutoff import AggregateCutoff as AggregateCutoff
 from graphsense.models.block import Block as Block
 from graphsense.models.block_at_date import BlockAtDate as BlockAtDate
+from graphsense.models.capabilities import Capabilities as Capabilities
 from graphsense.models.change_heuristics import ChangeHeuristics as ChangeHeuristics
 from graphsense.models.cluster import Cluster as Cluster
 from graphsense.models.cluster_addresses import ClusterAddresses as ClusterAddresses
@@ -217,6 +222,7 @@ from graphsense.models.neighbor_cluster import NeighborCluster as NeighborCluste
 from graphsense.models.neighbor_clusters import NeighborClusters as NeighborClusters
 from graphsense.models.neighbor_entities import NeighborEntities as NeighborEntities
 from graphsense.models.neighbor_entity import NeighborEntity as NeighborEntity
+from graphsense.models.network_capabilities import NetworkCapabilities as NetworkCapabilities
 from graphsense.models.one_time_change_heuristic import OneTimeChangeHeuristic as OneTimeChangeHeuristic
 from graphsense.models.per_tx_inner import PerTxInner as PerTxInner
 from graphsense.models.rate import Rate as Rate

graphsense/api/general_api.py

@@ -17,6 +17,7 @@ from typing_extensions import Annotated
 from pydantic import Field, StrictBool, StrictInt, StrictStr
 from typing import Optional
 from typing_extensions import Annotated
+from graphsense.models.capabilities import Capabilities
 from graphsense.models.search_result import SearchResult
 from graphsense.models.stats import Stats
 
@@ -127,6 +128,252 @@ class GeneralApi:
         self.api_client = api_client
 
 
+    @validate_call_compat
+    def get_capabilities(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> Capabilities:
+        """Get per-network feature availability
+
+        Returns which optional feature families are disabled per served network. A network absent from the list is fully enabled, as is every network of a deployment that does not serve this endpoint (404).
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_capabilities_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Capabilities",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call_compat
+    def get_capabilities_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[Capabilities]:
+        """Get per-network feature availability
+
+        Returns which optional feature families are disabled per served network. A network absent from the list is fully enabled, as is every network of a deployment that does not serve this endpoint (404).
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_capabilities_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Capabilities",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call_compat
+    def get_capabilities_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get per-network feature availability
+
+        Returns which optional feature families are disabled per served network. A network absent from the list is fully enabled, as is every network of a deployment that does not serve this endpoint (404).
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_capabilities_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "Capabilities",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_capabilities_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'api_key'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/capabilities',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
     @validate_call_compat
     def get_statistics(
         self,

graphsense/api_client.py

@@ -95,7 +95,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'graphsense-python/2.15.2'
+        self.user_agent = 'graphsense-python/2.17.0'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

graphsense/cli/context.py

@@ -7,8 +7,6 @@ import sys
 from dataclasses import dataclass, field
 from typing import Optional
 
-import rich_click as click
-
 from graphsense.ext.client import GraphSense
 
 
@@ -47,9 +45,16 @@ class CliContext:
                     "GRAPHSENSE_CLIENT_SHOW_DEPRECATED_ENDPOINTS"
                 )
                 == "1",
-                # Resolve click's current stderr stream on each write so
+                # Resolve the current stderr on each write so
                 # `CliRunner(mix_stderr=False)` on click 8.1 captures it.
-                deprecation_stream=lambda: click.get_text_stream("stderr"),
+                # Deliberately not `click.get_text_stream("stderr")`: click
+                # 8.5 moved that behind a module-level `__getattr__` that
+                # raises a DeprecationWarning (removal in 9.0), and the
+                # deprecation hook resolves this stream inside a
+                # `try/except Exception`, so under `-W error` the warning
+                # became the exception that silently swallowed every
+                # deprecation message.
+                deprecation_stream=lambda: sys.stderr,
             )
         return self._gs
 

graphsense/configuration.py

@@ -533,8 +533,8 @@ conf = graphsense.Configuration(
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 2.15.2\n"\
-               "SDK Package Version: 2.15.2".\
+               "Version of the API: 2.17.0\n"\
+               "SDK Package Version: 2.17.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

graphsense/ext/deprecation.py

@@ -33,7 +33,7 @@ def install(
       * None — write to `sys.stderr` at call time
       * a callable — invoked each write to resolve the current stream (useful
         when a test harness captures stderr with a stream the caller can only
-        obtain lazily, e.g. click.get_text_stream('stderr'))
+        obtain lazily, e.g. `lambda: sys.stderr` under click's CliRunner)
       * a file-like object — used directly
 
     Safe to call twice on the same client — the second call is a no-op.

graphsense/gs_files/__init__.py

@@ -14,16 +14,26 @@ Encode:
     GsBuilder                    — high-level fluent API for building graphs
     encode_gs_payload            — raw payload list to .gs bytes
     builder_from_spec            — build a GsBuilder from a JSON spec dict
+    spec_from_pathfinder         — decoded pathfinder file back to a spec
+    ANNOTATION_PALETTE           — the Pathfinder annotation dialog's colors
+
+Layout:
+    apply_hierarchical_layout    — stamp x/y onto a spec (direction-aware
+                                   when txs carry senders / receivers)
+    layout_metrics               — overlap / crossing / direction numbers
 """
 
 from .encoder import (
+    ANNOTATION_PALETTE,
     GsBuilder,
     apply_hierarchical_layout,
     builder_from_spec,
     encode_gs_payload,
     normalize_address_id,
     normalize_tx_id,
+    spec_from_pathfinder,
 )
+from .layout import directed_layout, has_flow_info, layout_metrics
 from .parser import (
     Color,
     GraphAddress,
@@ -46,6 +56,7 @@ from .summary import summarize
 from .writer import to_jsonable, write_decoded, write_json
 
 __all__ = [
+    "ANNOTATION_PALETTE",
     "Color",
     "GraphAddress",
     "GraphCluster",
@@ -62,11 +73,15 @@ __all__ = [
     "builder_from_spec",
     "decode_gs",
     "decode_gs_bytes",
+    "directed_layout",
     "encode_gs_payload",
+    "has_flow_info",
+    "layout_metrics",
     "lzw_pack",
     "lzw_unpack",
     "normalize_address_id",
     "normalize_tx_id",
+    "spec_from_pathfinder",
     "structure",
     "summarize",
     "to_jsonable",