Skip to content

Commit 09c4742

Browse files
davidt0xdavidt0x
committed
Merge branch 'development' of https://github.com/ModECI/modelspec into fix_val_info_perf
2 parents b314bec + 559f52e commit 09c4742

File tree

9 files changed

+85
-54
lines changed

9 files changed

+85
-54
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,3 +160,4 @@ cython_debug/
160160
# and can be added to the global gitignore or merged into this file. For a more nuclear
161161
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
162162
.idea/
163+
/examples/document.specification.bson

‎examples/document.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Document
2-
A model for documents
2+
A model for documents.
33

44
### Allowed parameters
55
<table>
@@ -38,7 +38,7 @@ A model for documents
3838
</table>
3939

4040
## Section
41-
A model of a section of the <a href="#document">Document</a>. Will contain one <a href="#paragraph">Paragraph</a> or more
41+
A model of a section of the <a href="#document">Document</a>. Will contain one <a href="#paragraph">Paragraph</a> or more, i.e the <a href="#paragraph">Paragraph</a>(s) in the section, probably related to the <b>title</b> of the `Document <#document>`_.
4242

4343
### Allowed parameters
4444
<table>
@@ -63,7 +63,7 @@ A model of a section of the <a href="#document">Document</a>. Will contain one <
6363
</table>
6464

6565
## Paragraph
66-
A model of a paragraph
66+
A model of a paragraph.
6767

6868
### Allowed parameters
6969
<table>

‎examples/document.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
@modelspec.define
1010
class Paragraph(Base):
1111
"""
12-
A model of a paragraph
12+
A model of a paragraph.
1313
1414
Args:
15-
contents: Paragraph contents, which make up the _Section_s.
15+
contents: Paragraph contents, which make up the :class:`Section`s.
1616
"""
1717

1818
contents: str = field(validator=instance_of(str))
@@ -21,7 +21,8 @@ class Paragraph(Base):
2121
@modelspec.define
2222
class Section(Base):
2323
"""
24-
A model of a section of the :class:`Document`. Will contain one :class:`Paragraph` or more
24+
A model of a section of the :class:`Document`.
25+
Will contain one :class:`Paragraph` or more, i.e the :class:`Paragraph`(s) in the section, probably related to the :code:`title` of the `Document <#document>`_.
2526
2627
Args:
2728
id: The id of the section
@@ -35,7 +36,7 @@ class Section(Base):
3536
@modelspec.define
3637
class Document(Base):
3738
"""
38-
A model for documents
39+
A model for documents.
3940
4041
Args:
4142
id: The unique id of the document

‎examples/document.rst

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,56 @@
11
========
22
Document
33
========
4-
A model for documents
4+
A model for documents.
55

66
**Allowed parameters**
77

8-
=============== =========== ====================================
8+
=============== =========== ==================================
99
Allowed field Data Type Description
10-
=============== =========== ====================================
11-
**id** str *The unique id of the document*
12-
**title** str *Document title*
13-
**ISBN** int *International Standard Book Number*
14-
=============== =========== ====================================
10+
=============== =========== ==================================
11+
**id** str The unique id of the document
12+
**title** str Document title
13+
**ISBN** int International Standard Book Number
14+
=============== =========== ==================================
1515

1616
**Allowed children**
1717

18-
=============== ===================== ==============================
18+
=============== ===================== ============================
1919
Allowed child Data Type Description
20-
=============== ===================== ==============================
21-
**sections** `Section <#section>`_ *The sections of the document*
22-
=============== ===================== ==============================
20+
=============== ===================== ============================
21+
**sections** `Section <#section>`_ The sections of the document
22+
=============== ===================== ============================
2323

2424
=======
2525
Section
2626
=======
27-
A model of a section of the <a href="#document">Document</a>. Will contain one <a href="#paragraph">Paragraph</a> or more
27+
A model of a section of the `Document <#document>`_. Will contain one `Paragraph <#paragraph>`_ or more, i.e the `Paragraph(s) <#paragraph>`_ in the section, probably related to the **title** of the `Document <#document>`_.
2828

