https://github.com/alexey-t/pyphptree

Python module, parses PHP source and finds class/function/namespace declarations
https://github.com/alexey-t/pyphptree

parser-library python

Last synced: 10 months ago
JSON representation

Python module, parses PHP source and finds class/function/namespace declarations

• Host: GitHub
• URL: https://github.com/alexey-t/pyphptree
• Owner: Alexey-T
• License: mpl-2.0
• Created: 2018-05-15T14:46:54.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-08-02T06:43:12.000Z (almost 8 years ago)
• Last Synced: 2024-11-28T19:53:00.189Z (over 1 year ago)
• Topics: parser-library, python
• Language: Python
• Homepage:
• Size: 34.2 KB
• Stars: 3
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: history.txt
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
pyPhpTree module

================

Module for Python 3. Tiny parser of PHP source code, which finds lines

with class/function/namespace/trait declarations. It reads PHP code only

inside `` ... ?>`` tags (any count of fragments in one file), and

outside of ``/* ... */`` and ``// ...`` comments, and outside of

single/double-quoted strings (multi-line strings supported, escape

backslash supported), and outside of heredoc/herenow blocks.

API

===

Function ``get_headers(filename, lines)`` finds all entities, in given

"lines" list, and gets dicts:

::

   {

     'line': int,      # 0-based line index, where name found

     'col': int,       # 0-based position in line, where name found

     'level': int,     # 0-based level of item. each item of level K+1

                       # is nested into (nearest upper) item of level K

     'name': str,      # name of entity

                       # empty for anonymous funcs

     'kind': str,      # "class", "function", "namespace", "trait"

   }

It's generator (yield), so to get list, use ``list(get_headers(...))``.