Merge branch 'main' of github.com:Rconybea/xo-pyreflect

This commit is contained in:
Roland Conybeare 2024-05-01 14:38:24 -04:00
commit 49688b828f
2 changed files with 26 additions and 13 deletions

View file

@ -1,4 +1,4 @@
# python bindings for c++ reflection library (xo-reflect)
# python bindings for c++ reflection library (xo-pyreflect)
## Getting Started
@ -22,6 +22,22 @@ $ make install
```
(also see .github/workflows/main.yml)
## Examples
Assumes `xo-pyreflect` installed to `~/local2/lib`
```
PYTHONPATH=~/local2/lib python
>>> import xo_pyreflect
>>> dir(xo_pyreflect)
['SelfTagging', 'TaggedRcptr', 'TypeDescr', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__']
>>> xo_pyreflect.TypeDescr.print_reflected_types()
<type_table_v[0]:>
```
(Not _immediately_ interesting: no reflected types in `pyreflect` itself)
## Development
### build for unit test coverage
```
$ cd xo-pyreflect
@ -37,24 +53,20 @@ $ cmake \
### LSP (language server) support
LSP looks for compile commands in the root of the source tree;
while Cmake creates them in the root of its build directory.
while `cmake` creates them in the root of its build directory.
```
$ cd xo-pyreflect
$ ln -s build/compile_commands.json # supply compile commands to LSP
```
## Examples
### display cmake variables
Assumes `xo-pyreflect` installed to `~/local2/lib`
- `-L` list variables
- `-A` include 'advanced' variables
- `-H` include help text
```
PYTHONPATH=~/local2/lib python
>>> import pyreflect
>>> dir(pyreflect)
['SelfTagging', 'TaggedRcptr', 'TypeDescr', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__']
>>> pyreflect.TypeDescr.print_reflected_types()
<type_table_v[0]:>
$ cd xo-pyprintjson/build
$ cmake -LAH
```
Not _immediately_ interesting: no reflected types in `pyreflect` itself

View file

@ -1,9 +1,10 @@
# xo_pyreflect/src/pyreflect/CMakeLists.txt
set(SELF_LIB pyreflect)
set(SELF_LIB xo_pyreflect)
set(SELF_SRCS pyreflect.cpp)
# ----------------------------------------------------------------
xo_pybind11_library(${SELF_LIB} ${PROJECT_NAME}Targets ${SELF_SRCS})
xo_pybind11_dependency(${SELF_LIB} reflect)
xo_pybind11_dependency(${SELF_LIB} xo_pyutil)