Rename import r2 to import r2libr

Author: wtdcode

.github/workflows/generate_bindings.yml

@@ -4,7 +4,7 @@ on:
   push:
     paths:
       - 'r2libr/**'
-      - '!r2libr/r2/**'
+      - '!r2libr/libr/**'
     branches:
       - "*"
   workflow_dispatch:
@@ -40,7 +40,7 @@ jobs:
       run: cd r2libr && env BINDINGS=1 python3 setup.py build
 
     - name: Generate bindings.
-      run: cd r2libr/tools && python3 gen.py -O ../r2/ -B ../radare2/pyr2installdir/
+      run: cd r2libr/tools && python3 gen.py -O ../libr/ -B ../radare2/pyr2installdir/
 
     - name: Test bindings.
       run: cd r2libr && python3 -m pip install -e . && cd tests && python3 test_r2libr.py

r2libr/README.md

@@ -20,24 +20,24 @@ pip3 install --upgrade r2libr
 Implement a basic command line r2 by r2libr.
 
 ```python
-import r2
+import libr
 import ctypes
 import argparse
 
 class R2:
 
     def __init__(self, binary):
         binary = binary.encode("utf-8")
-        self._r2c = r2.r_core.r_core_new()
-        fh = r2.r_core.r_core_file_open(self._r2c, ctypes.create_string_buffer(binary), 0b101, 0)
-        r2.r_core.r_core_bin_load(self._r2c, ctypes.create_string_buffer(binary), (1<<64) - 1)
+        self._r2c = libr.r_core.r_core_new()
+        fh = libr.r_core.r_core_file_open(self._r2c, ctypes.create_string_buffer(binary), 0b101, 0)
+        libr.r_core.r_core_bin_load(self._r2c, ctypes.create_string_buffer(binary), (1<<64) - 1)
 
     def cmd(self, cmd):
-        r = r2.r_core.r_core_cmd_str(self._r2c, ctypes.create_string_buffer(cmd.encode("utf-8")))
+        r = libr.r_core.r_core_cmd_str(self._r2c, ctypes.create_string_buffer(cmd.encode("utf-8")))
         return ctypes.string_at(r).decode('utf-8')
 
     def __del__(self):
-        r2.r_core.r_core_free(self._r2c)
+        libr.r_core.r_core_free(self._r2c)
 
 if __name__ == "__main__":
     ap = argparse.ArgumentParser("Implement a basic command line r2 by r2libr")

r2libr/examples/r2-cli.py

@@ -1,21 +1,21 @@
-import r2
+import libr
 import ctypes
 import argparse
 
 class R2:
 
     def __init__(self, binary):
         binary = binary.encode("utf-8")
-        self._r2c = r2.r_core.r_core_new()
-        fh = r2.r_core.r_core_file_open(self._r2c, ctypes.create_string_buffer(binary), 0b101, 0)
-        r2.r_core.r_core_bin_load(self._r2c, ctypes.create_string_buffer(binary), (1<<64) - 1)
+        self._r2c = libr.r_core.r_core_new()
+        fh = libr.r_core.r_core_file_open(self._r2c, ctypes.create_string_buffer(binary), 0b101, 0)
+        libr.r_core.r_core_bin_load(self._r2c, ctypes.create_string_buffer(binary), (1<<64) - 1)
 
     def cmd(self, cmd):
-        r = r2.r_core.r_core_cmd_str(self._r2c, ctypes.create_string_buffer(cmd.encode("utf-8")))
+        r = libr.r_core.r_core_cmd_str(self._r2c, ctypes.create_string_buffer(cmd.encode("utf-8")))
         return ctypes.string_at(r).decode('utf-8')
 
     def __del__(self):
-        r2.r_core.r_core_free(self._r2c)
+        libr.r_core.r_core_free(self._r2c)
 
 if __name__ == "__main__":
     ap = argparse.ArgumentParser("Implement a basic command line r2 by r2libr")

r2libr/r2/__init__.py r2libr/libr/__init__.py

@@ -18,7 +18,7 @@
 
 ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
 RADARE2_DIR = Path(ROOT_DIR) / "radare2"
-LIBS_DIR = Path(ROOT_DIR) / "r2" / "libr"
+LIBS_DIR = Path(ROOT_DIR) / "libr" / "libr"
 
 def detect_python_on_windows():
     try:
@@ -38,7 +38,7 @@ def detect_python_on_windows():
 
 def clean_builds():
     shutil.rmtree(Path(ROOT_DIR) / "build", ignore_errors=True)
-    shutil.rmtree(Path(ROOT_DIR) / "r2" / "libr", ignore_errors=True)
+    shutil.rmtree(Path(ROOT_DIR) / "libr" / "libr", ignore_errors=True)
     shutil.rmtree(Path(ROOT_DIR) / "radare2" / "pyr2installdir", ignore_errors=True)
     shutil.rmtree(Path(ROOT_DIR) / "radare2" / "pyr2build", ignore_errors=True)
 
@@ -176,7 +176,7 @@ def build_radare2():
             if sys.platform == "darwin" and not p.is_symlink():
                 rewrite_dyld_path(p)
             # Known Issue: Altough we copy symlinks here, still python would follow symlink and copy a duplicate one.
-            #              To keep r2libs.py simple (meson write versions to file names), let's keep that copy.
+            #              To keep r_libs.py simple (meson write versions to file names), let's keep that copy.
             shutil.copy(p, LIBS_DIR, follow_symlinks=False)
     os.chdir(ROOT_DIR) 
 
@@ -227,7 +227,7 @@ def run(self):
 
 setuptools.setup(
     name="r2libr",
-    version="5.1.0-1",
+    version="5.1.0-2",
     author="mio",
     author_email="[email protected]",
     description="Yet anohter radare2 python bindings.",
@@ -248,7 +248,7 @@ def run(self):
     include_package_data=True,
     is_pure=False,
     package_data= {
-        "r2" : ['libr/*']
+        "libr" : ['libr/*']
     }
 )
 

r2libr/r2/r_anal.py r2libr/libr/r_anal.py

@@ -1,6 +1,6 @@
 import unittest
 import ctypes
-import r2
+import libr
 import json
 import struct
 import sys
@@ -13,43 +13,43 @@
 class R2LIBRTest(unittest.TestCase):
 
     def __get_r_core(self):
-        r2c = r2.r_core.r_core_new()
-        fh = r2.r_core.r_core_file_open(r2c, ctypes.create_string_buffer(example_file), 0b101, 0)
-        r2.r_core.r_core_bin_load(r2c, ctypes.create_string_buffer(example_file), (1<<64) - 1)
+        r2c = libr.r_core.r_core_new()
+        fh = libr.r_core.r_core_file_open(r2c, ctypes.create_string_buffer(example_file), 0b101, 0)
+        libr.r_core.r_core_bin_load(r2c, ctypes.create_string_buffer(example_file), (1<<64) - 1)
         return r2c
 
     def test_r_core(self):
         r2c = self.__get_r_core()
-        r2.r_core.r_core_cmd_str(r2c, ctypes.create_string_buffer(b"ieq"))
-        r2.r_core.r_core_cmd_str(r2c, ctypes.create_string_buffer(b"aaa"))
+        libr.r_core.r_core_cmd_str(r2c, ctypes.create_string_buffer(b"ieq"))
+        libr.r_core.r_core_cmd_str(r2c, ctypes.create_string_buffer(b"aaa"))
         if sys.platform != "win32":
-            print(f'Disasm 1 instruction:\n{ctypes.string_at(r2.r_core.r_core_cmd_str(r2c, ctypes.create_string_buffer(b"pd 1"))).decode("utf-8")}')
+            print(f'Disasm 1 instruction:\n{ctypes.string_at(libr.r_core.r_core_cmd_str(r2c, ctypes.create_string_buffer(b"pd 1"))).decode("utf-8")}')
         else:
             # CMD doesn't support colors.
-            print(f'Disasm 1 instruction:\n{ctypes.string_at(r2.r_core.r_core_cmd_str(r2c, ctypes.create_string_buffer(b"pdj 1"))).decode("utf-8")}')
-        r2.r_core.r_core_free(r2c)
+            print(f'Disasm 1 instruction:\n{ctypes.string_at(libr.r_core.r_core_cmd_str(r2c, ctypes.create_string_buffer(b"pdj 1"))).decode("utf-8")}')
+        libr.r_core.r_core_free(r2c)
 
     def test_r_anal(self):
         r2c = self.__get_r_core()
-        r2.r_core.r_core_cmd_str(r2c, ctypes.create_string_buffer(b"ieq"))
-        r2.r_core.r_core_cmd_str(r2c, ctypes.create_string_buffer(b"aaa"))
+        libr.r_core.r_core_cmd_str(r2c, ctypes.create_string_buffer(b"ieq"))
+        libr.r_core.r_core_cmd_str(r2c, ctypes.create_string_buffer(b"aaa"))
         # Workaround for multiple declarations in sources.
-        r2anal = ctypes.cast(ctypes.addressof(r2c.contents.anal.contents), ctypes.POINTER(r2.r_anal.struct_r_anal_t))
-        print(f"We have {r2.r_anal.r_anal_xrefs_count(r2anal)} xrefs!")
+        r2anal = ctypes.cast(ctypes.addressof(r2c.contents.anal.contents), ctypes.POINTER(libr.r_anal.struct_r_anal_t))
+        print(f"We have {libr.r_anal.r_anal_xrefs_count(r2anal)} xrefs!")
 
     def test_r_asm(self):
         buffer = b"\x90\x90\x90"
         buffer = ctypes.cast(buffer, ctypes.POINTER(ctypes.c_ubyte))
         r2c = self.__get_r_core()
-        r2asm = ctypes.cast(r2c.contents.rasm, ctypes.POINTER(r2.r_asm.struct_r_asm_t))
-        asmcode = r2.r_asm.r_asm_mdisassemble(r2asm, buffer, 3)
+        r2asm = ctypes.cast(r2c.contents.rasm, ctypes.POINTER(libr.r_asm.struct_r_asm_t))
+        asmcode = libr.r_asm.r_asm_mdisassemble(r2asm, buffer, 3)
         disasm_output = ctypes.string_at(asmcode.contents.assembly).decode('utf-8')
         self.assertEqual(disasm_output, "nop\nnop\nnop\n")
 
     def test_r_util_json(self):
         json_str = b'{"key" : "value"}'
-        rjson = r2.r_util.r_json_parse(json_str)
-        rjson = r2.r_util.r_json_get(rjson, b"key")
+        rjson = libr.r_util.r_json_parse(json_str)
+        rjson = libr.r_util.r_json_get(rjson, b"key")
         value = ctypes.string_at(rjson.contents.str_value).decode("utf-8")
         self.assertEqual(value, "value")
 
@@ -58,7 +58,7 @@ def test_r_util_utf8(self):
         rune = ord(u8)
         buffer = ctypes.create_string_buffer(4)
         buffer = ctypes.cast(buffer, ctypes.POINTER(ctypes.c_ubyte))
-        l = r2.r_util.r_utf8_encode(buffer, ctypes.c_uint32(rune))
+        l = libr.r_util.r_utf8_encode(buffer, ctypes.c_uint32(rune))
         self.assertEqual(ctypes.string_at(buffer, l), u8.encode("utf-8"))
 
 if __name__ == "__main__":