revengai 2.3.0__py3-none-any.whl → 2.9.1__py3-none-any.whl

revengai/models/base_response_nearest_neighbor_analysis.py

@@ -1,135 +0,0 @@
-# coding: utf-8
-
-"""
-    RevEng.AI API
-
-    RevEng.AI is Similarity Search Engine for executable binaries
-
-    Generated by OpenAPI Generator (https://openapi-generator.tech)
-
-    Do not edit the class manually.
-"""  # noqa: E501
-
-
-from __future__ import annotations
-import pprint
-import re  # noqa: F401
-import json
-
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
-from revengai.models.error_model import ErrorModel
-from revengai.models.meta_model import MetaModel
-from revengai.models.nearest_neighbor import NearestNeighbor
-from typing import Optional, Set
-from typing_extensions import Self
-
-class BaseResponseNearestNeighborAnalysis(BaseModel):
-    """
-    BaseResponseNearestNeighborAnalysis
-    """ # noqa: E501
-    status: Optional[StrictBool] = Field(default=True, description="Response status on whether the request succeeded")
-    data: Optional[Dict[str, Dict[str, NearestNeighbor]]] = None
-    message: Optional[StrictStr] = None
-    errors: Optional[List[ErrorModel]] = None
-    meta: Optional[MetaModel] = Field(default=None, description="Metadata")
-    __properties: ClassVar[List[str]] = ["status", "data", "message", "errors", "meta"]
-
-    model_config = ConfigDict(
-        populate_by_name=True,
-        validate_assignment=True,
-        protected_namespaces=(),
-    )
-
-
-    def to_str(self) -> str:
-        """Returns the string representation of the model using alias"""
-        return pprint.pformat(self.model_dump(by_alias=True))
-
-    def to_json(self) -> str:
-        """Returns the JSON representation of the model using alias"""
-        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
-        return json.dumps(self.to_dict())
-
-    @classmethod
-    def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of BaseResponseNearestNeighborAnalysis from a JSON string"""
-        return cls.from_dict(json.loads(json_str))
-
-    def to_dict(self) -> Dict[str, Any]:
-        """Return the dictionary representation of the model using alias.
-
-        This has the following differences from calling pydantic's
-        `self.model_dump(by_alias=True)`:
-
-        * `None` is only added to the output dict for nullable fields that
-          were set at model initialization. Other fields with value `None`
-          are ignored.
-        """
-        excluded_fields: Set[str] = set([
-        ])
-
-        _dict = self.model_dump(
-            by_alias=True,
-            exclude=excluded_fields,
-            exclude_none=True,
-        )
-        # override the default output from pydantic by calling `to_dict()` of each value in data (dict)
-        _field_dict = {}
-        if self.data:
-            for _key_data in self.data:
-                if self.data[_key_data]:
-                    _field_dict[_key_data] = self.data[_key_data].to_dict()
-            _dict['data'] = _field_dict
-        # override the default output from pydantic by calling `to_dict()` of each item in errors (list)
-        _items = []
-        if self.errors:
-            for _item_errors in self.errors:
-                if _item_errors:
-                    _items.append(_item_errors.to_dict())
-            _dict['errors'] = _items
-        # override the default output from pydantic by calling `to_dict()` of meta
-        if self.meta:
-            _dict['meta'] = self.meta.to_dict()
-        # set to None if message (nullable) is None
-        # and model_fields_set contains the field
-        if self.message is None and "message" in self.model_fields_set:
-            _dict['message'] = None
-
-        # set to None if errors (nullable) is None
-        # and model_fields_set contains the field
-        if self.errors is None and "errors" in self.model_fields_set:
-            _dict['errors'] = None
-
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of BaseResponseNearestNeighborAnalysis from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "status": obj.get("status") if obj.get("status") is not None else True,
-            "data": dict(
-                (_k, dict(
-                    (_ik, NearestNeighbor.from_dict(_iv))
-                        for _ik, _iv in _v.items()
-                    )
-                    if _v is not None
-                    else None
-                )
-                for _k, _v in obj.get("data").items()
-            )
-            if obj.get("data") is not None
-            else None,
-            "message": obj.get("message"),
-            "errors": [ErrorModel.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None,
-            "meta": MetaModel.from_dict(obj["meta"]) if obj.get("meta") is not None else None
-        })
-        return _obj
-
-

revengai/models/box_plot_confidence.py

@@ -1,98 +0,0 @@
-# coding: utf-8
-
-"""
-    RevEng.AI API
-
-    RevEng.AI is Similarity Search Engine for executable binaries
-
-    Generated by OpenAPI Generator (https://openapi-generator.tech)
-
-    Do not edit the class manually.
-"""  # noqa: E501
-
-
-from __future__ import annotations
-import pprint
-import re  # noqa: F401
-import json
-
-from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt
-from typing import Any, ClassVar, Dict, List, Union
-from typing import Optional, Set
-from typing_extensions import Self
-
-class BoxPlotConfidence(BaseModel):
-    """
-    Format for confidence - returned in the box plot format
-    """ # noqa: E501
-    min: Union[StrictFloat, StrictInt]
-    max: Union[StrictFloat, StrictInt]
-    average: Union[StrictFloat, StrictInt]
-    upper_quartile: Union[StrictFloat, StrictInt]
-    lower_quartile: Union[StrictFloat, StrictInt]
-    positive_count: StrictInt
-    negative_count: StrictInt
-    __properties: ClassVar[List[str]] = ["min", "max", "average", "upper_quartile", "lower_quartile", "positive_count", "negative_count"]
-
-    model_config = ConfigDict(
-        populate_by_name=True,
-        validate_assignment=True,
-        protected_namespaces=(),
-    )
-
-
-    def to_str(self) -> str:
-        """Returns the string representation of the model using alias"""
-        return pprint.pformat(self.model_dump(by_alias=True))
-
-    def to_json(self) -> str:
-        """Returns the JSON representation of the model using alias"""
-        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
-        return json.dumps(self.to_dict())
-
-    @classmethod
-    def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of BoxPlotConfidence from a JSON string"""
-        return cls.from_dict(json.loads(json_str))
-
-    def to_dict(self) -> Dict[str, Any]:
-        """Return the dictionary representation of the model using alias.
-
-        This has the following differences from calling pydantic's
-        `self.model_dump(by_alias=True)`:
-
-        * `None` is only added to the output dict for nullable fields that
-          were set at model initialization. Other fields with value `None`
-          are ignored.
-        """
-        excluded_fields: Set[str] = set([
-        ])
-
-        _dict = self.model_dump(
-            by_alias=True,
-            exclude=excluded_fields,
-            exclude_none=True,
-        )
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of BoxPlotConfidence from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "min": obj.get("min"),
-            "max": obj.get("max"),
-            "average": obj.get("average"),
-            "upper_quartile": obj.get("upper_quartile"),
-            "lower_quartile": obj.get("lower_quartile"),
-            "positive_count": obj.get("positive_count"),
-            "negative_count": obj.get("negative_count")
-        })
-        return _obj
-
-

