Skip to main content

No project description provided

Project description

Stencila Schema for Python

Build Status Code coverage Code style PyPI Docs

This package provides Python bindings for the Stencila Schema 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, a Stencila plugin for Python.

Install

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.

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:

    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.

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:

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.

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>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stencila-schema-1.16.1.tar.gz (24.8 kB view details)

Uploaded Source

Built Distribution

stencila_schema-1.16.1-py3-none-any.whl (23.0 kB view details)

Uploaded Python 3

File details

Details for the file stencila-schema-1.16.1.tar.gz.

File metadata

  • Download URL: stencila-schema-1.16.1.tar.gz
  • Upload date:
  • Size: 24.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.8.2 requests/2.27.1 setuptools/56.0.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for stencila-schema-1.16.1.tar.gz
Algorithm Hash digest
SHA256 52989e7d6dd67a4153db281292655e5b453ec542de629d763df47a6bfd2dfc38
MD5 5cd1e692b1cc5d3e4aa93513627be11a
BLAKE2b-256 ee3e1f8ac7c654af867c88395c3b20a2a77745054fafd43ee241501e93bc92a2

See more details on using hashes here.

File details

Details for the file stencila_schema-1.16.1-py3-none-any.whl.

File metadata

  • Download URL: stencila_schema-1.16.1-py3-none-any.whl
  • Upload date:
  • Size: 23.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.8.2 requests/2.27.1 setuptools/56.0.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for stencila_schema-1.16.1-py3-none-any.whl
Algorithm Hash digest
SHA256 35a26642ba5aa122a39360d74b77c615557c36be465376cea85ebbd44abccd43
MD5 916054ee58be6545706ea07e21d4d276
BLAKE2b-256 2635ac89719c6db99bbcf0115174f5f4a28e0f783b1a8490966473e22600ecae

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page