This is the multi-page printable view of this section. Click here to print.
| Name | Description |
|---|---|
| AnnotationType | Provides an enumeration of annotations that can be used in template design files with the .pymd extension. |
| Name | Description |
|---|---|
| Position | Used to locate positions in the original template string. |
| TemplateBase | Backend class for Pymaidol templates, serves as the base class for all Pymaidol template classes. |
| TemplateRenderer | Class that renders template strings into strings. |
The AnnotationType module provides an enumeration of annotations that can be used in template design files with the .pymd extension.
Module: pymaidol
from pymaidol import AnnotationType
| Name | Description |
|---|---|
| AnnotationTypeEnum Enumeration | The AnnotationTypeEnum enumeration is the base class for all annotation type enumerations. It does not contain any enumeration values and is only used for inheritance. |
| SingleLineAnnotationTypeEnum Enumeration | Contains the types of single-line annotations that can be used in template design files with the .pymd extension. |
| MultiLineAnnotationTypeEnum Enumeration | Contains the types of multi-line annotations that can be used in template design files with the .pymd extension. |
| Name | Type | Description |
|---|---|---|
| FULL_ANNOTATION_TYPE | list[AnnotationTypeEnum] | A list that contains all the enumeration values of the annotation type enumerations. |
The AnnotationTypeEnum enumeration is the base class for all annotation type enumerations. It has no internal enumeration values and is only used for inheritance.
Module: pymaidol.AnnotationType
Inherits from: enum.Enum
from pymaidol import AnnotationTypeEnum
or
from pymaidol.AnnotationType import AnnotationTypeEnum
Contains the types of multiline annotations that can be used in template design files .pymd.
Module: pymaidol.AnnotationType
Inherits from: pymaidol.AnnotationType.AnnotationTypeEnum
from pymaidol import MultiLineAnnotationTypeEnum
or
from pymaidol.AnnotationType import MultiLineAnnotationTypeEnum
| Name | Value | Description |
|---|---|---|
| Python | ’'' | Multiline comment in Python, which starts and ends with '''. |
| C | /* | Multiline comment in C, which starts with /\* and ends with */. |
| HTML | <!– | Multiline comment in HTML, which starts with <!-- and ends with -->. |
Contains the types of single-line annotations that can be used in template design files .pymd.
Module: pymaidol.AnnotationType
Inherits from: pymaidol.AnnotationType.AnnotationTypeEnum
from pymaidol import SingleLineAnnotationTypeEnum
or
from pymaidol.AnnotationType import SingleLineAnnotationTypeEnum
| Name | Value | Description |
|---|---|---|
| Python | # | Single-line comment for Python, which starts with #. |
| C | // | Single-line comment for C, which starts with //. |
The Position class is used to locate positions in the original template string.
The properties of the Position object are read-only and cannot be modified after initialization.
Note: When the Position class is used for the end position, it includes the character at that position. For example, if start.total = 20 and end.total = 30, the slice of the original template string should be template[20:31].
Module: pymaidol.Positions
from pymaidol import Position
or
from pymaidol.Positions import Position
Position(line_index, char_index, total)line_index (int): Line index. Starting from 0.char_index (int): Character index of the current line. Starting from 0.total (int): Total character index. Starting from 0.line_index (int, readonly)Line index. Starting from 0.
char_index (int, readonly)Character index of the current line. Starting from 0.
total (int, readonly)Total character index. Starting from 0.
full_description (str, readonly)Complete and human-readable position description.
Position.Default()@ classmethod
Create and return a default Position object with all properties set to 0.
None.
Position)Default Position object.
Copy()Copy and return a new Position object.
None.
Position)New Position object with the same properties as the original object.
The TemplateBase class is the backend class for Pymaidol templates and serves as the base class for all Pymaidol template classes. It is an abstract class that cannot be instantiated and needs to be inherited for use.
Module: pymaidol.TemplateBase
Inherits from: abc.ABC
from pymaidol import TemplateBase
or
from pymaidol.TemplateBase import TemplateBase
TemplateBase(template, template_file_path, supported_annotation_types, disable_annotation_types) (virtual)template (str, optional): The template string. Default is None.template_file_path (str, optional): The template file path. Default is None.supported_annotation_types (list[AnnotationTypeEnum], optional): The list of supported annotation types. Default is all annotation types (Python, C single-line and multi-line comments, HTML comments).disable_annotation_types (list[AnnotationTypeEnum], optional): The list of disabled annotation types, making these annotations appear in the rendered text. Default is empty. Disabled annotations take precedence over supported annotations. For example, if AnnotationTypeEnum.SingleLineAnnotationTypeEnum.Python (Python single-line comments) is included in disable_annotation_types, it will be disabled regardless of whether it is included in supported_annotation_types.When both template and template_file_path are None, the TemplateBase class and its subclasses will attempt to read the template file .pymd with the same name in the same directory as itself. If both are not empty, template will be used as a priority.
rendered (str, readonly)The rendered string. If Render() method has not been called since self-initialization or calling HotReload() method, it will be None.
template (str, readonly)The template string.
HotReload(template, template_file_path) (final)Reloads the template.
template (str, optional): The template string. Default is None.template_file_path (str, optional): The template file path. Default is None.When both template and template_file_path are None, the TemplateBase class and its subclasses will attempt to read the template file .pymd with the same name in the same directory as itself. If both are not empty, template will be used as a priority.
None)None.
Render(inject_kwargs) (final)Renders the template string with the given data.
inject_kwargs (dict, Optional): The externally injected variables used for rendering the template string. Default is None. The injected variables will be treated as local variables.str)The rendered string.
A class that renders template strings into strings.
Module: pymaidol.TemplateRenderer
from pymaidol import TemplateRenderer
or
from pymaidol.TemplateRenderer import TemplateRenderer
TemplateRenderer(template, supported_annotation_types)template (str): The template string.supported_annotation_types (list[AnnotationTypeEnum], optional): The list of supported annotation types. Defaults to all annotation types (Python, C single-line and multi-line comments, HTML comments).template (str, readonly)The template string.
TemplateRenderer.ReadFromFile(template_file_path, supported_annotation_types) (classmethod)Given a template file path, returns a TemplateRenderer object.
template_file_path (str): The template file path.supported_annotation_types (list[AnnotationTypeEnum]): The list of supported annotation types.TemplateRenderer: The TemplateRenderer object.
Render(local_vars, global_vars) (final)Renders the template string with the given data.
local_vars (dict): The local variables used for rendering the template string.global_vars (dict, optional): The global variables used for rendering the template string. Defaults to None.str: The rendered string.