revengai/models/function_box_plot_confidence.py

@@ -1,92 +0,0 @@
-# coding: utf-8
-
-"""
-    RevEng.AI API
-
-    RevEng.AI is Similarity Search Engine for executable binaries
-
-    Generated by OpenAPI Generator (https://openapi-generator.tech)
-
-    Do not edit the class manually.
-"""  # noqa: E501
-
-
-from __future__ import annotations
-import pprint
-import re  # noqa: F401
-import json
-
-from pydantic import BaseModel, ConfigDict, StrictInt
-from typing import Any, ClassVar, Dict, List
-from revengai.models.box_plot_confidence import BoxPlotConfidence
-from typing import Optional, Set
-from typing_extensions import Self
-
-class FunctionBoxPlotConfidence(BaseModel):
-    """
-    FunctionBoxPlotConfidence
-    """ # noqa: E501
-    function_id: StrictInt
-    box_plot: BoxPlotConfidence
-    __properties: ClassVar[List[str]] = ["function_id", "box_plot"]
-
-    model_config = ConfigDict(
-        populate_by_name=True,
-        validate_assignment=True,
-        protected_namespaces=(),
-    )
-
-
-    def to_str(self) -> str:
-        """Returns the string representation of the model using alias"""
-        return pprint.pformat(self.model_dump(by_alias=True))
-
-    def to_json(self) -> str:
-        """Returns the JSON representation of the model using alias"""
-        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
-        return json.dumps(self.to_dict())
-
-    @classmethod
-    def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of FunctionBoxPlotConfidence from a JSON string"""
-        return cls.from_dict(json.loads(json_str))
-
-    def to_dict(self) -> Dict[str, Any]:
-        """Return the dictionary representation of the model using alias.
-
-        This has the following differences from calling pydantic's
-        `self.model_dump(by_alias=True)`:
-
-        * `None` is only added to the output dict for nullable fields that
-          were set at model initialization. Other fields with value `None`
-          are ignored.
-        """
-        excluded_fields: Set[str] = set([
-        ])
-
-        _dict = self.model_dump(
-            by_alias=True,
-            exclude=excluded_fields,
-            exclude_none=True,
-        )
-        # override the default output from pydantic by calling `to_dict()` of box_plot
-        if self.box_plot:
-            _dict['box_plot'] = self.box_plot.to_dict()
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of FunctionBoxPlotConfidence from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "function_id": obj.get("function_id"),
-            "box_plot": BoxPlotConfidence.from_dict(obj["box_plot"]) if obj.get("box_plot") is not None else None
-        })
-        return _obj
-
-

revengai/models/function_name_confidence_body.py

@@ -1,97 +0,0 @@
-# coding: utf-8
-
-"""
-    RevEng.AI API
-
-    RevEng.AI is Similarity Search Engine for executable binaries
-
-    Generated by OpenAPI Generator (https://openapi-generator.tech)
-
-    Do not edit the class manually.
-"""  # noqa: E501
-
-
-from __future__ import annotations
-import pprint
-import re  # noqa: F401
-import json
-
-from pydantic import BaseModel, ConfigDict, Field, StrictBool
-from typing import Any, ClassVar, Dict, List, Optional
-from typing_extensions import Annotated
-from revengai.models.function_name_input import FunctionNameInput
-from typing import Optional, Set
-from typing_extensions import Self
-
-class FunctionNameConfidenceBody(BaseModel):
-    """
-    FunctionNameConfidenceBody
-    """ # noqa: E501
-    functions: Optional[Annotated[List[FunctionNameInput], Field(min_length=1, max_length=100)]] = Field(default=None, description="List of function ids and the function names they want to check confidence for")
-    is_debug: Optional[StrictBool] = Field(default=False, description="Flag to match only to a debug function")
-    __properties: ClassVar[List[str]] = ["functions", "is_debug"]
-
-    model_config = ConfigDict(
-        populate_by_name=True,
-        validate_assignment=True,
-        protected_namespaces=(),
-    )
-
-
-    def to_str(self) -> str:
-        """Returns the string representation of the model using alias"""
-        return pprint.pformat(self.model_dump(by_alias=True))
-
-    def to_json(self) -> str:
-        """Returns the JSON representation of the model using alias"""
-        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
-        return json.dumps(self.to_dict())
-
-    @classmethod
-    def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of FunctionNameConfidenceBody from a JSON string"""
-        return cls.from_dict(json.loads(json_str))
-
-    def to_dict(self) -> Dict[str, Any]:
-        """Return the dictionary representation of the model using alias.
-
-        This has the following differences from calling pydantic's
-        `self.model_dump(by_alias=True)`:
-
-        * `None` is only added to the output dict for nullable fields that
-          were set at model initialization. Other fields with value `None`
-          are ignored.
-        """
-        excluded_fields: Set[str] = set([
-        ])
-
-        _dict = self.model_dump(
-            by_alias=True,
-            exclude=excluded_fields,
-            exclude_none=True,
-        )
-        # override the default output from pydantic by calling `to_dict()` of each item in functions (list)
-        _items = []
-        if self.functions:
-            for _item_functions in self.functions:
-                if _item_functions:
-                    _items.append(_item_functions.to_dict())
-            _dict['functions'] = _items
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of FunctionNameConfidenceBody from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "functions": [FunctionNameInput.from_dict(_item) for _item in obj["functions"]] if obj.get("functions") is not None else None,
-            "is_debug": obj.get("is_debug") if obj.get("is_debug") is not None else False
-        })
-        return _obj
-
-

