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
|
%global _empty_manifest_terminate_build 0
Name: python-stencila-schema
Version: 1.16.1
Release: 1
Summary: please add a summary manually as the author left a blank one
License: Apache-2.0
URL: https://github.com/stencila/schema
Source0: https://mirrors.aliyun.com/pypi/web/packages/ee/3e/1f8ac7c654af867c88395c3b20a2a77745054fafd43ee241501e93bc92a2/stencila-schema-1.16.1.tar.gz
BuildArch: noarch
%description
# Stencila Schema for Python
[](https://dev.azure.com/stencila/stencila/_build/latest?definitionId=9&branchName=master)
[](https://codecov.io/gh/stencila/schema/tree/master/python)
[](https://github.com/psf/black)
[](https://pypi.org/project/stencila-schema)
[](https://stencila.github.io/schema/python/docs)
This package provides Python bindings for the [Stencila Schema](https://schema.stenci.la) for executable documents.
It is primarily aimed at Python developers wanting to programmatically generate, or modify, executable documents. For example, it is used in [`pyla`](https://github.com/stencila/pyla), a Stencila plugin for Python.
## Install
```python
pip3 install stencila-schema
```
## Use
This packages exports a Python class for each type of document node in the Stencila Schema e.g. `Article`, `Paragraph`, `CodeChunk`.
For type safety, type annotations are places on attributes and parameters of the `__init__` method. e.g.
```python
class CodeExpression(CodeFragment):
"""An expression defined in programming language source code."""
errors: Optional[Array["CodeError"]] = None
"""Errors when compiling or executing the chunk."""
output: Optional["Node"] = None
"""The value of the expression when it was last evaluated."""
```
The `__init__` method of each class has as parameters the attributes of the class (including those that are inherited) with required attributes first (alphabetically where there are more than one), followed by optional attributes (also alphabetically) e.g. for `CodeExpression`:
```python
def __init__(
self,
text: str,
errors: Optional[Array["CodeError"]] = None,
format: Optional[str] = None,
id: Optional[str] = None,
meta: Optional[Dict[str, Any]] = None,
output: Optional["Node"] = None,
programmingLanguage: Optional[str] = None
)
```
It is recommended to use keyword arguments when calling constructors as it substantially reduces the likelihood that your code will break if you get the order wrong or if there are changes in the attributes of classes (and thus their order in `__init__` parameters) in later versions e.g.
```python
from stencila.schema.types import Article, CodeExpression, Paragraph, Person
article = Article(
title="My first executable document",
authors=[Person(givenNames=["Jane"], familyNames=["Doe"])],
content=[
Paragraph(
content=[
"Two times two: ",
CodeExpression(programmingLanguage="python", text="2 * 2"),
]
)
],
)
print(article.authors[0].givenNames)
# Jane
```
In contrast, the following code is more concise, but is broken because, although it provides all required arguments, it gets the order wrong:
```python
from stencila.schema.types import Article, CodeExpression, Paragraph, Person
article = Article(
"My first executable document",
[Person(["Jane"], ["Doe"])],
[Paragraph(["Two times two: ", CodeExpression("2 * 2", "python"),])],
)
print(article.authors[0].address)
# Jane
print(article.authors[0].givenNames)
# None
```
To support conversion of schema nodes to/from JSON, `json.py` defines `encode` and `decode` functions. e.g.
```python
from stencila.schema.types import Heading
from stencila.schema.json import encode, decode
heading = Heading(content=["Heading Text"], depth=2)
#<stencila.schema.types.Heading object at 0x7f2d038a3748>
json = encode(heading)
print(json)
#{
# "type": "Heading",
# "content": [
# "Heading Text"
# ],
# "depth": 2
#}
decode(json)
#<stencila.schema.types.Heading object at 0x7fda7bbdd780>
```
%package -n python3-stencila-schema
Summary: please add a summary manually as the author left a blank one
Provides: python-stencila-schema
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-stencila-schema
# Stencila Schema for Python
[](https://dev.azure.com/stencila/stencila/_build/latest?definitionId=9&branchName=master)
[](https://codecov.io/gh/stencila/schema/tree/master/python)
[](https://github.com/psf/black)
[](https://pypi.org/project/stencila-schema)
[](https://stencila.github.io/schema/python/docs)
This package provides Python bindings for the [Stencila Schema](https://schema.stenci.la) for executable documents.
It is primarily aimed at Python developers wanting to programmatically generate, or modify, executable documents. For example, it is used in [`pyla`](https://github.com/stencila/pyla), a Stencila plugin for Python.
## Install
```python
pip3 install stencila-schema
```
## Use
This packages exports a Python class for each type of document node in the Stencila Schema e.g. `Article`, `Paragraph`, `CodeChunk`.
For type safety, type annotations are places on attributes and parameters of the `__init__` method. e.g.
```python
class CodeExpression(CodeFragment):
"""An expression defined in programming language source code."""
errors: Optional[Array["CodeError"]] = None
"""Errors when compiling or executing the chunk."""
output: Optional["Node"] = None
"""The value of the expression when it was last evaluated."""
```
The `__init__` method of each class has as parameters the attributes of the class (including those that are inherited) with required attributes first (alphabetically where there are more than one), followed by optional attributes (also alphabetically) e.g. for `CodeExpression`:
```python
def __init__(
self,
text: str,
errors: Optional[Array["CodeError"]] = None,
format: Optional[str] = None,
id: Optional[str] = None,
meta: Optional[Dict[str, Any]] = None,
output: Optional["Node"] = None,
programmingLanguage: Optional[str] = None
)
```
It is recommended to use keyword arguments when calling constructors as it substantially reduces the likelihood that your code will break if you get the order wrong or if there are changes in the attributes of classes (and thus their order in `__init__` parameters) in later versions e.g.
```python
from stencila.schema.types import Article, CodeExpression, Paragraph, Person
article = Article(
title="My first executable document",
authors=[Person(givenNames=["Jane"], familyNames=["Doe"])],
content=[
Paragraph(
content=[
"Two times two: ",
CodeExpression(programmingLanguage="python", text="2 * 2"),
]
)
],
)
print(article.authors[0].givenNames)
# Jane
```
In contrast, the following code is more concise, but is broken because, although it provides all required arguments, it gets the order wrong:
```python
from stencila.schema.types import Article, CodeExpression, Paragraph, Person
article = Article(
"My first executable document",
[Person(["Jane"], ["Doe"])],
[Paragraph(["Two times two: ", CodeExpression("2 * 2", "python"),])],
)
print(article.authors[0].address)
# Jane
print(article.authors[0].givenNames)
# None
```
To support conversion of schema nodes to/from JSON, `json.py` defines `encode` and `decode` functions. e.g.
```python
from stencila.schema.types import Heading
from stencila.schema.json import encode, decode
heading = Heading(content=["Heading Text"], depth=2)
#<stencila.schema.types.Heading object at 0x7f2d038a3748>
json = encode(heading)
print(json)
#{
# "type": "Heading",
# "content": [
# "Heading Text"
# ],
# "depth": 2
#}
decode(json)
#<stencila.schema.types.Heading object at 0x7fda7bbdd780>
```
%package help
Summary: Development documents and examples for stencila-schema
Provides: python3-stencila-schema-doc
%description help
# Stencila Schema for Python
[](https://dev.azure.com/stencila/stencila/_build/latest?definitionId=9&branchName=master)
[](https://codecov.io/gh/stencila/schema/tree/master/python)
[](https://github.com/psf/black)
[](https://pypi.org/project/stencila-schema)
[](https://stencila.github.io/schema/python/docs)
This package provides Python bindings for the [Stencila Schema](https://schema.stenci.la) for executable documents.
It is primarily aimed at Python developers wanting to programmatically generate, or modify, executable documents. For example, it is used in [`pyla`](https://github.com/stencila/pyla), a Stencila plugin for Python.
## Install
```python
pip3 install stencila-schema
```
## Use
This packages exports a Python class for each type of document node in the Stencila Schema e.g. `Article`, `Paragraph`, `CodeChunk`.
For type safety, type annotations are places on attributes and parameters of the `__init__` method. e.g.
```python
class CodeExpression(CodeFragment):
"""An expression defined in programming language source code."""
errors: Optional[Array["CodeError"]] = None
"""Errors when compiling or executing the chunk."""
output: Optional["Node"] = None
"""The value of the expression when it was last evaluated."""
```
The `__init__` method of each class has as parameters the attributes of the class (including those that are inherited) with required attributes first (alphabetically where there are more than one), followed by optional attributes (also alphabetically) e.g. for `CodeExpression`:
```python
def __init__(
self,
text: str,
errors: Optional[Array["CodeError"]] = None,
format: Optional[str] = None,
id: Optional[str] = None,
meta: Optional[Dict[str, Any]] = None,
output: Optional["Node"] = None,
programmingLanguage: Optional[str] = None
)
```
It is recommended to use keyword arguments when calling constructors as it substantially reduces the likelihood that your code will break if you get the order wrong or if there are changes in the attributes of classes (and thus their order in `__init__` parameters) in later versions e.g.
```python
from stencila.schema.types import Article, CodeExpression, Paragraph, Person
article = Article(
title="My first executable document",
authors=[Person(givenNames=["Jane"], familyNames=["Doe"])],
content=[
Paragraph(
content=[
"Two times two: ",
CodeExpression(programmingLanguage="python", text="2 * 2"),
]
)
],
)
print(article.authors[0].givenNames)
# Jane
```
In contrast, the following code is more concise, but is broken because, although it provides all required arguments, it gets the order wrong:
```python
from stencila.schema.types import Article, CodeExpression, Paragraph, Person
article = Article(
"My first executable document",
[Person(["Jane"], ["Doe"])],
[Paragraph(["Two times two: ", CodeExpression("2 * 2", "python"),])],
)
print(article.authors[0].address)
# Jane
print(article.authors[0].givenNames)
# None
```
To support conversion of schema nodes to/from JSON, `json.py` defines `encode` and `decode` functions. e.g.
```python
from stencila.schema.types import Heading
from stencila.schema.json import encode, decode
heading = Heading(content=["Heading Text"], depth=2)
#<stencila.schema.types.Heading object at 0x7f2d038a3748>
json = encode(heading)
print(json)
#{
# "type": "Heading",
# "content": [
# "Heading Text"
# ],
# "depth": 2
#}
decode(json)
#<stencila.schema.types.Heading object at 0x7fda7bbdd780>
```
%prep
%autosetup -n stencila-schema-1.16.1
%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-stencila-schema -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 1.16.1-1
- Package Spec generated
|
