-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.md.bak
321 lines (230 loc) · 8.05 KB
/
README.md.bak
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
<!--
* @lanhuage: markdown
* @Descripttion:
* @version: beta
* @Author: xiaoshuyui
* @Date: 2021-01-06 08:24:38
* @LastEditors: xiaoshuyui
* @LastEditTime: 2021-02-20 09:26:19
-->
# dev-tool-for-python
a small tool for python development
[![Build Status](https://www.travis-ci.com/guchengxi1994/dev-tool-for-python.svg?branch=dev)](https://www.travis-ci.com/guchengxi1994/dev-tool-for-python.svg?branch=dev)
# Introduction
### Recently, I have wrote a lot of python codes but always like this.
![devtool-example](./static/devtool_example.gif)
![wtf](./static/wtf.jpg)
#### I think i am a bad programmer. o( ̄ヘ ̄o#)
#### I will forget where can i find the proper function or method even with a doc-string.(But i seldom write doc-string when coding alone.)
## So i want to develop a tool to record informations when coding by using python decorators.
# HOW TO USE.
## 1. Download this repo. run
pip install -r requestments.txt
## 2. Copy the "devtool" folder into your project, or try
pip install DevTool
# Change log
### 2020.4.15
is going to develop a tool, crop an image, using OCR to get words ,translate.
### 2021.4.14
Drawing simple UML and ER diagram supported.
![image](./static/drawing.gv.jpg)
![image](./static/drawing.extend.jpg)
test script can use [this](./testE2U.py)
### 2021.4.10
1. converting entities to images is under construction. See [here](./entity2uml/readme.md)
### 2021.1.26
1. merge some usage from ['show-and-search'](https://github.com/guchengxi1994/show-and-search)
2. add function [plot](./devtool/__init__.py)
To use this decorator, try [testPlot.py](./testPlot.py), effect:
@traceplot(False)
def add1(a, b):
c = 3
d = 4
e = c + d
return a + b + e
@traceplot()
def add2(a, b):
c = 3
d = 4
e = c + d
return a + b + e
if __name__ == "__main__":
add1(3,4)
add2(3,4)
(base) PS D:\testALg\mask2json\devTool\dev-tool-for-python> & D:/anaconda/python.exe d:/testALg/mask2json/devTool/dev-tool-for-python/testPlot.py
call __main__.add1:35 {'a': 3, 'b': 4} None
line __main__.add1:37 {'a': 3, 'b': 4} None
line __main__.add1:38 {'a': 3, 'b': 4, 'c': 3} None
line __main__.add1:39 {'a': 3, 'b': 4, 'c': 3, 'd': 4} None
line __main__.add1:40 {'a': 3, 'b': 4, 'c': 3, 'd': 4, 'e': 7} None
return __main__.add1:40 {'a': 3, 'b': 4, 'c': 3, 'd': 4, 'e': 7} 14
section1
_____________________
| call |
| __main__ |
| add2:42 |
| None |
|_____________________|
|
|
|
|
V
section2
_____________________
| line |
| __main__ |
| add2:44 |
| None |
|_____________________|
|
|
|
|
V
section3
_____________________
| line |
| __main__ |
| add2:45 |
| None |
|_____________________|
|
|
|
|
V
section4
_____________________
| line |
| __main__ |
| add2:46 |
| None |
|_____________________|
|
|
|
|
V
section5
_____________________
| line |
| __main__ |
| add2:47 |
| None |
|_____________________|
|
|
|
|
V
section6
_____________________
| return |
| __main__ |
| add2:47 |
| 14 |
|_____________________|
|
|
O
3. running function with a int number as the memory threshold.
@running(mThres=5)
def test11():
i = 0
while i <= 2:
print(test11.__name__ + ' running')
time.sleep(1.5)
i += 1
test11 running
memory : 21MB, memory_persent : 0.261%, cpu_percent : 0.0
This function out of memory with threshold 5 MB, but got 21 MB during runtime.
### 2021.1.25
1. add decorator "running", see [here](./devtool/__init__.py)
To use this decorator, try [testWrap.test10](./testWrap.py), effect:
(base) PS D:\testALg\mask2json\devTool\dev-tool-for-python> python .\testWrap.py
test10 running
memory : 21MB, memory_persent : 0.264%, cpu_percent : 0.0
memory : 21MB, memory_persent : 0.264%, cpu_percent : 0.0
memory : 21MB, memory_persent : 0.264%, cpu_percent : 0.0
test10 running
memory : 21MB, memory_persent : 0.264%, cpu_percent : 0.0
memory : 21MB, memory_persent : 0.264%, cpu_percent : 0.0
memory : 21MB, memory_persent : 0.264%, cpu_percent : 0.0
test10 running
memory : 21MB, memory_persent : 0.264%, cpu_percent : 0.0
memory : 21MB, memory_persent : 0.264%, cpu_percent : 0.0
memory : 21MB, memory_persent : 0.264%, cpu_percent : 0.0
Total
=============================================================
Used time: 9.000941753387451 s,
Average memory: 21.0 MB,
Average memory percent: 0.264 %,
Average cpu percent: 0.0 % ,
Average used gpu: 0.0 MB.
=============================================================
# Details.
### 1 For logs filter.
from devtool.devTool import DevTool
DevTool.logFilter(*kwds, **params)
kws are the keywords to be searched,params include path,since and until under this version.
To record log file easily,try this.
from devtool import logit
@logit()
def test4():
x = 1 / 0
test4()
then DevLog/devlog.log will be created and log information will be added.
2021-01-09 09:49:00,143 - DevTool - ERROR - __main__.test4 Traceback (most recent call last):
File "D:\dev-tool-for-python\devtool\__init__.py", line 112, in execute
func(*args, **kwargs)
File ".\testWrap.py", line 35, in test4
x = 1 / 0
ZeroDivisionError: division by zero
@logit can add three params: save,load,ignore
@save ,to record the function ,params and result to DevLog/devCache.dump
@load, load result from DevLog/devCache.dump if the function costs much time. if the params are same to the stored params, then return the result. Otherwise, excute again.
@ignore, force to execute the function
@logit(save=True,load=True,ignore=False)
def test8(a=1,b=2):
import time
rs = 'aaaaab'
t1 = time.time()
time.sleep(5)
print(time.time()-t1)
return rs
if __name__ == "__main__":
a = test8(a=3,b=4)
print(a)
first time:
(base) PS D:\dev-tool-for-python> python .\testWrap.py
5.01481556892395
aaaaab
second time:
(base) PS D:\dev-tool-for-python> python .\testWrap.py
aaaaab
![linux](./static/devtool_linux.gif)
### 2 init a new python project
from devtool.devTool import DevTool
if __name__ == "__main__":
DevTool.initProject('Test')
![initproject](./static/devtool_init_project.gif)
If 'DevTool.initProject' got a param 'tree=True', then
This script needs a parameter "path",but got "",using D:\testALg\mask2json\devTool\dev-tool-for-python\Test instead.
Init finishes.
.
|-- main.py
|-- static
|-- tests
|-- utils
| |-- __init__.py
The structure of project is stored in [style.yaml](./devtool/style.yaml).
MINE:
scripts:
main : root/main.py
utils_init : root/utils/__init__.py
folders:
static : root/static
utils : root/utils
tests : root/tests
And "MINE" is my style. :)