python-undef 0.1.1__tar.gz → 0.1.5__tar.gz

{python_undef-0.1.1 → python_undef-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python_undef
-Version: 0.1.1
+Version: 0.1.5
 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>
@@ -10,6 +10,12 @@ 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
@@ -18,13 +24,23 @@ pip install python_undef
 
 ## Usage
 
-This will create the file "Python_undef.h"
+This command under will create the file "Python_undef.h"
 
 ```bash
 python -m python_undef --generate
 ```
 
-This will output the include path of "Python_undef.h"
+It defaults output the file "Python_undef.h" in the package directory. You can use the `--output` option to specify the output file:
+
+```bash
+python -m python_undef --generate --output <path>
+```
+
+The command under 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.
+
+If hadn't run `python -m python_undef --generate` it will exit with code 1.
 
 ```bash
 python -m python_undef --include

python_undef-0.1.5/README.md

@@ -0,0 +1,53 @@
+# 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 under will create the file "Python_undef.h"
+
+```bash
+python -m python_undef --generate
+```
+
+It defaults output the file "Python_undef.h" in the package directory. You can use the `--output` option to specify the output file:
+
+```bash
+python -m python_undef --generate --output <path>
+```
+
+The command under 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.
+
+If hadn't run `python -m python_undef --generate` it will exit with code 1.
+
+```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.1 → python_undef-0.1.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "python_undef"
-version = "0.1.1"
+version = "0.1.5"
 description = "Python undefined header in pyconfig.h"
 readme = "README.md"
 license = {text = "MIT"}

{python_undef-0.1.1 → python_undef-0.1.5}/src/python_undef/__init__.py

@@ -1,9 +1,24 @@
+"""
+python_undef - A utility to generate a header file that undefines non-standard Python macros in pyconfig.h.
+
+Usage:
+    python -m python_undef --generate
+    This is the main command to generate Python_undef.h based on the system's pyconfig.h to the include directly under the package directly.
+    python -m python_undef --generate --output <path>
+    This command generates Python_undef.h and saves it to the specified output path.
+    python -m python_undef --include
+    This command prints the include path where Python_undef.h is located.
+    python -m python_undef --help
+    Display this help message.
+"""
+
 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 +35,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 +51,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 +59,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 +69,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,19 +79,24 @@ 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}", file=sys.stderr)
+                return False
     
     # Read pyconfig.h
     try:
         with open(pyconfig_path, 'r', encoding='utf-8') as f:
             lines = f.readlines()
     except FileNotFoundError:
-        print(f"Error: File not found {pyconfig_path}")
+        print(f"Error: File not found {pyconfig_path}", file=sys.stderr)
         return False
     except Exception as e:
-        print(f"Error reading file: {e}")
+        print(f"Error reading file: {e}", file=sys.stderr)
         return False
     
     # Collect macros
@@ -126,7 +146,7 @@ def generate_python_undef_header(pyconfig_path, output_path=None):
  *   #define DONOTUNDEF_MACRO_NAME
  * 
  * Generation rules:
- *   - Macros starting with Py_, PY_, _Py, _PY are preserved (Python standard)
+ *   - Macros starting with Py, PY, _Py, _PY are preserved (Python standard)
  *   - Macros ending with _H are preserved (header guards)
  *   - All other macros are undefined
  *   - Macro name validation uses Python's standard identifier checking
@@ -194,26 +214,28 @@ 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.")
         
         return True
         
     except Exception as e:
-        print(f"Error writing file: {e}")
+        print(f"Error writing file: {e}", file=sys.stderr)
         return False
 
 def main():
     import sysconfig
-    from pathlib import Path
     if sys.argv[1:]:
         if sys.argv[1] in ('-h', '--help'):
             print("""Usage:
 python -m python_undef --generate
-    Generate Python_undef.h based on the system's pyconfig.h.
+    Generate Python_undef.h based on the system's pyconfig.h to the include directly under the package directly.
+python -m python_undef --generate --output <path>
+    Generate Python_undef.h and specify output path.
 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}")
@@ -223,30 +245,44 @@ python -m python_undef --include
             pyconfig_path = include_dir / "pyconfig.h"
             
             if os.path.exists(pyconfig_path):
-                success = generate_python_undef_header(pyconfig_path)
-                
+                if sys.argv[2:]:
+                    if sys.argv[2] == "--output" and len(sys.argv) == 4:
+                        if not os.path.isdir(sys.argv[3]):
+                            print("Error: Specified output path does not exist.", file=sys.stderr)
+                            sys.exit(1)
+                        output_path = str(Path(sys.argv[3]) / "Python_undef.h")
+                        print(f"Output path specified: {output_path}")
+                    else:
+                        print("Invalid output argument. Use --output <path> to specify output file.", file=sys.stderr)
+                        sys.exit(1)
+                else:
+                    output_path = None
+                success = generate_python_undef_header(pyconfig_path, output_path)
+
                 if success:
                     print(f"\n✅ Generation complete!")
-                    print(f"💡 Tip: Place Python_undef.h inside Python include search path.")
+                    if not output_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!")
-                    
+                    print(f"\n❌ Generation failed!", file=sys.stderr)
+                    sys.exit(1)
+
             else:
-                print(f"File {pyconfig_path} not found.")
-                print("Please update the pyconfig_path variable to the actual pyconfig.h path.")
-                print("\nTypical paths on Windows:")
-                print("  C:\\\\Python3x\\\\include\\\\pyconfig.h")
-                print("\nTypical paths on Unix/Linux:")
-                print("  /usr/include/python3.x/pyconfig.h")
-                print("  /usr/local/include/python3.x/pyconfig.h")
+                print(f"File {pyconfig_path} not found.", file=sys.stderr)
+                print("Please ensure the python is standard installation with headers.", file=sys.stderr)
+                sys.exit(1)
         elif sys.argv[1] == "--include":
             file_dir = os.path.dirname(os.path.abspath(__file__))
-            if not Path(file_dir).exists():
-                print("File not found. Use 'python -m python_undef --generate' to generate the header first.")
-                return
+            if not (Path(file_dir) / "include" / "Python_undef.h").exists():
+                print(f"File not found. Use '{sys.executable} -m python_undef --generate' to generate the header first.", file=sys.stderr)
+                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.")
+            print("Unknown argument. Use --help for usage information.", file=sys.stderr)
+            sys.exit(1)
     else:
-        print("No arguments provided. Use --help for usage information.")
+        print("No arguments provided. Use --help for usage information.", file=sys.stderr)
+        sys.exit(1)

python_undef-0.1.1/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 want to save the macro, use `#define DONOTUNDEF_macro_name` before include "Python_undef.h" to keep it.
-
-## License
-
-MIT License