Clean up (#178)

Author: ofek

cm_library_c_binding/build.py

@@ -26,8 +26,8 @@ def gather_sources_from_directory(directory: str) -> list[Source]:
     """
     sources = []
     for filename in os.listdir(directory):
-        if filename.endswith('.h'):
-            include_line = f'#include <{filename}>'
+        if filename.endswith(".h"):
+            include_line = f"#include <{filename}>"
             sources.append(Source(filename, include_line))
     return sorted(sources)
 
@@ -43,7 +43,7 @@ def mk_ffi(
     directory: str,
     sources: list[Source],
     static_lib: bool = False,  # noqa: FBT001, FBT002
-    name: str = '_libsecp256k1',
+    name: str = "_libsecp256k1",
 ) -> FFI:
     """
     Create an FFI object.
@@ -56,45 +56,45 @@ def mk_ffi(
     _ffi = FFI()
     code = [define_static_lib] if static_lib else []
 
-    logging.info('   Static %s...', static_lib)
+    logging.info("   Static %s...", static_lib)
     for source in sources:
-        with open(os.path.join(directory, source.h), encoding='utf-8') as h:
-            logging.info('   Including %s...', source.h)
+        with open(os.path.join(directory, source.h), encoding="utf-8") as h:
+            logging.info("   Including %s...", source.h)
             c_header = h.read()
             _ffi.cdef(c_header)
 
         code.append(source.include)
 
-    code.append('#define PY_USE_BUNDLED')
-    _ffi.set_source(name, '\n'.join(code))
+    code.append("#define PY_USE_BUNDLED")
+    _ffi.set_source(name, "\n".join(code))
 
     return _ffi
 
 
-if __name__ == '__main__':
-    logging.info('Starting CFFI build process...')
-    parser = argparse.ArgumentParser(description='Generate C code using CFFI.')
-    parser.add_argument('headers_dir', help='Path to the header files.', type=str)
-    parser.add_argument('c_file', help='Generated C code filename.', type=str)
-    parser.add_argument('static_lib', help='Generate static lib in Windows.', default='0N', type=str)
+if __name__ == "__main__":
+    logging.info("Starting CFFI build process...")
+    parser = argparse.ArgumentParser(description="Generate C code using CFFI.")
+    parser.add_argument("headers_dir", help="Path to the header files.", type=str)
+    parser.add_argument("c_file", help="Generated C code filename.", type=str)
+    parser.add_argument("static_lib", help="Generate static lib in Windows.", default="0N", type=str)
     args = parser.parse_args()
 
     modules = gather_sources_from_directory(args.headers_dir)
-    ffi = mk_ffi(args.headers_dir, modules, args.static_lib == 'ON')
+    ffi = mk_ffi(args.headers_dir, modules, args.static_lib == "ON")
     ffi.emit_c_code(args.c_file)
 
-    vendor_cffi = os.environ.get('COINCURVE_VENDOR_CFFI', '1') == '1'
+    vendor_cffi = os.environ.get("COINCURVE_VENDOR_CFFI", "1") == "1"
     if vendor_cffi:
-        with open(args.c_file, encoding='utf-8') as f:
+        with open(args.c_file, encoding="utf-8") as f:
             source = f.read()
 
         expected_text = 'PyImport_ImportModule("_cffi_backend")'
         if expected_text not in source:
-            msg = f'{expected_text} not found in {args.c_file}'
+            msg = f"{expected_text} not found in {args.c_file}"
             raise ValueError(msg)
 
         new_source = source.replace(expected_text, 'PyImport_ImportModule("coincurve._cffi_backend")')
-        with open(args.c_file, 'w', encoding='utf-8') as f:
+        with open(args.c_file, "w", encoding="utf-8") as f:
             f.write(new_source)
 
-    logging.info('   Generated C code: %s', args.c_file)
+    logging.info("   Generated C code: %s", args.c_file)

cm_library_cffi_headers/compose_cffi_headers.py

@@ -8,21 +8,21 @@
 
 
 def remove_c_comments_emptylines(text):
-    text = re.sub(r'/\*.*?\*/', '', text, flags=re.DOTALL)  # Remove multi-line comments
-    text = re.sub(r'//.*', '', text)  # Remove single-line comments
-    return re.sub(r'\n\s*\n+', '\n', text)  # Remove empty lines
+    text = re.sub(r"/\*.*?\*/", "", text, flags=re.DOTALL)  # Remove multi-line comments
+    text = re.sub(r"//.*", "", text)  # Remove single-line comments
+    return re.sub(r"\n\s*\n+", "\n", text)  # Remove empty lines
 
 
 def remove_c_includes(lines):
-    return [line for line in lines if not re.match(r'^\s*#include\s', line)]
+    return [line for line in lines if not re.match(r"^\s*#include\s", line)]
 
 
 def remove_special_defines(lines, defines):
-    return [line for line in lines if not any(f'#define {define}' in line for define in defines)]
+    return [line for line in lines if not any(f"#define {define}" in line for define in defines)]
 
 
 def apply_cffi_defines_syntax(lines):
-    return [re.sub(r'#\s*define\s+(\w+).*', r'#define \1 ...', line) for line in lines]
+    return [re.sub(r"#\s*define\s+(\w+).*", r"#define \1 ...", line) for line in lines]
 
 
 def remove_c_ifdef(lines):
@@ -34,15 +34,15 @@ def remove_c_ifdef(lines):
     for line in lines:
         stripped_line = line.rstrip()
 
-        if re.match(r'^#\s*(if|el|endif)', stripped_line):
-            stripped_line = stripped_line.replace(' ', '')
-            ifdef_count += stripped_line.count('#if') - stripped_line.count('#endif')
+        if re.match(r"^#\s*(if|el|endif)", stripped_line):
+            stripped_line = stripped_line.replace(" ", "")
+            ifdef_count += stripped_line.count("#if") - stripped_line.count("#endif")
             continue
 
         if ifdef_count == 0:
             processed_lines.append(stripped_line)
         elif ifdef_count < 0 and line != lines[-1]:
-            msg = 'Unbalanced #if/#endif preprocessor directives.'
+            msg = "Unbalanced #if/#endif preprocessor directives."
             raise ValueError(msg)
 
     return processed_lines
@@ -56,16 +56,16 @@ def concatenate_c_defines(lines):
     for line in lines:
         stripped_line = line.rstrip()
 
-        if (re.match(r'#\s*define', stripped_line) or in_define) and stripped_line.endswith('\\'):
+        if (re.match(r"#\s*define", stripped_line) or in_define) and stripped_line.endswith("\\"):
             in_define = True
             buffer.append(
-                re.sub(r'#\s*define', '#define', stripped_line).rstrip('\\').strip()
+                re.sub(r"#\s*define", "#define", stripped_line).rstrip("\\").strip()
             )  # Normalize #define and remove trailing backslash
             continue  # Skip the rest of the loop to avoid resetting the buffer
 
         if in_define:
             buffer.append(stripped_line)
-            processed_lines.append(' '.join(buffer))
+            processed_lines.append(" ".join(buffer))
             buffer = []  # Reset the buffer for the next definition
             in_define = False
             continue  # Skip the rest of the loop to avoid adding the line again
@@ -85,25 +85,25 @@ def remove_deprecated_functions(lines, deprecation):
     for line in lines:
         stripped_line = line.rstrip()
 
-        if re.match(r'#\s*define', stripped_line) or in_define:
-            in_define = bool(stripped_line.endswith('\\'))
+        if re.match(r"#\s*define", stripped_line) or in_define:
+            in_define = bool(stripped_line.endswith("\\"))
             processed_lines.append(stripped_line)
             continue
 
-        if stripped_line.startswith('struct') or re.match(r'typedef\s+struct', stripped_line) or in_struct:
+        if stripped_line.startswith("struct") or re.match(r"typedef\s+struct", stripped_line) or in_struct:
             in_struct = True
             processed_lines.append(stripped_line)
-            brace_count += stripped_line.count('{') - stripped_line.count('}')
+            brace_count += stripped_line.count("{") - stripped_line.count("}")
             if brace_count == 0:  # End of struct block
                 in_struct = False
             continue
 
         buffer.append(stripped_line)
 
         # Check for the end of a function declaration
-        if stripped_line.endswith(';') and not in_struct:
+        if stripped_line.endswith(";") and not in_struct:
             # Extend if not DEPRECATED
-            if not any(d in ' '.join(buffer) for d in deprecation):
+            if not any(d in " ".join(buffer) for d in deprecation):
                 processed_lines.extend(buffer)
             buffer = []  # Reset the buffer for the next definition
 
@@ -119,14 +119,14 @@ def remove_function_attributes(lines, attributes):
         for attribute, replacement in attributes.items():
             # Attributes can be functions with (...), so using regular expression
             # Remove the definition
-            if re.search(rf'#\s*define\s+{attribute}(\(.*\))?\b', stripped_line):
+            if re.search(rf"#\s*define\s+{attribute}(\(.*\))?\b", stripped_line):
                 stripped_line = None
                 break
 
-            if re.search(rf'\b{attribute}(\(.*\))?\b', stripped_line):
-                stripped_line = re.sub(rf'\b{attribute}(\(.*\))?', f'{replacement}', stripped_line)
-                stripped_line = stripped_line.replace(' ;', ';')
-                stripped_line = stripped_line.replace('  ', ' ')
+            if re.search(rf"\b{attribute}(\(.*\))?\b", stripped_line):
+                stripped_line = re.sub(rf"\b{attribute}(\(.*\))?", f"{replacement}", stripped_line)
+                stripped_line = stripped_line.replace(" ;", ";")
+                stripped_line = stripped_line.replace("  ", " ")
 
         if stripped_line:
             processed_lines.append(stripped_line)
@@ -141,7 +141,7 @@ def remove_header_guard(lines, keywords):
         stripped_line = line.rstrip()
 
         for keyword in keywords:
-            if re.search(rf'#\s*define\s+{keyword}.*_H\b', stripped_line):
+            if re.search(rf"#\s*define\s+{keyword}.*_H\b", stripped_line):
                 continue
             processed_lines.append(stripped_line)
 
@@ -157,12 +157,12 @@ def concatenate_c_struct(lines):
     for line in lines:
         stripped_line = line.strip()
 
-        if stripped_line.startswith('struct') or re.match(r'typedef\s+struct', stripped_line) or in_struct:
+        if stripped_line.startswith("struct") or re.match(r"typedef\s+struct", stripped_line) or in_struct:
             in_struct = True
-            brace_count += stripped_line.count('{') - stripped_line.count('}')
+            brace_count += stripped_line.count("{") - stripped_line.count("}")
             buffer.append(stripped_line)
             if brace_count == 0:  # End of struct block
-                processed_lines.append(' '.join(buffer).strip())
+                processed_lines.append(" ".join(buffer).strip())
                 buffer = []  # Reset the buffer for the next definition
                 in_struct = False
             continue  # Skip the rest of the loop to avoid adding the line again
@@ -173,72 +173,72 @@ def concatenate_c_struct(lines):
 
 
 def make_header_cffi_compliant(src_header_dir, src_header, cffi_dir):
-    with open(os.path.join(src_header_dir, src_header), encoding='utf-8') as f:
+    with open(os.path.join(src_header_dir, src_header), encoding="utf-8") as f:
         text = remove_c_comments_emptylines(f.read())
-    lines = text.split('\n')
+    lines = text.split("\n")
 
     lines = remove_c_includes(lines)
     lines = remove_c_ifdef(lines)
     lines = concatenate_c_defines(lines)
-    lines = remove_deprecated_functions(lines, ['DEPRECATED'])
-    lines = remove_header_guard(lines, ['SECP256K1'])
+    lines = remove_deprecated_functions(lines, ["DEPRECATED"])
+    lines = remove_header_guard(lines, ["SECP256K1"])
     lines = remove_function_attributes(
         lines,
         {
-            'SECP256K1_API': 'extern',
-            'SECP256K1_WARN_UNUSED_RESULT': '',
-            'SECP256K1_DEPRECATED': '',
-            'SECP256K1_ARG_NONNULL': '',
+            "SECP256K1_API": "extern",
+            "SECP256K1_WARN_UNUSED_RESULT": "",
+            "SECP256K1_DEPRECATED": "",
+            "SECP256K1_ARG_NONNULL": "",
         },
     )
     lines = remove_special_defines(
         lines,
         [
             # Deprecated flags
-            'SECP256K1_CONTEXT_VERIFY',
-            'SECP256K1_CONTEXT_SIGN',
-            'SECP256K1_FLAGS_BIT_CONTEXT_VERIFY',
-            'SECP256K1_FLAGS_BIT_CONTEXT_SIGN',
+            "SECP256K1_CONTEXT_VERIFY",
+            "SECP256K1_CONTEXT_SIGN",
+            "SECP256K1_FLAGS_BIT_CONTEXT_VERIFY",
+            "SECP256K1_FLAGS_BIT_CONTEXT_SIGN",
             # Testing flags
-            'SECP256K1_CONTEXT_DECLASSIFY',
-            'SECP256K1_FLAGS_BIT_CONTEXT_DECLASSIFY',
+            "SECP256K1_CONTEXT_DECLASSIFY",
+            "SECP256K1_FLAGS_BIT_CONTEXT_DECLASSIFY",
             # Not for direct use - That may not mean to remove them!
             #   'SECP256K1_FLAGS_TYPE_MASK',
             #   'SECP256K1_FLAGS_TYPE_CONTEXT',
             #   'SECP256K1_FLAGS_TYPE_COMPRESSION',
             #   'SECP256K1_FLAGS_BIT_COMPRESSION',
             # Not supported
-            'SECP256K1_SCHNORRSIG_EXTRAPARAMS_MAGIC',
-            'SECP256K1_SCHNORRSIG_EXTRAPARAMS',
+            "SECP256K1_SCHNORRSIG_EXTRAPARAMS_MAGIC",
+            "SECP256K1_SCHNORRSIG_EXTRAPARAMS",
         ],
     )
     lines = apply_cffi_defines_syntax(lines)
 
-    logging.info('   Writting: %s in %s', src_header, cffi_dir)
+    logging.info("   Writting: %s in %s", src_header, cffi_dir)
     output_filename = os.path.join(cffi_dir, src_header)
-    with open(output_filename, 'w', encoding='utf-8') as f_out:
-        f_out.write('\n'.join(lines))
+    with open(output_filename, "w", encoding="utf-8") as f_out:
+        f_out.write("\n".join(lines))
 
 
-if __name__ == '__main__':
-    parser = argparse.ArgumentParser(description='Process a header file.')
-    parser.add_argument('src_header_dir', type=str, help='The path to the header file to be processed.')
-    parser.add_argument('cffi_header', type=str, help='The path where the compliant header will be written.')
-    parser.add_argument('cffi_dir', type=str, help='The path where the compliant header will be written.', default='.')
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Process a header file.")
+    parser.add_argument("src_header_dir", type=str, help="The path to the header file to be processed.")
+    parser.add_argument("cffi_header", type=str, help="The path where the compliant header will be written.")
+    parser.add_argument("cffi_dir", type=str, help="The path where the compliant header will be written.", default=".")
 
     args = parser.parse_args()
 
     # Verify args are valid
     if not os.path.isdir(args.src_header_dir):
-        logging.error('Error: Directory: %s not found.', args.src_header_dir)
+        logging.error("Error: Directory: %s not found.", args.src_header_dir)
         sys.exit(1)
 
     if not os.path.isdir(args.cffi_dir):
-        logging.error('Error: Directory: %s not found.', args.cffi_dir)
+        logging.error("Error: Directory: %s not found.", args.cffi_dir)
         sys.exit(1)
 
     if not os.path.isfile(os.path.join(args.src_header_dir, args.cffi_header)):
-        logging.error('Error: %s not found in %s.', args.cffi_header, args.src_header_dir)
+        logging.error("Error: %s not found in %s.", args.cffi_header, args.src_header_dir)
         sys.exit(1)
 
     make_header_cffi_compliant(args.src_header_dir, args.cffi_header, args.cffi_dir)

hatch_build.py

@@ -16,21 +16,21 @@ class CustomBuildHook(BuildHookInterface):
     the `cffi` package is not required as a runtime dependency.
     """
 
-    LICENSE_NAME = 'LICENSE-cffi'
+    LICENSE_NAME = "LICENSE-cffi"
 
     @cached_property
     def local_cffi_license(self) -> str:
         return os.path.join(self.root, self.LICENSE_NAME)
 
     def initialize(self, version: str, build_data: dict[str, Any]) -> None:  # noqa: ARG002
         cffi_shared_lib = _cffi_backend.__file__
-        relative_path = f'coincurve/{os.path.basename(cffi_shared_lib)}'
-        build_data['force_include'][cffi_shared_lib] = relative_path
+        relative_path = f"coincurve/{os.path.basename(cffi_shared_lib)}"
+        build_data["force_include"][cffi_shared_lib] = relative_path
 
-        dist = distribution('cffi')
-        license_files = [f for f in dist.files if f.name == 'LICENSE' and f.parent.name.endswith('.dist-info')]
+        dist = distribution("cffi")
+        license_files = [f for f in dist.files if f.name == "LICENSE" and f.parent.name.endswith(".dist-info")]
         if len(license_files) != 1:
-            message = f'Expected exactly one LICENSE file in cffi distribution, got {len(license_files)}'
+            message = f"Expected exactly one LICENSE file in cffi distribution, got {len(license_files)}"
             raise RuntimeError(message)
 
         license_file = license_files[0]

ruff.toml

@@ -2,7 +2,6 @@ extend = "ruff_defaults.toml"
 
 [format]
 preview = true
-quote-style = "single"
 
 [lint]
 preview = true

src/coincurve/__about__.py

@@ -1 +1 @@
-__version__ = '20.0.0'
+__version__ = "20.0.0"

src/coincurve/__init__.py

@@ -3,10 +3,10 @@
 from coincurve.utils import verify_signature
 
 __all__ = [
-    'GLOBAL_CONTEXT',
-    'Context',
-    'PrivateKey',
-    'PublicKey',
-    'PublicKeyXOnly',
-    'verify_signature',
+    "GLOBAL_CONTEXT",
+    "Context",
+    "PrivateKey",
+    "PublicKey",
+    "PublicKeyXOnly",
+    "verify_signature",
 ]