2929
**Allowed parameters**
3030

31-
=============== =========== =======================
31+
=============== =========== =====================
3232
Allowed field Data Type Description
33-
=============== =========== =======================
34-
**id** str *The id of the section*
35-
=============== =========== =======================
33+
=============== =========== =====================
34+
**id** str The id of the section
35+
=============== =========== =====================
3636

3737
**Allowed children**
3838

39-
=============== ========================= ================
39+
=============== ========================= ==============
4040
Allowed child Data Type Description
41-
=============== ========================= ================
42-
**paragraphs** `Paragraph <#paragraph>`_ *The paragraphs*
43-
=============== ========================= ================
41+
=============== ========================= ==============
42+
**paragraphs** `Paragraph <#paragraph>`_ The paragraphs
43+
=============== ========================= ==============
4444

4545
=========
4646
Paragraph
4747
=========
48-
A model of a paragraph
48+
A model of a paragraph.
4949

5050
**Allowed parameters**
5151

52-
=============== =========== =================================================
52+
=============== =========== =============================================================
5353
Allowed field Data Type Description
54-
=============== =========== =================================================
55-
**contents** str *Paragraph contents, which make up the Sections.*
56-
=============== =========== =================================================
54+
=============== =========== =============================================================
55+
**contents** str Paragraph contents, which make up the `Sections <#section>`_.
56+
=============== =========== =============================================================

‎examples/document.specification.bson

-866 Bytes
Binary file not shown.