revengai/models/function_name_input.py

@@ -1,88 +0,0 @@
-# coding: utf-8
-
-"""
-    RevEng.AI API
-
-    RevEng.AI is Similarity Search Engine for executable binaries
-
-    Generated by OpenAPI Generator (https://openapi-generator.tech)
-
-    Do not edit the class manually.
-"""  # noqa: E501
-
-
-from __future__ import annotations
-import pprint
-import re  # noqa: F401
-import json
-
-from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List
-from typing import Optional, Set
-from typing_extensions import Self
-
-class FunctionNameInput(BaseModel):
-    """
-    FunctionNameInput
-    """ # noqa: E501
-    function_id: StrictInt
-    function_name: StrictStr
-    __properties: ClassVar[List[str]] = ["function_id", "function_name"]
-
-    model_config = ConfigDict(
-        populate_by_name=True,
-        validate_assignment=True,
-        protected_namespaces=(),
-    )
-
-
-    def to_str(self) -> str:
-        """Returns the string representation of the model using alias"""
-        return pprint.pformat(self.model_dump(by_alias=True))
-
-    def to_json(self) -> str:
-        """Returns the JSON representation of the model using alias"""
-        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
-        return json.dumps(self.to_dict())
-
-    @classmethod
-    def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of FunctionNameInput from a JSON string"""
-        return cls.from_dict(json.loads(json_str))
-
-    def to_dict(self) -> Dict[str, Any]:
-        """Return the dictionary representation of the model using alias.
-
-        This has the following differences from calling pydantic's
-        `self.model_dump(by_alias=True)`:
-
-        * `None` is only added to the output dict for nullable fields that
-          were set at model initialization. Other fields with value `None`
-          are ignored.
-        """
-        excluded_fields: Set[str] = set([
-        ])
-
-        _dict = self.model_dump(
-            by_alias=True,
-            exclude=excluded_fields,
-            exclude_none=True,
-        )
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of FunctionNameInput from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "function_id": obj.get("function_id"),
-            "function_name": obj.get("function_name")
-        })
-        return _obj
-
-

revengai/models/nearest_neighbor.py

@@ -1,105 +0,0 @@
-# coding: utf-8
-
-"""
-    RevEng.AI API
-
-    RevEng.AI is Similarity Search Engine for executable binaries
-
-    Generated by OpenAPI Generator (https://openapi-generator.tech)
-
-    Do not edit the class manually.
-"""  # noqa: E501
-
-
-from __future__ import annotations
-import pprint
-import re  # noqa: F401
-import json
-
-from pydantic import BaseModel, ConfigDict, StrictBool, StrictFloat, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional, Union
-from typing import Optional, Set
-from typing_extensions import Self
-
-class NearestNeighbor(BaseModel):
-    """
-    NearestNeighbor
-    """ # noqa: E501
-    distance: Union[StrictFloat, StrictInt]
-    nearest_neighbor_analysis_id: StrictInt
-    nearest_neighbor_analysis_name: StrictStr
-    nearest_neighbor_function_name: StrictStr
-    nearest_neighbor_function_name_mangled: Optional[StrictStr]
-    nearest_neighbor_binary_id: StrictInt
-    nearest_neighbor_sha_256_hash: StrictStr
-    nearest_neighbor_debug: StrictBool
-    __properties: ClassVar[List[str]] = ["distance", "nearest_neighbor_analysis_id", "nearest_neighbor_analysis_name", "nearest_neighbor_function_name", "nearest_neighbor_function_name_mangled", "nearest_neighbor_binary_id", "nearest_neighbor_sha_256_hash", "nearest_neighbor_debug"]
-
-    model_config = ConfigDict(
-        populate_by_name=True,
-        validate_assignment=True,
-        protected_namespaces=(),
-    )
-
-
-    def to_str(self) -> str:
-        """Returns the string representation of the model using alias"""
-        return pprint.pformat(self.model_dump(by_alias=True))
-
-    def to_json(self) -> str:
-        """Returns the JSON representation of the model using alias"""
-        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
-        return json.dumps(self.to_dict())
-
-    @classmethod
-    def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of NearestNeighbor from a JSON string"""
-        return cls.from_dict(json.loads(json_str))
-
-    def to_dict(self) -> Dict[str, Any]:
-        """Return the dictionary representation of the model using alias.
-
-        This has the following differences from calling pydantic's
-        `self.model_dump(by_alias=True)`:
-
-        * `None` is only added to the output dict for nullable fields that
-          were set at model initialization. Other fields with value `None`
-          are ignored.
-        """
-        excluded_fields: Set[str] = set([
-        ])
-
-        _dict = self.model_dump(
-            by_alias=True,
-            exclude=excluded_fields,
-            exclude_none=True,
-        )
-        # set to None if nearest_neighbor_function_name_mangled (nullable) is None
-        # and model_fields_set contains the field
-        if self.nearest_neighbor_function_name_mangled is None and "nearest_neighbor_function_name_mangled" in self.model_fields_set:
-            _dict['nearest_neighbor_function_name_mangled'] = None
-
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of NearestNeighbor from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "distance": obj.get("distance"),
-            "nearest_neighbor_analysis_id": obj.get("nearest_neighbor_analysis_id"),
-            "nearest_neighbor_analysis_name": obj.get("nearest_neighbor_analysis_name"),
-            "nearest_neighbor_function_name": obj.get("nearest_neighbor_function_name"),
-            "nearest_neighbor_function_name_mangled": obj.get("nearest_neighbor_function_name_mangled"),
-            "nearest_neighbor_binary_id": obj.get("nearest_neighbor_binary_id"),
-            "nearest_neighbor_sha_256_hash": obj.get("nearest_neighbor_sha_256_hash"),
-            "nearest_neighbor_debug": obj.get("nearest_neighbor_debug")
-        })
-        return _obj
-
-

