python-undef 0.1.0__tar.gz → 0.1.3__tar.gz

python_undef-0.1.3/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.4
+Name: python_undef
+Version: 0.1.3
+Summary: Python undefined header in pyconfig.h
+Project-URL: homepage, https://github.com/Locked-chess-official/python_undef
+Author-email: Locked-chess-official <13140752715@163.com>
+License: MIT
+License-File: LICENSE
+Description-Content-Type: text/markdown
+
+# Python_undef
+
+This is a Python script that generates a header file "Python_undef.h" which undefine many macros in "pyconfig.h" that doesn't match the rule that "should start with PY_".
+
+## Why
+
+The "pyconfig.h" continue many macros that doesn't math the rule that "should start with PY_" which may cause the comflict with the other projects. This project undefines them.
+
+## Download
+
+```bash
+pip install python_undef
+```
+
+## Usage
+
+This command will create the file "Python_undef.h"
+
+```bash
+python -m python_undef --generate
+```
+
+This command will output the include path of "Python_undef.h".
+
+You can use this command in your C/C++ project such as "cmake", "gyp" and so on.
+
+```bash
+python -m python_undef --include
+```
+
+You can include the "Python_undef.h" file in your project:
+
+```c
+#include <Python.h>
+#include <Python_undef.h>
+#include <other_header.h>
+```
+
+The "pyconfig.h" continue many macros that doesn't math the rule that "should start with PY_". This file undefine them.
+
+If you want to save the macro, use `#define DONOTUNDEF_macro_name` before include "Python_undef.h" to keep it.
+
+## License
+
+MIT License

python_undef-0.1.3/README.md

@@ -0,0 +1,45 @@
+# Python_undef
+
+This is a Python script that generates a header file "Python_undef.h" which undefine many macros in "pyconfig.h" that doesn't match the rule that "should start with PY_".
+
+## Why
+
+The "pyconfig.h" continue many macros that doesn't math the rule that "should start with PY_" which may cause the comflict with the other projects. This project undefines them.
+
+## Download
+
+```bash
+pip install python_undef
+```
+
+## Usage
+
+This command will create the file "Python_undef.h"
+
+```bash
+python -m python_undef --generate
+```
+
+This command will output the include path of "Python_undef.h".
+
+You can use this command in your C/C++ project such as "cmake", "gyp" and so on.
+
+```bash
+python -m python_undef --include
+```
+
+You can include the "Python_undef.h" file in your project:
+
+```c
+#include <Python.h>
+#include <Python_undef.h>
+#include <other_header.h>
+```
+
+The "pyconfig.h" continue many macros that doesn't math the rule that "should start with PY_". This file undefine them.
+
+If you want to save the macro, use `#define DONOTUNDEF_macro_name` before include "Python_undef.h" to keep it.
+
+## License
+
+MIT License

{python_undef-0.1.0 → python_undef-0.1.3}/pyproject.toml

@@ -4,8 +4,9 @@ build-backend = "hatchling.build"
 
 [project]
 name = "python_undef"
-version = "0.1.0"
+version = "0.1.3"
 description = "Python undefined header in pyconfig.h"
