modelspec/examples/document.py at main · ModECI/modelspec · GitHub

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
import modelspec
from modelspec import field, instance_of, optional
from modelspec.base_types import Base
from typing import List
import sys
import json
import yaml
import bson

# Example showing how to create a model of a document and use it to create/serialize instances


@modelspec.define
class Paragraph(Base):
    """
    A model of a paragraph.

    Args:
        contents: Paragraph contents, which make up the :class:`Section`s.
    """

    contents: str = field(validator=instance_of(str))


@modelspec.define
class Section(Base):
    """
    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>`_.

    Args:
        id: The id of the section
        paragraphs: The paragraphs
    """

    id: str = field(validator=instance_of(str))
    paragraphs: List[Paragraph] = field(factory=list)


@modelspec.define
class Document(Base):
    """
    A model for documents.

    Args:
        id: The unique id of the document
        title: The document title
        ISBN: International Standard Book Number
        sections: The sections of the document
    """

    id: str = field(validator=instance_of(str))
    title: str = field(default=None, validator=optional(instance_of(str)))
    ISBN: int = field(default=None, validator=optional(instance_of(int)))
    sections: List[Section] = field(factory=list)


doc = Document(id="MyBook", ISBN=123)
doc.title = "My life in Python"

a = Section(id="Abstract")
a.paragraphs.append(Paragraph(contents="Blah blah blah"))
a.paragraphs.append(Paragraph(contents="Blah2"))
doc.sections.append(a)

c1 = Section(id="Chapter 1")
doc.sections.append(c1)
c1.paragraphs.append(Paragraph(contents="More..."))

print(doc)
print(doc.sections[0].paragraphs[0].contents)
print(doc.sections[0].paragraphs[1].__getattribute__("contents"))

doc.to_json_file("document.json")
doc.to_yaml_file("document.yaml")
print(" >> Full document details in YAML format:\n")
print(doc.to_yaml())

doc.to_bson_file("document.bson")

if sys.version_info >= (3, 8):
    doc.to_xml_file("document.xml")
    print(" >> Full document details in XML format:\n")
    print(doc.to_xml())


doc_md = doc.generate_documentation(format="markdown")

with open("document.md", "w") as d:
    d.write(doc_md)


doc_rst = doc.generate_documentation(format="rst")

with open("document.rst", "w") as d:
    d.write(doc_rst)


print("\n  >> Generating specification in dict form...")
doc_dict = doc.generate_documentation(format="dict")


with open("document.specification.json", "w") as d:
    d.write(json.dumps(doc_dict, indent=4))

print("  >> Generating specification in YAML...\n")

with open("document.specification.yaml", "w") as d:
    yy = yaml.dump(doc_dict, indent=4, sort_keys=False)
    print(yy)
    d.write(yy)

with open("document.specification.bson", "wb") as d:
    d.write(bson.encode(doc_dict))