revengai 2.74.0__py3-none-any.whl

revengai/models/function_header.py

@@ -0,0 +1,112 @@
+# 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.argument import Argument
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionHeader(BaseModel):
+    """
+    FunctionHeader
+    """ # noqa: E501
+    last_change: Optional[StrictStr] = None
+    name: StrictStr = Field(description="Name of the function")
+    addr: StrictInt = Field(description="Memory address of the function")
+    type: StrictStr = Field(description="Return type of the function")
+    args: Dict[str, Argument] = Field(description="Dictionary of function arguments")
+    __properties: ClassVar[List[str]] = ["last_change", "name", "addr", "type", "args"]
+
+    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 FunctionHeader 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 args (dict)
+        _field_dict = {}
+        if self.args:
+            for _key_args in self.args:
+                if self.args[_key_args]:
+                    _field_dict[_key_args] = self.args[_key_args].to_dict()
+            _dict['args'] = _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
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionHeader 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"),
+            "name": obj.get("name"),
+            "addr": obj.get("addr"),
+            "type": obj.get("type"),
+            "args": dict(
+                (_k, Argument.from_dict(_v))
+                for _k, _v in obj["args"].items()
+            )
+            if obj.get("args") is not None
+            else None
+        })
+        return _obj
+
+

revengai/models/function_info_input.py

@@ -0,0 +1,105 @@
+# 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, Optional
+from revengai.models.function_info_input_func_deps_inner import FunctionInfoInputFuncDepsInner
+from revengai.models.function_type_input import FunctionTypeInput
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionInfoInput(BaseModel):
+    """
+    FunctionInfoInput
+    """ # noqa: E501
+    func_types: Optional[FunctionTypeInput] = None
+    func_deps: List[FunctionInfoInputFuncDepsInner] = Field(description="List of function dependencies")
+    __properties: ClassVar[List[str]] = ["func_types", "func_deps"]
+
+    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 FunctionInfoInput 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 func_types
+        if self.func_types:
+            _dict['func_types'] = self.func_types.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in func_deps (list)
+        _items = []
+        if self.func_deps:
+            for _item_func_deps in self.func_deps:
+                if _item_func_deps:
+                    _items.append(_item_func_deps.to_dict())
+            _dict['func_deps'] = _items
+        # set to None if func_types (nullable) is None
+        # and model_fields_set contains the field
+        if self.func_types is None and "func_types" in self.model_fields_set:
+            _dict['func_types'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionInfoInput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "func_types": FunctionTypeInput.from_dict(obj["func_types"]) if obj.get("func_types") is not None else None,
+            "func_deps": [FunctionInfoInputFuncDepsInner.from_dict(_item) for _item in obj["func_deps"]] if obj.get("func_deps") is not None else None
+        })
+        return _obj
+
+

revengai/models/function_info_input_func_deps_inner.py

