build.Page Class Reference

Inheritance diagram for build.Page:

Public Member Functions
	__init__ (self, str name)
	__repr__ (self)
	depends_on (self, str path)
	build (self)

Public Attributes
	name
	output
	inputs
Public Attributes inherited from build.Artifact
	output
	inputs

Protected Member Functions
	_load_markdown (self)
	_update_xref_section (self, xrefs)

Additional Inherited Members
Static Public Member Functions inherited from build.Artifact
	build_all ()
	build_matching (Callable[[Artifact], bool] predicate)
Static Public Attributes inherited from build.Artifact
dict	all = {}
list	listeners = []

Detailed Description

A single wiki Page (a markdown file).

Definition at line 130 of file build.py.

Constructor & Destructor Documentation

__init__()

build.Page.__init__	(		self,
		str	name
	)

Reimplemented from build.Artifact.

Definition at line 133 of file build.py.

    def __init__(self, name: str):
        self.name = name
        output_name = 'index' if name == 'README' else name
        super().__init__(os.path.join(OUTPUT_DIR, f'{output_name}.html'),
                         [os.path.join(WIKI_SOURCE_DIR, f'{name}.md')])
 

Member Function Documentation

__repr__()

build.Page.__repr__

(

self

)

Definition at line 139 of file build.py.

    def __repr__(self):
        return f'Page({self.output} <- {self.inputs[0]})'
 

_load_markdown()

build.Page._load_markdown (   self )

protected

Definition at line 146 of file build.py.

    def _load_markdown(self):
        with open(self.inputs[0], 'r', encoding='utf-8') as file:
            content = file.read()
 
            # Remove autogenerated xref section.
            content = re.sub(r'<!\-\- AUTOGENERATED XREF SECTION \-\->.*$',
                             '',
                             content,
                             flags=re.DOTALL)
 
            return convert_admonitions(content)
 

_update_xref_section()

build.Page._update_xref_section (   self,   xrefs  )

protected

Definition at line 158 of file build.py.

    def _update_xref_section(self, xrefs):
        with open(self.inputs[0], 'r', encoding='utf-8') as file:
            content = file.read()
        section = '\n'.join(
            ['', '<!-- AUTOGENERATED XREF SECTION -->'] +
            [f'[{key}]: {value}' for key, value in xrefs.items()])
        with open(self.inputs[0], 'w', encoding='utf-8') as file:
            content = re.sub(r'\n<!-- AUTOGENERATED XREF SECTION -->.*$',
                             '',
                             content,
                             flags=re.DOTALL)
            content += section
            file.write(content)
 

build()

build.Page.build

(

self

)

Convert artifact inputs into an output.

Reimplemented from build.Artifact.

Definition at line 172 of file build.py.

    def build(self):
        logging.info('Build %s from %s', self.output, self.inputs[0])
 
        template = jinja2_env.get_template(PAGE_TEMPLATE)
        md_converter = markdown.Markdown(extensions=[
            'admonition',
            'extra',
            CodeHiliteExtension(),
            'tables',
            'pymdownx.superfences',
            'toc',
            xref_extension,
        ])
        result = template.render({
            'dev':
            is_dev_mode,
            'body':
            md_converter.convert(self._load_markdown()),
            'root':
            deployment_root
        })
        # pylint: disable=no-member
        if not is_dev_mode and len(md_converter.xrefs) > 0:
            self._update_xref_section(md_converter.xrefs)
 
        os.makedirs(os.path.dirname(self.output), exist_ok=True)
        with codecs.open(self.output, "w", encoding='utf-8') as file:
            file.write(result)
 
        template_filename = template.filename  # pytype: disable=attribute-error
        self.inputs = [self.inputs[0], template_filename]
 
 

depends_on()

build.Page.depends_on	(		self,
		str	path
	)

Check if this

Reimplemented from build.Artifact.

Definition at line 142 of file build.py.

    def depends_on(self, path: str):
        return path.startswith(TEMPLATES_INCLUDES_DIR) or super().depends_on(
            path)
 

Member Data Documentation

inputs

build.Page.inputs

Definition at line 202 of file build.py.

name

build.Page.name

Definition at line 134 of file build.py.

output

build.Page.output

Definition at line 173 of file build.py.

---

The documentation for this class was generated from the following file:

• third_party/dart-lang/sdk/runtime/tools/wiki/build/build.py