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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
|
%global _empty_manifest_terminate_build 0
Name: python-sqlalchemy-easy-profile
Version: 1.3.0
Release: 1
Summary: An easy profiler for SQLAlchemy queries
License: MIT License
URL: https://github.com/dmvass/sqlalchemy-easy-profile
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/84/7f/b2503e4ed65bc58c69c9adf1e2651c521b100fc23b9eac53ba6befa6acce/sqlalchemy-easy-profile-1.3.0.tar.gz
BuildArch: noarch
Requires: python3-sqlalchemy
Requires: python3-sqlparse
Requires: python3-tox
%description
# SQLAlchemy Easy Profile
[](https://travis-ci.com/dmvass/sqlalchemy-easy-profile)
[](https://pypi.python.org/pypi/sqlalchemy-easy-profile)
[](https://codecov.io/gh/dmvass/sqlalchemy-easy-profile)
[](https://github.com/dmvass/sqlalchemy-easy-profile/blob/master/LICENSE)
Inspired by [django-querycount](https://github.com/bradmontgomery/django-querycount),
is a library that hooks into SQLAlchemy to collect metrics, streaming statistics into
console output and help you understand where in application you have slow or redundant
queries.
## Installation
Install the package with pip:
```
pip install sqlalchemy-easy-profile
```
## Session profiler
The profiling session hooks into SQLAlchemy and captures query statements, duration information,
and query parameters. You also may have multiple profiling sessions active at the same
time on the same or different Engines. If multiple profiling sessions are active on the
same engine, queries on that engine will be collected by both sessions and reported on
different reporters.
You may begin and commit a profiling session as much as you like. Calling begin on an already
started session or commit on an already committed session will raise an `AssertionError`.
You also can use a contextmanager interface for session profiling or used it like a decorator.
This has the effect of only profiling queries occurred within the decorated function or inside
a manager context.
How to use `begin` and `commit`:
```python
from easy_profile import SessionProfiler
profiler = SessionProfiler()
profiler.begin()
session.query(User).filter(User.name == "Arthur Dent").first()
profiler.commit()
print(profiler.stats)
```
How to use as a context manager interface:
```python
profiler = SessionProfiler()
with profiler:
session.query(User).filter(User.name == "Arthur Dent").first()
print(profiler.stats)
```
How to use profiler as a decorator:
```python
profiler = SessionProfiler()
class UsersResource:
@profiler()
def on_get(self, req, resp, **args, **kwargs):
return session.query(User).all()
```
Keep in mind that profiler decorator interface accepts a special reporter and
If it was not defined by default will be used a base streaming reporter. Decorator
also accept `name` and `name_callback` optional parameters.
## WSGI integration
Easy Profiler provides a specified middleware which can prints the number of database
queries for each HTTP request and can be applied as a WSGI server middleware. So you
can easily integrate Easy Profiler into any WSGI application.
How to integrate with a Flask application:
```python
from flask import Flask
from easy_profile import EasyProfileMiddleware
app = Flask(__name__)
app.wsgi_app = EasyProfileMiddleware(app.wsgi_app)
```
How to integrate with a Falcon application:
```python
import falcon
from easy_profile import EasyProfileMiddleware
api = application = falcon.API()
application = EasyProfileMiddleware(application)
```
## How to customize output
The `StreamReporter` accepts medium-high thresholds, output file destination (stdout by default), a special
flag for disabling color formatting and number of displayed duplicated queries:
```python
from flask import Flask
from easy_profile import EasyProfileMiddleware, StreamReporter
app = Flask(__name__)
app.wsgi_app = EasyProfileMiddleware(app.wsgi_app, reporter=StreamReporter(display_duplicates=100))
```
Any custom reporter can be created as:
```python
from easy_profile.reporters import Reporter
class CustomReporter(Reporter):
def report(self, path, stats):
"""Do something with path and stats.
:param str path: where profiling occurred
:param dict stats: profiling statistics
"""
...
```
## Testing
To run the tests:
```
python setup.py test
```
Or use `tox` for running in all tests environments.
## License
This code is distributed under the terms of the MIT license.
## Changes
A full changelog is maintained in the [CHANGELOG](https://github.com/dmvass/sqlalchemy-easy-profile/blob/master/CHANGELOG.md) file.
## Contributing
**sqlalchemy-easy-profile** is an open source project and contributions are
welcome! Check out the [Issues](https://github.com/dmvass/sqlalchemy-easy-profile/issues)
page to see if your idea for a contribution has already been mentioned, and feel
free to raise an issue or submit a pull request.
%package -n python3-sqlalchemy-easy-profile
Summary: An easy profiler for SQLAlchemy queries
Provides: python-sqlalchemy-easy-profile
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-sqlalchemy-easy-profile
# SQLAlchemy Easy Profile
[](https://travis-ci.com/dmvass/sqlalchemy-easy-profile)
[](https://pypi.python.org/pypi/sqlalchemy-easy-profile)
[](https://codecov.io/gh/dmvass/sqlalchemy-easy-profile)
[](https://github.com/dmvass/sqlalchemy-easy-profile/blob/master/LICENSE)
Inspired by [django-querycount](https://github.com/bradmontgomery/django-querycount),
is a library that hooks into SQLAlchemy to collect metrics, streaming statistics into
console output and help you understand where in application you have slow or redundant
queries.
## Installation
Install the package with pip:
```
pip install sqlalchemy-easy-profile
```
## Session profiler
The profiling session hooks into SQLAlchemy and captures query statements, duration information,
and query parameters. You also may have multiple profiling sessions active at the same
time on the same or different Engines. If multiple profiling sessions are active on the
same engine, queries on that engine will be collected by both sessions and reported on
different reporters.
You may begin and commit a profiling session as much as you like. Calling begin on an already
started session or commit on an already committed session will raise an `AssertionError`.
You also can use a contextmanager interface for session profiling or used it like a decorator.
This has the effect of only profiling queries occurred within the decorated function or inside
a manager context.
How to use `begin` and `commit`:
```python
from easy_profile import SessionProfiler
profiler = SessionProfiler()
profiler.begin()
session.query(User).filter(User.name == "Arthur Dent").first()
profiler.commit()
print(profiler.stats)
```
How to use as a context manager interface:
```python
profiler = SessionProfiler()
with profiler:
session.query(User).filter(User.name == "Arthur Dent").first()
print(profiler.stats)
```
How to use profiler as a decorator:
```python
profiler = SessionProfiler()
class UsersResource:
@profiler()
def on_get(self, req, resp, **args, **kwargs):
return session.query(User).all()
```
Keep in mind that profiler decorator interface accepts a special reporter and
If it was not defined by default will be used a base streaming reporter. Decorator
also accept `name` and `name_callback` optional parameters.
## WSGI integration
Easy Profiler provides a specified middleware which can prints the number of database
queries for each HTTP request and can be applied as a WSGI server middleware. So you
can easily integrate Easy Profiler into any WSGI application.
How to integrate with a Flask application:
```python
from flask import Flask
from easy_profile import EasyProfileMiddleware
app = Flask(__name__)
app.wsgi_app = EasyProfileMiddleware(app.wsgi_app)
```
How to integrate with a Falcon application:
```python
import falcon
from easy_profile import EasyProfileMiddleware
api = application = falcon.API()
application = EasyProfileMiddleware(application)
```
## How to customize output
The `StreamReporter` accepts medium-high thresholds, output file destination (stdout by default), a special
flag for disabling color formatting and number of displayed duplicated queries:
```python
from flask import Flask
from easy_profile import EasyProfileMiddleware, StreamReporter
app = Flask(__name__)
app.wsgi_app = EasyProfileMiddleware(app.wsgi_app, reporter=StreamReporter(display_duplicates=100))
```
Any custom reporter can be created as:
```python
from easy_profile.reporters import Reporter
class CustomReporter(Reporter):
def report(self, path, stats):
"""Do something with path and stats.
:param str path: where profiling occurred
:param dict stats: profiling statistics
"""
...
```
## Testing
To run the tests:
```
python setup.py test
```
Or use `tox` for running in all tests environments.
## License
This code is distributed under the terms of the MIT license.
## Changes
A full changelog is maintained in the [CHANGELOG](https://github.com/dmvass/sqlalchemy-easy-profile/blob/master/CHANGELOG.md) file.
## Contributing
**sqlalchemy-easy-profile** is an open source project and contributions are
welcome! Check out the [Issues](https://github.com/dmvass/sqlalchemy-easy-profile/issues)
page to see if your idea for a contribution has already been mentioned, and feel
free to raise an issue or submit a pull request.
%package help
Summary: Development documents and examples for sqlalchemy-easy-profile
Provides: python3-sqlalchemy-easy-profile-doc
%description help
# SQLAlchemy Easy Profile
[](https://travis-ci.com/dmvass/sqlalchemy-easy-profile)
[](https://pypi.python.org/pypi/sqlalchemy-easy-profile)
[](https://codecov.io/gh/dmvass/sqlalchemy-easy-profile)
[](https://github.com/dmvass/sqlalchemy-easy-profile/blob/master/LICENSE)
Inspired by [django-querycount](https://github.com/bradmontgomery/django-querycount),
is a library that hooks into SQLAlchemy to collect metrics, streaming statistics into
console output and help you understand where in application you have slow or redundant
queries.
## Installation
Install the package with pip:
```
pip install sqlalchemy-easy-profile
```
## Session profiler
The profiling session hooks into SQLAlchemy and captures query statements, duration information,
and query parameters. You also may have multiple profiling sessions active at the same
time on the same or different Engines. If multiple profiling sessions are active on the
same engine, queries on that engine will be collected by both sessions and reported on
different reporters.
You may begin and commit a profiling session as much as you like. Calling begin on an already
started session or commit on an already committed session will raise an `AssertionError`.
You also can use a contextmanager interface for session profiling or used it like a decorator.
This has the effect of only profiling queries occurred within the decorated function or inside
a manager context.
How to use `begin` and `commit`:
```python
from easy_profile import SessionProfiler
profiler = SessionProfiler()
profiler.begin()
session.query(User).filter(User.name == "Arthur Dent").first()
profiler.commit()
print(profiler.stats)
```
How to use as a context manager interface:
```python
profiler = SessionProfiler()
with profiler:
session.query(User).filter(User.name == "Arthur Dent").first()
print(profiler.stats)
```
How to use profiler as a decorator:
```python
profiler = SessionProfiler()
class UsersResource:
@profiler()
def on_get(self, req, resp, **args, **kwargs):
return session.query(User).all()
```
Keep in mind that profiler decorator interface accepts a special reporter and
If it was not defined by default will be used a base streaming reporter. Decorator
also accept `name` and `name_callback` optional parameters.
## WSGI integration
Easy Profiler provides a specified middleware which can prints the number of database
queries for each HTTP request and can be applied as a WSGI server middleware. So you
can easily integrate Easy Profiler into any WSGI application.
How to integrate with a Flask application:
```python
from flask import Flask
from easy_profile import EasyProfileMiddleware
app = Flask(__name__)
app.wsgi_app = EasyProfileMiddleware(app.wsgi_app)
```
How to integrate with a Falcon application:
```python
import falcon
from easy_profile import EasyProfileMiddleware
api = application = falcon.API()
application = EasyProfileMiddleware(application)
```
## How to customize output
The `StreamReporter` accepts medium-high thresholds, output file destination (stdout by default), a special
flag for disabling color formatting and number of displayed duplicated queries:
```python
from flask import Flask
from easy_profile import EasyProfileMiddleware, StreamReporter
app = Flask(__name__)
app.wsgi_app = EasyProfileMiddleware(app.wsgi_app, reporter=StreamReporter(display_duplicates=100))
```
Any custom reporter can be created as:
```python
from easy_profile.reporters import Reporter
class CustomReporter(Reporter):
def report(self, path, stats):
"""Do something with path and stats.
:param str path: where profiling occurred
:param dict stats: profiling statistics
"""
...
```
## Testing
To run the tests:
```
python setup.py test
```
Or use `tox` for running in all tests environments.
## License
This code is distributed under the terms of the MIT license.
## Changes
A full changelog is maintained in the [CHANGELOG](https://github.com/dmvass/sqlalchemy-easy-profile/blob/master/CHANGELOG.md) file.
## Contributing
**sqlalchemy-easy-profile** is an open source project and contributions are
welcome! Check out the [Issues](https://github.com/dmvass/sqlalchemy-easy-profile/issues)
page to see if your idea for a contribution has already been mentioned, and feel
free to raise an issue or submit a pull request.
%prep
%autosetup -n sqlalchemy-easy-profile-1.3.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-sqlalchemy-easy-profile -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 1.3.0-1
- Package Spec generated
|
