note_splitter.patterns module

Compiled regular expressions.

Resources for learning and using regex: https://wheelercj.github.io/notes/pages/20210506235005.html

Most of these patterns are for full-line elements that are each in their own string with no newline characters.

note_splitter.patterns.blockquote

The pattern for a quote that takes up one entire line (a full-line element).

Type

re.Pattern

note_splitter.patterns.code_fence

The pattern for a multi-line code block delimiter (a full-line element); the line starts with either three backticks or three tildes.

Type

re.Pattern

note_splitter.patterns.finished_task

The pattern for a to do list item that is finished (a full-line element).

Type

re.Pattern

note_splitter.patterns.footnote

The pattern for a footnote (a full-line element).

Type

re.Pattern

note_splitter.patterns.frontmatter_fence

The pattern for a frontmatter delimiter (a full-line element).

Type

re.Pattern

note_splitter.patterns.header

The pattern of a header of any level (a full-line element).

Type

re.Pattern

note_splitter.patterns.horizontal_rule

The pattern for a horizontal rule, which is composed of three or more minuses, underscores, or asterisks. There may be any number of whitespace characters anywhere on the line (a full-line element).

Type

re.Pattern

The pattern for a relative or absolute file path in a link (an inline element). This pattern also matches some website URLs in links.

Type

re.Pattern

note_splitter.patterns.math_fence

The pattern for the delimiter of a multi-line block of math equations (a full-line element).

Type

re.Pattern

note_splitter.patterns.ordered_list_item

The pattern for an item in an ordered list (a full-line element).

Type

re.Pattern

note_splitter.patterns.table_divider

The pattern for the part of a table that divides the table’s header from its body (a full-line element). This pattern can also match some horizontal rules.

Type

re.Pattern

note_splitter.patterns.table_row

The pattern for a row of a table (a full-line element). This pattern can also match some table dividers. Table rows that do not start and end with a pipe symbol are not supported.

Type

re.Pattern

note_splitter.patterns.task

The pattern for a to do list item that is either finished or finished (a full-line element).

Type

re.Pattern

note_splitter.patterns.tag

The pattern for a tag (an inline element).

Type

re.Pattern

note_splitter.patterns.unordered_list_item

The pattern for an item in a bullet point list (a full-line element). The list can have bullet points as asterisks, minuses, or pluses. This pattern can also match some horizontal rules and to dos.

Type

re.Pattern