php-parser-py 0.1.1__py3-none-any.whl

php_parser_py/vendor/LICENSE.txt

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2011, Nikita Popov
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

php_parser_py-0.1.1.dist-info/METADATA

@@ -0,0 +1,190 @@
+Metadata-Version: 2.3
+Name: php-parser-py
+Version: 0.1.1
+Summary: Python wrapper for PHP-Parser using cpg2py
+Author: samhsu-dev
+Author-email: samhsu-dev <yxu166@jh.edu>
+Requires-Dist: cpg2py>=1.1.0
+Requires-Dist: static-php-py
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# php-parser-py
+
+Python wrapper for PHP-Parser using cpg2py's graph framework.
+
+## Overview
+
+`php-parser-py` provides a Python interface to [PHP-Parser](https://github.com/nikic/PHP-Parser), enabling Abstract Syntax Tree (AST) parsing and manipulation of PHP code. The library integrates with [cpg2py](https://github.com/jhu-seclab/cpg2py)'s graph framework for powerful graph-based code analysis.
+
+## Features
+
+- **Native PHP-Parser Integration**: Delegates all parsing and code generation to PHP-Parser for maximum compatibility
+- **Zero-Configuration PHP**: Bundled PHP binaries via static-php-py - no system PHP installation required
+- **Graph-Based Analysis**: Uses cpg2py's graph framework for AST traversal and querying
+- **Dynamic Node Types**: No hardcoded PHP node types - all types come from PHP-Parser's JSON output
+- **Lossless Round-Trip**: Parse → Modify → Generate code with full fidelity
+- **Cross-Platform Support**: Pre-built PHP 8.4 binaries for Linux (x86_64/aarch64), macOS (x86_64/arm64), and Windows (x64)
+
+## Installation
+
+```bash
+pip install php-parser-py
+```
+
+**Note**: Platform-specific wheels include pre-built PHP 8.4 binaries. No separate PHP installation required!
+
+## Quick Start
+
+### Parse PHP Code
+
+```python
+from php_parser_py import parse
+
+# Parse PHP code
+code = """<?php
+function greet($name) {
+    echo "Hello, $name!";
+}
+"""
+
+ast = parse(code)
+
+# Query nodes by type
+for func in ast.nodes(lambda n: n.label == "Stmt_Function"):
+    name = func.get_property("name")
+    print(f"Found function: {name}")
+```
+
+### Parse PHP File
+
+```python
+from php_parser_py import parse_file
+
+ast = parse_file("example.php")
+```
+
+### Traverse AST
+
+```python
+# Find all echo statements
+for echo in ast.nodes(lambda n: n.label == "Stmt_Echo"):
+    print(f"Echo at line {echo.get_property('startLine')}")
+
+# Get children of a node
+for child in ast.children(some_node):
+    print(f"Child type: {child.label}")
+
+# Get all descendants
+for descendant in ast.descendants(some_node):
+    print(f"Descendant: {descendant.label}")
+```
+
+### Generate PHP Code
+
+```python
+from php_parser_py import parse, PrettyPrinter
+
+# Parse code
+ast = parse("<?php echo 'hello';")
+
+# Modify AST (example: change properties)
+# ... modify nodes as needed ...
+
+# Generate code
+printer = PrettyPrinter()
+generated_code = printer.print(ast)
+print(generated_code)
+```
+
+## Advanced Usage
+
+### Custom PHP Binary
+
+If you need to use a specific PHP version or custom binary:
+
+```python
+from php_parser_py import Parser
+from pathlib import Path
+
+# Use local PHP binary
+parser = Parser(php_binary_path=Path("/usr/local/bin/php"))
+ast = parser.parse("<?php echo 'hello';")
+
+# Or download from remote URL
+parser = Parser(php_binary_url="https://example.com/php-8.4.zip")
+ast = parser.parse("<?php echo 'hello';")
+```
+
+## API Reference
+
+### Main Functions
+
+- **`parse(code: str) -> AST`**: Parse PHP code string and return AST
+- **`parse_file(path: str) -> AST`**: Parse PHP file and return AST
+
+### Classes
+
+- **`AST`**: Represents the complete AST as a graph
+  - `node(id)`: Get node by ID
+  - `nodes(predicate)`: Iterate nodes matching predicate
+  - `first_node(predicate)`: Get first matching node
+  - `children(node)`: Get child nodes
+  - `descendants(node)`: Get all descendants
+  - `to_json()`: Reconstruct PHP-Parser JSON
+
+- **`Node`**: Wraps a single AST node
+  - `id`: Node identifier
+  - `label`: Node type (e.g., "Stmt_Function")
+  - `properties`: All node properties
+  - `get_property(*names)`: Get property value
+
+- **`Parser`**: Parses PHP code
+  - `__init__(php_binary_path=None, php_binary_url=None)`: Initialize parser
+    - `php_binary_path`: Optional path to local PHP binary
+    - `php_binary_url`: Optional URL to download PHP binary from
+  - `parse(code, prefix="")`: Parse code string
+    - `prefix`: Optional prefix for node IDs (useful for multi-file parsing)
+  - `parse_file(path, prefix=None)`: Parse file
+    - `prefix`: Optional prefix (auto-generated from file path if not provided)
+
+- **`PrettyPrinter`**: Generates PHP code
+  - `__init__(php_binary_path=None, php_binary_url=None)`: Initialize printer
+    - `php_binary_path`: Optional path to local PHP binary
+    - `php_binary_url`: Optional URL to download PHP binary from
+  - `print(ast)`: Generate code from AST
+
+### Exceptions
+
+- **`ParseError`**: Raised when PHP-Parser reports syntax error
+- **`RunnerError`**: Raised when PHP execution fails
+
+## Architecture
+
+The library follows a delegation-based architecture:
+
+1. **PHP-Parser** handles all parsing and code generation
+2. **cpg2py Storage** stores the AST as a graph
+3. **Python classes** provide convenient access to the graph
+
+This design ensures:
+- No need to maintain PHP node type definitions in Python
+- Automatic compatibility with PHP-Parser updates
+- Full access to PHP-Parser's features
+
+## Requirements
+
+- Python >= 3.11
+- cpg2py
+- static-php-py (bundled PHP binaries)
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Documentation
+
+For detailed design documentation, see:
+- [Design Document](docs/design.md)
+- [Idea Document](docs/idea.md)
+- [API Demo](docs/api_demo.ipynb)

php_parser_py-0.1.1.dist-info/RECORD

@@ -0,0 +1,16 @@
+php_parser_py/__init__.py,sha256=-XSNHcVejEr0sasn7QU-Ly_UmhdcFbNvIrFXxaLxImQ,2095
+php_parser_py/_ast.py,sha256=y_YUeLkd40LNH-kEHJX1vbLVK7u2XZROgHLmCUtIrkk,6405
+php_parser_py/_edge.py,sha256=gIWkL-EhsLOWj4BuOwKHh5mHSC2z4Qk-ZxygCF7uPqk,3775
+php_parser_py/_node.py,sha256=8YZfXjKf_4lf1R29UxxByw_iN2pBlTK6HNbx0z-9uWU,5654
+php_parser_py/_parser.py,sha256=s35wKG7uoL0alut-tBVzmDVse-f-tivh-3T6B06b_bc,6885
+php_parser_py/_printer.py,sha256=XwhJWiVI8h0jhQE8FA6vzMKAHVJ2ktQbL-omcQhMet4,1371
+php_parser_py/_resources.py,sha256=jYPhMjyGX86IvT-JWT33fzF7CEaUr6t_gZRGuGbBRZ8,4487
+php_parser_py/_runner.py,sha256=J9-fBUwAIYonvWjHrtTkSUzMSTXLF4BC5XxDD1klmwc,7653
+php_parser_py/exceptions.py,sha256=cqGfU64-jXzJ9Y0edlMMZUzmMyClco0t-e33p5r90TA,1351
+php_parser_py/resources/php-parser-4.19.4.zip,sha256=ND6zsylItt4owMoQnq-3id_ScMAXEfVyHzzRi0wKthQ,144334
+php_parser_py/vendor/.extracted,sha256=35VHVRaR8xmvJSW2J6Z8MXxiFVnsRgeuJJPNS_5yzB8,64
+php_parser_py/vendor/LICENSE.txt,sha256=3YWeEH-sn4ekQTq4w8lvDxYRoX9Zai21YqWk9JBMHpc,1520
+php_parser_py/vendor/php-parser.phar,sha256=xeuVm4n37yt_DX3pNH1Ugc1ihGtoC97b7ao7a-AGjTk,1009441
+php_parser_py-0.1.1.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
+php_parser_py-0.1.1.dist-info/METADATA,sha256=taZyq_b2_CuZU0WqjfdSvSeKBMd4htqSdRCh2x_io8c,5420
+php_parser_py-0.1.1.dist-info/RECORD,,

php_parser_py-0.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.26
+Root-Is-Purelib: true
+Tag: py3-none-any