1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
# Snippets Translate
To install dependencies on an activated virtual environment run
`pip install -r requirements.txt`.
To run the tests, execute `python -m pytest`. It's important not to
run `pytest` alone to include the PYTHONPATH so the imports work.
Here's an explanation for each file:
* `main.py`, main file that handle the arguments, the general process
of copying/writing files into the pyside-setup/ repository.
* `converter.py`, main function that translate each line depending
of the decision making process that use different handlers.
* `handlers.py`, functions that handle the different translation cases.
* `parse_utils.py`, some useful function that help the translation process.
* `tests/test_converter.py`, tests cases for the converter function.
## Usage
```
% python main.py -h
usage: sync_snippets [-h] --qt QT_DIR --pyside PYSIDE_DIR [-w] [-v]
optional arguments:
-h, --help show this help message and exit
--qt QT_DIR Path to the Qt directory (QT_SRC_DIR)
--pyside PYSIDE_DIR Path to the pyside-setup directory
-w, --write Actually copy over the files to the pyside-setup directory
-v, --verbose Generate more output
```
For example:
```
python main.py --qt /home/cmaureir/dev/qt6/ --pyside /home/cmaureir/dev/pyside-setup -w
```
which will create all the snippet files in the pyside repository. The `-w`
option is in charge of actually writing the files.
## Pending cases
As described at the end of the `converter.py` and `tests/test_converter.py`
files there are a couple of corner cases that are not covered like:
* handler `std::` types and functions
* handler for `operator...`
* handler for `tr("... %1").arg(a)`
* support for lambda expressions
* there are also strange cases that cannot be properly handle with
a line-by-line approach, for example, `for ( ; it != end; ++it) {`
* interpretation of `typedef ...` (including function pointers)
* interpretation of `extern "C" ...`
Additionally,
one could add more test cases for each handler, because at the moment
only the general converter function (which uses handlers) is being
tested as a whole.
## Patterns for directories
### Snippets
Everything that has .../snippets/*, for example:
```
qtbase/src/corelib/doc/snippets/
./qtdoc/doc/src/snippets/
```
goes to:
```
pyside-setup/sources/pyside6/doc/codesnippets/doc/src/snippets/*
```
### Examples
Everything that has .../examples/*/*, for example:
```
./qtbase/examples/widgets/dialogs/licensewizard
./qtbase/examples/widgets/itemviews/pixelator
```
goes to
```
pyside-setup/sources/pyside6/doc/codesnippets/examples/
dialogs/licensewizard
itemviews/pixelator
```
## Patterns for files
Files to skip:
```
*.pro
*.pri
*.cmake
*.qdoc
CMakeLists.txt
```
which means we will be copying:
```
*.png
*.cpp
*.h
*.ui
*.qrc
*.xml
*.qml
*.svg
*.js
*.ts
*.xq
*.txt
etc
```
## Files examples
```
[repo] qt5
./qtbase/src/corelib/doc/snippets/code/src_corelib_thread_qmutexpool.cpp
./qtbase/src/widgets/doc/snippets/code/src_gui_styles_qstyle.cpp
./qtbase/src/network/doc/snippets/code/src_network_kernel_qhostinfo.cpp
./qtbase/examples/sql/relationaltablemodel/relationaltablemodel.cpp
./qtbase/src/printsupport/doc/snippets/code/src_gui_dialogs_qabstractprintdialog.cpp
./qtdoc/doc/src/snippets/qlistview-using
./qtbase/src/widgets/doc/snippets/layouts/layouts.cpp
```
```
[repo] pyside-setup
./sources/pyside6/doc/codesnippets/doc/src/snippets/code/src_corelib_thread_qmutexpool.cpp
./sources/pyside6/doc/codesnippets/doc/src/snippets/code/src_gui_styles_qstyle.cpp
./sources/pyside6/doc/codesnippets/doc/src/snippets/code/src_network_kernel_qhostinfo.cpp
./sources/pyside6/doc/codesnippets/examples/relationaltablemodel/relationaltablemodel.cpp
./sources/pyside6/doc/codesnippets/doc/src/snippets/code/src_gui_dialogs_qabstractprintdialog.cpp
./sources/pyside6/doc/codesnippets/doc/src/snippets/qlistview-using
./sources/pyside6/doc/codesnippets/doc/src/snippets/layouts
```
## The `module_classes` file
This file is being used to identify
if the `#include` from C++ have a counterpart from Python.
The file was generated with:
```
from pprint import pprint
from PySide2 import *
_out = {}
modules = {i for i in dir() if i.startswith("Q")}
for m in modules:
exec(f"import PySide2.{m}")
exec(f"m_classes = [i for i in dir(PySide2.{m}) if i.startswith('Q')]")
if len(m_classes) == 1:
try:
exec(f"from PySide2.{m} import {m}")
exec(f"m_classes = [i for i in dir({m}) if i.startswith('Q')]")
except ImportError:
pass
_out[m] = m_classes
pprint(_out)
```
PySide2 was used to cover more classes that are not available for Qt 6.0.
|
