revengai 2.74.0__py3-none-any.whl

revengai/models/function_type_output.py

@@ -0,0 +1,127 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from revengai.models.function_header import FunctionHeader
+from revengai.models.stack_variable import StackVariable
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionTypeOutput(BaseModel):
+    """
+    FunctionTypeOutput
+    """ # noqa: E501
+    last_change: Optional[StrictStr] = None
+    addr: StrictInt = Field(description="Memory address of the function")
+    size: StrictInt = Field(description="Size of the function in bytes")
+    header: FunctionHeader = Field(description="Function header information")
+    stack_vars: Optional[Dict[str, StackVariable]] = None
+    name: StrictStr = Field(description="Name of the function")
+    type: StrictStr = Field(description="Return type of the function")
+    artifact_type: Optional[StrictStr] = Field(default='Function', description="Type of artifact that the structure is associated with")
+    __properties: ClassVar[List[str]] = ["last_change", "addr", "size", "header", "stack_vars", "name", "type", "artifact_type"]
+
+    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 FunctionTypeOutput 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 header
+        if self.header:
+            _dict['header'] = self.header.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each value in stack_vars (dict)
+        _field_dict = {}
+        if self.stack_vars:
+            for _key_stack_vars in self.stack_vars:
+                if self.stack_vars[_key_stack_vars]:
+                    _field_dict[_key_stack_vars] = self.stack_vars[_key_stack_vars].to_dict()
+            _dict['stack_vars'] = _field_dict
+        # set to None if last_change (nullable) is None
+        # and model_fields_set contains the field
+        if self.last_change is None and "last_change" in self.model_fields_set:
+            _dict['last_change'] = None
+
+        # set to None if stack_vars (nullable) is None
+        # and model_fields_set contains the field
+        if self.stack_vars is None and "stack_vars" in self.model_fields_set:
+            _dict['stack_vars'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionTypeOutput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "last_change": obj.get("last_change"),
+            "addr": obj.get("addr"),
+            "size": obj.get("size"),
+            "header": FunctionHeader.from_dict(obj["header"]) if obj.get("header") is not None else None,
+            "stack_vars": dict(
+                (_k, StackVariable.from_dict(_v))
+                for _k, _v in obj["stack_vars"].items()
+            )
+            if obj.get("stack_vars") is not None
+            else None,
+            "name": obj.get("name"),
+            "type": obj.get("type"),
+            "artifact_type": obj.get("artifact_type") if obj.get("artifact_type") is not None else 'Function'
+        })
+        return _obj
+
+

revengai/models/functions_detail_response.py

@@ -0,0 +1,125 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionsDetailResponse(BaseModel):
+    """
+    FunctionsDetailResponse
+    """ # noqa: E501
+    function_id: StrictInt = Field(description="Function id")
+    function_name: StrictStr
+    function_name_mangled: StrictStr
+    function_vaddr: StrictInt
+    function_size: StrictInt
+    analysis_id: StrictInt
+    binary_id: StrictInt
+    binary_name: StrictStr
+    sha_256_hash: StrictStr
+    debug_hash: Optional[StrictStr]
+    debug: StrictBool
+    embedding_3d: Optional[List[Union[StrictFloat, StrictInt]]] = None
+    embedding_1d: Optional[List[Union[StrictFloat, StrictInt]]] = None
+    __properties: ClassVar[List[str]] = ["function_id", "function_name", "function_name_mangled", "function_vaddr", "function_size", "analysis_id", "binary_id", "binary_name", "sha_256_hash", "debug_hash", "debug", "embedding_3d", "embedding_1d"]
+
+    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 FunctionsDetailResponse 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 debug_hash (nullable) is None
+        # and model_fields_set contains the field
+        if self.debug_hash is None and "debug_hash" in self.model_fields_set:
+            _dict['debug_hash'] = None
+
+        # set to None if embedding_3d (nullable) is None
+        # and model_fields_set contains the field
+        if self.embedding_3d is None and "embedding_3d" in self.model_fields_set:
+            _dict['embedding_3d'] = None
+
+        # set to None if embedding_1d (nullable) is None
+        # and model_fields_set contains the field
+        if self.embedding_1d is None and "embedding_1d" in self.model_fields_set:
+            _dict['embedding_1d'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionsDetailResponse 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"),
+            "function_name_mangled": obj.get("function_name_mangled"),
+            "function_vaddr": obj.get("function_vaddr"),
+            "function_size": obj.get("function_size"),
+            "analysis_id": obj.get("analysis_id"),
+            "binary_id": obj.get("binary_id"),
+            "binary_name": obj.get("binary_name"),
+            "sha_256_hash": obj.get("sha_256_hash"),
+            "debug_hash": obj.get("debug_hash"),
+            "debug": obj.get("debug"),
+            "embedding_3d": obj.get("embedding_3d"),
+            "embedding_1d": obj.get("embedding_1d")
+        })
+        return _obj
+
+