@@ -0,0 +1,163 @@
+# 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
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Optional
+from revengai.models.enumeration import Enumeration
+from revengai.models.global_variable import GlobalVariable
+from revengai.models.structure import Structure
+from revengai.models.type_definition import TypeDefinition
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+FUNCTIONINFOINPUTFUNCDEPSINNER_ANY_OF_SCHEMAS = ["Enumeration", "GlobalVariable", "Structure", "TypeDefinition"]
+
+class FunctionInfoInputFuncDepsInner(BaseModel):
+    """
+    FunctionInfoInputFuncDepsInner
+    """
+
+    # data type: Structure
+    anyof_schema_1_validator: Optional[Structure] = None
+    # data type: Enumeration
+    anyof_schema_2_validator: Optional[Enumeration] = None
+    # data type: TypeDefinition
+    anyof_schema_3_validator: Optional[TypeDefinition] = None
+    # data type: GlobalVariable
+    anyof_schema_4_validator: Optional[GlobalVariable] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[Enumeration, GlobalVariable, Structure, TypeDefinition]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "Enumeration", "GlobalVariable", "Structure", "TypeDefinition" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = FunctionInfoInputFuncDepsInner.model_construct()
+        error_messages = []
+        # validate data type: Structure
+        if not isinstance(v, Structure):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `Structure`")
+        else:
+            return v
+
+        # validate data type: Enumeration
+        if not isinstance(v, Enumeration):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `Enumeration`")
+        else:
+            return v
+
+        # validate data type: TypeDefinition
+        if not isinstance(v, TypeDefinition):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TypeDefinition`")
+        else:
+            return v
+
+        # validate data type: GlobalVariable
+        if not isinstance(v, GlobalVariable):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `GlobalVariable`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in FunctionInfoInputFuncDepsInner with anyOf schemas: Enumeration, GlobalVariable, Structure, TypeDefinition. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # anyof_schema_1_validator: Optional[Structure] = None
+        try:
+            instance.actual_instance = Structure.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[Enumeration] = None
+        try:
+            instance.actual_instance = Enumeration.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_3_validator: Optional[TypeDefinition] = None
+        try:
+            instance.actual_instance = TypeDefinition.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_4_validator: Optional[GlobalVariable] = None
+        try:
+            instance.actual_instance = GlobalVariable.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into FunctionInfoInputFuncDepsInner with anyOf schemas: Enumeration, GlobalVariable, Structure, TypeDefinition. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], Enumeration, GlobalVariable, Structure, TypeDefinition]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

revengai/models/function_info_output.py

@@ -0,0 +1,105 @@
+# 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, Optional
+from revengai.models.function_info_input_func_deps_inner import FunctionInfoInputFuncDepsInner
+from revengai.models.function_type_output import FunctionTypeOutput
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionInfoOutput(BaseModel):
+    """
+    FunctionInfoOutput
+    """ # noqa: E501
+    func_types: Optional[FunctionTypeOutput] = None
+    func_deps: List[FunctionInfoInputFuncDepsInner] = Field(description="List of function dependencies")
+    __properties: ClassVar[List[str]] = ["func_types", "func_deps"]
+
+    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 FunctionInfoOutput 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 func_types
+        if self.func_types:
+            _dict['func_types'] = self.func_types.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in func_deps (list)
+        _items = []
+        if self.func_deps:
+            for _item_func_deps in self.func_deps:
+                if _item_func_deps:
+                    _items.append(_item_func_deps.to_dict())
+            _dict['func_deps'] = _items
+        # set to None if func_types (nullable) is None
+        # and model_fields_set contains the field
+        if self.func_types is None and "func_types" in self.model_fields_set:
+            _dict['func_types'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FunctionInfoOutput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "func_types": FunctionTypeOutput.from_dict(obj["func_types"]) if obj.get("func_types") is not None else None,
+            "func_deps": [FunctionInfoInputFuncDepsInner.from_dict(_item) for _item in obj["func_deps"]] if obj.get("func_deps") is not None else None
+        })
+        return _obj
+
+

revengai/models/function_list_item.py

@@ -0,0 +1,96 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionListItem(BaseModel):
+    """
+    FunctionListItem
+    """ # noqa: E501
+    id: StrictInt = Field(description="Function id")
+    name: StrictStr = Field(description="Name of the function")
+    mangled_name: StrictStr = Field(description="Mangled name of the function")
+    vaddr: StrictInt = Field(description="Function virtual address")
+    size: StrictInt = Field(description="Function size in bytes")
+    debug: StrictBool = Field(description="Whether the function has debug information")
+    __properties: ClassVar[List[str]] = ["id", "name", "mangled_name", "vaddr", "size", "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 FunctionListItem 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 FunctionListItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "mangled_name": obj.get("mangled_name"),
+            "vaddr": obj.get("vaddr"),
+            "size": obj.get("size"),
+            "debug": obj.get("debug")
+        })
+        return _obj
+
+

revengai/models/function_local_variable_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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FunctionLocalVariableResponse(BaseModel):
+    """
+    FunctionLocalVariableResponse
+    """ # noqa: E501
+    address: StrictStr
+    d_type: StrictStr
+    size: StrictInt
+    loc: StrictStr
+    name: StrictStr
+    __properties: ClassVar[List[str]] = ["address", "d_type", "size", "loc", "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 FunctionLocalVariableResponse 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 FunctionLocalVariableResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "address": obj.get("address"),
+            "d_type": obj.get("d_type"),
+            "size": obj.get("size"),
+            "loc": obj.get("loc"),
+            "name": obj.get("name")
+        })
+        return _obj
+
+