‎examples/document.specification.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Document": {
3-
"definition": "A model for documents",
3+
"definition": "A model for documents.",
44
"allowed_parameters": {
55
"id": {
66
"type": "str",
@@ -23,7 +23,7 @@
2323
}
2424
},
2525
"Section": {
26-
"definition": "A model of a section of the :class:`Document`. Will contain one :class:`Paragraph` or more",
26+
"definition": "A model of a section of the :class:`Document`. Will contain one :class:`Paragraph` or more, i.e the :class:`Paragraph`(s) in the section, probably related to the :code:`title` of the `Document <#document>`_.",
2727
"allowed_parameters": {
2828
"id": {
2929
"type": "str",
@@ -38,11 +38,11 @@
3838
}
3939
},
4040
"Paragraph": {
41-
"definition": "A model of a paragraph",
41+
"definition": "A model of a paragraph.",
4242
"allowed_parameters": {
4343
"contents": {
4444
"type": "str",
45-
"description": "Paragraph contents, which make up the _Section_s."
45+
"description": "Paragraph contents, which make up the :class:`Section`s."
4646
}
4747
}
4848
}

‎examples/document.specification.yaml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Document:
2-
definition: A model for documents
2+
definition: A model for documents.
33
allowed_parameters:
44
id:
55
type: str
@@ -16,7 +16,8 @@ Document:
1616
description: The sections of the document
1717
Section:
1818
definition: A model of a section of the :class:`Document`. Will contain one :class:`Paragraph`
19-
or more
19+
or more, i.e the :class:`Paragraph`(s) in the section, probably related to
20+
the :code:`title` of the `Document <#document>`_.
2021
allowed_parameters:
2122
id:
2223
type: str
@@ -26,8 +27,8 @@ Section:
2627
type: Paragraph
2728
description: The paragraphs
2829
Paragraph:
29-
definition: A model of a paragraph
30+
definition: A model of a paragraph.
3031
allowed_parameters:
3132
contents:
3233
type: str
33-
description: Paragraph contents, which make up the _Section_s.
34+
description: Paragraph contents, which make up the :class:`Section`s.

‎src/modelspec/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
__version__ = "0.2.4"
1+
__version__ = "0.2.6"
22

33
from .base_types import Base, define, has, field, fields, optional, instance_of, in_
44

‎src/modelspec/base_types.py

Lines changed: 41 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,14 @@ def _parse_definition(cls) -> str:
373373
p = parse(cls.__doc__)
374374

375375
# Extract the description, use the long description if available.
376-
return p.long_description if p.long_description else p.short_description
376+
# "short_description" only parse the first non-empty line and
377+
# "long_description" parse the rest of the docstring i.e.
378+
# it skips the first non-empty line and parse the rest of the docstring
379+
if p.long_description:
380+
definition = f"{p.short_description} {p.long_description}"
381+
else:
382+
definition = p.short_description
383+
return definition
377384

378385
@classmethod
379386
def _parse_allowed_fields(cls) -> Dict[str, Tuple[str, Any]]:
@@ -587,7 +594,12 @@ def insert_links(text, format=MARKDOWN_FORMAT):
587594
pre = text2[0:ind]
588595
ref = text2[ind + len(code_ref) : ind2]
589596
post = text2[ind2 + 1 :]
590-
text2 = f"{pre}<b>{ref}</b>{post}"
597+
598+
if format == MARKDOWN_FORMAT:
599+
text2 = f"{pre}<b>{ref}</b>{post}"
600+
elif format == RST_FORMAT:
601+
text2 = f"{pre}**{ref}**{post}"
602+
591603
# print(" > Converted to: %s" % text2)
592604
text = text2
593605

@@ -602,28 +614,44 @@ def insert_links(text, format=MARKDOWN_FORMAT):
602614
if ref[0] == "~":
603615
ref = ref[1:]
604616
post = text2[ind2 + 1 :]
605-
text2 = f'{pre}<a href="#{ref.lower()}">{ref}</a>{post}'
617+
if format == MARKDOWN_FORMAT:
618+
text2 = f'{pre}<a href="#{ref.lower()}">{ref}</a>{post}'
619+
elif format == RST_FORMAT:
620+
rr = ref
621+
pp = post
622+
623+
######################################
624+
# Some hardcoded fixes for plurals...
625+
if pp.startswith("s "):
626+
rr += "s"
627+
pp = pp[1:]
628+
if pp.startswith("s."):
629+
rr += "s"
630+
pp = pp[1:]
631+
if pp.startswith("(s)"):
632+
rr += "(s)"
633+
pp = pp[3:]
634+
######################################
635+
636+
text2 = f"{pre}`{rr} <#{ref.lower()}>`_{pp}"
637+
606638
# print(" > Converted to: %s" % text2)
607639
text = text2
608640

609641
if "_" not in text:
610642
return text
611643
if '"' in text:
612644
return text # Assume it's a quoted string containing an underscore...
645+
if format == RST_FORMAT:
646+
return text # No need to remove underscore for RST format
647+
613648
split = text.split("_")
614649
text2 = ""
615650
for i in range(int(len(split) / 2.0)):
616651
pre = split[i * 2]
617652
type = split[i * 2 + 1]
618-
if format == MARKDOWN_FORMAT:
619-
text2 += f'{pre}<a href="#{type.lower()}">{type}</a>'
620-
elif format == RST_FORMAT:
621-
# text2 += ('%s'+rst_url_format) % (pre, type, '#'+type.lower # problem with handling links ending with s e.g. _Graph_s
653+
text2 += f'{pre}<a href="#{type.lower()}">{type}</a>'
622654

623-
text2 += ("%s%s") % (
624-
pre,
625-
type,
626-
) # temp hack... problem with handling links ending with s e.g. _Graph_s
627655
if int(len(split) / 2.0) != len(split) / 2.0:
628656
text2 += split[-1]
629657
return text2
@@ -687,7 +715,7 @@ def insert_links(text, format=MARKDOWN_FORMAT):
687715
if referencable
688716
else type_str,
689717
)
690-
d = "*%s*" % (insert_links(description, format=RST_FORMAT))
718+
d = "%s" % (insert_links(description, format=RST_FORMAT))
691719
table_info.append([n, t, d])
692720

693721
if referencable:
@@ -748,7 +776,7 @@ def insert_links(text, format=MARKDOWN_FORMAT):
748776
if referencable
749777
else type_str,
750778
)
751-
d = "*%s*" % (insert_links(description, format=RST_FORMAT))
779+
d = "%s" % (insert_links(description, format=RST_FORMAT))
752780
table_info.append([n, t, d])
753781

754782
# Get the contained type

0 commit comments

Comments
 (0)