revengai/models/origin.py

@@ -1,42 +0,0 @@
-# coding: utf-8
-
-"""
-    RevEng.AI API
-
-    RevEng.AI is Similarity Search Engine for executable binaries
-
-    Generated by OpenAPI Generator (https://openapi-generator.tech)
-
-    Do not edit the class manually.
-"""  # noqa: E501
-
-
-from __future__ import annotations
-import json
-from enum import Enum
-from typing_extensions import Self
-
-
-class Origin(str, Enum):
-    """
-    Origin
-    """
-
-    """
-    allowed enum values
-    """
-    REV_ENG_MINUS_MALWARE = 'RevEng-Malware'
-    REV_ENG_MINUS_LIBRARY = 'RevEng-Library'
-    REV_ENG_MINUS_BENIGN = 'RevEng-Benign'
-    REVENG = 'RevEng'
-    REV_ENG_MINUS_HEURISTIC = 'RevEng-Heuristic'
-    REV_ENG_MINUS_UNKNOWN = 'RevEng-Unknown'
-    VIRUSTOTAL = 'VirusTotal'
-    MALWAREBAZAAR = 'MalwareBazaar'
-
-    @classmethod
-    def from_json(cls, json_str: str) -> Self:
-        """Create an instance of Origin from a JSON string"""
-        return cls(json.loads(json_str))
-
-