sourcetypes2 0.0.5

Python Source Code Types For Inline Syntax Highlighting

Python Source Code Types For Inline Syntax Highlighting

The original Python Inline Source by Sam Willis is no longer maintained. Please raise your issues and questions in jurooravec/python-inline-source-2.

The PyPI package and VSCode extension have also been migrated:

• PyPI: sourcetypes -> sourcetypes2
• VSCode: samwillis.python-inline-source -> jurooravec.python-inline-source-2

This fork is based on v0.0.4.

Type annotations for various languages, when applied to multi line strings will syntax highlighting with the python-inline-source-2 VS Code plugin.

Supports html, css, javascript, typescript, sql, graphql, multiple css extension languages, template languages and many more, see below for a full list.

Uses typing.Annotated to annotate the str type with the language used. You can use typing.get_type_hints at runtime to determine the language that a string has been annotated with.

On Python versions prior to 3.9 uses typing_extensions to support Annotated types.

Installation

pip install sourcetypes2

Example

Usage

Use a type decoration named for language that you are using:

import sourcetypes

my_html_string: sourcetypes.html = """
  <h1>Some HTML</h1>
"""

or:

from sourcetypes import html

my_html_string: html = """
  <h1>Some HTML</h1>
"""

Supported Languages

• markdown (aliased as md)
• html
• django_html (aliased as django)
• django_txt
• jinja
• jinja_html
• css (aliased as style, and styles)
• scss
• less
• sass
• stylus
• javascript (aliased as js)
• jsx (aliased as javascriptreact, and react)
• typescript (aliased as ts)
• tsx (aliased as typescriptreact)
• coffeescript (aliased as coffee)
• sql
• json
• yaml
• graphql
• xml
• python

Release Notes

[0.0.5] - 2024-10-17

• Add py.typed. #4

[0.0.4] - 2024-10-17

• Forked from v0.0.4

Dev notes

Install twine and build

pip install twine build

Packaging:

python -m build --sdist --wheel --outdir dist/ .

Publishing:

twine upload --repository pypi dist/* -u __token__ -p <pypi-token>