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
|
%global _empty_manifest_terminate_build 0
Name: python-examples
Version: 1.0.2
Release: 1
Summary: Tests and Documentation Done by Example.
License: MIT
URL: https://pypi.org/project/examples/
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/08/1a/1a68ca1db40e06efdd016fcc59863f755f1bceb12b9a7551f52f90fd3253/examples-1.0.2.tar.gz
BuildArch: noarch
Requires: python3-pydantic
%description
[](https://timothycrosley.github.io/examples/)
_________________
[](http://badge.fury.io/py/examples)
[](https://travis-ci.org/timothycrosley/examples)
[](https://codecov.io/gh/timothycrosley/examples)
[](https://gitter.im/timothycrosley/examples?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://pypi.python.org/pypi/examples/)
[](https://pepy.tech/project/examples)
_________________
[Read Latest Documentation](https://timothycrosley.github.io/examples/) - [Browse GitHub Code Repository](https://github.com/timothycrosley/examples/)
_________________
**eXamples** (AKA: xamples for SEO) is a Python3 library enabling interactable, self-documenting, and self-verifying examples. These examples are attached directly to Python functions using decorators or via separate `MODULE_examples.py` source files.
[](https://raw.githubusercontent.com/timothycrosley/examples/master/art/example.gif)
Key Features:
* **Simple and Obvious API**: Add `@examples.example(*args, **kwargs)` decorators for each example you want to add to a function.
* **Auto Documenting**: Examples, by default, get added to your functions docstring viewable both in interactive interpreters and when using [portray](https://timothycrosley.github.io/portray/) or [pdocs](https://timothycrosley.github.io/pdocs/).
* **Signature Validating**: All examples can easily be checked to ensure they match the function signature (and type annotations!) with a single call (`examples.verify_all_signatures()`).
* **Act as Tests**: Examples act as additional test cases, that can easily be verified using a single test case in your favorite test runner: (`examples.test_all_examples()`).
* **Async Compatibility**: Examples can be attached and tested as easily against async functions as non-async ones.
What's Missing:
* **Class Support**: Currently examples can only be attached to individual functions. Class and method support is planned for a future release.
## Quick Start
The following guides should get you up and running using eXamples in no time.
1. [Installation](https://timothycrosley.github.io/examples/docs/quick_start/1.-installation/) - TL;DR: Run `pip3 install examples` within your projects virtual environment.
2. [Adding Examples](https://timothycrosley.github.io/examples/docs/quick_start/2.-adding-examples/) -
TL;DR: Add example decorators that represent each of your examples:
# my_module_with_examples.py
from examples import example
@example(1, number_2=1, _example_returns=2)
def add(number_1: int, number_2: int) -> int:
return number_1 + number_2
3. [Verify and Test Examples](https://timothycrosley.github.io/examples/docs/quick_start/3.-testing-examples/) -
TL;DR: run `examples.verify_and_test_examples` within your projects test cases.
# test_my_module_with_examples.py
from examples import verify_and_test_examples
import my_module_with_examples
def test_examples_verifying_signature():
verify_and_test_examples(my_module_with_examples)
4. Introspect Examples -
import examples
from my_module_with_examples import add
examples.get_examples(add)[0].use() == 2
## Why Create Examples?
I've always wanted a way to attach examples to functions in a way that would be re-useable for documentation, testing, and API proposes.
Just like moving Python parameter types from comments into type annotations has made them more broadly useful, I hope examples can do the same for example calls.
I hope you too find `eXamples` useful!
~Timothy Crosley
%package -n python3-examples
Summary: Tests and Documentation Done by Example.
Provides: python-examples
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-examples
[](https://timothycrosley.github.io/examples/)
_________________
[](http://badge.fury.io/py/examples)
[](https://travis-ci.org/timothycrosley/examples)
[](https://codecov.io/gh/timothycrosley/examples)
[](https://gitter.im/timothycrosley/examples?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://pypi.python.org/pypi/examples/)
[](https://pepy.tech/project/examples)
_________________
[Read Latest Documentation](https://timothycrosley.github.io/examples/) - [Browse GitHub Code Repository](https://github.com/timothycrosley/examples/)
_________________
**eXamples** (AKA: xamples for SEO) is a Python3 library enabling interactable, self-documenting, and self-verifying examples. These examples are attached directly to Python functions using decorators or via separate `MODULE_examples.py` source files.
[](https://raw.githubusercontent.com/timothycrosley/examples/master/art/example.gif)
Key Features:
* **Simple and Obvious API**: Add `@examples.example(*args, **kwargs)` decorators for each example you want to add to a function.
* **Auto Documenting**: Examples, by default, get added to your functions docstring viewable both in interactive interpreters and when using [portray](https://timothycrosley.github.io/portray/) or [pdocs](https://timothycrosley.github.io/pdocs/).
* **Signature Validating**: All examples can easily be checked to ensure they match the function signature (and type annotations!) with a single call (`examples.verify_all_signatures()`).
* **Act as Tests**: Examples act as additional test cases, that can easily be verified using a single test case in your favorite test runner: (`examples.test_all_examples()`).
* **Async Compatibility**: Examples can be attached and tested as easily against async functions as non-async ones.
What's Missing:
* **Class Support**: Currently examples can only be attached to individual functions. Class and method support is planned for a future release.
## Quick Start
The following guides should get you up and running using eXamples in no time.
1. [Installation](https://timothycrosley.github.io/examples/docs/quick_start/1.-installation/) - TL;DR: Run `pip3 install examples` within your projects virtual environment.
2. [Adding Examples](https://timothycrosley.github.io/examples/docs/quick_start/2.-adding-examples/) -
TL;DR: Add example decorators that represent each of your examples:
# my_module_with_examples.py
from examples import example
@example(1, number_2=1, _example_returns=2)
def add(number_1: int, number_2: int) -> int:
return number_1 + number_2
3. [Verify and Test Examples](https://timothycrosley.github.io/examples/docs/quick_start/3.-testing-examples/) -
TL;DR: run `examples.verify_and_test_examples` within your projects test cases.
# test_my_module_with_examples.py
from examples import verify_and_test_examples
import my_module_with_examples
def test_examples_verifying_signature():
verify_and_test_examples(my_module_with_examples)
4. Introspect Examples -
import examples
from my_module_with_examples import add
examples.get_examples(add)[0].use() == 2
## Why Create Examples?
I've always wanted a way to attach examples to functions in a way that would be re-useable for documentation, testing, and API proposes.
Just like moving Python parameter types from comments into type annotations has made them more broadly useful, I hope examples can do the same for example calls.
I hope you too find `eXamples` useful!
~Timothy Crosley
%package help
Summary: Development documents and examples for examples
Provides: python3-examples-doc
%description help
[](https://timothycrosley.github.io/examples/)
_________________
[](http://badge.fury.io/py/examples)
[](https://travis-ci.org/timothycrosley/examples)
[](https://codecov.io/gh/timothycrosley/examples)
[](https://gitter.im/timothycrosley/examples?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://pypi.python.org/pypi/examples/)
[](https://pepy.tech/project/examples)
_________________
[Read Latest Documentation](https://timothycrosley.github.io/examples/) - [Browse GitHub Code Repository](https://github.com/timothycrosley/examples/)
_________________
**eXamples** (AKA: xamples for SEO) is a Python3 library enabling interactable, self-documenting, and self-verifying examples. These examples are attached directly to Python functions using decorators or via separate `MODULE_examples.py` source files.
[](https://raw.githubusercontent.com/timothycrosley/examples/master/art/example.gif)
Key Features:
* **Simple and Obvious API**: Add `@examples.example(*args, **kwargs)` decorators for each example you want to add to a function.
* **Auto Documenting**: Examples, by default, get added to your functions docstring viewable both in interactive interpreters and when using [portray](https://timothycrosley.github.io/portray/) or [pdocs](https://timothycrosley.github.io/pdocs/).
* **Signature Validating**: All examples can easily be checked to ensure they match the function signature (and type annotations!) with a single call (`examples.verify_all_signatures()`).
* **Act as Tests**: Examples act as additional test cases, that can easily be verified using a single test case in your favorite test runner: (`examples.test_all_examples()`).
* **Async Compatibility**: Examples can be attached and tested as easily against async functions as non-async ones.
What's Missing:
* **Class Support**: Currently examples can only be attached to individual functions. Class and method support is planned for a future release.
## Quick Start
The following guides should get you up and running using eXamples in no time.
1. [Installation](https://timothycrosley.github.io/examples/docs/quick_start/1.-installation/) - TL;DR: Run `pip3 install examples` within your projects virtual environment.
2. [Adding Examples](https://timothycrosley.github.io/examples/docs/quick_start/2.-adding-examples/) -
TL;DR: Add example decorators that represent each of your examples:
# my_module_with_examples.py
from examples import example
@example(1, number_2=1, _example_returns=2)
def add(number_1: int, number_2: int) -> int:
return number_1 + number_2
3. [Verify and Test Examples](https://timothycrosley.github.io/examples/docs/quick_start/3.-testing-examples/) -
TL;DR: run `examples.verify_and_test_examples` within your projects test cases.
# test_my_module_with_examples.py
from examples import verify_and_test_examples
import my_module_with_examples
def test_examples_verifying_signature():
verify_and_test_examples(my_module_with_examples)
4. Introspect Examples -
import examples
from my_module_with_examples import add
examples.get_examples(add)[0].use() == 2
## Why Create Examples?
I've always wanted a way to attach examples to functions in a way that would be re-useable for documentation, testing, and API proposes.
Just like moving Python parameter types from comments into type annotations has made them more broadly useful, I hope examples can do the same for example calls.
I hope you too find `eXamples` useful!
~Timothy Crosley
%prep
%autosetup -n examples-1.0.2
%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-examples -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Mon May 15 2023 Python_Bot <Python_Bot@openeuler.org> - 1.0.2-1
- Package Spec generated
|