+readme = "README.md"
 license = {text = "MIT"}
 authors = [
     { name = "Locked-chess-official", email = "13140752715@163.com" }

{python_undef-0.1.0 → python_undef-0.1.3}/src/python_undef/__init__.py

@@ -2,8 +2,9 @@ import os
 import re
 import datetime
 import sys
+from pathlib import Path
 
-def is_valid_macro_name(macro_name):
+def is_valid_macro_name(macro_name: str):
     """
     Determine whether a macro name is valid using Python's standard library methods.
     
@@ -20,7 +21,7 @@ def is_valid_macro_name(macro_name):
     # Use str.isidentifier() to check for valid identifier syntax
     return macro_name.isidentifier()
 
-def extract_macro_name(line):
+def extract_macro_name(line: str):
     """Extract the macro name from a #define line (handles spaces between # and define)."""
     line = line.strip()
 
@@ -36,7 +37,7 @@ def extract_macro_name(line):
         return candidate
     return None
 
-def is_standard_python_macro(macro_name):
+def is_standard_python_macro(macro_name: str):
     """
     Check whether a macro follows Python's standard naming conventions.
     Rules: Starts with Py, PY, _Py, _PY, or ends with _H.
@@ -44,7 +45,7 @@ def is_standard_python_macro(macro_name):
     standard_prefixes = ('Py', 'PY', '_Py', '_PY')
     return macro_name.startswith(standard_prefixes) or macro_name.endswith('_H')
 
-def generate_undef_code(macro_name):
+def generate_undef_code(macro_name: str):
     """Generate the code to undefine a macro."""
     return f"""#ifndef DONOTUNDEF_{macro_name}
 #ifdef {macro_name}
@@ -54,7 +55,7 @@ def generate_undef_code(macro_name):
 
 """
 
-def generate_python_undef_header(pyconfig_path, output_path=None):
+def generate_python_undef_header(pyconfig_path: str, output_path: str|None=None):
     """
     Generate the Python_undef.h header file.
     
@@ -64,9 +65,14 @@ def generate_python_undef_header(pyconfig_path, output_path=None):
     """
     if output_path is None:
         file_dir = os.path.dirname(os.path.abspath(__file__))
-        output_path = f'{file_dir}/include/Python_undef.h'
-        if not os.path.exists(f'{file_dir}/include'):
-            os.makedirs(f'{file_dir}/include')
+        include_dir = Path(file_dir) / 'include'
+        output_path = str(include_dir / 'Python_undef.h')
+        if not include_dir.exists():
+            try:
+                os.makedirs(f'{file_dir}/include')
+            except Exception as e:
+                print(f"Error creating include directory: {e}")
+                return False
     
     # Read pyconfig.h
     try:
@@ -194,7 +200,7 @@ def generate_python_undef_header(pyconfig_path, output_path=None):
                 print(f"  ... and {len(macros_to_undef) - 50} more")
         
         print(f"\nUsage Notes:")
-        print(f"  1. Include this file before including other library headers.")
+        print(f"  1. Include this file before including other library headers but must be after '<Python.h>'.")
         print(f"  2. Use DONOTUNDEF_XXX to protect macros that must be kept.")
         print(f"  3. Regenerate this file whenever rebuilding Python.")
         
@@ -206,7 +212,6 @@ def generate_python_undef_header(pyconfig_path, output_path=None):
 
 def main():
     import sysconfig
-    from pathlib import Path
     if sys.argv[1:]:
         if sys.argv[1] in ('-h', '--help'):
             print("""Usage:
@@ -214,6 +219,7 @@ python -m python_undef --generate
     Generate Python_undef.h based on the system's pyconfig.h.
 python -m python_undef --include
     Print the include path where Python_undef.h is located.""")
+            sys.exit(0)
         elif sys.argv[1] == '--generate': 
             include_dir = Path(sysconfig.get_path('include'))
             print(f"\n{'='*60}")
@@ -227,9 +233,11 @@ python -m python_undef --include
                 
                 if success:
                     print(f"\n✅ Generation complete!")
-                    print(f"💡 Tip: Place Python_undef.h inside Python include search path.")
+                    print(f"💡 Tip: Use '{sys.executable} -m python_undef --include' to add this header file path to search path.")
+                    sys.exit(0)
                 else:
                     print(f"\n❌ Generation failed!")
+                    sys.exit(1)
                     
             else:
                 print(f"File {pyconfig_path} not found.")
@@ -239,14 +247,18 @@ python -m python_undef --include
                 print("\nTypical paths on Unix/Linux:")
                 print("  /usr/include/python3.x/pyconfig.h")
                 print("  /usr/local/include/python3.x/pyconfig.h")
+                sys.exit(1)
         elif sys.argv[1] == "--include":
             file_dir = os.path.dirname(os.path.abspath(__file__))
-            if not Path(file_dir).exists():
+            if not (Path(file_dir) / "include" / "Python_undef.h").exists():
                 print("File not found. Use 'python -m python_undef --generate' to generate the header first.")
-                return
+                sys.exit(1)
             include_path = os.path.abspath(os.path.join(file_dir, 'include'))
             print(include_path)
+            sys.exit(0)
         else:
             print("Unknown argument. Use --help for usage information.")
+            sys.exit(1)
     else:
         print("No arguments provided. Use --help for usage information.")
+        sys.exit(1)

python_undef-0.1.0/PKG-INFO

@@ -1,8 +0,0 @@
-Metadata-Version: 2.4
-Name: python_undef
-Version: 0.1.0
-Summary: Python undefined header in pyconfig.h
-Project-URL: homepage, https://github.com/Locked-chess-official/python_undef
-Author-email: Locked-chess-official <13140752715@163.com>
-License: MIT
-License-File: LICENSE

python_undef-0.1.0/README.md

@@ -1,37 +0,0 @@
-# Python_undef
-
-## Download
-
-```bash
-pip install python_undef
-```
-
-## Usage
-
-This will create the file "Python_undef.h"
-
-```bash
-python -m python_undef --generate
-```
-
-This will output the include path of "Python_undef.h"
-
-```bash
-python -m python_undef --include
-```
-
-You can include the "Python_undef.h" file in your project:
-
-```c
-#include <Python.h>
-#include <Python_undef.h>
-#include <other_header.h>
-```
-
-The "pyconfig.h" continue many macros that doesn't math the rule that "should start with PY_". This file undefine them.
-
-If you wan't to save the macro, use `#define DONOTUNDEF_macro_name` before include "Python_undef.h" to keep it.
-
-## License
-
-MIT License