revengai/models/functions_list_rename.py

@@ -0,0 +1,94 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from revengai.models.function_rename_map import FunctionRenameMap
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionsListRename(BaseModel):
+    """
+    FunctionsListRename
+    """ # noqa: E501
+    functions: List[FunctionRenameMap] = Field(description="A list of functions to rename")
+    __properties: ClassVar[List[str]] = ["functions"]
+
+    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 FunctionsListRename 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 FunctionsListRename from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "functions": [FunctionRenameMap.from_dict(_item) for _item in obj["functions"]] if obj.get("functions") is not None else None
+        })
+        return _obj
+
+

revengai/models/generate_function_data_types.py

@@ -0,0 +1,94 @@
+# 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
+from revengai.models.generation_status_list import GenerationStatusList
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GenerateFunctionDataTypes(BaseModel):
+    """
+    GenerateFunctionDataTypes
+    """ # noqa: E501
+    queued: StrictBool = Field(description="[DEPRECATED] This value has been replaced with the `data_types_list` field")
+    reference: StrictStr = Field(description="[DEPRECATED] This value has been replaced with the `data_types_list` field")
+    data_types_list: GenerationStatusList = Field(description="List of function data types information that are either already generated, or now queued for generation")
+    __properties: ClassVar[List[str]] = ["queued", "reference", "data_types_list"]
+
+    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 GenerateFunctionDataTypes 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 data_types_list
+        if self.data_types_list:
+            _dict['data_types_list'] = self.data_types_list.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GenerateFunctionDataTypes from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "queued": obj.get("queued"),
+            "reference": obj.get("reference"),
+            "data_types_list": GenerationStatusList.from_dict(obj["data_types_list"]) if obj.get("data_types_list") is not None else None
+        })
+        return _obj
+
+

revengai/models/generation_status_list.py

@@ -0,0 +1,98 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from revengai.models.function_data_types_status import FunctionDataTypesStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GenerationStatusList(BaseModel):
+    """
+    GenerationStatusList
+    """ # noqa: E501
+    total_count: Optional[StrictInt] = Field(default=0, description="Total number of functions in analysis")
+    total_data_types_count: Optional[StrictInt] = Field(default=0, description="Total number of functions with data types")
+    items: List[FunctionDataTypesStatus] = Field(description="List of function data types information")
+    __properties: ClassVar[List[str]] = ["total_count", "total_data_types_count", "items"]
+
+    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 GenerationStatusList 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 items (list)
+        _items = []
+        if self.items:
+            for _item_items in self.items:
+                if _item_items:
+                    _items.append(_item_items.to_dict())
+            _dict['items'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GenerationStatusList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "total_count": obj.get("total_count") if obj.get("total_count") is not None else 0,
+            "total_data_types_count": obj.get("total_data_types_count") if obj.get("total_data_types_count") is not None else 0,
+            "items": [FunctionDataTypesStatus.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None
+        })
+        return _obj
+
+

revengai/models/get_ai_decompilation_rating_response.py

@@ -0,0 +1,94 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from revengai.models.ai_decompilation_rating import AiDecompilationRating
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetAiDecompilationRatingResponse(BaseModel):
+    """
+    GetAiDecompilationRatingResponse
+    """ # noqa: E501
+    rating: AiDecompilationRating = Field(description="The rating the user has given to the AI decompilation response")
+    reason: Optional[StrictStr]
+    __properties: ClassVar[List[str]] = ["rating", "reason"]
+
+    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 GetAiDecompilationRatingResponse 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 reason (nullable) is None
+        # and model_fields_set contains the field
+        if self.reason is None and "reason" in self.model_fields_set:
+            _dict['reason'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetAiDecompilationRatingResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "rating": obj.get("rating"),
+            "reason": obj.get("reason")
+        })
+        return _obj
+
+