开源软件构建与测试

_service:tar_scm:python-markdown.spec Changed

@@ -1,7 +1,7 @@
 %{!?python3_version: %global python3_version %(%{__python3} -c "import sys; sys.stdout.write(sys.version:3)")}
 
 Name:           python-markdown
-Version:        3.4.1
+Version:        3.5.1
 Release:        1
 Summary:        A Python implementation of John Gruber’s Markdown
 License:        BSD-3-Clause
@@ -10,7 +10,7 @@
 
 BuildArch:      noarch
 
-BuildRequires:  python3-devel >= 3.1 python3-nose2 python3-pyyaml
+BuildRequires:  python3-devel >= 3.1 python3-nose2 python3-pyyaml python3-pip python3-wheel
 
 %description
 This is a Python implementation of John Gruber’s Markdown.
@@ -30,23 +30,28 @@
 %prep
 %autosetup -n Markdown-%{version} -p1
 
-find markdown -type f -name '*.py' -exec sed -i -e '/^#!/{1D}' {} \;
-find docs -type f -exec sed -i 's/\r//' {} \;
-
 %build
-%{__python3} setup.py build
+%pyproject_build
 
 %install
-%{__python3} setup.py install -O1 --skip-build --root %{buildroot}
+%pyproject_install
+
+PYTHONPATH=%{buildroot}%{python3_sitelib} \
+  %{buildroot}%{_bindir}/markdown_py \
+  LICENSE.md > LICENSE.html
 
 %check
 %{__python3} -m unittest discover tests
 
 %files -n python3-markdown
+%license LICENSE.html LICENSE.md
 %{python3_sitelib}/*
 %{_bindir}/markdown_py
 
 %changelog
+* Mon Jan 8 2024 liyanan <liyanan61@h-partners.com> - 3.5.1-1
+- Upgrade to 3.5.1
+
 * Wed May 31 2023 chenchen <chen_aka_jan@163.com> - 3.4.1-1
 - Upgrade to 3.4.1

_service Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/doc-requirements.txt Deleted

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/change_log/release-3.0.md Deleted

@@ -1,228 +0,0 @@
-title: Release Notes for v3.0
-
-# Python-Markdown 3.0 Release Notes
-
-We are pleased to release Python-Markdown 3.0 which adds a few new features and
-fixes various bugs and deprecates various old features. See the list of changes
-below for details.
-
-Python-Markdown version 3.0 supports Python versions 2.7, 3.4, 3.5, 3.6, 3.7,
-PyPy and PyPy3.
-
-## Backwards-incompatible changes
-
-### `enable_attributes` keyword deprecated
-
-The `enable_attributes` keyword is deprecated in version 3.0 and will be
-ignored. Previously the keyword was `True` by default and enabled an
-undocumented way to define attributes on document elements. The feature has been
-removed from version 3.0. As most users did not use the undocumented feature, it
-should not affect most users. For the few who did use the feature, it can be
-enabled by using the Legacy Attributes(../extensions/legacy_attrs.md)
-extension.
-
-### `smart_emphasis` keyword and `smart_strong` extension deprecated
-
-The `smart_emphasis` keyword is deprecated in version 3.0 and will be ignored.
-Previously the keyword was `True` by default and caused the parser to ignore
-middle-word emphasis. Additionally, the optional `smart_strong` extension
-provided the same behavior for strong emphasis. Both of those features are now
-part of the default behavior, and the Legacy
-Emphasis(../extensions/legacy_em.md) extension is available to disable that
-behavior.
-
-### `output_formats` simplified to `html` and `xhtml`.
-
-The `output_formats` keyword now only accepts two options: `html` and `xhtml`
-Note that if `(x)html1`, `(x)html4` or `(x)html5` are passed in, the number is
-stripped and ignored.
-
-### `safe_mode` and `html_replacement_text` keywords deprecated
-
-Both `safe_mode` and the associated `html_replacement_text` keywords are
-deprecated in version 3.0 and will be ignored. The so-called "safe mode" was
-never actually "safe" which has resulted in many people having a false sense of
-security when using it. As an alternative, the developers of Python-Markdown
-recommend that any untrusted content be passed through an HTML sanitizer (like
-Bleach) after being converted to HTML by markdown. In fact, Bleach Whitelist
-provides a curated list of tags, attributes, and styles suitable for filtering
-user-provided HTML using bleach.
-
-If your code previously looked like this:
-
-```python
-html = markdown.markdown(text, safe_mode=True)
-```
-
-Then it is recommended that you change your code to read something like this:
-
-```python
-import bleach
-from bleach_whitelist import markdown_tags, markdown_attrs
-html = bleach.clean(markdown.markdown(text), markdown_tags, markdown_attrs)
-```
-
-If you are not interested in sanitizing untrusted text, but simply desire to
-escape raw HTML, then that can be accomplished through an extension which
-removes HTML parsing:
-
-```python
-from markdown.extensions import Extension
-
-class EscapeHtml(Extension):
-    def extendMarkdown(self, md):
-        md.preprocessors.deregister('html_block')
-        md.inlinePatterns.deregister('html')
-
-html = markdown.markdown(text, extensions=EscapeHtml())
-```
-
-As the HTML would not be parsed with the above Extension, then the serializer
-will escape the raw HTML, which is exactly what happened in previous versions
-with `safe_mode="escape"`.
-
-Bleach: https://bleach.readthedocs.io/
-Bleach Whitelist: https://github.com/yourcelf/bleach-whitelist
-
-### Positional arguments deprecated
-
-Positional arguments on the `markdown.Markdown()` class are deprecated as are
-all except the `text` argument on the `markdown.markdown()` wrapper function.
-Using positional arguments will raise an error. Only keyword arguments should be
-used. For example, if your code previously looked like this:
-
-```python
-html = markdown.markdown(text, SomeExtension())
-```
-
-Then it is recommended that you change it to read something like this:
-
-```python
-html = markdown.markdown(text, extensions=SomeExtension())
-```
-
-!!! Note
-    This change is being made as a result of deprecating `"safe_mode"` as the
-    `safe_mode` argument was one of the positional arguments. When that argument
-    is removed, the two arguments following it will no longer be at the correct
-    position. It is recommended that you always use keywords when they are
-    supported for this reason.
-
-### Extension name behavior has changed
-
-In previous versions of Python-Markdown, the built-in extensions received
-special status and did not require the full path to be provided. Additionally,
-third party extensions whose name started with `"mdx_"` received the same
-special treatment. This is no longer the case.
-
-Support has been added for extensions to define an entry
-point(../extensions/api.md#entry_point). An entry point is a string name which
-can be used to point to an `Extension` class. The built-in extensions now have
-entry points which match the old short names. And any third-party extensions
-which define entry points can now get the same behavior. See the documentation
-for each specific extension to find the assigned name.
-
-If an extension does not define an entry point, then the full path to the
-extension must be used. See the documentation(../reference.md#extensions) for
-a full explanation of the current behavior.
-
-### Extension configuration as part of extension name deprecated
-
-The previously documented method of appending the extension configuration
-options as a string to the extension name is deprecated and will raise an error.
-The `extension_configs`(../reference.md#extension_configs) keyword should be
-used instead. See the documentation(../reference.md#extension_configs) for a
-full explanation of the current behavior.
-
-### HeaderId extension deprecated
-
-The HeaderId Extension is deprecated and will raise an error if specified. Use
-the Table of Contents(../extensions/toc.md) Extension instead, which offers
-most of the features of the HeaderId Extension and more (support for meta data
-is missing).
-
-Extension authors who have been using the `slugify` and `unique` functions
-defined in the HeaderId Extension should note that those functions are now
-defined in the Table of Contents extension and should adjust their import
-statements accordingly (`from markdown.extensions.toc import slugify, unique`).
-
-###  Homegrown `OrderedDict` has been replaced with a purpose-built `Registry`
-
-All processors and patterns now get "registered" to a
-Registry(../extensions/api.md#registry). A backwards compatible shim is
-included so that existing simple extensions should continue to work.
-A `DeprecationWarning` will be raised for any code which calls the old API.
-
-### Markdown class instance references.
-
-Previously, instances of the `Markdown` class were represented as any one of
-`md`, `md_instance`, or `markdown`. This inconsistency made it difficult when
-developing extensions, or just maintaining the existing code. Now, all instances
-are consistently represented as `md`.
-
-The old attributes on class instances still exist, but raise a
-`DeprecationWarning` when accessed. Also on classes where the instance was
-optional, the attribute always exists now and is simply `None` if no instance
-was provided (previously the attribute would not exist).
-
-### `markdown.util.isBlockLevel` deprecated
-
-The `markdown.util.isBlockLevel` function is deprecated and will raise a
-`DeprecationWarning`. Instead, extensions should use the `isBlockLevel` method
-of the `Markdown` class instance. Additionally, a list of block level elements
-is defined in the `block_level_elements` attribute of the `Markdown` class which
-extensions can access to alter the list of elements which are treated as block
-level elements.
-
-### `md_globals` keyword deprecated from extension API
-
-Previously, the `extendMarkdown` method of a `markdown.extensions.Extension`
-subclasses accepted an `md_globals` keyword, which contained the value returned
-by Python's `globals()` built-in function. As all of the configuration is now
-held within the `Markdown` class instance, access to the globals is no longer
-necessary and any extensions which expect the keyword will raise a
-`DeprecationWarning`. A future release will raise an error.
-
-### `markdown.version` and `markdown.version_info` deprecated
-
-Historically, version numbers were acquired via the attributes
-`markdown.version` and `markdown.version_info`. Moving forward, a more
-standardized approach is being followed and versions are acquired via the
-`markdown.__version__` and `markdown.__version_info__` attributes.  The legacy
-attributes are still available to allow distinguishing versions between the
-legacy Markdown 2.0 series and the Markdown 3.0 series, but in the future the
-legacy attributes will be removed.
-
-### Added new, more flexible `InlineProcessor` class
-
-A new `InlineProcessor` class handles inline processing much better and allows
-for more flexibility. The new `InlineProcessor` classes no longer utilize

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/change_log/release-3.1.md Deleted

@@ -1,48 +0,0 @@
-title: Release Notes for v3.1
-
-# Python-Markdown 3.1 Release Notes
-
-Python-Markdown version 3.1 supports Python versions 2.7, 3.5, 3.6, 3.7,
-PyPy and PyPy3.
-
-## Backwards-incompatible changes
-
-### `markdown.version` and `markdown.version_info` deprecated
-
-Historically, version numbers were acquired via the attributes
-`markdown.version` and `markdown.version_info`. As of 3.0, a more standardized
-approach is being followed and versions are acquired via the
-`markdown.__version__` and `markdown.__version_info__` attributes.  As of 3.1
-the legacy attributes will raise a `DeprecationWarning` if they are accessed. In
-a future release the legacy attributes will be removed.
-
-## New features
-
-The following new features have been included in the release:
-
-* A Contributing Guide(../contributing.md) has been added (#732).
-
-* A new configuration option to set the footnote separator has been added. Also,
-  the `rel` and `rev` attributes have been removed from footnotes as they are
-  not valid in HTML5. The `refs` and `backrefs` classes already exist and
-  serve the same purpose (#723).
-
-* A new option for `toc_depth` to set not only the bottom section level,
-  but also the top section level. A string consisting of two digits
-  separated by a hyphen in between (`"2-5"`), defines the top (`t`) and the
-  bottom (`b`) (`<ht>..<hb>`). A single integer still defines the bottom
-  section level (`<h1>..<hb>`) only. (#787).
-
-## Bug fixes
-
-The following bug fixes are included in the 3.1 release:
-
-* Update CLI to support PyYAML 5.1.
-* Overlapping raw HTML matches no longer leave placeholders behind (#458).
-* Emphasis patterns now recognize newline characters as whitespace (#783).
-* Version format had been updated to be PEP 440 compliant (#736).
-* Block level elements are defined per instance, not as class attributes
-  (#731).
-* Double escaping of block code has been eliminated (#725).
-* Problems with newlines in references has been fixed (#742).
-* Escaped `#` are now handled in header syntax (#762).

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/change_log/release-3.2.md Deleted

@@ -1,96 +0,0 @@
-title: Release Notes for v3.2
-
-# Python-Markdown 3.2 Release Notes
-
-Python-Markdown version 3.2 supports Python versions 3.5, 3.6, 3.7, 3.8, and
-PyPy3.
-
-## Backwards-incompatible changes
-
-### Drop support for Python 2.7
-
-Python 2.7 reaches end-of-life on 2020-01-01 and Python-Markdown 3.2 has dropped
-support for it. Please upgrade to Python 3, or use Python-Markdown 3.1.
-
-### `em` and `strong` inline processor changes
-
-In order to fix issue #792, `em`/`strong` inline processors were refactored. This
-translated into removing many of the existing inline processors that handled this
-logic:
-
-* `em_strong`
-* `strong`
-* `emphasis`
-* `strong2`
-* `emphasis`
-
-These processors were replaced with two new ones:
-
-* `em_strong`
-* `em_strong2`
-
-The `legacy_em`(../extensions/legacy_em.md) extension was also modified with new,
-refactored logic and simply overrides the `em_strong2` inline processor.
-
-### CodeHilite now always wraps with `<code>` tags
-
-Before, the HTML generated by CodeHilite looked like:
-- `<pre><code>foo = 'bar'</code></pre>` if you **were not** using Pygments.
-- `<pre>foo = 'bar'</pre>`  if you **were** using Pygments.
-
-To make the cases more consistent (and adhere to many Markdown specifications and
-HTML code block markup suggestions), CodeHilite will now always additionally wrap
-code with `<code>` tags. See #862 for more details.
-
-This change does not alter the Python-Markdown API, but users relying on the old
-markup will find their output now changed.
-
-Internally, this change relies on the Pygments 2.4, so you must be using at least
-that version to see this effect. Users with earlier Pygments versions will
-continue to see the old behavior.
-
-### `markdown.util.etree` deprecated
-
-Previously, Python-Markdown was using either the `xml.etree.cElementTree` module
-or the `xml.etree.ElementTree` module, based on their availability. In modern
-Python versions, the former is a deprecated alias for the latter. Thus, the
-compatibility layer is deprecated and extensions are advised to use
-`xml.etree.ElementTree` directly. Importing `markdown.util.etree` will raise
-a `DeprecationWarning` beginning in version 3.2 and may be removed in a future
-release.
-
-Therefore, extension developers are encouraged to replace
-`from markdown.util import etree` with
-`import xml.etree.ElementTree as etree` in their code.
-
-## New features
-
-The following new features have been included in the release:
-
-* Some new configuration options have been added to the toc(../extensions/toc.md)
-  extension:
-
-    * The `anchorlink_class` and `permalink_class` options allow class(es) to be
-      assigned to the `anchorlink` and `permalink` respectively. This allows using
-      icon fonts from CSS for the links. Therefore, an empty string passed to
-      `permalink` now generates an empty `permalink`. Previously no `permalink`
-      would have been generated. (#776)
-
-    * The `permalink_title` option allows the title attribute of a `permalink` to be
-      set to something other than the default English string `Permanent link`. (#877)
-
-* Document thread safety (#812).
-
-* Markdown parsing in HTML has been exposed via a separate extension called
-  `md_in_html`(../extensions/md_in_html.md).
-
-* Add support for Python 3.8.
-
-## Bug fixes
-
-The following bug fixes are included in the 3.2 release:
-
-* HTML tag placeholders are no longer included in  `.toc_tokens` (#899).
-* Unescape backslash-escaped characters in TOC ids (#864).
-* Refactor bold and italic logic in order to solve complex nesting issues (#792).
-* Always wrap CodeHilite code in `code` tags (#862).

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/change_log/release-3.3.md Deleted

@@ -1,109 +0,0 @@
-title: Release Notes for v3.3
-
-# Python-Markdown 3.3 Release Notes
-
-Python-Markdown version 3.3 supports Python versions 3.6, 3.7, 3.8, 3.9 and PyPy3.
-
-## Backwards-incompatible changes
-
-### The prefix `language-` is now prepended to all language classes by default on code blocks.
-
-The HTML5 specspec recommends that the class defining the language of a code block be prefixed with `language-`.
-Therefore, by default, both the fenced_code and codehilite extensions now prepend the prefix when code
-highlighting is disabled.
-
-If you have previously been including the prefix manually in your fenced code blocks, then you will not want a second
-instance of the prefix. Similarly, if you are using a third party syntax highlighting tool which does not recognize
-the prefix, or requires a different prefix, then you will want to redefine the prefix globally using the `lang_prefix`
-configuration option of either the `fenced_code` or `codehilite` extensions.
-
-For example, to configure `fenced_code` to not apply any prefix (the previous behavior), set the option to an empty string:
-
-```python
-from markdown.extensions.fenced_code import FencedCodeExtension
-
-markdown.markdown(src, extensions=FencedCodeExtension(lang_prefix=''))
-```
-
-!!! note
-    When code highlighting is enabled, the output from Pygments is used unaltered. Currently, Pygments does not
-    provide an option to include the language class in the output, let alone prefix it. Therefore, any language prefix
-    is only applied when syntax highlighting is disabled.
-
-### Attribute Lists are more strict (#898).
-
-Empty curly braces are now completely ignored by the Attribute List extension. Previously, the extension would
-recognize them as attribute lists and remove them from the document. Therefore, it is no longer necessary to backslash
-escape a set of curly braces which are empty or only contain whitespace.
-
-Despite not being documented, previously an attribute list could be defined anywhere within a table cell and get
-applied to the cell (`<td>` element). Now the attribute list must be defined at the end of the cell content and must
-be separated from the rest of the content by at least one space. This makes it easy to differentiate between attribute
-lists defined on inline elements within a cell and the attribute list for the cell itself. It is also more consistent
-with how attribute lists are defined on other types of elements.
-
-The extension has also added support for defining attribute lists on table header cells (`<th>` elements) in the same
-manner as data cells (`<td>` elements).
-
-In addition, the documentation for the extensions received an overhaul. The features (#987) and limitations (#965) of the extension are now fully documented.
-
-## New features
-
-The following new features have been included in the 3.3 release:
-
-* All Pygments' options are now available for syntax highlighting (#816).
-    - The Codehilite(../extensions/code_hilite.md) extension now accepts any options
-      which Pygments supports as global configuration settings on the extension.
-    - Fenced Code Blocks(../extensions/fenced_code_blocks.md) will accept any of the
-      same options on individual code blocks.
-    - Any of the previously supported aliases to Pygments' options continue to be
-      supported at this time. However, it is recommended that the Pygments option names
-      be used directly to ensure continued compatibility in the future.
-
-* Fenced Code Blocks(../extensions/fenced_code_blocks.md) now work with
-  Attribute Lists(../extensions/attr_list.md) when syntax highlighting is disabled.
-  Any random HTML attribute can be defined and set on the `<code>` tag of fenced code
-  blocks when the `attr_list` extension is enabled (#816).
-
-* The HTML parser has been completely replaced. The new HTML parser is built on Python's
-  html.parser.HTMLParser(https://docs.python.org/3/library/html.parser.html), which
-  alleviates various bugs and simplify maintenance of the code (#803, #830).
-
-* The Markdown in HTML(../extensions/md_in_html.md) extension has been rebuilt on the
-  new HTML Parser, which drastically simplifies it. Note that raw HTML elements with a
-  `markdown` attribute defined are now converted to ElementTree Elements and are rendered
-  by the serializer. Various bugs have been fixed (#803, #595, #780, and #1012).
-
-* Link reference parsing, abbreviation reference parsing and footnote reference parsing
-  has all been moved from `preprocessors` to `blockprocessors`, which allows them to be
-  nested within other block level elements. Specifically, this change was necessary to
-  maintain the current behavior in the rebuilt Markdown in HTML extension. A few random
-  edge-case bugs (see the included tests) were resolved in the process (#803).
-
-* An alternate function `markdown.extensions.headerid.slugify_unicode` has been included
-  with the Table of Contents(../extensions/toc.md) extension which supports Unicode
-  characters in table of contents slugs. The old `markdown.extensions.headerid.slugify`
-  method which removes non-ASCII characters remains the default. Import and pass
-  `markdown.extensions.headerid.slugify_unicode` to the `slugify` configuration option
-  to use the new behavior.
-
-* Support was added for Python 3.9 and dropped for Python 3.5.
-
-## Bug fixes
-
-The following bug fixes are included in the 3.3 release:
-
-* Document how to pass configuration options to Extra (#1019).
-* Fix HR which follows strong em (#897).
-* Support short reference image links (#894).
-* Avoid a `RecursionError` from deeply nested blockquotes (#799).
-* Fix issues with complex emphasis (#979).
-* Fix unescaping of HTML characters `<>` in CodeHilite (#990).
-* Fix complex scenarios involving lists and admonitions (#1004).
-* Fix complex scenarios with nested ordered and unordered lists in a definition list (#918).
-
-spec: https://www.w3.org/TR/html5/text-level-semantics.html#the-code-element
-fenced_code: ../extensions/fenced_code_blocks.md
-codehilite: ../extensions/code_hilite.md
-enabled: ../extensions/fenced_code_blocks.md#enabling-syntax-highlighting
-Attribute List: ../extensions/attr_list.md

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/change_log/release-3.4.md Deleted

@@ -1,113 +0,0 @@
-title: Release Notes for v3.4
-
-# Python-Markdown 3.4 Release Notes
-
-Python-Markdown version 3.4 supports Python versions 3.7, 3.8, 3.9, 3.10 and
-PyPy3.
-
-## Backwards-incompatible changes
-
-### The `tables` extension now uses a `style` attribute instead of an `align` attribute for alignment.
-
-The HTML4 specspec4 specifically deprecates the use of the `align` attribute
-and it does not appear at all in the HTML5 specspec5. Therefore, by default,
-the tables extension will now use the `style` attribute (setting just the
-`text-align` property) in `td` and `th` blocks.
-
-spec4: https://www.w3.org/TR/html4/present/graphics.html#h-15.1.2
-spec5: https://www.w3.org/TR/html53/tabular-data.html#attributes-common-to-td-and-th-elements
-tables: ../extensions/tables.md
-
-The former behavior is available by setting the `use_align_attribute`
-configuration option to `True` when enabling the extension.
-
-For example, to configure the old `align` behavior:
-
-```python
-from markdown.extensions.tables import TableExtension
-
-markdown.markdown(src, extensions=TableExtension(use_align_attribute=True))
-```
-
-### Backslash unescaping moved to Treeprocessor (#1131).
-
-Unescaping backslash escapes has been moved to a Treeprocessor, which  enables
-proper HTML escaping during serialization. However, it is recognized that
-various third-party extensions may be calling the old class at
-`postprocessors.UnescapePostprocessor`. Therefore, the old class remains in the
-code base, but has been deprecated and will be removed in a future release. The
-new class `treeprocessors.UnescapeTreeprocessor` should be used instead.
-
-### Previously deprecated objects have been removed
-
-Various objects were deprecated in version 3.0 and began raising deprecation
-warnings (see the version 3.0 release notes for details). Any of those objects
-which remained in version 3.3 have been removed from the code base in version 3.4
-and will now raise errors. The relevant objects are listed below.
-
-version 3.0 release notes: release-3.0.md
-
-| Deprecated Object                      | Replacement Object                  |
-|----------------------------------------|-------------------------------------|
-| `markdown.version`                     | `markdown.__version__`              |
-| `markdown.version_info`                | `markdown.__version_info__`         |
-| `markdown.util.etree`                  | `xml.etree.ElementTree`             |
-| `markdown.util.string_type`            | `str`                               |
-| `markdown.util.text_type`              | `str`                               |
-| `markdown.util.int2str`                | `chr`                               |
-| `markdown.util.iterrange`              | `range`                             |
-| `markdown.util.isBlockLevel`           | `markdown.Markdown().is_block_level`|
-| `markdown.util.Processor().markdown`   | `markdown.util.Processor().md`      |
-| `markdown.util.Registry().__setitem__` | `markdown.util.Registry().register` |
-| `markdown.util.Registry().__delitem__` |`markdown.util.Registry().deregister`|
-| `markdown.util.Registry().add`         | `markdown.util.Registry().register` |
-
-In addition, the `md_globals` parameter of
-`Markdown.extensions.Extension.extendMarkdown()` is no longer recognized as a
-valid parameter and will raise an error if provided.
-
-## New features
-
-The following new features have been included in the 3.4 release:
-
-
-* Some new configuration options have been added to the
-  footnotes(../extensions/footnotes.md) extension (#1218):
-
-    * Small refactor of the `BACKLINK_TITLE` option; The use of `format()`
-      instead of "old" `%d` formatter allows one to specify text without the
-      need to have the number of the footnote in it (like footnotes on
-      Wikipedia for example). The modification is backward compatible so no
-      configuration change is required.
-
-    * Addition of a new option `SUPERSCRIPT_TEXT` that allows one to specify a
-      custom placeholder for the footnote itself in the text.
-      Ex: `{}` will give `<sup>1</sup>`, `({})` will give `<sup>(1)</sup>`,
-      or by default, the current behavior: `<sup>1</sup>`.
-
-* The Table of Contents(../extensions/toc.md) extension now accepts a
-  `toc_class` parameter which can be used to set the CSS class(es) on the
-  `<div>` that contains the Table of Contents (#1224).
-
-* The CodeHilite extension now supports a `pygments_formatter` option that can
-  be set to a custom formatter class (#1187).
-
-    - If `pygments_formatter` is set to a string (ex: `'html'`), Pygments'
-      default formatter by that name is used.
-    - If `pygments_formatter` is set to a formatter class (or any callable
-      which returns a formatter instance), then an instance of that class is
-      used.
-
-    The formatter class is now passed an additional option, `lang_str`, to
-    denote the language of the code block (#1258). While Pygments' built-in
-    formatters will ignore the option, a custom formatter assigned to the
-    `pygments_formatter` option can make use of the `lang_str` to include the
-    code block's language in the output.
-
-## Bug fixes
-
-The following bug fixes are included in the 3.4 release:
-
-* Extension entry-points are only loaded if needed (#1216).
-* Added additional checks to the `<pre><code>` handling of
-  `PrettifyTreeprocessor` (#1261, #1263).

_service:tar_scm:Markdown-3.4.1.tar.gz/setup.py Deleted

@@ -1,132 +0,0 @@
-#!/usr/bin/env python
-"""
-Python Markdown
-
-A Python implementation of John Gruber's Markdown.
-
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
-
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
-
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
-
-License: BSD (see LICENSE.md for details).
-"""
-
-
-import os
-from setuptools import setup
-
-
-def get_version():
-    """Get version and version_info from markdown/__meta__.py file."""
-    module_path = os.path.join(os.path.dirname('__file__'), 'markdown', '__meta__.py')
-
-    import importlib.util
-    spec = importlib.util.spec_from_file_location('__meta__', module_path)
-    meta = importlib.util.module_from_spec(spec)
-    spec.loader.exec_module(meta)
-    return meta.__version__, meta.__version_info__
-
-
-__version__, __version_info__ = get_version()
-
-# Get development Status for classifiers
-dev_status_map = {
-    'dev':   '2 - Pre-Alpha',
-    'alpha': '3 - Alpha',
-    'beta':  '4 - Beta',
-    'rc':    '4 - Beta',
-    'final': '5 - Production/Stable'
-}
-DEVSTATUS = dev_status_map__version_info__3
-
-# The command line script name.  Currently set to "markdown_py" so as not to
-# conflict with the perl implementation (which uses "markdown").
-SCRIPT_NAME = 'markdown_py'
-
-with open('README.md') as f:
-    long_description = f.read()
-
-setup(
-    name='Markdown',
-    version=__version__,
-    url='https://Python-Markdown.github.io/',
-    project_urls={
-        'Documentation': 'https://Python-Markdown.github.io/',
-        'GitHub Project': 'https://github.com/Python-Markdown/markdown',
-        'Issue Tracker': 'https://github.com/Python-Markdown/markdown/issues'
-    },
-    description='Python implementation of Markdown.',
-    long_description=long_description,
-    long_description_content_type='text/markdown',
-    author='Manfred Stienstra, Yuri takhteyev and Waylan limberg',
-    author_email='python.markdown@gmail.com',
-    maintainer='Waylan Limberg',
-    maintainer_email='python.markdown@gmail.com',
-    license='BSD License',
-    packages='markdown', 'markdown.extensions',
-    python_requires='>=3.7',
-    install_requires="importlib-metadata>=4.4;python_version<'3.10'",
-    extras_require={
-        'testing': 
-            'coverage',
-            'pyyaml',
-        ,
-    },
-    entry_points={
-        'console_scripts': 
-            '%s = markdown.__main__:run' % SCRIPT_NAME,
-        ,
-        # Register the built in extensions
-        'markdown.extensions': 
-            'abbr = markdown.extensions.abbr:AbbrExtension',
-            'admonition = markdown.extensions.admonition:AdmonitionExtension',
-            'attr_list = markdown.extensions.attr_list:AttrListExtension',
-            'codehilite = markdown.extensions.codehilite:CodeHiliteExtension',
-            'def_list = markdown.extensions.def_list:DefListExtension',
-            'extra = markdown.extensions.extra:ExtraExtension',
-            'fenced_code = markdown.extensions.fenced_code:FencedCodeExtension',
-            'footnotes = markdown.extensions.footnotes:FootnoteExtension',
-            'md_in_html = markdown.extensions.md_in_html:MarkdownInHtmlExtension',
-            'meta = markdown.extensions.meta:MetaExtension',
-            'nl2br = markdown.extensions.nl2br:Nl2BrExtension',
-            'sane_lists = markdown.extensions.sane_lists:SaneListExtension',
-            'smarty = markdown.extensions.smarty:SmartyExtension',
-            'tables = markdown.extensions.tables:TableExtension',
-            'toc = markdown.extensions.toc:TocExtension',
-            'wikilinks = markdown.extensions.wikilinks:WikiLinkExtension',
-            'legacy_attrs = markdown.extensions.legacy_attrs:LegacyAttrExtension',
-            'legacy_em = markdown.extensions.legacy_em:LegacyEmExtension',
-        
-    },
-    classifiers=
-        'Development Status :: %s' % DEVSTATUS,
-        'License :: OSI Approved :: BSD License',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
-        'Programming Language :: Python :: 3.9',
-        'Programming Language :: Python :: 3.10',
-        'Programming Language :: Python :: 3 :: Only',
-        'Programming Language :: Python :: Implementation :: CPython',
-        'Programming Language :: Python :: Implementation :: PyPy',
-        'Topic :: Communications :: Email :: Filters',
-        'Topic :: Internet :: WWW/HTTP :: Dynamic Content :: CGI Tools/Libraries',
-        'Topic :: Internet :: WWW/HTTP :: Site Management',
-        'Topic :: Software Development :: Documentation',
-        'Topic :: Software Development :: Libraries :: Python Modules',
-        'Topic :: Text Processing :: Filters',
-        'Topic :: Text Processing :: Markup :: HTML',
-        'Topic :: Text Processing :: Markup :: Markdown'
-    
-)

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/extensions/smarty.html Deleted

@@ -1,32 +0,0 @@
-<p>&rsquo;.<br />
-1440&ndash;80&rsquo;s<br />
-1440&ndash;&rsquo;80s<br />
-1440&mdash;&rsquo;80s<br />
-1960s<br />
-1960&rsquo;s<br />
-one two &rsquo;60s<br />
-&rsquo;60s</p>
-<p>It&rsquo;s fun. What&rsquo;s fun?<br />
-&ldquo;Isn&rsquo;t this fun&rdquo;? &mdash; she said&hellip;<br />
-&ldquo;&lsquo;Quoted&rsquo; words in a larger quote.&rdquo;<br />
-&lsquo;Quoted &ldquo;words&rdquo; in a larger quote.&rsquo;<br />
-&ldquo;quoted&rdquo; text and <strong>bold &ldquo;quoted&rdquo; text</strong><br />
-&lsquo;quoted&rsquo; text and <strong>bold &lsquo;quoted&rsquo; text</strong><br />
-em-dashes (&mdash;) and ellipes (&hellip;)<br />
-&ldquo;<a href="http://example.com">Link</a>&rdquo; &mdash; she said.</p>
-<p>&ldquo;Ellipsis within quotes&hellip;&rdquo;</p>
-<p>Кавычки-&laquo;ёлочки&raquo;<br />
-&laquo;hello&raquo;<br />
-Anführungszeichen-&raquo;Chevrons&laquo;</p>
-<hr />
-<p>Escaped -- ndash<br />
-'Escaped' "quotes"<br />
-Escaped ellipsis...</p>
-<p>&lsquo;Escaped "quotes" in real ones&rsquo;<br />
-'&ldquo;Real&rdquo; quotes in escaped ones'</p>
-<p>Skip <code>&lt;&lt;all&gt;&gt; "code" -- --- 'spans' ...</code>.</p>
-<pre><code>Also skip "code" 'blocks'
-foo -- bar --- baz ...
-</code></pre>
-<p>A line that &lsquo;wraps&rsquo; with
-<em>emphasis</em> at the beginning of the next line.</p>
\ No newline at end of file

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/extensions/smarty.txt Deleted

_service:tar_scm:Markdown-3.4.1.tar.gz/MANIFEST.in -> _service:tar_scm:Markdown-3.5.1.tar.gz/MANIFEST.in Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/Markdown.egg-info/PKG-INFO -> _service:tar_scm:Markdown-3.5.1.tar.gz/Markdown.egg-info/PKG-INFO Changed

@@ -1,25 +1,57 @@
 Metadata-Version: 2.1
 Name: Markdown
-Version: 3.4.1
-Summary: Python implementation of Markdown.
-Home-page: https://Python-Markdown.github.io/
-Author: Manfred Stienstra, Yuri takhteyev and Waylan limberg
-Author-email: python.markdown@gmail.com
-Maintainer: Waylan Limberg
-Maintainer-email: python.markdown@gmail.com
-License: BSD License
+Version: 3.5.1
+Summary: Python implementation of John Gruber's Markdown.
+Author: Manfred Stienstra, Yuri Takhteyev
+Author-email: Waylan limberg <python.markdown@gmail.com>
+Maintainer: Isaac Muse
+Maintainer-email: Waylan Limberg <python.markdown@gmail.com>
+License: Copyright 2007, 2008 The Python Markdown Project (v. 1.7 and later)
+        Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+        Copyright 2004 Manfred Stienstra (the original version)
+        
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        * Redistributions of source code must retain the above copyright
+          notice, this list of conditions and the following disclaimer.
+        * Redistributions in binary form must reproduce the above copyright
+          notice, this list of conditions and the following disclaimer in the
+          documentation and/or other materials provided with the distribution.
+        * Neither the name of the Python Markdown Project nor the
+          names of its contributors may be used to endorse or promote products
+          derived from this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE PYTHON MARKDOWN PROJECT ''AS IS'' AND ANY
+        EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL ANY CONTRIBUTORS TO THE PYTHON MARKDOWN PROJECT
+        BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+        CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+        SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+        INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+        CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+        ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+        POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, https://Python-Markdown.github.io/
 Project-URL: Documentation, https://Python-Markdown.github.io/
-Project-URL: GitHub Project, https://github.com/Python-Markdown/markdown
+Project-URL: Repository, https://github.com/Python-Markdown/markdown
 Project-URL: Issue Tracker, https://github.com/Python-Markdown/markdown/issues
+Project-URL: Changelog, https://github.com/Python-Markdown/markdown/blob/master/docs/change_log/index.md
+Keywords: markdown,markdown-parser,python-markdown,markdown-to-html
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
@@ -31,10 +63,21 @@
 Classifier: Topic :: Text Processing :: Filters
 Classifier: Topic :: Text Processing :: Markup :: HTML
 Classifier: Topic :: Text Processing :: Markup :: Markdown
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
-Provides-Extra: testing
 License-File: LICENSE.md
+Requires-Dist: importlib-metadata>=4.4; python_version < "3.10"
+Provides-Extra: testing
+Requires-Dist: coverage; extra == "testing"
+Requires-Dist: pyyaml; extra == "testing"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5; extra == "docs"
+Requires-Dist: mkdocs-nature>=0.6; extra == "docs"
+Requires-Dist: mdx_gh_links>=0.2; extra == "docs"
+Requires-Dist: mkdocstringspython; extra == "docs"
+Requires-Dist: mkdocs-gen-files; extra == "docs"
+Requires-Dist: mkdocs-section-index; extra == "docs"
+Requires-Dist: mkdocs-literate-nav; extra == "docs"
 
 Python-Markdown
 ===================

_service:tar_scm:Markdown-3.4.1.tar.gz/Markdown.egg-info/SOURCES.txt -> _service:tar_scm:Markdown-3.5.1.tar.gz/Markdown.egg-info/SOURCES.txt Changed

@@ -2,12 +2,10 @@
 LICENSE.md
 MANIFEST.in
 README.md
-doc-requirements.txt
 makefile
 mkdocs.yml
 pyproject.toml
-setup.cfg
-setup.py
+tox.ini
 Markdown.egg-info/PKG-INFO
 Markdown.egg-info/SOURCES.txt
 Markdown.egg-info/dependency_links.txt
@@ -15,11 +13,14 @@
 Markdown.egg-info/requires.txt
 Markdown.egg-info/top_level.txt
 docs/authors.md
+docs/changelog.md
 docs/cli.md
 docs/contributing.md
+docs/custom.css
 docs/favicon.ico
 docs/index.md
 docs/install.md
+docs/mkdocstrings.css
 docs/py.png
 docs/reference.md
 docs/test_tools.md
@@ -31,11 +32,6 @@
 docs/change_log/release-2.4.md
 docs/change_log/release-2.5.md
 docs/change_log/release-2.6.md
-docs/change_log/release-3.0.md
-docs/change_log/release-3.1.md
-docs/change_log/release-3.2.md
-docs/change_log/release-3.3.md
-docs/change_log/release-3.4.md
 docs/extensions/abbreviations.md
 docs/extensions/admonition.md
 docs/extensions/api.md
@@ -56,6 +52,11 @@
 docs/extensions/tables.md
 docs/extensions/toc.md
 docs/extensions/wikilinks.md
+docs/templates/python/nature/attribute.html
+docs/templates/python/nature/class.html
+docs/templates/python/nature/function.html
+docs/templates/python/nature/module.html
+docs/templates/python/nature/docstring/admonition.html
 markdown/__init__.py
 markdown/__main__.py
 markdown/__meta__.py
@@ -142,8 +143,6 @@
 tests/extensions/nl2br_w_attr_list.txt
 tests/extensions/sane_lists.html
 tests/extensions/sane_lists.txt
-tests/extensions/smarty.html
-tests/extensions/smarty.txt
 tests/extensions/toc.html
 tests/extensions/toc.txt
 tests/extensions/toc_invalid.html

_service:tar_scm:Markdown-3.4.1.tar.gz/Markdown.egg-info/requires.txt -> _service:tar_scm:Markdown-3.5.1.tar.gz/Markdown.egg-info/requires.txt Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/PKG-INFO -> _service:tar_scm:Markdown-3.5.1.tar.gz/PKG-INFO Changed

@@ -1,25 +1,57 @@
 Metadata-Version: 2.1
 Name: Markdown
-Version: 3.4.1
-Summary: Python implementation of Markdown.
-Home-page: https://Python-Markdown.github.io/
-Author: Manfred Stienstra, Yuri takhteyev and Waylan limberg
-Author-email: python.markdown@gmail.com
-Maintainer: Waylan Limberg
-Maintainer-email: python.markdown@gmail.com
-License: BSD License
+Version: 3.5.1
+Summary: Python implementation of John Gruber's Markdown.
+Author: Manfred Stienstra, Yuri Takhteyev
+Author-email: Waylan limberg <python.markdown@gmail.com>
+Maintainer: Isaac Muse
+Maintainer-email: Waylan Limberg <python.markdown@gmail.com>
+License: Copyright 2007, 2008 The Python Markdown Project (v. 1.7 and later)
+        Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+        Copyright 2004 Manfred Stienstra (the original version)
+        
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        * Redistributions of source code must retain the above copyright
+          notice, this list of conditions and the following disclaimer.
+        * Redistributions in binary form must reproduce the above copyright
+          notice, this list of conditions and the following disclaimer in the
+          documentation and/or other materials provided with the distribution.
+        * Neither the name of the Python Markdown Project nor the
+          names of its contributors may be used to endorse or promote products
+          derived from this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE PYTHON MARKDOWN PROJECT ''AS IS'' AND ANY
+        EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL ANY CONTRIBUTORS TO THE PYTHON MARKDOWN PROJECT
+        BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+        CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+        SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+        INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+        CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+        ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+        POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, https://Python-Markdown.github.io/
 Project-URL: Documentation, https://Python-Markdown.github.io/
-Project-URL: GitHub Project, https://github.com/Python-Markdown/markdown
+Project-URL: Repository, https://github.com/Python-Markdown/markdown
 Project-URL: Issue Tracker, https://github.com/Python-Markdown/markdown/issues
+Project-URL: Changelog, https://github.com/Python-Markdown/markdown/blob/master/docs/change_log/index.md
+Keywords: markdown,markdown-parser,python-markdown,markdown-to-html
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
@@ -31,10 +63,21 @@
 Classifier: Topic :: Text Processing :: Filters
 Classifier: Topic :: Text Processing :: Markup :: HTML
 Classifier: Topic :: Text Processing :: Markup :: Markdown
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
-Provides-Extra: testing
 License-File: LICENSE.md
+Requires-Dist: importlib-metadata>=4.4; python_version < "3.10"
+Provides-Extra: testing
+Requires-Dist: coverage; extra == "testing"
+Requires-Dist: pyyaml; extra == "testing"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5; extra == "docs"
+Requires-Dist: mkdocs-nature>=0.6; extra == "docs"
+Requires-Dist: mdx_gh_links>=0.2; extra == "docs"
+Requires-Dist: mkdocstringspython; extra == "docs"
+Requires-Dist: mkdocs-gen-files; extra == "docs"
+Requires-Dist: mkdocs-section-index; extra == "docs"
+Requires-Dist: mkdocs-literate-nav; extra == "docs"
 
 Python-Markdown
 ===================

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/authors.md -> _service:tar_scm:Markdown-3.5.1.tar.gz/docs/authors.md Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/change_log/index.md -> _service:tar_scm:Markdown-3.5.1.tar.gz/docs/change_log/index.md Changed

@@ -3,95 +3,9 @@
 Python-Markdown Change Log
 =========================
 
-July 15, 2022: version 3.4.1 (a bug-fix release).
+!!! note
 
-* Fix an import issue with `importlib.util` (#1274).
-
-July 15, 2022: version 3.4 (Notes(release-3.4.md)).
-
-May 5, 2022: version 3.3.7 (a bug-fix release).
-
-* Disallow square brackets in reference link ids (#1209).
-* Retain configured `pygments_style` after first code block (#1240).
-* Ensure fenced code attributes are properly escaped (#1247).
-
-Nov 17, 2021: version 3.3.6 (a bug-fix release).
-
-* Fix a dependency issue (#1195, #1196).
-
-Nov 16, 2021: version 3.3.5 (a bug-fix release).
-
-* Make the `slugify_unicode` function not remove diacritical marks (#1118).
-* Fix `toc` detection when used with `nl2br` extension (#1160).
-* Re-use compiled regex for block level checks (#1169).
-* Don't process shebangs in fenced code blocks when using CodeHilite (#1156).
-* Improve email address validation for Automatic Links (#1165).
-* Ensure `<summary>` tags are parsed correctly (#1079).
-* Support Python 3.10 (#1124).
-
-Feb 24, 2021: version 3.3.4 (a bug-fix release).
-
-* Properly parse unclosed tags in code spans (#1066).
-* Properly parse processing instructions in md_in_html (#1070).
-* Properly parse code spans in md_in_html (#1069).
-* Preserve text immediately before an admonition (#1092).
-* Simplified regex for HTML placeholders (#928) addressing (#932).
-* Ensure `permalinks` and `anchorlinks` are not restricted by `toc_depth` (#1107).
-* Fix corner cases with lists under admonitions (#1102).
-
-Oct 25, 2020: version 3.3.3 (a bug-fix release).
-
-* Unify all block-level tags (#1047).
-* Fix issue where some empty elements would have text rendered as `None` when using `md_in_html` (#1049).
-* Avoid catastrophic backtracking in `hr` regex (#1055).
-* Fix `hr` HTML handling (#1053).
-
-Oct 19, 2020: version 3.3.2 (a bug-fix release).
-
-* Properly parse inline HTML in md_in_html (#1040 & #1045).
-* Avoid crashing when md_in_html fails (#1040).
-
-Oct 12, 2020: version 3.3.1 (a bug-fix release).
-
-* Correctly parse raw `script` and `style` tags (#1036).
-* Ensure consistent class handling by `fenced_code` and `codehilite` (#1032).
-
-Oct 6, 2020: version 3.3 (Notes(release-3.3.md)).
-
-May 8, 2020: version 3.2.2 (a bug-fix release).
-
-* Add `checklinks` tox environment to ensure all links in documentation are good.
-* Refactor extension API documentation (#729).
-* Load entry_points (for extensions) only once using `importlib.metadata`.
-* Do not double escape entities in TOC.
-* Correctly report if an extension raises a `TypeError` (#939).
-* Raise a `KeyError` when attempting to delete a nonexistent key from the
-  extension registry (#939).
-* Remove import of `packaging` (or `pkg_resources` fallback) entirely.
-* Remove `setuptools` as a run-time dependency (`install_required`).
-
-Feb 12, 2020: Released version 3.2.1 (a bug-fix release).
-
-* The `name` property in `toc_tokens` from the TOC extension now
-  escapes HTML special characters (`<`, `>`, and `&`).
-
-Feb 7, 2020: Released version 3.2 (Notes(release-3.2.md)).
-
-May 20, 2019: Released version 3.1.1 (a bug-fix release).
-
-* Fixed import failure in `setup.py` when the source directory is not
-  on `sys.path` (#823).
-* Prefer public `packaging` module to pkg_resources' private copy of
-  it (#825).
-
-Mar 25, 2019: Released version 3.1 (Notes(release-3.1.md)).
-
-Sept 28, 2018: Released version 3.0.1 (a bug-fix release).
-
-* Brought back the `version` and `version_info` variables (#709).
-* Added support for hexadecimal HTML entities (#712).
-
-Sept 21, 2018: Released version 3.0 (Notes(release-3.0.md)).
+    This is an archive of the changelog prior to the release of version 3.0. See the current changelog(../changelog.md) for up-to-date details.
 
 Jan 4, 2018: Released version 2.6.11 (a bug-fix release). Added a new
 `BACKLINK-TITLE` option to the footnote extension so that non-English
@@ -171,10 +85,10 @@
 and moved all extensions into a 'markdown-extensions' package.
 Added additional documentation and a few bug fixes. (v2.0-beta)
 
-August 4 2008: Updated included extensions to ElementTree. Added a
+August 4 2008: Updated included extensions to `ElementTree`. Added a
 separate command line script. (v2.0-alpha)
 
-July 2008: Switched from home-grown NanoDOM to ElementTree and
+July 2008: Switched from home-grown `NanoDOM` to `ElementTree` and
 various related bugs (thanks Artem Yunusov).
 
 June 2008: Fixed issues with nested inline patterns and cleaned
@@ -299,7 +213,7 @@
 correctly (v. 0.8)
 
 Aug. 29, 2005: Added flexible tabs, fixed a few small issues, added
-basic support for footnotes.  Got rid of xml.dom.minidom and added
+basic support for footnotes.  Got rid of `xml.dom.minidom` and added
 pretty-printing. (v. 0.7)
 
 Aug. 13, 2005: Fixed a number of small bugs in order to conform to the

_service:tar_scm:Markdown-3.5.1.tar.gz/docs/changelog.md Added

@@ -0,0 +1,727 @@
+title: Changelog
+toc_depth: 2
+
+# Python-Markdown Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on Keep a Changelog(https://keepachangelog.com/en/1.1.0/),
+and this project adheres to Semantic Versioning(https://semver.org/spec/v2.0.0.html). See the Contributing Guide(contributing.md) for details.
+
+## 3.5.1 -- 2023-10-31
+
+### Fixed
+
+* Fix a performance problem with HTML extraction where large HTML input could
+  trigger quadratic line counting behavior (#1392).
+* Improve and expand type annotations in the code base (#1394).
+
+## 3.5 -- 2023-10-06
+
+### Added
+
+#### Add `permalink_leading` configuration option to the toc extension (#1339)
+
+A new boolean option `permalink_leading` controls the position of the permanent
+link anchors generated with `permalink`. Setting `permalink_leading` to `True`
+will cause the links to be inserted at the start of the header, before any other
+header content. The default behavior for `permalink` is to append permanent
+links to the header, placing them after all other header content.
+
+### Changed
+
+* Add support for cPython version 3.12 (and PyPy 3.10) and drop support for
+  Python version 3.7 (#1357).
+* Refactor changelog to use the format defined at <https://keepachangelog.com/>.
+* Update the list of empty HTML tags (#1353).
+* Add customizable TOC title class to TOC extension (#1293).
+* Add API documentation of the code base which is generated by
+  mkdocstrings(https://mkdocstrings.github.io/) (#1220).
+
+### Fixed
+
+* Fix a corner case in admonitions where if an indented code block was provided
+  as the first block, the output would be malformed (#1329).
+
+## 3.4.4 -- 2023-07-25
+
+### Fixed
+
+* Add a special case for initial `'s` to smarty extension (#1305).
+* Unescape any backslash escaped inline raw HTML (#1358).
+* Unescape backslash escaped TOC token names (#1360).
+
+## 3.4.3 -- 2023-03-23
+
+### Fixed
+
+* Restore console script (#1327).
+
+## 3.4.2 -- 2023-03-22
+
+### Fixed
+* Officially support Python 3.11.
+* Improve standalone * and _ parsing (#1300).
+* Consider `<html>` HTML tag a block-level element (#1309).
+* Switch from `setup.py` to `pyproject.toml`.
+
+## 3.4.1 -- 2022-07-15
+
+### Fixed
+
+* Fix an import issue with `importlib.util` (#1274).
+
+## 3.4 -- 2022-07-15
+
+### Changed
+
+#### The `tables` extension now uses a `style` attribute instead of an `align` attribute for alignment.
+
+The HTML4 spec(https://www.w3.org/TR/html4/present/graphics.html#h-15.1.2)
+specifically deprecates the use of the `align` attribute and it does not appear
+at all in the HTML5
+spec(https://www.w3.org/TR/html53/tabular-data.html#attributes-common-to-td-and-th-elements).
+Therefore, by default, the tables(extensions/tables.md) extension will now use
+the `style` attribute (setting just the `text-align` property) in `td` and `th`
+blocks.
+
+The former behavior is available by setting the `use_align_attribute`
+configuration option to `True` when enabling the extension.
+
+For example, to configure the old `align` behavior:
+
+```python
+from markdown.extensions.tables import TableExtension
+
+markdown.markdown(src, extensions=TableExtension(use_align_attribute=True))
+```
+
+#### Backslash unescaping moved to Treeprocessor (#1131).
+
+Unescaping backslash escapes has been moved to a Treeprocessor, which  enables
+proper HTML escaping during serialization. However, it is recognized that
+various third-party extensions may be calling the old class at
+`postprocessors.UnescapePostprocessor`. Therefore, the old class remains in the
+code base, but has been deprecated and will be removed in a future release. The
+new class `treeprocessors.UnescapeTreeprocessor` should be used instead.
+
+#### Previously deprecated objects have been removed
+
+Various objects were deprecated in version 3.0 and began raising deprecation
+warnings (see the version 3.0 release notes(#30-2018-09-21) for details). Any of those objects
+which remained in version 3.3 have been removed from the code base in version 3.4
+and will now raise errors. The relevant objects are listed below.
+
+
+| Deprecated Object                      | Replacement Object                  |
+|----------------------------------------|-------------------------------------|
+| `markdown.version`                     | `markdown.__version__`              |
+| `markdown.version_info`                | `markdown.__version_info__`         |
+| `markdown.util.etree`                  | `xml.etree.ElementTree`             |
+| `markdown.util.string_type`            | `str`                               |
+| `markdown.util.text_type`              | `str`                               |
+| `markdown.util.int2str`                | `chr`                               |
+| `markdown.util.iterrange`              | `range`                             |
+| `markdown.util.isBlockLevel`           | `markdown.Markdown().is_block_level`|
+| `markdown.util.Processor().markdown`   | `markdown.util.Processor().md`      |
+| `markdown.util.Registry().__setitem__` | `markdown.util.Registry().register` |
+| `markdown.util.Registry().__delitem__` |`markdown.util.Registry().deregister`|
+| `markdown.util.Registry().add`         | `markdown.util.Registry().register` |
+
+In addition, the `md_globals` parameter of
+`Markdown.extensions.Extension.extendMarkdown()` is no longer recognized as a
+valid parameter and will raise an error if provided.
+
+### Added
+
+* Some new configuration options have been added to the
+  footnotes(extensions/footnotes.md) extension (#1218):
+
+    * Small refactor of the `BACKLINK_TITLE` option; The use of `format()`
+      instead of "old" `%d` formatter allows one to specify text without the
+      need to have the number of the footnote in it (like footnotes on
+      Wikipedia for example). The modification is backward compatible so no
+      configuration change is required.
+
+    * Addition of a new option `SUPERSCRIPT_TEXT` that allows one to specify a
+      custom placeholder for the footnote itself in the text.
+      Ex: `{}` will give `<sup>1</sup>`, `({})` will give `<sup>(1)</sup>`,
+      or by default, the current behavior: `<sup>1</sup>`.
+
+* The Table of Contents(extensions/toc.md) extension now accepts a
+  `toc_class` parameter which can be used to set the CSS class(es) on the
+  `<div>` that contains the Table of Contents (#1224).
+
+* The CodeHilite extension now supports a `pygments_formatter` option that can
+  be set to a custom formatter class (#1187).
+
+    - If `pygments_formatter` is set to a string (ex: `'html'`), Pygments'
+      default formatter by that name is used.
+    - If `pygments_formatter` is set to a formatter class (or any callable
+      which returns a formatter instance), then an instance of that class is
+      used.
+
+    The formatter class is now passed an additional option, `lang_str`, to
+    denote the language of the code block (#1258). While Pygments' built-in
+    formatters will ignore the option, a custom formatter assigned to the
+    `pygments_formatter` option can make use of the `lang_str` to include the
+    code block's language in the output.
+
+### Fixed
+
+* Extension entry-points are only loaded if needed (#1216).
+* Added additional checks to the `<pre><code>` handling of
+  `PrettifyTreeprocessor` (#1261, #1263).
+* Fix XML deprecation warnings.
+
+## 3.3.7 -- 2022-05-05
+
+### Fixed
+
+* Disallow square brackets in reference link ids (#1209).
+* Retain configured `pygments_style` after first code block (#1240).
+* Ensure fenced code attributes are properly escaped (#1247).
+
+## 3.3.6 -- 2021-11-17
+
+### Fixed
+
+* Fix a dependency issue (#1195, #1196).
+
+## 3.3.5 -- 2021-11-16
+
+### Fixed
+
+* Make the `slugify_unicode` function not remove diacritical marks (#1118).
+* Fix `toc` detection when used with `nl2br` extension (#1160).
+* Re-use compiled regex for block level checks (#1169).
+* Don't process shebangs in fenced code blocks when using CodeHilite (#1156).
+* Improve email address validation for Automatic Links (#1165).

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/contributing.md -> _service:tar_scm:Markdown-3.5.1.tar.gz/docs/contributing.md Changed

@@ -56,9 +56,16 @@
 allows us to keep the maintenance overhead of Python-Markdown to a minimum, so
 that the focus can be on continued stability, bug fixes, and documentation.
 
-Closing an issue does not necessarily mean the end of a discussion. If you
-believe your issue has been closed incorrectly, explain why and we'll consider
-if it needs to be reopened.
+If you intend to submit a fix for your bug or provide an implementation of your
+feature request, it is not necessary to first open an issue. You can report a
+bug or make a feature request as part of a pull request. Of course, if you want
+to receive feedback on how to implement a bug-fix or feature before submitting
+a solution, then it would be appropriate to open an issue first and ask your
+questions there.
+
+Having your issue closed does not necessarily mean the end of a discussion. If
+you believe your issue has been closed incorrectly, explain why and we'll
+consider if it needs to be reopened.
 
 ## Pull Requests
 
@@ -85,7 +92,7 @@
 
 Before being accepted, each pull request must include the applicable code, new
 tests of all new features, updated tests for any changed features, documentation
-updates, and an appropriate update to the release notes. All changes must follow
+updates, and an appropriate update to the changelog. All changes must follow
 the applicable style guides. Failure to meet any one of the requirements is
 likely to delay any serious consideration of your pull request and may even
 cause it to be closed. Of course, if you are in the early stages of development,
@@ -99,6 +106,12 @@
 fail, you may push additional commits to your branch. GitHub will add those
 commits to the pull request and rerun the checks.
 
+It is generally best not to squash multiple commits and force-push your changes
+to a pull request. Instead, the maintainers would like to be able to follow the
+series of commits along with the discussion about those changes as they
+progress over time. If your pull request is accepted, it will be squashed at
+that time if deemed appropriate.
+
 ## Style Guides
 
 In an effort to maintain consistency, Python-Markdown adheres to the following
@@ -224,6 +237,32 @@
     This is the content of the note.
 ```
 
+#### Changelog
+
+Any commit/pull request which changes the behavior of the Markdown library in
+any way must include an entry in the changelog. If a change only alters the
+documentation or tooling for the project, then an entry in the changelog is
+not necessary. The current changelog can be found at `docs/changelog.md`.
+
+The current changelog follows the format defined at
+keepachangelog.com(https://keepachangelog.com/en/1.1.0/). The description of
+each change should include a reference to the relevant GitHub issue in the
+format `#123` (where `123` is the issue number).
+
+Edits to the changelog should generally add entries to the `unreleased`
+version at the top of the log. A pull request should not alter an entry for a
+previously released version, unless it is editing an error in the notes for
+that version, or is otherwise expressly deemed appropriate by the project
+maintainers.
+
+The current changelog should only document the changes for one MAJOR release and
+its various MINOR and PATCH releases (see Versions(#versions) for an
+explanation of MAJOR, MINOR, and PATCH releases). Older versions from previous
+series of releases can be found in the archive at `docs/change_log/` and may
+follow a different format. Note that the archived changelogs are not in the site
+navigation and are only linked from the Previous
+Releases(changelog.md#previous-releases) section of the current changelog.
+
 ### Commit Message Style Guide
 
 Use the present tense ("Add feature" not "Added feature").
@@ -234,7 +273,7 @@
 
 Reference issues and pull requests liberally after the first line. Include a
 summary of the changes/additions made without replicating the content of the
-documentation or release notes. This is where an explanation of the choices made
+documentation or changelog. This is where an explanation of the choices made
 should be found. References to issues and pull requests should only provide the
 context in which a choice was made. However, the commit should be able to stand
 on its own.
@@ -280,7 +319,7 @@
 virtual environment for the first time:
 
 ```sh
-pip install --editable .
+pip install -e .
 ```
 
 Now any saved changes will immediately be available within the virtual
@@ -292,29 +331,63 @@
 python -m markdown
 ```
 
+Before building the documentation for the first time, you will need to install
+some optional dependencies with the command:
+
+```sh
+pip install -e .docs
+```
+
+To build the documentation and serve it locally on a development server, run:
+
+```sh
+mkdocs serve
+```
+
+Then point your browser at `http://127.0.0.1:8000/`. For a complete list of
+options available, view MkDocs' help with the command:
+
+```sh
+mkdocs --help
+```
+
+Before running tests for the first time, you will need to install some optional
+dependencies with the command:
+
+```sh
+pip install -e .testing
+```
+
 And you can directly run the tests with:
 
 ```sh
 python -m unittest discover tests
 ```
 
+To get a coverage report after running the tests, use these commands instead:
+
+```sh
+coverage run --source=markdown -m unittest discover tests
+coverage report --show-missing
+```
+
 !!! note
 
     Some tests require the PyTidyLib library, which depends on the HTML Tidy
     library. If you do not have PyTidyLib installed, the tests which depend upon
     it will be skipped. Given the difficulty in installing the HTML Tidy library
     on many systems, you may choose to leave both libraries uninstalled and
-    depend on the Travis server to run those tests when you submit a pull
-    request.
+    depend on the continuous integration server to run those tests when you
+    submit a pull request.
 
 The above setup will only run tests against the code in one version of Python.
 However,  Python-Markdown supports multiple versions of Python. Therefore, a
 tox configuration is included in the repository, which includes test
 environments for all supported Python versions, a Flake8 test environment, and
 a spellchecker for the documentation. While it is generally fine to leave those
-tests for the Travis server to run when a pull request is submitted, for more
-advanced changes, you may want to run those tests locally. To do so, simply
-install tox:
+tests for the continuous integration server to run when a pull request is
+submitted, for more advanced changes, you may want to run those tests locally.
+To do so, simply install tox:
 
 ```sh
 pip install tox
@@ -337,7 +410,7 @@
 
 !!! seealso "See Also"
 
-    Python-Markdown provides test tools which simply testing Markdown syntax.
+    Python-Markdown provides test tools which simply test Markdown syntax.
     Understanding those tools will often help in understanding why a test may be
     failing.
 
@@ -348,8 +421,9 @@
 of the `master` branch should always be identified in the `__version_info__`
 tuple defined in `markdown/__meta__.py`markdown/__meta__.py. The contents of
 that tuple will automatically be converted into a normalized version which
-conforms to PEP 440. An invalid `__version_info__` tuple will raise an error,
-preventing the library from running and the package from building.
+conforms to PEP 440. Each time the version is changed, the continuous
+integration server will run a test to ensure that the current version is in a
+valid normalized format.
 
 ### Version Status
 
@@ -395,8 +469,8 @@
 1. Verify that all outstanding issues and pull requests related to the release
    have been resolved.
 
-2. Confirm that the release notes and change log have been updated and indicate
-   the date of the new release.
+2. Confirm that the changelog has been updated and indicate the date and
+   version of the new release.
 
 3. Update the version defined in `markdown/__meta__.py`markdown/__meta__.py.
 
@@ -421,8 +495,9 @@
 
     - Deploy an update to the documentation using MkDocs. The following example
       assumes that local clones of the Python-Markdown/markdown and
-      Python-Markdown/Python-Markdown.github.io repositories are in sibling
-      directories named `markdown` and `Python-Markdown.github.io` respectively.

_service:tar_scm:Markdown-3.5.1.tar.gz/docs/custom.css Added

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/extensions/api.md -> _service:tar_scm:Markdown-3.5.1.tar.gz/docs/extensions/api.md Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/extensions/fenced_code_blocks.md -> _service:tar_scm:Markdown-3.5.1.tar.gz/docs/extensions/fenced_code_blocks.md Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/extensions/meta_data.md -> _service:tar_scm:Markdown-3.5.1.tar.gz/docs/extensions/meta_data.md Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/extensions/toc.md -> _service:tar_scm:Markdown-3.5.1.tar.gz/docs/extensions/toc.md Changed

@@ -151,6 +151,9 @@
 * **`title`**:
     Title to insert in the Table of Contents' `<div>`. Defaults to `None`.
 
+* **`title_class`**:
+    CSS class used for the title contained in the Table of Contents. Defaults to `toctitle`.
+
 * **`toc_class`**:
     CSS class(es) used for the `<div>` containing the Table of Contents. Defaults to `toc`.
 
@@ -174,6 +177,15 @@
 * **`permalink_title`**:
     Title attribute of the permanent link. Defaults to `Permanent link`.
 
+* **`permalink_leading`**:
+    Set to `True` if the extension should generate leading permanent links.
+    Default is `False`.
+
+    Leading permanent links are placed at the start of the header tag,
+    before any header content. The default `permalink` behavior (when
+    `permalink_leading` is unset or set to `False`) creates trailing
+    permanent links, which are placed at the end of the header content.
+
 * **`baselevel`**:
     Base level for headers. Defaults to `1`.
 
@@ -195,7 +207,7 @@
 * **`slugify`**:
     Callable to generate anchors.
 
-    Default: `markdown.extensions.headerid.slugify`
+    Default: `markdown.extensions.toc.slugify`
 
     In order to use a different algorithm to define the id attributes, define  and
     pass in a callable which takes the following two arguments:
@@ -206,7 +218,7 @@
     The callable must return a string appropriate for use in HTML `id` attributes.
 
     An alternate version of the default callable supporting Unicode strings is also
-    provided as `markdown.extensions.headerid.slugify_unicode`.
+    provided as `markdown.extensions.toc.slugify_unicode`.
 
 * **`separator`**:
     Word separator. Character which replaces white space in id. Defaults to "`-`".

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/index.md -> _service:tar_scm:Markdown-3.5.1.tar.gz/docs/index.md Changed

@@ -21,13 +21,23 @@
 * Maintain a Python library (with an optional CLI wrapper) suited to use in web
   server environments (never raise an exception, never write to stdout, etc.) as
   an implementation of the markdown parser that follows the
-  syntax rules(https://daringfireball.net/projects/markdown/syntax) and the
-  behavior of the original (markdown.pl) implementation as reasonably as
-  possible (see differences(#differences) for a few exceptions).
+  syntax rules and the behavior of the original (markdown.pl)
+  implementation as reasonably as possible (see differences(#differences) for
+  a few exceptions).
 
 * Provide an Extension API(extensions/api.md) which makes it possible
   to change and/or extend the behavior of the parser.
 
+!!! Note
+
+    *This is not a CommonMark implementation*; nor is it trying to be!
+    Python-Markdown was developed long before the CommonMark specification was
+    released and has always (mostly) followed the syntax rules and behavior
+    of the original reference implementation. No accommodations have been made
+    to address the changes which CommonMark has suggested. It is recommended
+    that you look elsewhere if you want an implementation which follows the
+    CommonMark specification.
+
 Features
 --------
 
@@ -91,7 +101,7 @@
     In the event that one would prefer different behavior,
     tab_length(reference.md#tab_length) can be set to whatever length is
     desired. Be warned however, as this will affect indentation for all aspects
-    of the syntax (including root level code blocks). Alternatively, a 
+    of the syntax (including root level code blocks). Alternatively, a
     third party extension may offer a solution that meets your needs.
 
 * __Consecutive Lists__
@@ -109,4 +119,5 @@
 You may report bugs, ask for help, and discuss various other issues on the bug tracker.
 
 third party extension: https://github.com/Python-Markdown/markdown/wiki/Third-Party-Extensions
+syntax rules: https://daringfireball.net/projects/markdown/syntax
 bug tracker: https://github.com/Python-Markdown/markdown/issues

_service:tar_scm:Markdown-3.5.1.tar.gz/docs/mkdocstrings.css Added

@@ -0,0 +1,105 @@
+/* Indentation. */
+div.doc-contents:not(.first) {
+  padding-left: 25px;
+}
+
+/* Mark external links as such. */
+a.external::after,
+a.autorefs-external::after {
+  /* https://primer.style/octicons/arrow-up-right-24 */
+  mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+  -webkit-mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+  content: ' ';
+
+  display: inline-block;
+  vertical-align: middle;
+  position: relative;
+
+  height: 1em;
+  width: 1em;
+  background-color: #005b81;
+}
+
+a.external:hover::after,
+a.autorefs-external:hover::after {
+  background-color: #e32e00;
+}
+
+/* Customize custom links. */
+a.autorefs code {
+  background-color: #ecf0f3;
+  font-weight: normal;
+  color: #005B81;
+}
+
+a.autorefs:hover code {
+  color: #E32E00;
+}
+
+/* Customize labels. */
+.doc-label {
+  border-radius: 15px;
+  padding: 2px 8px;
+  background-color: #f2f2f3;
+  text-wrap: nowrap;
+}
+
+.doc-label code {
+  color: #444;
+}
+
+.doc-label-deprecated {
+  background-color: #ffe4e4;
+  border: 1px solid #f66;
+}
+
+/* No shadows in any code. */
+
+code {
+  text-shadow: none;
+}
+
+/* Code spans in tables. */
+
+table code {
+  background-color: transparent !important;
+}
+
+/* Style source links */
+a.doc-source-link {
+  position: relative;
+  float: right;
+  border: 1px #005B81 solid;
+  margin: 0 5px;
+  padding: 0 5px;
+  font-weight: normal;
+  text-shadow: none;
+  background-color: #f2f2f3;
+  font-size: 1rem;
+}
+
+a.doc-source-link:hover {
+  text-decoration: none;
+  border-color: #E32E00;
+}
+
+/* Customize symbol names. */
+code.doc-symbol-attribute::after {
+  content: "Attr";
+}
+
+code.doc-symbol-function::after {
+  content: "Func";
+}
+
+code.doc-symbol-method::after {
+  content: "Method";
+}
+
+code.doc-symbol-class::after {
+  content: "Class";
+}
+
+code.doc-symbol-module::after {
+  content: "Module";
+}

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/reference.md -> _service:tar_scm:Markdown-3.5.1.tar.gz/docs/reference.md Changed

_service:tar_scm:Markdown-3.5.1.tar.gz/docs/templates Added

_service:tar_scm:Markdown-3.5.1.tar.gz/docs/templates/python Added

_service:tar_scm:Markdown-3.5.1.tar.gz/docs/templates/python/nature Added

_service:tar_scm:Markdown-3.5.1.tar.gz/docs/templates/python/nature/attribute.html Added

_service:tar_scm:Markdown-3.5.1.tar.gz/docs/templates/python/nature/class.html Added

_service:tar_scm:Markdown-3.5.1.tar.gz/docs/templates/python/nature/docstring Added

_service:tar_scm:Markdown-3.5.1.tar.gz/docs/templates/python/nature/docstring/admonition.html Added

_service:tar_scm:Markdown-3.5.1.tar.gz/docs/templates/python/nature/function.html Added

_service:tar_scm:Markdown-3.5.1.tar.gz/docs/templates/python/nature/module.html Added

_service:tar_scm:Markdown-3.4.1.tar.gz/docs/test_tools.md -> _service:tar_scm:Markdown-3.5.1.tar.gz/docs/test_tools.md Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/makefile -> _service:tar_scm:Markdown-3.5.1.tar.gz/makefile Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/__init__.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/__init__.py Changed

@@ -1,23 +1,43 @@
-"""
-Python Markdown
+# Python Markdown
+
+# A Python implementation of John Gruber's Markdown.
 
-A Python implementation of John Gruber's Markdown.
+# - Documentation: https://python-markdown.github.io/
+# - GitHub: https://github.com/Python-Markdown/markdown/
+# - PyPI: https://pypi.org/project/Markdown/
 
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
+# - Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# - Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# - Copyright 2004 Manfred Stienstra (the original version)
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# License: BSD (see LICENSE.md for details).
 
-License: BSD (see LICENSE.md for details).
 """
+Python-Markdown provides two public functions (`markdown.markdown` and `markdown.markdownFromFile`)
+both of which wrap the public class `markdown.Markdown`. All submodules support these public functions
+and class and/or provide extension support.
+
+Modules:
+    core: Core functionality.
+    preprocessors: Pre-processors.
+    blockparser: Core Markdown block parser.
+    blockprocessors: Block processors.
+    treeprocessors: Tree processors.
+    inlinepatterns: Inline patterns.
+    postprocessors: Post-processors.
+    serializers: Serializers.
+    util: Utility functions.
+    htmlparser: HTML parser.
+    test_tools: Testing utilities.
+    extensions: Markdown extensions.
+"""
+
+from __future__ import annotations
 
 from .core import Markdown, markdown, markdownFromFile
 from .__meta__ import __version__, __version_info__  # noqa

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/__main__.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/__main__.py Changed

@@ -1,23 +1,23 @@
-"""
-Python Markdown
+# Python Markdown
 
-A Python implementation of John Gruber's Markdown.
+# A Python implementation of John Gruber's Markdown.
 
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
+# Documentation: https://python-markdown.github.io/
+# GitHub: https://github.com/Python-Markdown/markdown/
+# PyPI: https://pypi.org/project/Markdown/
 
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# Copyright 2004 Manfred Stienstra (the original version)
 
-License: BSD (see LICENSE.md for details).
-"""
+# License: BSD (see LICENSE.md for details).
+
+from __future__ import annotations
 
 import sys
 import optparse
@@ -146,6 +146,6 @@
 
 
 if __name__ == '__main__':  # pragma: no cover
-    # Support running module as a commandline command.
-    # `python -m markdown options args`.
+    # Support running module as a command line command.
+    #     python -m markdown options args
     run()

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/__meta__.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/__meta__.py Changed

@@ -1,36 +1,38 @@
-"""
-Python Markdown
+# Python Markdown
 
-A Python implementation of John Gruber's Markdown.
+# A Python implementation of John Gruber's Markdown.
 
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
+# Documentation: https://python-markdown.github.io/
+# GitHub: https://github.com/Python-Markdown/markdown/
+# PyPI: https://pypi.org/project/Markdown/
 
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# Copyright 2004 Manfred Stienstra (the original version)
 
-License: BSD (see LICENSE.md for details).
-"""
+# License: BSD (see LICENSE.md for details).
 
 # __version_info__ format:
-# (major, minor, patch, dev/alpha/beta/rc/final, #)
-# (1, 1, 2, 'dev', 0) => "1.1.2.dev0"
-# (1, 1, 2, 'alpha', 1) => "1.1.2a1"
-# (1, 2, 0, 'beta', 2) => "1.2b2"
-# (1, 2, 0, 'rc', 4) => "1.2rc4"
-# (1, 2, 0, 'final', 0) => "1.2"
-__version_info__ = (3, 4, 1, 'final', 0)
+#     (major, minor, patch, dev/alpha/beta/rc/final, #)
+#     (1, 1, 2, 'dev', 0) => "1.1.2.dev0"
+#     (1, 1, 2, 'alpha', 1) => "1.1.2a1"
+#     (1, 2, 0, 'beta', 2) => "1.2b2"
+#     (1, 2, 0, 'rc', 4) => "1.2rc4"
+#     (1, 2, 0, 'final', 0) => "1.2"
+
+from __future__ import annotations
+
+
+__version_info__ = (3, 5, 1, 'final', 0)
 
 
 def _get_version(version_info):
-    " Returns a PEP 440-compliant version number from version_info. "
+    " Returns a PEP 440-compliant version number from `version_info`. "
     assert len(version_info) == 5
     assert version_info3 in ('dev', 'alpha', 'beta', 'rc', 'final')

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/blockparser.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/blockparser.py Changed

@@ -1,32 +1,47 @@
-"""
-Python Markdown
+# Python Markdown
+
+# A Python implementation of John Gruber's Markdown.
 
-A Python implementation of John Gruber's Markdown.
+# Documentation: https://python-markdown.github.io/
+# GitHub: https://github.com/Python-Markdown/markdown/
+# PyPI: https://pypi.org/project/Markdown/
 
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
+# Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# Copyright 2004 Manfred Stienstra (the original version)
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# License: BSD (see LICENSE.md for details).
+
+"""
+The block parser handles basic parsing of Markdown blocks.  It doesn't concern
+itself with inline elements such as `**bold**` or `*italics*`, but rather just
+catches blocks, lists, quotes, etc.
 
-License: BSD (see LICENSE.md for details).
+The `BlockParser` is made up of a bunch of `BlockProcessors`, each handling a
+different type of block. Extensions may add/replace/remove `BlockProcessors`
+as they need to alter how Markdown blocks are parsed.
 """
 
+from __future__ import annotations
+
 import xml.etree.ElementTree as etree
+from typing import TYPE_CHECKING, Iterable, Any
 from . import util
 
+if TYPE_CHECKING:  # pragma: no cover
+    from markdown import Markdown
+    from .blockprocessors import BlockProcessor
+
 
 class State(list):
     """ Track the current and nested state of the parser.
 
-    This utility class is used to track the state of the BlockParser and
+    This utility class is used to track the state of the `BlockParser` and
     support multiple levels if nesting. It's just a simple API wrapped around
     a list. Each time a state is set, that state is appended to the end of the
     list. Each time a state is reset, that state is removed from the end of
@@ -41,15 +56,15 @@
 
     """
 
-    def set(self, state):
+    def set(self, state: Any):
         """ Set a new state. """
         self.append(state)
 
-    def reset(self):
+    def reset(self) -> None:
         """ Step back one step in nested state. """
         self.pop()
 
-    def isstate(self, state):
+    def isstate(self, state: Any) -> bool:
         """ Test that top (current) level is of given state. """
         if len(self):
             return self-1 == state
@@ -58,58 +73,84 @@
 
 
 class BlockParser:
-    """ Parse Markdown blocks into an ElementTree object.
+    """ Parse Markdown blocks into an `ElementTree` object.
+
+    A wrapper class that stitches the various `BlockProcessors` together,
+    looping through them and creating an `ElementTree` object.
 
-    A wrapper class that stitches the various BlockProcessors together,
-    looping through them and creating an ElementTree object.
     """
 
-    def __init__(self, md):
-        self.blockprocessors = util.Registry()
+    def __init__(self, md: Markdown):
+        """ Initialize the block parser.
+
+        Arguments:
+            md: A Markdown instance.
+
+        Attributes:
+            BlockParser.md (Markdown): A Markdown instance.
+            BlockParser.state (State): Tracks the nesting level of current location in document being parsed.
+            BlockParser.blockprocessors (util.Registry): A collection of
+                `blockprocessors`markdown.blockprocessors.
+
+        """
+        self.blockprocessors: util.RegistryBlockProcessor = util.Registry()
         self.state = State()
         self.md = md
 
-    def parseDocument(self, lines):
-        """ Parse a markdown document into an ElementTree.
+    def parseDocument(self, lines: Iterablestr) -> etree.ElementTree:
+        """ Parse a Markdown document into an `ElementTree`.
 
-        Given a list of lines, an ElementTree object (not just a parent
-        Element) is created and the root element is passed to the parser
-        as the parent. The ElementTree object is returned.
+        Given a list of lines, an `ElementTree` object (not just a parent
+        `Element`) is created and the root element is passed to the parser
+        as the parent. The `ElementTree` object is returned.
 
         This should only be called on an entire document, not pieces.
 
+        Arguments:
+            lines: A list of lines (strings).
+
+        Returns:
+            An element tree.
         """
-        # Create a ElementTree from the lines
+        # Create an `ElementTree` from the lines
         self.root = etree.Element(self.md.doc_tag)
         self.parseChunk(self.root, '\n'.join(lines))
         return etree.ElementTree(self.root)
 
-    def parseChunk(self, parent, text):
-        """ Parse a chunk of markdown text and attach to given etree node.
+    def parseChunk(self, parent: etree.Element, text: str) -> None:
+        """ Parse a chunk of Markdown text and attach to given `etree` node.
 
-        While the ``text`` argument is generally assumed to contain multiple
+        While the `text` argument is generally assumed to contain multiple
         blocks which will be split on blank lines, it could contain only one
         block. Generally, this method would be called by extensions when
         block parsing is required.
 
-        The ``parent`` etree Element passed in is altered in place.
+        The `parent` `etree` Element passed in is altered in place.
         Nothing is returned.
 
+        Arguments:
+            parent: The parent element.
+            text: The text to parse.
+
         """
         self.parseBlocks(parent, text.split('\n\n'))
 
-    def parseBlocks(self, parent, blocks):
-        """ Process blocks of markdown text and attach to given etree node.
+    def parseBlocks(self, parent: etree.Element, blocks: liststr) -> None:
+        """ Process blocks of Markdown text and attach to given `etree` node.
 
-        Given a list of ``blocks``, each blockprocessor is stepped through
+        Given a list of `blocks`, each `blockprocessor` is stepped through
         until there are no blocks left. While an extension could potentially
         call this method directly, it's generally expected to be used
         internally.
 
         This is a public method as an extension may need to add/alter
-        additional BlockProcessors which call this method to recursively
+        additional `BlockProcessors` which call this method to recursively
         parse a nested block.
 
+        Arguments:
+            parent: The parent element.
+            blocks: The blocks of text to parse.
+
         """
         while blocks:
             for processor in self.blockprocessors:

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/blockprocessors.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/blockprocessors.py Changed

@@ -1,45 +1,45 @@
-"""
-Python Markdown
-
-A Python implementation of John Gruber's Markdown.
+# Python Markdown
 
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
+# A Python implementation of John Gruber's Markdown.
 
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
+# Documentation: https://python-markdown.github.io/
+# GitHub: https://github.com/Python-Markdown/markdown/
+# PyPI: https://pypi.org/project/Markdown/
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-License: BSD (see LICENSE.md for details).
+# Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# Copyright 2004 Manfred Stienstra (the original version)
 
-CORE MARKDOWN BLOCKPARSER
-===========================================================================
+# License: BSD (see LICENSE.md for details).
 
-This parser handles basic parsing of Markdown blocks.  It doesn't concern
-itself with inline elements such as **bold** or *italics*, but rather just
-catches blocks, lists, quotes, etc.
-
-The BlockParser is made up of a bunch of BlockProcessors, each handling a
-different type of block. Extensions may add/replace/remove BlockProcessors
-as they need to alter how markdown blocks are parsed.
+"""
+A block processor parses blocks of text and adds new elements to the ElementTree. Blocks of text,
+separated from other text by blank lines, may have a different syntax and produce a differently
+structured tree than other Markdown. Block processors excel at handling code formatting, equation
+layouts, tables, etc.
 """
 
+from __future__ import annotations
+
 import logging
 import re
 import xml.etree.ElementTree as etree
+from typing import TYPE_CHECKING, Any
 from . import util
 from .blockparser import BlockParser
 
+if TYPE_CHECKING:  # pragma: no cover
+    from markdown import Markdown
+
 logger = logging.getLogger('MARKDOWN')
 
 
-def build_block_parser(md, **kwargs):
+def build_block_parser(md: Markdown, **kwargs: Any) -> BlockParser:
     """ Build the default block parser used by Markdown. """
     parser = BlockParser(md)
     parser.blockprocessors.register(EmptyBlockProcessor(parser), 'empty', 100)
@@ -60,25 +60,29 @@
     """ Base class for block processors.
 
     Each subclass will provide the methods below to work with the source and
-    tree. Each processor will need to define it's own ``test`` and ``run``
-    methods. The ``test`` method should return True or False, to indicate
+    tree. Each processor will need to define it's own `test` and `run`
+    methods. The `test` method should return True or False, to indicate
     whether the current block should be processed by this processor. If the
-    test passes, the parser will call the processors ``run`` method.
+    test passes, the parser will call the processors `run` method.
+
+    Attributes:
+        BlockProcessor.parser (BlockParser): The `BlockParser` instance this is attached to.
+        BlockProcessor.tab_length (int): The tab length set on the `Markdown` instance.
 
     """
 
-    def __init__(self, parser):
+    def __init__(self, parser: BlockParser):
         self.parser = parser
         self.tab_length = parser.md.tab_length
 
-    def lastChild(self, parent):
-        """ Return the last child of an etree element. """
+    def lastChild(self, parent: etree.Element) -> etree.Element | None:
+        """ Return the last child of an `etree` element. """
         if len(parent):
             return parent-1
         else:
             return None
 
-    def detab(self, text, length=None):
+    def detab(self, text: str, length: int | None = None) -> tuplestr, str:
         """ Remove a tab from the front of each line of the given text. """
         if length is None:
             length = self.tab_length
@@ -93,7 +97,7 @@
                 break
         return '\n'.join(newtext), '\n'.join(lineslen(newtext):)
 
-    def looseDetab(self, text, level=1):
+    def looseDetab(self, text: str, level: int = 1) -> str:
         """ Remove a tab from front of lines but allowing dedented lines. """
         lines = text.split('\n')
         for i in range(len(lines)):
@@ -101,47 +105,47 @@
                 linesi = linesiself.tab_length*level:
         return '\n'.join(lines)
 
-    def test(self, parent, block):
+    def test(self, parent: etree.Element, block: str) -> bool:
         """ Test for block type. Must be overridden by subclasses.
 
-        As the parser loops through processors, it will call the ``test``
+        As the parser loops through processors, it will call the `test`
         method on each to determine if the given block of text is of that
-        type. This method must return a boolean ``True`` or ``False``. The
+        type. This method must return a boolean `True` or `False`. The
         actual method of testing is left to the needs of that particular
-        block type. It could be as simple as ``block.startswith(some_string)``
+        block type. It could be as simple as `block.startswith(some_string)`
         or a complex regular expression. As the block type may be different
         depending on the parent of the block (i.e. inside a list), the parent
-        etree element is also provided and may be used as part of the test.
+        `etree` element is also provided and may be used as part of the test.
 
-        Keywords:
-
-        * ``parent``: A etree element which will be the parent of the block.
-        * ``block``: A block of text from the source which has been split at
-            blank lines.
+        Keyword arguments:
+            parent: An `etree` element which will be the parent of the block.
+            block: A block of text from the source which has been split at blank lines.
         """
         pass  # pragma: no cover
 
-    def run(self, parent, blocks):
+    def run(self, parent: etree.Element, blocks: liststr) -> bool | None:
         """ Run processor. Must be overridden by subclasses.
 
         When the parser determines the appropriate type of a block, the parser
-        will call the corresponding processor's ``run`` method. This method
+        will call the corresponding processor's `run` method. This method
         should parse the individual lines of the block and append them to
-        the etree.
+        the `etree`.
 
-        Note that both the ``parent`` and ``etree`` keywords are pointers
+        Note that both the `parent` and `etree` keywords are pointers
         to instances of the objects which should be edited in place. Each
         processor must make changes to the existing objects as there is no
         mechanism to return new/different objects to replace them.
 
-        This means that this method should be adding SubElements or adding text
-        to the parent, and should remove (``pop``) or add (``insert``) items to
+        This means that this method should be adding `SubElements` or adding text
+        to the parent, and should remove (`pop`) or add (`insert`) items to
         the list of blocks.
 
-        Keywords:
+        If `False` is returned, this will have the same effect as returning `False`
+        from the `test` method.
 
-        * ``parent``: A etree element which is the parent of the current block.
-        * ``blocks``: A list of all remaining blocks of the document.
+        Keyword arguments:
+            parent: An `etree` element which is the parent of the current block.
+            blocks: A list of all remaining blocks of the document.
         """
         pass  # pragma: no cover
 
@@ -149,7 +153,8 @@
 class ListIndentProcessor(BlockProcessor):
     """ Process children of list items.
 
-    Example:
+    Example
+
         * a list item
             process this part
 
@@ -158,7 +163,9 @@
     """
 
     ITEM_TYPES = 'li'
+    """ List of tags used for list items. """
     LIST_TYPES = 'ul', 'ol'

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/core.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/core.py Changed

@@ -1,28 +1,29 @@
-"""
-Python Markdown
+# Python Markdown
 
-A Python implementation of John Gruber's Markdown.
+# A Python implementation of John Gruber's Markdown.
 
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
+# Documentation: https://python-markdown.github.io/
+# GitHub: https://github.com/Python-Markdown/markdown/
+# PyPI: https://pypi.org/project/Markdown/
 
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# Copyright 2004 Manfred Stienstra (the original version)
 
-License: BSD (see LICENSE.md for details).
-"""
+# License: BSD (see LICENSE.md for details).
+
+from __future__ import annotations
 
 import codecs
 import sys
 import logging
 import importlib
+from typing import TYPE_CHECKING, Any, Callable, ClassVar, Mapping, Sequence, TextIO
 from . import util
 from .preprocessors import build_preprocessors
 from .blockprocessors import build_block_parser
@@ -31,6 +32,10 @@
 from .postprocessors import build_postprocessors
 from .extensions import Extension
 from .serializers import to_html_string, to_xhtml_string
+from .util import BLOCK_LEVEL_ELEMENTS
+
+if TYPE_CHECKING:  # pragma: no cover
+    from xml.etree.ElementTree import Element
 
 __all__ = 'Markdown', 'markdown', 'markdownFromFile'
 
@@ -39,67 +44,111 @@
 
 
 class Markdown:
-    """Convert Markdown to HTML."""
+    """
+    A parser which converts Markdown to HTML.
+
+    Attributes:
+        Markdown.tab_length (int): The number of spaces which correspond to a single tab. Default: `4`.
+        Markdown.ESCAPED_CHARS (liststr): List of characters which get the backslash escape treatment.
+        Markdown.block_level_elements (liststr): List of HTML tags which get treated as block-level elements.
+            See `markdown.util.BLOCK_LEVEL_ELEMENTS` for the full list of elements.
+        Markdown.registeredExtensions (listExtension): List of extensions which have called
+            `registerExtension`markdown.Markdown.registerExtension during setup.
+        Markdown.doc_tag (str): Element used to wrap document. Default: `div`.
+        Markdown.stripTopLevelTags (bool): Indicates whether the `doc_tag` should be removed. Default: 'True'.
+        Markdown.references (dictstr, tuplestr, str): A mapping of link references found in a parsed document
+             where the key is the reference name and the value is a tuple of the URL and title.
+        Markdown.htmlStash (util.HtmlStash): The instance of the `HtmlStash` used by an instance of this class.
+        Markdown.output_formats (dictstr, Callablexml.etree.ElementTree.Element): A mapping of known output
+             formats by name and their respective serializers. Each serializer must be a callable which accepts an
+            `Element`xml.etree.ElementTree.Element and returns a `str`.
+        Markdown.output_format (str): The output format set by
+            `set_output_format`markdown.Markdown.set_output_format.
+        Markdown.serializer (Callablexml.etree.ElementTree.Element): The serializer set by
+            `set_output_format`markdown.Markdown.set_output_format.
+        Markdown.preprocessors (util.Registry): A collection of `preprocessors`markdown.preprocessors.
+        Markdown.parser (blockparser.BlockParser): A collection of `blockprocessors`markdown.blockprocessors.
+        Markdown.inlinePatterns (util.Registry): A collection of `inlinepatterns`markdown.inlinepatterns.
+        Markdown.treeprocessors (util.Registry): A collection of `treeprocessors`markdown.treeprocessors.
+        Markdown.postprocessors (util.Registry): A collection of `postprocessors`markdown.postprocessors.
+
+    """
 
     doc_tag = "div"     # Element used to wrap document - later removed
 
-    output_formats = {
+    output_formats: ClassVardictstr, CallableElement, str = {
         'html':   to_html_string,
         'xhtml':  to_xhtml_string,
     }
+    """
+    A mapping of known output formats by name and their respective serializers. Each serializer must be a
+    callable which accepts an `Element`xml.etree.ElementTree.Element and returns a `str`.
+    """
 
     def __init__(self, **kwargs):
         """
         Creates a new Markdown instance.
 
-        Keyword arguments:
+        Keyword Arguments:
+            extensions (listExtension | str): A list of extensions.
 
-        * extensions: A list of extensions.
-            If an item is an instance of a subclass of `markdown.extension.Extension`, the  instance will be used
-            as-is. If an item is of type string, first an entry point will be loaded. If that fails, the string is
-            assumed to use Python dot notation (`path.to.module:ClassName`) to load a markdown.Extension subclass. If
-            no class is specified, then a `makeExtension` function is called within the specified module.
-        * extension_configs: Configuration settings for extensions.
-        * output_format: Format of output. Supported formats are:
-            * "xhtml": Outputs XHTML style tags. Default.
-            * "html": Outputs HTML style tags.
-        * tab_length: Length of tabs in the source. Default: 4
+                If an item is an instance of a subclass of `markdown.extensions.Extension`,
+                the instance will be used as-is. If an item is of type `str`, it is passed
+                to `build_extension`markdown.Markdown.build_extension with its corresponding
+                `extension_configs` and the returned instance  of `markdown.extensions.Extension`
+                is used.
+            extension_configs (dictstr, dictstr, Any): Configuration settings for extensions.
+            output_format (str): Format of output. Supported formats are:
+
+                * `xhtml`: Outputs XHTML style tags. Default.
+                * `html`: Outputs HTML style tags.
+            tab_length (int): Length of tabs in the source. Default: `4`
 
         """
 
-        self.tab_length = kwargs.get('tab_length', 4)
-
-        self.ESCAPED_CHARS = '\\', '`', '*', '_', '{', '}', '', '',
-                              '(', ')', '>', '#', '+', '-', '.', '!'
-
-        self.block_level_elements = 
-            # Elements which are invalid to wrap in a `<p>` tag.
-            # See https://w3c.github.io/html/grouping-content.html#the-p-element
-            'address', 'article', 'aside', 'blockquote', 'details', 'div', 'dl',
-            'fieldset', 'figcaption', 'figure', 'footer', 'form', 'h1', 'h2', 'h3',
-            'h4', 'h5', 'h6', 'header', 'hgroup', 'hr', 'main', 'menu', 'nav', 'ol',
-            'p', 'pre', 'section', 'table', 'ul',
-            # Other elements which Markdown should not be mucking up the contents of.
-            'canvas', 'colgroup', 'dd', 'body', 'dt', 'group', 'iframe', 'li', 'legend',
-            'math', 'map', 'noscript', 'output', 'object', 'option', 'progress', 'script',
-            'style', 'summary', 'tbody', 'td', 'textarea', 'tfoot', 'th', 'thead', 'tr', 'video'
+        self.tab_length: int = kwargs.get('tab_length', 4)
+
+        self.ESCAPED_CHARS: liststr = 
+            '\\', '`', '*', '_', '{', '}', '', '', '(', ')', '>', '#', '+', '-', '.', '!'
         
+        """ List of characters which get the backslash escape treatment. """
 
-        self.registeredExtensions = 
-        self.docType = ""
-        self.stripTopLevelTags = True
+        self.block_level_elements: liststr = BLOCK_LEVEL_ELEMENTS.copy()
+
+        self.registeredExtensions: listExtension = 
+        self.docType = ""  # TODO: Maybe delete this. It does not appear to be used anymore.
+        self.stripTopLevelTags: bool = True
 
         self.build_parser()
 
-        self.references = {}
-        self.htmlStash = util.HtmlStash()
+        self.references: dictstr, tuplestr, str = {}
+        self.htmlStash: util.HtmlStash = util.HtmlStash()
         self.registerExtensions(extensions=kwargs.get('extensions', ),
                                 configs=kwargs.get('extension_configs', {}))
         self.set_output_format(kwargs.get('output_format', 'xhtml'))
         self.reset()
 
-    def build_parser(self):
-        """ Build the parser from the various parts. """
+    def build_parser(self) -> Markdown:
+        """
+        Build the parser from the various parts.
+
+        Assigns a value to each of the following attributes on the class instance:
+
+        * **`Markdown.preprocessors`** (`Registry`markdown.util.Registry) -- A collection of
+          `preprocessors`markdown.preprocessors.
+        * **`Markdown.parser`** (`BlockParser`markdown.blockparser.BlockParser) -- A collection of
+          `blockprocessors`markdown.blockprocessors.
+        * **`Markdown.inlinePatterns`** (`Registry`markdown.util.Registry) -- A collection of
+          `inlinepatterns`markdown.inlinepatterns.
+        * **`Markdown.treeprocessors`** (`Registry`markdown.util.Registry) -- A collection of
+          `treeprocessors`markdown.treeprocessors.
+        * **`Markdown.postprocessors`** (`Registry`markdown.util.Registry) -- A collection of
+          `postprocessors`markdown.postprocessors.
+
+        This method could be redefined in a subclass to build a custom parser which is made up of a different
+        combination of processors and patterns.
+

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/__init__.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/__init__.py Changed

@@ -1,83 +1,142 @@
-"""
-Python Markdown
+# Python Markdown
+
+# A Python implementation of John Gruber's Markdown.
 
-A Python implementation of John Gruber's Markdown.
+# Documentation: https://python-markdown.github.io/
+# GitHub: https://github.com/Python-Markdown/markdown/
+# PyPI: https://pypi.org/project/Markdown/
 
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
+# Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# Copyright 2004 Manfred Stienstra (the original version)
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# License: BSD (see LICENSE.md for details).
 
-License: BSD (see LICENSE.md for details).
 """
+Markdown accepts an `Extension`markdown.extensions.Extension instance for each extension. Therefore, each extension
+must to define a class that extends `Extension`markdown.extensions.Extension and over-rides the
+`extendMarkdown`markdown.extensions.Extension.extendMarkdown method. Within this class one can manage configuration
+options for their extension and attach the various processors and patterns which make up an extension to the
+`Markdown`markdown.Markdown instance.
+"""
+
+from __future__ import annotations
 
+from typing import TYPE_CHECKING, Any, Mapping, Sequence
 from ..util import parseBoolValue
 
+if TYPE_CHECKING:  # pragma: no cover
+    from markdown import Markdown
+
 
 class Extension:
     """ Base class for extensions to subclass. """
 
-    # Default config -- to be overridden by a subclass
-    # Must be of the following format:
-    #     {
-    #       'key': 'value', 'description'
-    #     }
-    # Note that Extension.setConfig will raise a KeyError
-    # if a default is not set here.
-    config = {}
+    config: Mappingstr, list = {}
+    """
+    Default configuration for an extension.
+
+    This attribute is to be defined in a subclass and must be of the following format:
+
+    ``` python
+    config = {
+        'key': 'value', 'description'
+    }
+    ```
+
+    Note that `setConfig`markdown.extensions.Extension.setConfig will raise a `KeyError`
+    if a default is not set for each option.
+    """
 
     def __init__(self, **kwargs):
         """ Initiate Extension and set up configs. """
         self.setConfigs(kwargs)
 
-    def getConfig(self, key, default=''):
-        """ Return a setting for the given key or an empty string. """
+    def getConfig(self, key: str, default: Any = '') -> Any:
+        """
+        Return a single configuration option value.
+
+        Arguments:
+            key: The configuration option name.
+            default: Default value to return if key is not set.
+
+        Returns:
+            Value of stored configuration option.
+        """
         if key in self.config:
             return self.configkey0
         else:
             return default
 
-    def getConfigs(self):
-        """ Return all configs settings as a dict. """
+    def getConfigs(self) -> dictstr, Any:
+        """
+        Return all configuration options.
+
+        Returns:
+            All configuration options.
+        """
         return {key: self.getConfig(key) for key in self.config.keys()}
 
-    def getConfigInfo(self):
-        """ Return all config descriptions as a list of tuples. """
+    def getConfigInfo(self) -> listtuplestr, str:
+        """
+        Return descriptions of all configuration options.
+
+        Returns:
+            All descriptions of configuration options.
+        """
         return (key, self.configkey1) for key in self.config.keys()
 
-    def setConfig(self, key, value):
-        """ Set a config setting for `key` with the given `value`. """
+    def setConfig(self, key: str, value: Any) -> None:
+        """
+        Set a configuration option.
+
+        If the corresponding default value set in `config`markdown.extensions.Extension.config
+        is a `bool` value or `None`, then `value` is passed through
+        `parseBoolValue`markdown.util.parseBoolValue before being stored.
+
+        Arguments:
+            key: Name of configuration option to set.
+            value: Value to assign to option.
+
+        Raises:
+            KeyError: If `key` is not known.
+        """
         if isinstance(self.configkey0, bool):
             value = parseBoolValue(value)
         if self.configkey0 is None:
             value = parseBoolValue(value, preserve_none=True)
         self.configkey0 = value
 
-    def setConfigs(self, items):
-        """ Set multiple config settings given a dict or list of tuples. """
+    def setConfigs(self, items: Mappingstr, Any | Sequencetuplestr, Any):
+        """
+        Loop through a collection of configuration options, passing each to
+        `setConfig`markdown.extensions.Extension.setConfig.
+
+        Arguments:
+            items: Collection of configuration options.
+
+        Raises:
+            KeyError: for any unknown key.
+        """
         if hasattr(items, 'items'):
             # it's a dict
             items = items.items()
         for key, value in items:
             self.setConfig(key, value)
 
-    def extendMarkdown(self, md):
+    def extendMarkdown(self, md: Markdown) -> None:
         """
         Add the various processors and patterns to the Markdown Instance.
 
         This method must be overridden by every extension.
 
-        Keyword arguments:
-
-        * md: The Markdown instance.
+        Arguments:
+            md: The Markdown instance.
 
         """
         raise NotImplementedError(

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/abbr.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/abbr.py Changed

@@ -1,20 +1,26 @@
-'''
-Abbreviation Extension for Python-Markdown
-==========================================
+# Abbreviation Extension for Python-Markdown
+# ==========================================
 
-This extension adds abbreviation handling to Python-Markdown.
+# This extension adds abbreviation handling to Python-Markdown.
+
+# See https://Python-Markdown.github.io/extensions/abbreviations
+# for documentation.
 
-See <https://Python-Markdown.github.io/extensions/abbreviations>
-for documentation.
+# Original code Copyright 2007-2008 Waylan Limberg(http://achinghead.com/)
+# and Seemant Kulleen(http://www.kulleen.org/)
 
-Oringinal code Copyright 2007-2008 Waylan Limberg(http://achinghead.com/) and
- Seemant Kulleen(http://www.kulleen.org/)
+# All changes Copyright 2008-2014 The Python Markdown Project
 
-All changes Copyright 2008-2014 The Python Markdown Project
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
+
+"""
+This extension adds abbreviation handling to Python-Markdown.
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+See the documentation(https://Python-Markdown.github.io/extensions/abbreviations)
+for details.
+"""
 
-'''
+from __future__ import annotations
 
 from . import Extension
 from ..blockprocessors import BlockProcessor
@@ -28,7 +34,7 @@
     """ Abbreviation Extension for Python-Markdown. """
 
     def extendMarkdown(self, md):
-        """ Insert AbbrPreprocessor before ReferencePreprocessor. """
+        """ Insert `AbbrPreprocessor` before `ReferencePreprocessor`. """
         md.parser.blockprocessors.register(AbbrPreprocessor(md.parser), 'abbr', 16)
 
 
@@ -41,11 +47,11 @@
         return True
 
     def run(self, parent, blocks):
-        '''
+        """
         Find and remove all Abbreviation references from the text.
-        Each reference is set as a new AbbrPattern in the markdown instance.
+        Each reference is set as a new `AbbrPattern` in the markdown instance.
 
-        '''
+        """
         block = blocks.pop(0)
         m = self.RE.search(block)
         if m:
@@ -66,7 +72,7 @@
         return False
 
     def _generate_pattern(self, text):
-        '''
+        """
         Given a string, returns an regex pattern to match that string.
 
         'HTML' -> r'(?P<abbr>HTML)'
@@ -74,7 +80,7 @@
         Note: we force each char as a literal match (in brackets) as we don't
         know what they will be beforehand.
 
-        '''
+        """
         chars = list(text)
         for i in range(len(chars)):
             charsi = r'%s' % charsi

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/admonition.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/admonition.py Changed

@@ -1,22 +1,31 @@
-"""
-Admonition extension for Python-Markdown
-========================================
+# Admonition extension for Python-Markdown
+# ========================================
 
-Adds rST-style admonitions. Inspired by rST feature with the same name.
+# Adds rST-style admonitions. Inspired by rST feature with the same name.
+
+# rST: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions
+
+# See https://Python-Markdown.github.io/extensions/admonition
+# for documentation.
 
-rST: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions  # noqa
+# Original code Copyright Tiago Serafim(https://www.tiagoserafim.com/).
 
-See <https://Python-Markdown.github.io/extensions/admonition>
-for documentation.
+# All changes Copyright The Python Markdown Project
 
-Original code Copyright Tiago Serafim(https://www.tiagoserafim.com/).
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
-All changes Copyright The Python Markdown Project
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+"""
+Adds rST-style admonitions. Inspired by rST feature with the same name.
 
+rST: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions
+
+See the documentation(https://Python-Markdown.github.io/extensions/admonition)
+for details.
 """
 
+from __future__ import annotations
+
 from . import Extension
 from ..blockprocessors import BlockProcessor
 import xml.etree.ElementTree as etree
@@ -69,23 +78,23 @@
 
         sibling = self.lastChild(parent)
 
-        if sibling is None or sibling.get('class', '').find(self.CLASSNAME) == -1:
+        if sibling is None or sibling.tag != 'div' or sibling.get('class', '').find(self.CLASSNAME) == -1:
             sibling = None
         else:
             # If the last child is a list and the content is sufficiently indented
             # to be under it, then the content's sibling is in the list.
             last_child = self.lastChild(sibling)
             indent = 0
-            while last_child:
+            while last_child is not None:
                 if (
-                    sibling and block.startswith(' ' * self.tab_length * 2) and
-                    last_child and last_child.tag in ('ul', 'ol', 'dl')
+                    sibling is not None and block.startswith(' ' * self.tab_length * 2) and
+                    last_child is not None and last_child.tag in ('ul', 'ol', 'dl')
                 ):
 
-                    # The expectation is that we'll find an <li> or <dt>.
+                    # The expectation is that we'll find an `<li>` or `<dt>`.
                     # We should get its last child as well.
                     sibling = self.lastChild(last_child)
-                    last_child = self.lastChild(sibling) if sibling else None
+                    last_child = self.lastChild(sibling) if sibling is not None else None
 
                     # Context has been lost at this point, so we must adjust the
                     # text's indentation level so it will be evaluated correctly
@@ -155,7 +164,7 @@
         klass, title = match.group(1).lower(), match.group(2)
         klass = self.RE_SPACES.sub(' ', klass)
         if title is None:
-            # no title was provided, use the capitalized classname as title
+            # no title was provided, use the capitalized class name as title
             # e.g.: `!!! note` will render
             # `<p class="admonition-title">Note</p>`
             title = klass.split(' ', 1)0.capitalize()

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/attr_list.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/attr_list.py Changed

@@ -1,26 +1,38 @@
-"""
-Attribute List Extension for Python-Markdown
-============================================
+# Attribute List Extension for Python-Markdown
+# ============================================
 
-Adds attribute list syntax. Inspired by
-maruku(http://maruku.rubyforge.org/proposal.html#attribute_lists)'s
-feature of the same name.
+# Adds attribute list syntax. Inspired by
+# Maruku(http://maruku.rubyforge.org/proposal.html#attribute_lists)'s
+# feature of the same name.
 
-See <https://Python-Markdown.github.io/extensions/attr_list>
-for documentation.
+# See https://Python-Markdown.github.io/extensions/attr_list
+# for documentation.
 
-Original code Copyright 2011 Waylan Limberg(http://achinghead.com/).
+# Original code Copyright 2011 Waylan Limberg(http://achinghead.com/).
 
-All changes Copyright 2011-2014 The Python Markdown Project
+# All changes Copyright 2011-2014 The Python Markdown Project
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
 """
+ Adds attribute list syntax. Inspired by
+Maruku(http://maruku.rubyforge.org/proposal.html#attribute_lists)'s
+feature of the same name.
+
+See the documentation(https://Python-Markdown.github.io/extensions/attr_list)
+for details.
+"""
+
+from __future__ import annotations
+from typing import TYPE_CHECKING
 
 from . import Extension
 from ..treeprocessors import Treeprocessor
 import re
 
+if TYPE_CHECKING:  # pragma: no cover
+    from xml.etree.ElementTree import Element
+
 
 def _handle_double_quote(s, t):
     k, v = t.split('=', 1)
@@ -53,12 +65,12 @@
 )
 
 
-def get_attrs(str):
+def get_attrs(str: str) -> listtuplestr, str:
     """ Parse attribute list and return a list of attribute tuples. """
     return _scanner.scan(str)0
 
 
-def isheader(elem):
+def isheader(elem: Element) -> bool:
     return elem.tag in 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'
 
 
@@ -74,36 +86,36 @@
                          r'\uf900-\ufdcf\ufdf0-\ufffd'
                          r'\:\-\.0-9\u00b7\u0300-\u036f\u203f-\u2040+')
 
-    def run(self, doc):
+    def run(self, doc: Element):
         for elem in doc.iter():
             if self.md.is_block_level(elem.tag):
-                # Block level: check for attrs on last line of text
+                # Block level: check for `attrs` on last line of text
                 RE = self.BLOCK_RE
                 if isheader(elem) or elem.tag in 'dt', 'td', 'th':
-                    # header, def-term, or table cell: check for attrs at end of element
+                    # header, def-term, or table cell: check for attributes at end of element
                     RE = self.HEADER_RE
                 if len(elem) and elem.tag == 'li':
-                    # special case list items. children may include a ul or ol.
+                    # special case list items. children may include a `ul` or `ol`.
                     pos = None
-                    # find the ul or ol position
+                    # find the `ul` or `ol` position
                     for i, child in enumerate(elem):
                         if child.tag in 'ul', 'ol':
                             pos = i
                             break
                     if pos is None and elem-1.tail:
-                        # use tail of last child. no ul or ol.
+                        # use tail of last child. no `ul` or `ol`.
                         m = RE.search(elem-1.tail)
                         if m:
                             self.assign_attrs(elem, m.group(1))
                             elem-1.tail = elem-1.tail:m.start()
                     elif pos is not None and pos > 0 and elempos-1.tail:
-                        # use tail of last child before ul or ol
+                        # use tail of last child before `ul` or `ol`
                         m = RE.search(elempos-1.tail)
                         if m:
                             self.assign_attrs(elem, m.group(1))
                             elempos-1.tail = elempos-1.tail:m.start()
                     elif elem.text:
-                        # use text. ul is first child.
+                        # use text. `ul` is first child.
                         m = RE.search(elem.text)
                         if m:
                             self.assign_attrs(elem, m.group(1))
@@ -127,15 +139,15 @@
                             # clean up trailing #s
                             elem.text = elem.text.rstrip('#').rstrip()
             else:
-                # inline: check for attrs at start of tail
+                # inline: check for `attrs` at start of tail
                 if elem.tail:
                     m = self.INLINE_RE.match(elem.tail)
                     if m:
                         self.assign_attrs(elem, m.group(1))
                         elem.tail = elem.tailm.end():
 
-    def assign_attrs(self, elem, attrs):
-        """ Assign attrs to element. """
+    def assign_attrs(self, elem: Element, attrs: str) -> None:
+        """ Assign `attrs` to element. """
         for k, v in get_attrs(attrs):
             if k == '.':
                 # add to class
@@ -145,10 +157,10 @@
                 else:
                     elem.set('class', v)
             else:
-                # assign attr k with v
+                # assign attribute `k` with `v`
                 elem.set(self.sanitize_name(k), v)
 
-    def sanitize_name(self, name):
+    def sanitize_name(self, name: str) -> str:
         """
         Sanitize name as 'an XML Name, minus the ":"'.
         See https://www.w3.org/TR/REC-xml-names/#NT-NCName
@@ -157,6 +169,7 @@
 
 
 class AttrListExtension(Extension):
+    """ Attribute List extension for Python-Markdown """
     def extendMarkdown(self, md):
         md.treeprocessors.register(AttrListTreeprocessor(md), 'attr_list', 8)
         md.registerExtension(self)

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/codehilite.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/codehilite.py Changed

@@ -1,20 +1,26 @@
-"""
-CodeHilite Extension for Python-Markdown
-========================================
+# CodeHilite Extension for Python-Markdown
+# ========================================
 
-Adds code/syntax highlighting to standard Python-Markdown code blocks.
+# Adds code/syntax highlighting to standard Python-Markdown code blocks.
+
+# See https://Python-Markdown.github.io/extensions/code_hilite
+# for documentation.
 
-See <https://Python-Markdown.github.io/extensions/code_hilite>
-for documentation.
+# Original code Copyright 2006-2008 Waylan Limberg(http://achinghead.com/).
 
-Original code Copyright 2006-2008 Waylan Limberg(http://achinghead.com/).
+# All changes Copyright 2008-2014 The Python Markdown Project
 
-All changes Copyright 2008-2014 The Python Markdown Project
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+"""
+Adds code/syntax highlighting to standard Python-Markdown code blocks.
 
+See the documentation(https://Python-Markdown.github.io/extensions/code_hilite)
+for details.
 """
 
+from __future__ import annotations
+
 from . import Extension
 from ..treeprocessors import Treeprocessor
 from ..util import parseBoolValue
@@ -29,11 +35,11 @@
     pygments = False
 
 
-def parse_hl_lines(expr):
+def parse_hl_lines(expr: str) -> listint:
     """Support our syntax for emphasizing certain lines of code.
 
-    expr should be like '1 2' to emphasize lines 1 and 2 of a code block.
-    Returns a list of ints, the line numbers to emphasize.
+    `expr` should be like '1 2' to emphasize lines 1 and 2 of a code block.
+    Returns a list of integers, the line numbers to emphasize.
     """
     if not expr:
         return 
@@ -50,57 +56,59 @@
     Determine language of source code, and pass it on to the Pygments highlighter.
 
     Usage:
-        code = CodeHilite(src=some_code, lang='python')
-        html = code.hilite()
-
-    Arguments:
-    * src: Source string or any object with a .readline attribute.
-
-    * lang: String name of Pygments lexer to use for highlighting. Default: `None`.
-
-    * guess_lang: Auto-detect which lexer to use. Ignored if `lang` is set to a valid
-      value. Default: `True`.
-
-    * use_pygments: Pass code to pygments for code highlighting. If `False`, the code is
-      instead wrapped for highlighting by a JavaScript library. Default: `True`.
-
-    * pygments_formatter: The name of a Pygments formatter or a formatter class used for
-      highlighting the code blocks. Default: `html`.
 
-    * linenums: An alias to Pygments `linenos` formatter option. Default: `None`.
+    ```python
+    code = CodeHilite(src=some_code, lang='python')
+    html = code.hilite()
+    ```
 
-    * css_class: An alias to Pygments `cssclass` formatter option. Default: 'codehilite'.
-
-    * lang_prefix: Prefix prepended to the language. Default: "language-".
+    Arguments:
+        src: Source string or any object with a `.readline` attribute.
+
+    Keyword arguments:
+        lang (str): String name of Pygments lexer to use for highlighting. Default: `None`.
+        guess_lang (bool): Auto-detect which lexer to use.
+            Ignored if `lang` is set to a valid value. Default: `True`.
+        use_pygments (bool): Pass code to Pygments for code highlighting. If `False`, the code is
+            instead wrapped for highlighting by a JavaScript library. Default: `True`.
+        pygments_formatter (str): The name of a Pygments formatter or a formatter class used for
+            highlighting the code blocks. Default: `html`.
+        linenums (bool): An alias to Pygments `linenos` formatter option. Default: `None`.
+        css_class (str): An alias to Pygments `cssclass` formatter option. Default: 'codehilite'.
+        lang_prefix (str): Prefix prepended to the language. Default: "language-".
 
     Other Options:
+
     Any other options are accepted and passed on to the lexer and formatter. Therefore,
     valid options include any options which are accepted by the `html` formatter or
     whichever lexer the code's language uses. Note that most lexers do not have any
     options. However, a few have very useful options, such as PHP's `startinline` option.
     Any invalid options are ignored without error.
 
-    Formatter options: https://pygments.org/docs/formatters/#HtmlFormatter
-    Lexer Options: https://pygments.org/docs/lexers/
+    * **Formatter options**: <https://pygments.org/docs/formatters/#HtmlFormatter>
+    * **Lexer Options**: <https://pygments.org/docs/lexers/>
 
     Additionally, when Pygments is enabled, the code's language is passed to the
     formatter as an extra option `lang_str`, whose value being `{lang_prefix}{lang}`.
-    This option has no effect to the Pygments's builtin formatters.
+    This option has no effect to the Pygments' builtin formatters.
 
     Advanced Usage:
-        code = CodeHilite(
-            src = some_code,
-            lang = 'php',
-            startinline = True,      # Lexer option. Snippet does not start with `<?php`.
-            linenostart = 42,        # Formatter option. Snippet starts on line 42.
-            hl_lines = 45, 49, 50, # Formatter option. Highlight lines 45, 49, and 50.
-            linenos = 'inline'       # Formatter option. Avoid alignment problems.
-        )
-        html = code.hilite()
+
+    ```python
+    code = CodeHilite(
+        src = some_code,
+        lang = 'php',
+        startinline = True,      # Lexer option. Snippet does not start with `<?php`.
+        linenostart = 42,        # Formatter option. Snippet starts on line 42.
+        hl_lines = 45, 49, 50, # Formatter option. Highlight lines 45, 49, and 50.
+        linenos = 'inline'       # Formatter option. Avoid alignment problems.
+    )
+    html = code.hilite()
+    ```
 
     """
 
-    def __init__(self, src, **options):
+    def __init__(self, src: str, **options):
         self.src = src
         self.lang = options.pop('lang', None)
         self.guess_lang = options.pop('guess_lang', True)
@@ -113,19 +121,19 @@
         if 'cssclass' not in options:
             options'cssclass' = options.pop('css_class', 'codehilite')
         if 'wrapcode' not in options:
-            # Override pygments default
+            # Override Pygments default
             options'wrapcode' = True
         # Disallow use of `full` option
         options'full' = False
 
         self.options = options
 
-    def hilite(self, shebang=True):
+    def hilite(self, shebang=True) -> str:
         """
-        Pass code to the Pygments(http://pygments.pocoo.org/) highliter with
-        optional line numbers. The output should then be styled with css to
+        Pass code to the Pygments(https://pygments.org/) highlighter with
+        optional line numbers. The output should then be styled with CSS to
         your liking. No styles are applied by default - only styling hooks
-        (i.e.: <span class="k">).
+        (i.e.: `<span class="k">`).
 
         returns : A string of html.
 
@@ -160,7 +168,7 @@
                 formatter = self.pygments_formatter(lang_str=lang_str, **self.options)
             return highlight(self.src, lexer, formatter)
         else:
-            # just escape and build markup usable by JS highlighting libs
+            # just escape and build markup usable by JavaScript highlighting libraries
             txt = self.src.replace('&', '&amp;')
             txt = txt.replace('<', '&lt;')
             txt = txt.replace('>', '&gt;')
@@ -182,14 +190,14 @@
     def _parseHeader(self):
         """
         Determines language of a code block from shebang line and whether the
-        said line should be removed or left in place. If the sheband line
+        said line should be removed or left in place. If the shebang line
         contains a path (even a single /) then it is assumed to be a real
         shebang line and left alone. However, if no path is given
-        (e.i.: #!python or :::python) then it is assumed to be a mock shebang
+        (e.i.: `#!python` or `:::python`) then it is assumed to be a mock shebang
         for language identification of a code fragment and removed from the
         code block prior to processing for code highlighting. When a mock
-        shebang (e.i: #!python) is found, line numbering is turned on. When
-        colons are found in place of a shebang (e.i.: :::python), line
+        shebang (e.i: `#!python`) is found, line numbering is turned on. When
+        colons are found in place of a shebang (e.i.: `:::python`), line
         numbering is left in the current state - off by default.
 
         Also parses optional list of highlight lines, like:
@@ -251,7 +259,7 @@
         return text

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/def_list.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/def_list.py Changed

@@ -1,20 +1,26 @@
-"""
-Definition List Extension for Python-Markdown
-=============================================
+# Definition List Extension for Python-Markdown
+# =============================================
 
-Adds parsing of Definition Lists to Python-Markdown.
+# Adds parsing of Definition Lists to Python-Markdown.
+
+# See https://Python-Markdown.github.io/extensions/definition_lists
+# for documentation.
 
-See <https://Python-Markdown.github.io/extensions/definition_lists>
-for documentation.
+# Original code Copyright 2008 Waylan Limberg(http://achinghead.com)
 
-Original code Copyright 2008 Waylan Limberg(http://achinghead.com)
+# All changes Copyright 2008-2014 The Python Markdown Project
 
-All changes Copyright 2008-2014 The Python Markdown Project
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+"""
+Adds parsing of Definition Lists to Python-Markdown.
 
+See the documentation(https://Python-Markdown.github.io/extensions/definition_lists)
+for details.
 """
 
+from __future__ import annotations
+
 from . import Extension
 from ..blockprocessors import BlockProcessor, ListIndentProcessor
 import xml.etree.ElementTree as etree
@@ -89,10 +95,12 @@
 
     # Definition lists need to be aware of all list types
     ITEM_TYPES = 'dd', 'li'
+    """ Include `dd` in list item types. """
     LIST_TYPES = 'dl', 'ol', 'ul'
+    """ Include `dl` is list types. """
 
     def create_item(self, parent, block):
-        """ Create a new dd or li (depending on parent) and parse the block with it as the parent. """
+        """ Create a new `dd` or `li` (depending on parent) and parse the block with it as the parent. """
 
         dd = etree.SubElement(parent, 'dd')
         self.parser.parseBlocks(dd, block)
@@ -102,7 +110,7 @@
     """ Add definition lists to Markdown. """
 
     def extendMarkdown(self, md):
-        """ Add an instance of DefListProcessor to BlockParser. """
+        """ Add an instance of `DefListProcessor` to `BlockParser`. """
         md.parser.blockprocessors.register(DefListIndentProcessor(md.parser), 'defindent', 85)
         md.parser.blockprocessors.register(DefListProcessor(md.parser), 'deflist', 25)

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/extra.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/extra.py Changed

@@ -1,12 +1,22 @@
-"""
-Python-Markdown Extra Extension
-===============================
+# Python-Markdown Extra Extension
+# ===============================
+
+# A compilation of various Python-Markdown extensions that imitates
+# PHP Markdown Extra(http://michelf.com/projects/php-markdown/extra/).
+
+# See https://Python-Markdown.github.io/extensions/extra
+# for documentation.
+
+# Copyright The Python Markdown Project
+
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
+"""
 A compilation of various Python-Markdown extensions that imitates
 PHP Markdown Extra(http://michelf.com/projects/php-markdown/extra/).
 
 Note that each of the individual extensions still need to be available
-on your PYTHONPATH. This extension simply wraps them all up as a
+on your `PYTHONPATH`. This extension simply wraps them all up as a
 convenience so that only one extension needs to be listed when
 initiating Markdown. See the documentation for each individual
 extension for specifics about that extension.
@@ -20,15 +30,12 @@
 variable defined below, but be aware that such changes may be lost
 when you upgrade to any future version of Python-Markdown.
 
-See <https://Python-Markdown.github.io/extensions/extra>
-for documentation.
-
-Copyright The Python Markdown Project
-
-License: BSD(https://opensource.org/licenses/bsd-license.php)
-
+See the documentation(https://Python-Markdown.github.io/extensions/extra)
+for details.
 """
 
+from __future__ import annotations
+
 from . import Extension
 
 extensions = 
@@ -40,13 +47,14 @@
     'abbr',
     'md_in_html'
 
+""" The list of included extensions. """
 
 
 class ExtraExtension(Extension):
     """ Add various extensions to Markdown class."""
 
     def __init__(self, **kwargs):
-        """ config is a dumb holder which gets passed to actual ext later. """
+        """ `config` is a dumb holder which gets passed to the actual extension later. """
         self.config = kwargs
 
     def extendMarkdown(self, md):

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/fenced_code.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/fenced_code.py Changed

@@ -1,20 +1,25 @@
-"""
-Fenced Code Extension for Python Markdown
-=========================================
+# Fenced Code Extension for Python Markdown
+# =========================================
 
-This extension adds Fenced Code Blocks to Python-Markdown.
+# This extension adds Fenced Code Blocks to Python-Markdown.
+
+# See https://Python-Markdown.github.io/extensions/fenced_code_blocks
+# for documentation.
 
-See <https://Python-Markdown.github.io/extensions/fenced_code_blocks>
-for documentation.
+# Original code Copyright 2007-2008 Waylan Limberg(http://achinghead.com/).
 
-Original code Copyright 2007-2008 Waylan Limberg(http://achinghead.com/).
+# All changes Copyright 2008-2014 The Python Markdown Project
 
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
-All changes Copyright 2008-2014 The Python Markdown Project
+"""
+This extension adds Fenced Code Blocks to Python-Markdown.
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+See the documentation(https://Python-Markdown.github.io/extensions/fenced_code_blocks)
+for details.
 """
 
+from __future__ import annotations
 
 from textwrap import dedent
 from . import Extension
@@ -31,16 +36,19 @@
         self.config = {
             'lang_prefix': 'language-', 'Prefix prepended to the language. Default: "language-"'
         }
+        """ Default configuration options. """
         super().__init__(**kwargs)
 
     def extendMarkdown(self, md):
-        """ Add FencedBlockPreprocessor to the Markdown instance. """
+        """ Add `FencedBlockPreprocessor` to the Markdown instance. """
         md.registerExtension(self)
 
         md.preprocessors.register(FencedBlockPreprocessor(md, self.getConfigs()), 'fenced_code_block', 25)
 
 
 class FencedBlockPreprocessor(Preprocessor):
+    """ Find and extract fenced code blocks. """
+
     FENCED_BLOCK_RE = re.compile(
         dedent(r'''
             (?P<fence>^(?:~{3,}|`{3,})) *                          # opening fence
@@ -60,7 +68,7 @@
         self.checked_for_deps = False
         self.codehilite_conf = {}
         self.use_attr_list = False
-        # List of options to convert to bool values
+        # List of options to convert to boolean values
         self.bool_options = 
             'linenums',
             'guess_lang',
@@ -69,7 +77,7 @@
         
 
     def run(self, lines):
-        """ Match and store Fenced Code Blocks in the HtmlStash. """
+        """ Match and store Fenced Code Blocks in the `HtmlStash`. """
 
         # Check for dependent extensions
         if not self.checked_for_deps:
@@ -94,16 +102,16 @@
                     if m.group('lang'):
                         lang = m.group('lang')
                     if m.group('hl_lines'):
-                        # Support hl_lines outside of attrs for backward-compatibility
+                        # Support `hl_lines` outside of `attrs` for backward-compatibility
                         config'hl_lines' = parse_hl_lines(m.group('hl_lines'))
 
-                # If config is not empty, then the codehighlite extension
+                # If `config` is not empty, then the `codehighlite` extension
                 # is enabled, so we call it to highlight the code
                 if self.codehilite_conf and self.codehilite_conf'use_pygments' and config.get('use_pygments', True):
                     local_config = self.codehilite_conf.copy()
                     local_config.update(config)
-                    # Combine classes with cssclass. Ensure cssclass is at end
-                    # as pygments appends a suffix under certain circumstances.
+                    # Combine classes with `cssclass`. Ensure `cssclass` is at end
+                    # as Pygments appends a suffix under certain circumstances.
                     # Ignore ID as Pygments does not offer an option to set it.
                     if classes:
                         local_config'css_class' = '{} {}'.format(
@@ -128,9 +136,9 @@
                     if id:
                         id_attr = f' id="{_escape_attrib_html(id)}"'
                     if self.use_attr_list and config and not config.get('use_pygments', False):
-                        # Only assign key/value pairs to code element if attr_list ext is enabled, key/value pairs
-                        # were defined on the code block, and the `use_pygments` key was not set to True. The
-                        # `use_pygments` key could be either set to False or not defined. It is omitted from output.
+                        # Only assign key/value pairs to code element if `attr_list` extension is enabled, key/value
+                        # pairs were defined on the code block, and the `use_pygments` key was not set to `True`. The
+                        # `use_pygments` key could be either set to `False` or not defined. It is omitted from output.
                         kv_pairs = ''.join(
                             f' {k}="{_escape_attrib_html(v)}"' for k, v in config.items() if k != 'use_pygments'
                         )
@@ -144,7 +152,7 @@
         return text.split("\n")
 
     def handle_attrs(self, attrs):
-        """ Return tuple: (id, list, of, classes, {configs}) """
+        """ Return tuple: `(id, list, of, classes, {configs})` """
         id = ''
         classes = 
         configs = {}

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/footnotes.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/footnotes.py Changed

@@ -1,18 +1,24 @@
-"""
-Footnotes Extension for Python-Markdown
-=======================================
+# Footnotes Extension for Python-Markdown
+# =======================================
 
-Adds footnote handling to Python-Markdown.
+# Adds footnote handling to Python-Markdown.
+
+# See https://Python-Markdown.github.io/extensions/footnotes
+# for documentation.
 
-See <https://Python-Markdown.github.io/extensions/footnotes>
-for documentation.
+# Copyright The Python Markdown Project
 
-Copyright The Python Markdown Project
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+"""
+Adds footnote handling to Python-Markdown.
 
+See the documentation(https://Python-Markdown.github.io/extensions/footnotes)
+for details.
 """
 
+from __future__ import annotations
+
 from . import Extension
 from ..blockprocessors import BlockProcessor
 from ..inlinepatterns import InlineProcessor
@@ -36,30 +42,28 @@
         """ Setup configs. """
 
         self.config = {
-            'PLACE_MARKER':
-                "///Footnotes Go Here///",
-                 "The text string that marks where the footnotes go",
-            'UNIQUE_IDS':
-                False,
-                 "Avoid name collisions across "
-                 "multiple calls to reset().",
-            "BACKLINK_TEXT":
-                "&#8617;",
-                 "The text string that links from the footnote "
-                 "to the reader's place.",
-            "SUPERSCRIPT_TEXT":
-                "{}",
-                 "The text string that links from the reader's place "
-                 "to the footnote.",
-            "BACKLINK_TITLE":
-                "Jump back to footnote %d in the text",
-                 "The text string used for the title HTML attribute "
-                 "of the backlink. %d will be replaced by the "
-                 "footnote number.",
-            "SEPARATOR":
-                ":",
-                 "Footnote separator."
+            'PLACE_MARKER': 
+                '///Footnotes Go Here///', 'The text string that marks where the footnotes go'
+            ,
+            'UNIQUE_IDS': 
+                False, 'Avoid name collisions across multiple calls to `reset()`.'
+            ,
+            'BACKLINK_TEXT': 
+                '&#8617;', "The text string that links from the footnote to the reader's place."
+            ,
+            'SUPERSCRIPT_TEXT': 
+                '{}', "The text string that links from the reader's place to the footnote."
+            ,
+            'BACKLINK_TITLE': 
+                'Jump back to footnote %d in the text',
+                'The text string used for the title HTML attribute of the backlink. '
+                '%d will be replaced by the footnote number.'
+            ,
+            'SEPARATOR': 
+                ':', 'Footnote separator.'
+            
         }
+        """ Default configuration options. """
         super().__init__(**kwargs)
 
         # In multiple invocations, emit links that don't get tangled.
@@ -74,34 +78,34 @@
         md.registerExtension(self)
         self.parser = md.parser
         self.md = md
-        # Insert a blockprocessor before ReferencePreprocessor
+        # Insert a `blockprocessor` before `ReferencePreprocessor`
         md.parser.blockprocessors.register(FootnoteBlockProcessor(self), 'footnote', 17)
 
-        # Insert an inline pattern before ImageReferencePattern
+        # Insert an inline pattern before `ImageReferencePattern`
         FOOTNOTE_RE = r'\\^(^\*)\'  # blah blah ^1 blah
         md.inlinePatterns.register(FootnoteInlineProcessor(FOOTNOTE_RE, self), 'footnote', 175)
         # Insert a tree-processor that would actually add the footnote div
-        # This must be before all other treeprocessors (i.e., inline and
-        # codehilite) so they can run on the the contents of the div.
+        # This must be before all other tree-processors (i.e., `inline` and
+        # `codehilite`) so they can run on the the contents of the div.
         md.treeprocessors.register(FootnoteTreeprocessor(self), 'footnote', 50)
 
         # Insert a tree-processor that will run after inline is done.
         # In this tree-processor we want to check our duplicate footnote tracker
-        # And add additional backrefs to the footnote pointing back to the
+        # And add additional `backrefs` to the footnote pointing back to the
         # duplicated references.
         md.treeprocessors.register(FootnotePostTreeprocessor(self), 'footnote-duplicate', 15)
 
         # Insert a postprocessor after amp_substitute processor
         md.postprocessors.register(FootnotePostprocessor(self), 'footnote', 25)
 
-    def reset(self):
+    def reset(self) -> None:
         """ Clear footnotes on reset, and prepare for distinct document. """
-        self.footnotes = OrderedDict()
+        self.footnotes: OrderedDictstr, str = OrderedDict()
         self.unique_prefix += 1
         self.found_refs = {}
         self.used_refs = set()
 
-    def unique_ref(self, reference, found=False):
+    def unique_ref(self, reference, found: bool = False):
         """ Get a unique reference if there are duplicates. """
         if not found:
             return reference
@@ -140,7 +144,7 @@
         res = finder(root)
         return res
 
-    def setFootnote(self, id, text):
+    def setFootnote(self, id, text) -> None:
         """ Store a footnote for later retrieval. """
         self.footnotesid = text
 
@@ -155,7 +159,7 @@
         else:
             return 'fn{}{}'.format(self.get_separator(), id)
 
-    def makeFootnoteRefId(self, id, found=False):
+    def makeFootnoteRefId(self, id, found: bool = False):
         """ Return footnote back-link id. """
         if self.getConfig("UNIQUE_IDS"):
             return self.unique_ref('fnref%s%d-%s' % (self.get_separator(), self.unique_prefix, id), found)
@@ -163,7 +167,7 @@
             return self.unique_ref('fnref{}{}'.format(self.get_separator(), id), found)
 
     def makeFootnotesDiv(self, root):
-        """ Return div of footnotes as et Element. """
+        """ Return `div` of footnotes as `etree` Element. """
 
         if not list(self.footnotes.keys()):
             return None
@@ -180,9 +184,9 @@
         for index, id in enumerate(self.footnotes.keys(), start=1):
             li = etree.SubElement(ol, "li")
             li.set("id", self.makeFootnoteId(id))
-            # Parse footnote with surrogate parent as li cannot be used.
-            # List block handlers have special logic to deal with li.
-            # When we are done parsing, we will copy everything over to li.
+            # Parse footnote with surrogate parent as `li` cannot be used.
+            # List block handlers have special logic to deal with `li`.
+            # When we are done parsing, we will copy everything over to `li`.
             self.parser.parseChunk(surrogate_parent, self.footnotesid)
             for el in list(surrogate_parent):
                 li.append(el)
@@ -255,10 +259,11 @@
         blocks.insert(0, block)
         return False
 
-    def detectTabbed(self, blocks):
-        """ Find indented text and remove indent before further proccesing.
+    def detectTabbed(self, blocks) -> liststr:
+        """ Find indented text and remove indent before further processing.
 
-        Returns: a list of blocks with indentation removed.
+        Returns:
+            A list of blocks with indentation removed.
         """
         fn_blocks = 
         while blocks:
@@ -296,7 +301,7 @@
 
 
 class FootnoteInlineProcessor(InlineProcessor):
-    """ InlinePattern for footnote markers in a document's body text. """
+    """ `InlineProcessor` for footnote markers in a document's body text. """
 
     def __init__(self, pattern, footnotes):
         super().__init__(pattern)
@@ -324,8 +329,8 @@
     def __init__(self, footnotes):
         self.footnotes = footnotes
 
-    def add_duplicates(self, li, duplicates):
-        """ Adjust current li and add the duplicates: fnref2, fnref3, etc. """
+    def add_duplicates(self, li, duplicates) -> None:
+        """ Adjust current `li` and add the duplicates: `fnref2`, `fnref3`, etc. """

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/legacy_attrs.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/legacy_attrs.py Changed

@@ -1,36 +1,35 @@
-"""
-Python Markdown
-
-A Python implementation of John Gruber's Markdown.
+# Python Markdown
 
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
+# A Python implementation of John Gruber's Markdown.
 
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
+# Documentation: https://python-markdown.github.io/
+# GitHub: https://github.com/Python-Markdown/markdown/
+# PyPI: https://pypi.org/project/Markdown/
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-License: BSD (see LICENSE.md for details).
+# Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# Copyright 2004 Manfred Stienstra (the original version)
 
-Legacy Attributes Extension
-===========================
+# License: BSD (see LICENSE.md for details).
 
+"""
 An extension to Python Markdown which implements legacy attributes.
 
 Prior to Python-Markdown version 3.0, the Markdown class had an `enable_attributes`
 keyword which was on by default and provided for attributes to be defined for elements
 using the format `{@key=value}`. This extension is provided as a replacement for
-backward compatibility. New documents should be authored using attr_lists. However,
-numerious documents exist which have been using the old attribute format for many
+backward compatibility. New documents should be authored using `attr_lists`. However,
+numerous documents exist which have been using the old attribute format for many
 years. This extension can be used to continue to render those documents correctly.
 """
 
+from __future__ import annotations
+
 import re
 from markdown.treeprocessors import Treeprocessor, isString
 from markdown.extensions import Extension
@@ -60,6 +59,7 @@
 
 class LegacyAttrExtension(Extension):
     def extendMarkdown(self, md):
+        """ Add `LegacyAttrs` to Markdown instance. """
         md.treeprocessors.register(LegacyAttrs(md), 'legacyattrs', 15)

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/legacy_em.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/legacy_em.py Changed

@@ -1,14 +1,17 @@
-'''
-Legacy Em Extension for Python-Markdown
-=======================================
+# Legacy Em Extension for Python-Markdown
+# =======================================
 
-This extension provides legacy behavior for _connected_words_.
+# This extension provides legacy behavior for _connected_words_.
+
+# Copyright 2015-2018 The Python Markdown Project
 
-Copyright 2015-2018 The Python Markdown Project
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+"""
+This extension provides legacy behavior for _connected_words_.
+"""
 
-'''
+from __future__ import annotations
 
 from . import Extension
 from ..inlinepatterns import UnderscoreProcessor, EmStrongItem, EM_STRONG2_RE, STRONG_EM2_RE
@@ -45,5 +48,5 @@
 
 
 def makeExtension(**kwargs):  # pragma: no cover
-    """ Return an instance of the LegacyEmExtension """
+    """ Return an instance of the `LegacyEmExtension` """
     return LegacyEmExtension(**kwargs)

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/md_in_html.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/md_in_html.py Changed

@@ -1,19 +1,26 @@
-"""
-Python-Markdown Markdown in HTML Extension
-===============================
+# Python-Markdown Markdown in HTML Extension
+# ===============================
 
-An implementation of PHP Markdown Extra(http://michelf.com/projects/php-markdown/extra/)'s
-parsing of Markdown syntax in raw HTML.
+# An implementation of PHP Markdown Extra(http://michelf.com/projects/php-markdown/extra/)'s
+# parsing of Markdown syntax in raw HTML.
+
+# See https://Python-Markdown.github.io/extensions/raw_html
+# for documentation.
 
-See <https://Python-Markdown.github.io/extensions/raw_html>
-for documentation.
+# Copyright The Python Markdown Project
 
-Copyright The Python Markdown Project
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+"""
+An implementation of PHP Markdown Extra(http://michelf.com/projects/php-markdown/extra/)'s
+parsing of Markdown syntax in raw HTML.
 
+See the documentation(https://Python-Markdown.github.io/extensions/raw_html)
+for details.
 """
 
+from __future__ import annotations
+
 from . import Extension
 from ..blockprocessors import BlockProcessor
 from ..preprocessors import Preprocessor
@@ -25,7 +32,8 @@
 
 class HTMLExtractorExtra(HTMLExtractor):
     """
-    Override HTMLExtractor and create etree Elements for any elements which should have content parsed as Markdown.
+    Override `HTMLExtractor` and create `etree` `Elements` for any elements which should have content parsed as
+    Markdown.
     """
 
     def __init__(self, md, *args, **kwargs):
@@ -56,17 +64,17 @@
         super().close()
         # Handle any unclosed tags.
         if self.mdstack:
-            # Close the outermost parent. handle_endtag will close all unclosed children.
+            # Close the outermost parent. `handle_endtag` will close all unclosed children.
             self.handle_endtag(self.mdstack0)
 
     def get_element(self):
-        """ Return element from treebuilder and reset treebuilder for later use. """
+        """ Return element from `treebuilder` and reset `treebuilder` for later use. """
         element = self.treebuilder.close()
         self.treebuilder = etree.TreeBuilder()
         return element
 
     def get_state(self, tag, attrs):
-        """ Return state from tag and `markdown` attr. One of 'block', 'span', or 'off'. """
+        """ Return state from tag and `markdown` attribute. One of 'block', 'span', or 'off'. """
         md_attr = attrs.get('markdown', '0')
         if md_attr == 'markdown':
             # `<tag markdown>` is the same as `<tag markdown='1'>`.
@@ -100,7 +108,7 @@
             return
 
         if tag in self.block_level_tags and (self.at_line_start() or self.intail):
-            # Valueless attr (ex: `<tag checked>`) results in `('checked', None)`.
+            # Valueless attribute (ex: `<tag checked>`) results in `('checked', None)`.
             # Convert to `{'checked': 'checked'}`.
             attrs = {key: value if value is not None else key for key, value in attrs}
             state = self.get_state(tag, attrs)
@@ -157,7 +165,7 @@
                     # Check if element has a tail
                     if not blank_line_re.match(
                             self.rawdataself.line_offset + self.offset + len(self.get_endtag_text(tag)):):
-                        # More content exists after endtag.
+                        # More content exists after `endtag`.
                         self.intail = True
             else:
                 # Treat orphan closing tag as a span level tag.
@@ -209,8 +217,8 @@
 
     def parse_pi(self, i):
         if self.at_line_start() or self.intail or self.mdstack:
-            # The same override exists in HTMLExtractor without the check
-            # for mdstack. Therefore, use HTMLExtractor's parent instead.
+            # The same override exists in `HTMLExtractor` without the check
+            # for `mdstack`. Therefore, use parent of `HTMLExtractor` instead.
             return super(HTMLExtractor, self).parse_pi(i)
         # This is not the beginning of a raw block so treat as plain data
         # and avoid consuming any tags which may follow (see #1066).
@@ -219,8 +227,8 @@
 
     def parse_html_declaration(self, i):
         if self.at_line_start() or self.intail or self.mdstack:
-            # The same override exists in HTMLExtractor without the check
-            # for mdstack. Therefore, use HTMLExtractor's parent instead.
+            # The same override exists in `HTMLExtractor` without the check
+            # for `mdstack`. Therefore, use parent of `HTMLExtractor` instead.
             return super(HTMLExtractor, self).parse_html_declaration(i)
         # This is not the beginning of a raw block so treat as plain data
         # and avoid consuming any tags which may follow (see #1066).
@@ -240,19 +248,19 @@
 
 
 class MarkdownInHtmlProcessor(BlockProcessor):
-    """Process Markdown Inside HTML Blocks which have been stored in the HtmlStash."""
+    """Process Markdown Inside HTML Blocks which have been stored in the `HtmlStash`."""
 
     def test(self, parent, block):
-        # ALways return True. `run` will return `False` it not a valid match.
+        # Always return True. `run` will return `False` it not a valid match.
         return True
 
     def parse_element_content(self, element):
         """
-        Recursively parse the text content of an etree Element as Markdown.
+        Recursively parse the text content of an `etree` Element as Markdown.
 
         Any block level elements generated from the Markdown will be inserted as children of the element in place
         of the text content. All `markdown` attributes are removed. For any elements in which Markdown parsing has
-        been disabled, the text content of it and its chidlren are wrapped in an `AtomicString`.
+        been disabled, the text content of it and its children are wrapped in an `AtomicString`.
         """
 
         md_attr = element.attrib.pop('markdown', 'off')
@@ -301,7 +309,7 @@
                     element.insert(0, child)
 
         elif md_attr == 'span':
-            # Span level parsing will be handled by inlineprocessors.
+            # Span level parsing will be handled by inline processors.
             # Walk children here to remove any `markdown` attributes.
             for child in list(element):
                 self.parse_element_content(child)
@@ -329,7 +337,7 @@
                 # Cleanup stash. Replace element with empty string to avoid confusing postprocessor.
                 self.parser.md.htmlStash.rawHtmlBlocks.pop(index)
                 self.parser.md.htmlStash.rawHtmlBlocks.insert(index, '')
-                # Confirm the match to the blockparser.
+                # Confirm the match to the `blockparser`.
                 return True
         # No match found.
         return False
@@ -337,7 +345,7 @@
 
 class MarkdownInHTMLPostprocessor(RawHtmlPostprocessor):
     def stash_to_string(self, text):
-        """ Override default to handle any etree elements still in the stash. """
+        """ Override default to handle any `etree` elements still in the stash. """
         if isinstance(text, etree.Element):
             return self.md.serializer(text)
         else:
@@ -352,7 +360,7 @@
 
         # Replace raw HTML preprocessor
         md.preprocessors.register(HtmlBlockPreprocessor(md), 'html_block', 20)
-        # Add blockprocessor which handles the placeholders for etree elements
+        # Add `blockprocessor` which handles the placeholders for `etree` elements
         md.parser.blockprocessors.register(
             MarkdownInHtmlProcessor(md.parser), 'markdown_block', 105
         )

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/meta.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/meta.py Changed

@@ -1,20 +1,26 @@
-"""
-Meta Data Extension for Python-Markdown
-=======================================
+# Meta Data Extension for Python-Markdown
+# =======================================
 
-This extension adds Meta Data handling to markdown.
+# This extension adds Meta Data handling to markdown.
+
+# See https://Python-Markdown.github.io/extensions/meta_data
+# for documentation.
 
-See <https://Python-Markdown.github.io/extensions/meta_data>
-for documentation.
+# Original code Copyright 2007-2008 Waylan Limberg(http://achinghead.com).
 
-Original code Copyright 2007-2008 Waylan Limberg(http://achinghead.com).
+# All changes Copyright 2008-2014 The Python Markdown Project
 
-All changes Copyright 2008-2014 The Python Markdown Project
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+"""
+This extension adds Meta Data handling to markdown.
 
+See the documentation(https://Python-Markdown.github.io/extensions/meta_data)
+for details.
 """
 
+from __future__ import annotations
+
 from . import Extension
 from ..preprocessors import Preprocessor
 import re
@@ -33,12 +39,12 @@
     """ Meta-Data extension for Python-Markdown. """
 
     def extendMarkdown(self, md):
-        """ Add MetaPreprocessor to Markdown instance. """
+        """ Add `MetaPreprocessor` to Markdown instance. """
         md.registerExtension(self)
         self.md = md
         md.preprocessors.register(MetaPreprocessor(md), 'meta', 27)
 
-    def reset(self):
+    def reset(self) -> None:
         self.md.Meta = {}

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/nl2br.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/nl2br.py Changed

@@ -1,21 +1,28 @@
-"""
-NL2BR Extension
-===============
+# `NL2BR` Extension
+# ===============
 
-A Python-Markdown extension to treat newlines as hard breaks; like
-GitHub-flavored Markdown does.
+# A Python-Markdown extension to treat newlines as hard breaks; like
+# GitHub-flavored Markdown does.
+
+# See https://Python-Markdown.github.io/extensions/nl2br
+# for documentation.
 
-See <https://Python-Markdown.github.io/extensions/nl2br>
-for documentation.
+# Original code Copyright 2011 Brian Neal(https://deathofagremmie.com/)
 
-Oringinal code Copyright 2011 Brian Neal(https://deathofagremmie.com/)
+# All changes Copyright 2011-2014 The Python Markdown Project
 
-All changes Copyright 2011-2014 The Python Markdown Project
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+"""
+A Python-Markdown extension to treat newlines as hard breaks; like
+GitHub-flavored Markdown does.
 
+See the documentation(https://Python-Markdown.github.io/extensions/nl2br)
+for details.
 """
 
+from __future__ import annotations
+
 from . import Extension
 from ..inlinepatterns import SubstituteTagInlineProcessor
 
@@ -25,6 +32,7 @@
 class Nl2BrExtension(Extension):
 
     def extendMarkdown(self, md):
+        """ Add a `SubstituteTagInlineProcessor` to Markdown. """
         br_tag = SubstituteTagInlineProcessor(BR_RE, 'br')
         md.inlinePatterns.register(br_tag, 'nl', 5)

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/sane_lists.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/sane_lists.py Changed

@@ -1,29 +1,38 @@
-"""
-Sane List Extension for Python-Markdown
-=======================================
+# Sane List Extension for Python-Markdown
+# =======================================
 
-Modify the behavior of Lists in Python-Markdown to act in a sane manor.
+# Modify the behavior of Lists in Python-Markdown to act in a sane manor.
+
+# See https://Python-Markdown.github.io/extensions/sane_lists
+# for documentation.
 
-See <https://Python-Markdown.github.io/extensions/sane_lists>
-for documentation.
+# Original code Copyright 2011 Waylan Limberg(http://achinghead.com)
 
-Original code Copyright 2011 Waylan Limberg(http://achinghead.com)
+# All changes Copyright 2011-2014 The Python Markdown Project
 
-All changes Copyright 2011-2014 The Python Markdown Project
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+"""
+Modify the behavior of Lists in Python-Markdown to act in a sane manor.
 
+See documentation(https://Python-Markdown.github.io/extensions/sane_lists)
+for details.
 """
 
+from __future__ import annotations
+
 from . import Extension
 from ..blockprocessors import OListProcessor, UListProcessor
 import re
 
 
 class SaneOListProcessor(OListProcessor):
+    """ Override `SIBLING_TAGS` to not include `ul` and set `LAZY_OL` to `False`. """
 
     SIBLING_TAGS = 'ol'
+    """ Exclude `ul` from list of siblings. """
     LAZY_OL = False
+    """ Disable lazy list behavior. """
 
     def __init__(self, parser):
         super().__init__(parser)
@@ -32,8 +41,10 @@
 
 
 class SaneUListProcessor(UListProcessor):
+    """ Override `SIBLING_TAGS` to not include `ol`. """
 
     SIBLING_TAGS = 'ul'
+    """ Exclude `ol` from list of siblings. """
 
     def __init__(self, parser):
         super().__init__(parser)

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/smarty.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/smarty.py Changed

@@ -1,84 +1,90 @@
-'''
-Smarty extension for Python-Markdown
-====================================
+# Smarty extension for Python-Markdown
+# ====================================
 
-Adds conversion of ASCII dashes, quotes and ellipses to their HTML
-entity equivalents.
+# Adds conversion of ASCII dashes, quotes and ellipses to their HTML
+# entity equivalents.
+
+# See https://Python-Markdown.github.io/extensions/smarty
+# for documentation.
 
-See <https://Python-Markdown.github.io/extensions/smarty>
-for documentation.
+# Author: 2013, Dmitry Shachnev <mitya57@gmail.com>
 
-Author: 2013, Dmitry Shachnev <mitya57@gmail.com>
+# All changes Copyright 2013-2014 The Python Markdown Project
 
-All changes Copyright 2013-2014 The Python Markdown Project
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+# SmartyPants license:
 
-SmartyPants license:
+#    Copyright (c) 2003 John Gruber <https://daringfireball.net/>
+#    All rights reserved.
 
-   Copyright (c) 2003 John Gruber <https://daringfireball.net/>
-   All rights reserved.
+#    Redistribution and use in source and binary forms, with or without
+#    modification, are permitted provided that the following conditions are
+#    met:
 
-   Redistribution and use in source and binary forms, with or without
-   modification, are permitted provided that the following conditions are
-   met:
+#    *  Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
 
-   *  Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
+#    *  Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in
+#       the documentation and/or other materials provided with the
+#       distribution.
 
-   *  Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in
-      the documentation and/or other materials provided with the
-      distribution.
+#    *  Neither the name "SmartyPants" nor the names of its contributors
+#       may be used to endorse or promote products derived from this
+#       software without specific prior written permission.
 
-   *  Neither the name "SmartyPants" nor the names of its contributors
-      may be used to endorse or promote products derived from this
-      software without specific prior written permission.
+#    This software is provided by the copyright holders and contributors "as
+#    is" and any express or implied warranties, including, but not limited
+#    to, the implied warranties of merchantability and fitness for a
+#    particular purpose are disclaimed. In no event shall the copyright
+#    owner or contributors be liable for any direct, indirect, incidental,
+#    special, exemplary, or consequential damages (including, but not
+#    limited to, procurement of substitute goods or services; loss of use,
+#    data, or profits; or business interruption) however caused and on any
+#    theory of liability, whether in contract, strict liability, or tort
+#    (including negligence or otherwise) arising in any way out of the use
+#    of this software, even if advised of the possibility of such damage.
 
-   This software is provided by the copyright holders and contributors "as
-   is" and any express or implied warranties, including, but not limited
-   to, the implied warranties of merchantability and fitness for a
-   particular purpose are disclaimed. In no event shall the copyright
-   owner or contributors be liable for any direct, indirect, incidental,
-   special, exemplary, or consequential damages (including, but not
-   limited to, procurement of substitute goods or services; loss of use,
-   data, or profits; or business interruption) however caused and on any
-   theory of liability, whether in contract, strict liability, or tort
-   (including negligence or otherwise) arising in any way out of the use
-   of this software, even if advised of the possibility of such damage.
 
+# `smartypants.py` license:
 
-smartypants.py license:
+#    `smartypants.py` is a derivative work of SmartyPants.
+#    Copyright (c) 2004, 2007 Chad Miller <http://web.chad.org/>
 
-   smartypants.py is a derivative work of SmartyPants.
-   Copyright (c) 2004, 2007 Chad Miller <http://web.chad.org/>
+#    Redistribution and use in source and binary forms, with or without
+#    modification, are permitted provided that the following conditions are
+#    met:
 
-   Redistribution and use in source and binary forms, with or without
-   modification, are permitted provided that the following conditions are
-   met:
+#    *  Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
 
-   *  Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
+#    *  Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in
+#       the documentation and/or other materials provided with the
+#       distribution.
 
-   *  Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in
-      the documentation and/or other materials provided with the
-      distribution.
+#    This software is provided by the copyright holders and contributors "as
+#    is" and any express or implied warranties, including, but not limited
+#    to, the implied warranties of merchantability and fitness for a
+#    particular purpose are disclaimed. In no event shall the copyright
+#    owner or contributors be liable for any direct, indirect, incidental,
+#    special, exemplary, or consequential damages (including, but not
+#    limited to, procurement of substitute goods or services; loss of use,
+#    data, or profits; or business interruption) however caused and on any
+#    theory of liability, whether in contract, strict liability, or tort
+#    (including negligence or otherwise) arising in any way out of the use
+#    of this software, even if advised of the possibility of such damage.
 
-   This software is provided by the copyright holders and contributors "as
-   is" and any express or implied warranties, including, but not limited
-   to, the implied warranties of merchantability and fitness for a
-   particular purpose are disclaimed. In no event shall the copyright
-   owner or contributors be liable for any direct, indirect, incidental,
-   special, exemplary, or consequential damages (including, but not
-   limited to, procurement of substitute goods or services; loss of use,
-   data, or profits; or business interruption) however caused and on any
-   theory of liability, whether in contract, strict liability, or tort
-   (including negligence or otherwise) arising in any way out of the use
-   of this software, even if advised of the possibility of such damage.
+"""
+Adds conversion of ASCII dashes, quotes and ellipses to their HTML
+entity equivalents.
 
-'''
+See the documentation(https://Python-Markdown.github.io/extensions/smarty)
+for details.
+"""
 
+from __future__ import annotations
 
 from . import Extension
 from ..inlinepatterns import HtmlInlineProcessor, HTML_RE
@@ -95,7 +101,7 @@
     r'(\s'               # a  whitespace char
     r'|&nbsp;'           # or a non-breaking space entity
     r'|--'               # or dashes
-    r'|–|—'              # or unicode
+    r'|–|—'              # or Unicode
     r'|&mndash;'       # or named dash entities
     r'|&#8211;|&#8212;'  # or decimal entities
     r')'
@@ -139,7 +145,7 @@
 
 # Single closing quotes:
 closingSingleQuotesRegex = r"(?<=%s)'(?!\s|s\b|\d)" % closeClass
-closingSingleQuotesRegex2 = r"(?<=%s)'(\s|s\b)" % closeClass
+closingSingleQuotesRegex2 = r"'(\s|s\b)"
 
 # All remaining quotes should be opening ones
 remainingSingleQuotesRegex = r"'"
@@ -166,6 +172,7 @@
 
 
 class SmartyExtension(Extension):
+    """ Add Smarty to Markdown. """
     def __init__(self, **kwargs):
         self.config = {
             'smart_quotes': True, 'Educate quotes',
@@ -174,6 +181,7 @@
             'smart_ellipses': True, 'Educate ellipses',
             'substitutions': {}, 'Overwrite default substitutions',
         }
+        """ Default configuration options. """
         super().__init__(**kwargs)
         self.substitutions = dict(substitutions)
         self.substitutions.update(self.getConfig('substitutions', default={}))
@@ -185,7 +193,7 @@
             name = 'smarty-%s-%d' % (serie, ind)
             self.inlinePatterns.register(pattern, name, priority-ind)
 
-    def educateDashes(self, md):
+    def educateDashes(self, md) -> None:
         emDashesPattern = SubstituteTextPattern(
             r'(?<!-)---(?!-)', (self.substitutions'mdash',), md
         )
@@ -195,13 +203,13 @@
         self.inlinePatterns.register(emDashesPattern, 'smarty-em-dashes', 50)
         self.inlinePatterns.register(enDashesPattern, 'smarty-en-dashes', 45)
 
-    def educateEllipses(self, md):
+    def educateEllipses(self, md) -> None:

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/tables.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/tables.py Changed

@@ -1,20 +1,26 @@
-"""
-Tables Extension for Python-Markdown
-====================================
+# Tables Extension for Python-Markdown
+# ====================================
 
-Added parsing of tables to Python-Markdown.
+# Added parsing of tables to Python-Markdown.
+
+# See https://Python-Markdown.github.io/extensions/tables
+# for documentation.
 
-See <https://Python-Markdown.github.io/extensions/tables>
-for documentation.
+# Original code Copyright 2009 Waylan Limberg(http://achinghead.com)
 
-Original code Copyright 2009 Waylan Limberg(http://achinghead.com)
+# All changes Copyright 2008-2014 The Python Markdown Project
 
-All changes Copyright 2008-2014 The Python Markdown Project
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+"""
+Added parsing of tables to Python-Markdown.
 
+See the documentation(https://Python-Markdown.github.io/extensions/tables)
+for details.
 """
 
+from __future__ import annotations
+
 from . import Extension
 from ..blockprocessors import BlockProcessor
 import xml.etree.ElementTree as etree
@@ -221,11 +227,12 @@
         self.config = {
             'use_align_attribute': False, 'True to use align attribute instead of style.',
         }
+        """ Default configuration options. """
 
         super().__init__(**kwargs)
 
     def extendMarkdown(self, md):
-        """ Add an instance of TableProcessor to BlockParser. """
+        """ Add an instance of `TableProcessor` to `BlockParser`. """
         if '|' not in md.ESCAPED_CHARS:
             md.ESCAPED_CHARS.append('|')
         processor = TableProcessor(md.parser, self.getConfigs())

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/toc.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/toc.py Changed

@@ -1,18 +1,24 @@
-"""
-Table of Contents Extension for Python-Markdown
-===============================================
+# Table of Contents Extension for Python-Markdown
+# ===============================================
+
+# See https://Python-Markdown.github.io/extensions/toc
+# for documentation.
 
-See <https://Python-Markdown.github.io/extensions/toc>
-for documentation.
+# Original code Copyright 2008 Jack Miller(https://codezen.org/)
 
-Oringinal code Copyright 2008 Jack Miller(https://codezen.org/)
+# All changes Copyright 2008-2014 The Python Markdown Project
 
-All changes Copyright 2008-2014 The Python Markdown Project
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+"""
+Add table of contents support to Python-Markdown.
 
+See the documentation(https://Python-Markdown.github.io/extensions/toc)
+for details.
 """
 
+from __future__ import annotations
+
 from . import Extension
 from ..treeprocessors import Treeprocessor
 from ..util import code_escape, parseBoolValue, AMP_SUBSTITUTE, HTML_PLACEHOLDER_RE, AtomicString
@@ -26,7 +32,7 @@
 def slugify(value, separator, unicode=False):
     """ Slugify a string, to make it URL friendly. """
     if not unicode:
-        # Replace Extended Latin characters with ASCII, i.e. žlutý → zluty
+        # Replace Extended Latin characters with ASCII, i.e. `žlutý` => `zluty`
         value = unicodedata.normalize('NFKD', value)
         value = value.encode('ascii', 'ignore').decode('ascii')
     value = re.sub(r'^\w\s-', '', value).strip().lower()
@@ -65,7 +71,7 @@
     return ''.join(text).strip()
 
 
-def stashedHTML2text(text, md, strip_entities=True):
+def stashedHTML2text(text, md, strip_entities: bool = True):
     """ Extract raw HTML from stash, reduce to plain text and swap with placeholder. """
     def _html_sub(m):
         """ Substitute raw html with plain text. """
@@ -90,14 +96,16 @@
 
 def nest_toc_tokens(toc_list):
     """Given an unsorted list with errors and skips, return a nested one.
-    {'level': 1}, {'level': 2}
-    =>
-    {'level': 1, 'children': {'level': 2, 'children': }}
+
+        {'level': 1}, {'level': 2}
+        =>
+        {'level': 1, 'children': {'level': 2, 'children': }}
 
     A wrong list is also converted:
-    {'level': 2}, {'level': 1}
-    =>
-    {'level': 2, 'children': }, {'level': 1, 'children': }
+
+        {'level': 2}, {'level': 1}
+        =>
+        {'level': 2, 'children': }, {'level': 1, 'children': }
     """
 
     ordered_list = 
@@ -152,6 +160,8 @@
 
 
 class TocTreeprocessor(Treeprocessor):
+    """ Step through document and build TOC. """
+
     def __init__(self, md, config):
         super().__init__(md)
 
@@ -161,6 +171,7 @@
         self.slugify = config"slugify"
         self.sep = config"separator"
         self.toc_class = config"toc_class"
+        self.title_class = config"title_class"
         self.use_anchors = parseBoolValue(config"anchorlink")
         self.anchorlink_class = config"anchorlink_class"
         self.use_permalinks = parseBoolValue(config"permalink", False)
@@ -168,6 +179,7 @@
             self.use_permalinks = config"permalink"
         self.permalink_class = config"permalink_class"
         self.permalink_title = config"permalink_title"
+        self.permalink_leading = parseBoolValue(config"permalink_leading", False)
         self.header_rgx = re.compile("Hh123456")
         if isinstance(config"toc_depth", str) and '-' in config"toc_depth":
             self.toc_top, self.toc_bottom = int(x) for x in config"toc_depth".split('-')
@@ -176,45 +188,45 @@
             self.toc_bottom = int(config"toc_depth")
 
     def iterparent(self, node):
-        ''' Iterator wrapper to get allowed parent and child all at once. '''
+        """ Iterator wrapper to get allowed parent and child all at once. """
 
         # We do not allow the marker inside a header as that
-        # would causes an enless loop of placing a new TOC
+        # would causes an endless loop of placing a new TOC
         # inside previously generated TOC.
         for child in node:
             if not self.header_rgx.match(child.tag) and child.tag not in 'pre', 'code':
                 yield node, child
                 yield from self.iterparent(child)
 
-    def replace_marker(self, root, elem):
-        ''' Replace marker with elem. '''
+    def replace_marker(self, root, elem) -> None:
+        """ Replace marker with elem. """
         for (p, c) in self.iterparent(root):
             text = ''.join(c.itertext()).strip()
             if not text:
                 continue
 
             # To keep the output from screwing up the
-            # validation by putting a <div> inside of a <p>
-            # we actually replace the <p> in its entirety.
+            # validation by putting a `<div>` inside of a `<p>`
+            # we actually replace the `<p>` in its entirety.
 
-            # The <p> element may contain more than a single text content
-            # (nl2br can introduce a <br>). In this situation, c.text returns
+            # The `<p>` element may contain more than a single text content
+            # (`nl2br` can introduce a `<br>`). In this situation, `c.text` returns
             # the very first content, ignore children contents or tail content.
-            # len(c) == 0 is here to ensure there is only text in the <p>.
+            # `len(c) == 0` is here to ensure there is only text in the `<p>`.
             if c.text and c.text.strip() == self.marker and len(c) == 0:
                 for i in range(len(p)):
                     if pi == c:
                         pi = elem
                         break
 
-    def set_level(self, elem):
-        ''' Adjust header level according to base level. '''
+    def set_level(self, elem) -> None:
+        """ Adjust header level according to base level. """
         level = int(elem.tag-1) + self.base_level
         if level > 6:
             level = 6
         elem.tag = 'h%d' % level
 
-    def add_anchor(self, c, elem_id):  # @ReservedAssignment
+    def add_anchor(self, c, elem_id) -> None:
         anchor = etree.Element("a")
         anchor.text = c.text
         anchor.attrib"href" = "#" + elem_id
@@ -226,7 +238,7 @@
             c.remove(c0)
         c.append(anchor)
 
-    def add_permalink(self, c, elem_id):
+    def add_permalink(self, c, elem_id) -> None:
         permalink = etree.Element("a")
         permalink.text = ("%spara;" % AMP_SUBSTITUTE
                           if self.use_permalinks is True
@@ -235,7 +247,12 @@
         permalink.attrib"class" = self.permalink_class
         if self.permalink_title:
             permalink.attrib"title" = self.permalink_title
-        c.append(permalink)
+        if self.permalink_leading:
+            permalink.tail = c.text
+            c.text = ""
+            c.insert(0, permalink)
+        else:
+            c.append(permalink)
 
     def build_toc_div(self, toc_list):
         """ Return a string div given a toc list. """
@@ -245,7 +262,8 @@
         # Add title to the div
         if self.title:
             header = etree.SubElement(div, "span")
-            header.attrib"class" = "toctitle"
+            if self.title_class:
+                header.attrib"class" = self.title_class
             header.text = self.title
 
         def build_etree_ul(toc_list, parent):
@@ -289,10 +307,10 @@
                     toc_tokens.append({
                         'level': int(el.tag-1),
                         'id': el.attrib"id",
-                        'name': stashedHTML2text(
+                        'name': unescape(stashedHTML2text(
                             code_escape(el.attrib.get('data-toc-label', text)),
                             self.md, strip_entities=False
-                        )
+                        ))

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/extensions/wikilinks.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/extensions/wikilinks.py Changed

@@ -1,19 +1,25 @@
-'''
-WikiLinks Extension for Python-Markdown
-======================================
+# WikiLinks Extension for Python-Markdown
+# ======================================
 
-Converts WikiLinks to relative links.
+# Converts WikiLinks to relative links.
 
-See <https://Python-Markdown.github.io/extensions/wikilinks>
-for documentation.
+# See https://Python-Markdown.github.io/extensions/wikilinks
+# for documentation.
 
-Original code Copyright Waylan Limberg(http://achinghead.com/).
+# Original code Copyright Waylan Limberg(http://achinghead.com/).
 
-All changes Copyright The Python Markdown Project
+# All changes Copyright The Python Markdown Project
 
-License: BSD(https://opensource.org/licenses/bsd-license.php)
+# License: BSD(https://opensource.org/licenses/bsd-license.php)
 
-'''
+"""
+Converts `WikiLinks` to relative links.
+
+See the documentation(https://Python-Markdown.github.io/extensions/wikilinks)
+for details.
+"""
+
+from __future__ import annotations
 
 from . import Extension
 from ..inlinepatterns import InlineProcessor
@@ -22,12 +28,13 @@
 
 
 def build_url(label, base, end):
-    """ Build a url from the label, a base, and an end. """
+    """ Build a URL from the label, a base, and an end. """
     clean_label = re.sub(r'( +_)|(_ +)|( +)', '_', label)
     return '{}{}{}'.format(base, clean_label, end)
 
 
 class WikiLinkExtension(Extension):
+    """ Add inline processor to Markdown. """
 
     def __init__(self, **kwargs):
         self.config = {
@@ -36,7 +43,7 @@
             'html_class': 'wikilink', 'CSS hook. Leave blank for none.',
             'build_url': build_url, 'Callable formats URL from label.',
         }
-
+        """ Default configuration options. """
         super().__init__(**kwargs)
 
     def extendMarkdown(self, md):
@@ -50,6 +57,8 @@
 
 
 class WikiLinksInlineProcessor(InlineProcessor):
+    """ Build link from `wikilink`. """
+
     def __init__(self, pattern, config):
         super().__init__(pattern)
         self.config = config
@@ -69,7 +78,7 @@
         return a, m.start(0), m.end(0)
 
     def _getMeta(self):
-        """ Return meta data or config data. """
+        """ Return meta data or `config` data. """
         base_url = self.config'base_url'
         end_url = self.config'end_url'
         html_class = self.config'html_class'

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/htmlparser.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/htmlparser.py Changed

@@ -1,24 +1,30 @@
-"""
-Python Markdown
+# Python Markdown
+
+# A Python implementation of John Gruber's Markdown.
 
-A Python implementation of John Gruber's Markdown.
+# Documentation: https://python-markdown.github.io/
+# GitHub: https://github.com/Python-Markdown/markdown/
+# PyPI: https://pypi.org/project/Markdown/
 
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
+# Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# Copyright 2004 Manfred Stienstra (the original version)
 
-Copyright 2007-2020 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# License: BSD (see LICENSE.md for details).
 
-License: BSD (see LICENSE.md for details).
+"""
+This module imports a copy of `html.parser.HTMLParser` and modifies it heavily through monkey-patches.
+A copy is imported rather than the module being directly imported as this ensures that the user can import
+and  use the unmodified library for their own needs.
 """
 
+from __future__ import annotations
+
 import re
 import importlib.util
 import sys
@@ -31,15 +37,15 @@
 spec.loader.exec_module(htmlparser)
 sys.modules'htmlparser' = htmlparser
 
-# Monkeypatch HTMLParser to only accept `?>` to close Processing Instructions.
+# Monkeypatch `HTMLParser` to only accept `?>` to close Processing Instructions.
 htmlparser.piclose = re.compile(r'\?>')
-# Monkeypatch HTMLParser to only recognize entity references with a closing semicolon.
+# Monkeypatch `HTMLParser` to only recognize entity references with a closing semicolon.
 htmlparser.entityref = re.compile(r'&(a-zA-Z-.a-zA-Z0-9*);')
-# Monkeypatch HTMLParser to no longer support partial entities. We are always feeding a complete block,
-# so the 'incomplete' functionality is unnecessary. As the entityref regex is run right before incomplete,
+# Monkeypatch `HTMLParser` to no longer support partial entities. We are always feeding a complete block,
+# so the 'incomplete' functionality is unnecessary. As the `entityref` regex is run right before incomplete,
 # and the two regex are the same, then incomplete will simply never match and we avoid the logic within.
 htmlparser.incomplete = htmlparser.entityref
-# Monkeypatch HTMLParser to not accept a backtick in a tag name, attribute name, or bare value.
+# Monkeypatch `HTMLParser` to not accept a backtick in a tag name, attribute name, or bare value.
 htmlparser.locatestarttagend_tolerant = re.compile(r"""
   <a-zA-Z^`\t\n\r\f />\x00*       # tag name <= added backtick here
   (?:\s/*                           # optional whitespace before attribute name
@@ -65,8 +71,9 @@
     """
     Extract raw HTML from text.
 
-    The raw HTML is stored in the `htmlStash` of the Markdown instance passed
-    to `md` and the remaining text is stored in `cleandoc` as a list of strings.
+    The raw HTML is stored in the `htmlStash`markdown.util.HtmlStash of the
+    `Markdown`markdown.Markdown instance passed to `md` and the remaining text
+    is stored in `cleandoc` as a list of strings.
     """
 
     def __init__(self, md, *args, **kwargs):
@@ -76,6 +83,8 @@
         # Block tags that should contain no content (self closing)
         self.empty_tags = set('hr')
 
+        self.lineno_start_cache = 0
+
         # This calls self.reset
         super().__init__(*args, **kwargs)
         self.md = md
@@ -84,9 +93,11 @@
         """Reset this instance.  Loses all unprocessed data."""
         self.inraw = False
         self.intail = False
-        self.stack =   # When inraw==True, stack contains a list of tags
+        self.stack =   # When `inraw==True`, stack contains a list of tags
         self._cache = 
         self.cleandoc = 
+        self.lineno_start_cache = 0
+
         super().reset()
 
     def close(self):
@@ -105,19 +116,19 @@
             self._cache = 
 
     @property
-    def line_offset(self):
-        """Returns char index in self.rawdata for the start of the current line. """
-        if self.lineno > 1 and '\n' in self.rawdata:
-            m = re.match(r'(^\n*\n){{{}}}'.format(self.lineno-1), self.rawdata)
-            if m:
-                return m.end()
-            else:  # pragma: no cover
-                # Value of self.lineno must exceed total number of lines.
-                # Find index of beginning of last line.
-                return self.rawdata.rfind('\n')
-        return 0
-
-    def at_line_start(self):
+    def line_offset(self) -> int:
+        """Returns char index in `self.rawdata` for the start of the current line. """
+        for ii in range(len(self.lineno_start_cache)-1, self.lineno-1):
+            last_line_start_pos = self.lineno_start_cacheii
+            lf_pos = self.rawdata.find('\n', last_line_start_pos)
+            if lf_pos == -1:
+                # No more newlines found. Use end of raw data as start of line beyond end.
+                lf_pos = len(self.rawdata)
+            self.lineno_start_cache.append(lf_pos+1)
+
+        return self.lineno_start_cacheself.lineno-1
+
+    def at_line_start(self) -> bool:
         """
         Returns True if current position is at start of line.
 
@@ -130,7 +141,7 @@
         # Confirm up to first 3 chars are whitespace
         return self.rawdataself.line_offset:self.line_offset + self.offset.strip() == ''
 
-    def get_endtag_text(self, tag):
+    def get_endtag_text(self, tag: str) -> str:
         """
         Returns the text of the end tag.
 
@@ -145,7 +156,7 @@
             # Failed to extract from raw data. Assume well formed and lowercase.
             return '</{}>'.format(tag)
 
-    def handle_starttag(self, tag, attrs):
+    def handle_starttag(self, tag: str, attrs: listtuplestr, str):
         # Handle tags that should always be empty and do not specify a closing tag
         if tag in self.empty_tags:
             self.handle_startendtag(tag, attrs)
@@ -166,7 +177,7 @@
                 # This is presumably a standalone tag in a code span (see #1036).
                 self.clear_cdata_mode()
 
-    def handle_endtag(self, tag):
+    def handle_endtag(self, tag: str):
         text = self.get_endtag_text(tag)
 
         if self.inraw:
@@ -182,7 +193,7 @@
                     # Preserve blank line and end of raw block.
                     self._cache.append('\n')
                 else:
-                    # More content exists after endtag.
+                    # More content exists after `endtag`.
                     self.intail = True
                 # Reset stack.
                 self.inraw = False
@@ -193,7 +204,7 @@
         else:
             self.cleandoc.append(text)
 
-    def handle_data(self, data):
+    def handle_data(self, data: str):
         if self.intail and '\n' in data:
             self.intail = False
         if self.inraw:
@@ -201,7 +212,7 @@
         else:
             self.cleandoc.append(data)
 
-    def handle_empty_tag(self, data, is_block):
+    def handle_empty_tag(self, data: str, is_block: bool):
         """ Handle empty tags (`<data>`). """
         if self.inraw or self.intail:
             # Append this to the existing raw block
@@ -224,29 +235,29 @@
         else:
             self.cleandoc.append(data)
 
-    def handle_startendtag(self, tag, attrs):
+    def handle_startendtag(self, tag: str, attrs: listtuplestr, str):
         self.handle_empty_tag(self.get_starttag_text(), is_block=self.md.is_block_level(tag))
 
-    def handle_charref(self, name):
+    def handle_charref(self, name: str):
         self.handle_empty_tag('&#{};'.format(name), is_block=False)
 
-    def handle_entityref(self, name):

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/inlinepatterns.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/inlinepatterns.py Changed

@@ -1,67 +1,47 @@
-"""
-Python Markdown
-
-A Python implementation of John Gruber's Markdown.
-
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
-
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
-
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# Python Markdown
 
-License: BSD (see LICENSE.md for details).
+# A Python implementation of John Gruber's Markdown.
 
-INLINE PATTERNS
-=============================================================================
+# Documentation: https://python-markdown.github.io/
+# GitHub: https://github.com/Python-Markdown/markdown/
+# PyPI: https://pypi.org/project/Markdown/
 
-Inline patterns such as *emphasis* are handled by means of auxiliary
-objects, one per pattern.  Pattern objects must be instances of classes
-that extend markdown.Pattern.  Each pattern object uses a single regular
-expression and needs support the following methods:
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-    pattern.getCompiledRegExp() # returns a regular expression
+# Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# Copyright 2004 Manfred Stienstra (the original version)
 
-    pattern.handleMatch(m) # takes a match object and returns
-                           # an ElementTree element or just plain text
+# License: BSD (see LICENSE.md for details).
 
-All of python markdown's built-in patterns subclass from Pattern,
-but you can add additional patterns that don't.
-
-Also note that all the regular expressions used by inline must
-capture the whole block.  For this reason, they all start with
-'^(.*)' and end with '(.*)!'.  In case with built-in expression
-Pattern takes care of adding the "^(.*)" and "(.*)!".
-
-Finally, the order in which regular expressions are applied is very
-important - e.g. if we first replace http://.../ links with <a> tags
-and _then_ try to replace inline html, we would end up with a mess.
-So, we apply the expressions in the following order:
-
-* escape and backticks have to go before everything else, so
-  that we can preempt any markdown patterns by escaping them.
+"""
+In version 3.0, a new, more flexible inline processor was added, `markdown.inlinepatterns.InlineProcessor`.   The
+original inline patterns, which inherit from `markdown.inlinepatterns.Pattern` or one of its children are still
+supported, though users are encouraged to migrate.
 
-* then we handle auto-links (must be done before inline html)
+The new `InlineProcessor` provides two major enhancements to `Patterns`:
 
-* then we handle inline HTML.  At this point we will simply
-  replace all inline HTML strings with a placeholder and add
-  the actual HTML to a hash.
+1. Inline Processors no longer need to match the entire block, so regular expressions no longer need to start with
+  `r'^(.*?)'` and end with `r'(.*?)%'`. This runs faster. The returned `Match`re.Match object will only contain
+   what is explicitly matched in the pattern, and extension pattern groups now start with `m.group(1)`.
 
-* then inline images (must be done before links)
+2.  The `handleMatch` method now takes an additional input called `data`, which is the entire block under analysis,
+    not just what is matched with the specified pattern. The method now returns the element *and* the indexes relative
+    to `data` that the return element is replacing (usually `m.start(0)` and `m.end(0)`).  If the boundaries are
+    returned as `None`, it is assumed that the match did not take place, and nothing will be altered in `data`.
 
-* then bracketed links, first regular then reference-style
+    This allows handling of more complex constructs than regular expressions can handle, e.g., matching nested
+    brackets, and explicit control of the span "consumed" by the processor.
 
-* finally we apply strong and emphasis
 """
 
+from __future__ import annotations
+
 from . import util
-from collections import namedtuple
+from typing import TYPE_CHECKING, Any, Collection, NamedTuple
 import re
 import xml.etree.ElementTree as etree
 try:  # pragma: no cover
@@ -69,9 +49,29 @@
 except ImportError:  # pragma: no cover
     import htmlentitydefs as entities
 
+if TYPE_CHECKING:  # pragma: no cover
+    from markdown import Markdown
 
-def build_inlinepatterns(md, **kwargs):
-    """ Build the default set of inline patterns for Markdown. """
+
+def build_inlinepatterns(md: Markdown, **kwargs: Any) -> util.RegistryInlineProcessor:
+    """
+    Build the default set of inline patterns for Markdown.
+
+    The order in which processors and/or patterns are applied is very important - e.g. if we first replace
+    `http://.../` links with `<a>` tags and _then_ try to replace inline HTML, we would end up with a mess. So, we
+    apply the expressions in the following order:
+
+    * backticks and escaped characters have to be handled before everything else so that we can preempt any markdown
+      patterns by escaping them;
+
+    * then we handle the various types of links (auto-links must be handled before inline HTML);
+
+    * then we handle inline HTML.  At this point we will simply replace all inline HTML strings with a placeholder
+      and add the actual HTML to a stash;
+
+    * finally we apply strong, emphasis, etc.
+
+    """
     inlinePatterns = util.Registry()
     inlinePatterns.register(BacktickInlineProcessor(BACKTICK_RE), 'backtick', 190)
     inlinePatterns.register(EscapeInlineProcessor(ESCAPE_RE, md), 'escape', 180)
@@ -98,81 +98,80 @@
     return inlinePatterns
 
 
-"""
-The actual regular expressions for patterns
------------------------------------------------------------------------------
-"""
+# The actual regular expressions for patterns
+# -----------------------------------------------------------------------------
 
 NOIMG = r'(?<!\!)'
+""" Match not an image. Partial regular expression which matches if not preceded by `!`. """
 
-# `e=f()` or ``e=f("`")``
 BACKTICK_RE = r'(?:(?<!\\)((?:\\{2})+)(?=`+)|(?<!\\)(`+)(.+?)(?<!`)\2(?!`))'
+""" Match backtick quoted string (`` `e=f()` `` or ``` ``e=f("`")`` ```). """
 
-# \<
 ESCAPE_RE = r'\\(.)'
+""" Match a backslash escaped character (`\\<` or `\\*`). """
 
-# *emphasis*
 EMPHASIS_RE = r'(\*)(^\*+)\1'
+""" Match emphasis with an asterisk (`*emphasis*`). """
 
-# **strong**
 STRONG_RE = r'(\*{2})(.+?)\1'
+""" Match strong with an asterisk (`**strong**`). """
 
-# __smart__strong__
 SMART_STRONG_RE = r'(?<!\w)(_{2})(?!_)(.+?)(?<!_)\1(?!\w)'
+""" Match strong with underscore while ignoring middle word underscores (`__smart__strong__`). """
 
-# _smart_emphasis_
 SMART_EMPHASIS_RE = r'(?<!\w)(_)(?!_)(.+?)(?<!_)\1(?!\w)'
+""" Match emphasis with underscore while ignoring middle word underscores (`_smart_emphasis_`). """
 
-# __strong _em__
 SMART_STRONG_EM_RE = r'(?<!\w)(\_)\1(?!\1)(.+?)(?<!\w)\1(?!\1)(.+?)\1{3}(?!\w)'
+""" Match strong emphasis with underscores (`__strong _em__`). """
 
-# ***strongem*** or ***em*strong**
 EM_STRONG_RE = r'(\*)\1{2}(.+?)\1(.*?)\1{2}'
+""" Match emphasis strong with asterisk (`***strongem***` or `***em*strong**`). """
 
-# ___strongem___ or ___em_strong__
 EM_STRONG2_RE = r'(_)\1{2}(.+?)\1(.*?)\1{2}'
+""" Match emphasis strong with underscores (`___emstrong___` or `___em_strong__`). """
 
-# ***strong**em*
 STRONG_EM_RE = r'(\*)\1{2}(.+?)\1{2}(.*?)\1'
+""" Match strong emphasis with asterisk (`***strong**em*`). """
 
-# ___strong__em_
 STRONG_EM2_RE = r'(_)\1{2}(.+?)\1{2}(.*?)\1'
+""" Match strong emphasis with underscores (`___strong__em_`). """
 
-# **strong*em***
 STRONG_EM3_RE = r'(\*)\1(?!\1)(^*+?)\1(?!\1)(.+?)\1{3}'
+""" Match strong emphasis with asterisk (`**strong*em***`). """
 
-# text(url) or text(<url>) or text(url "title")
 LINK_RE = NOIMG + r'\'
+""" Match start of in-line link (`text(url)` or `text(<url>)` or `text(url "title")`). """
 
-# !alttxt(http://x.com/) or !alttxt(<http://x.com/>)
 IMAGE_LINK_RE = r'\!\'
+""" Match start of in-line image link (`!alttxt(url)` or `!alttxt(<url>)`). """

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/postprocessors.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/postprocessors.py Changed

@@ -1,38 +1,43 @@
-"""
-Python Markdown
+# Python Markdown
 
-A Python implementation of John Gruber's Markdown.
+# A Python implementation of John Gruber's Markdown.
 
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
+# Documentation: https://python-markdown.github.io/
+# GitHub: https://github.com/Python-Markdown/markdown/
+# PyPI: https://pypi.org/project/Markdown/
 
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# Copyright 2004 Manfred Stienstra (the original version)
 
-License: BSD (see LICENSE.md for details).
+# License: BSD (see LICENSE.md for details).
 
-POST-PROCESSORS
-=============================================================================
+"""
 
-Markdown also allows post-processors, which are similar to preprocessors in
-that they need to implement a "run" method. However, they are run after core
-processing.
+Post-processors run on the text of the entire document after is has been serialized into a string.
+Postprocessors should be used to work with the text just before output. Usually, they are used add
+back sections that were extracted in a preprocessor, fix up outgoing encodings, or wrap the whole
+document.
 
 """
 
+from __future__ import annotations
+
 from collections import OrderedDict
+from typing import TYPE_CHECKING, Any
 from . import util
 import re
 
+if TYPE_CHECKING:  # pragma: no cover
+    from markdown import Markdown
 
-def build_postprocessors(md, **kwargs):
+
+def build_postprocessors(md: Markdown, **kwargs: Any) -> util.RegistryPostprocessor:
     """ Build the default postprocessors for Markdown. """
     postprocessors = util.Registry()
     postprocessors.register(RawHtmlPostprocessor(md), 'raw_html', 30)
@@ -44,16 +49,16 @@
     """
     Postprocessors are run after the ElementTree it converted back into text.
 
-    Each Postprocessor implements a "run" method that takes a pointer to a
+    Each Postprocessor implements a `run` method that takes a pointer to a
     text string, modifies it as necessary and returns a text string.
 
-    Postprocessors must extend markdown.Postprocessor.
+    Postprocessors must extend `Postprocessor`.
 
     """
 
-    def run(self, text):
+    def run(self, text: str) -> str:
         """
-        Subclasses of Postprocessor should implement a `run` method, which
+        Subclasses of `Postprocessor` should implement a `run` method, which
         takes the html document as a single text string and returns a
         (possibly modified) string.
 
@@ -66,7 +71,7 @@
 
     BLOCK_LEVEL_REGEX = re.compile(r'^\<\/?(^ >+)')
 
-    def run(self, text):
+    def run(self, text: str):
         """ Iterate over html stash and restore html. """
         replacements = OrderedDict()
         for i in range(self.md.htmlStash.html_counter):
@@ -99,16 +104,17 @@
         else:
             return self.run(processed_text)
 
-    def isblocklevel(self, html):
+    def isblocklevel(self, html: str) -> bool:
+        """ Check is block of HTML is block-level. """
         m = self.BLOCK_LEVEL_REGEX.match(html)
         if m:
             if m.group(1)0 in ('!', '?', '@', '%'):
-                # Comment, php etc...
+                # Comment, PHP etc...
                 return True
             return self.md.is_block_level(m.group(1))
         return False
 
-    def stash_to_string(self, text):
+    def stash_to_string(self, text: str) -> str:
         """ Convert a stashed object to a string. """
         return str(text)
 
@@ -122,11 +128,11 @@
 
 
 @util.deprecated(
-    "This class will be removed in the future; "
-    "use 'treeprocessors.UnescapeTreeprocessor' instead."
+    "This class is deprecated and will be removed in the future; "
+    "use `UnescapeTreeprocessor`markdown.treeprocessors.UnescapeTreeprocessor instead."
 )
 class UnescapePostprocessor(Postprocessor):
-    """ Restore escaped chars """
+    """ Restore escaped chars. """
 
     RE = re.compile(r'{}(\d+){}'.format(util.STX, util.ETX))

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/preprocessors.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/preprocessors.py Changed

@@ -1,37 +1,41 @@
-"""
-Python Markdown
-
-A Python implementation of John Gruber's Markdown.
+# Python Markdown
 
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
+# A Python implementation of John Gruber's Markdown.
 
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
+# Documentation: https://python-markdown.github.io/
+# GitHub: https://github.com/Python-Markdown/markdown/
+# PyPI: https://pypi.org/project/Markdown/
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-License: BSD (see LICENSE.md for details).
+# Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# Copyright 2004 Manfred Stienstra (the original version)
 
-PRE-PROCESSORS
-=============================================================================
+# License: BSD (see LICENSE.md for details).
 
-Preprocessors work on source text before we start doing anything too
-complicated.
 """
+Preprocessors work on source text before it is broken down into its individual parts.
+This is an excellent place to clean up bad characters or to extract portions for later
+processing that the parser may otherwise choke on.
+"""
+
+from __future__ import annotations
 
+from typing import TYPE_CHECKING, Any
 from . import util
 from .htmlparser import HTMLExtractor
 import re
 
+if TYPE_CHECKING:  # pragma: no cover
+    from markdown import Markdown
 
-def build_preprocessors(md, **kwargs):
-    """ Build the default set of preprocessors used by Markdown. """
+
+def build_preprocessors(md: Markdown, **kwargs: Any) -> util.RegistryPreprocessor:
+    """ Build and return the default set of preprocessors used by Markdown. """
     preprocessors = util.Registry()
     preprocessors.register(NormalizeWhitespace(md), 'normalize_whitespace', 30)
     preprocessors.register(HtmlBlockPreprocessor(md), 'html_block', 20)
@@ -42,16 +46,16 @@
     """
     Preprocessors are run after the text is broken into lines.
 
-    Each preprocessor implements a "run" method that takes a pointer to a
+    Each preprocessor implements a `run` method that takes a pointer to a
     list of lines of the document, modifies it as necessary and returns
     either the same pointer or a pointer to a new list.
 
-    Preprocessors must extend markdown.Preprocessor.
+    Preprocessors must extend `Preprocessor`.
 
     """
-    def run(self, lines):
+    def run(self, lines: liststr) -> liststr:
         """
-        Each subclass of Preprocessor should override the `run` method, which
+        Each subclass of `Preprocessor` should override the `run` method, which
         takes the document as a list of strings split by newlines and returns
         the (possibly modified) list of lines.
 
@@ -62,7 +66,7 @@
 class NormalizeWhitespace(Preprocessor):
     """ Normalize whitespace for consistent parsing. """
 
-    def run(self, lines):
+    def run(self, lines: liststr) -> liststr:
         source = '\n'.join(lines)
         source = source.replace(util.STX, "").replace(util.ETX, "")
         source = source.replace("\r\n", "\n").replace("\r", "\n") + "\n\n"
@@ -72,9 +76,14 @@
 
 
 class HtmlBlockPreprocessor(Preprocessor):
-    """Remove html blocks from the text and store them for later retrieval."""
+    """
+    Remove html blocks from the text and store them for later retrieval.
+
+    The raw HTML is stored in the `htmlStash`markdown.util.HtmlStash of the
+    `Markdown`markdown.Markdown instance.
+    """
 
-    def run(self, lines):
+    def run(self, lines: liststr) -> liststr:
         source = '\n'.join(lines)
         parser = HTMLExtractor(self.md)
         parser.feed(source)

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/serializers.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/serializers.py Changed

@@ -1,6 +1,4 @@
-# markdown/searializers.py
-#
-# Add x/html serialization to Elementree
+# Add x/html serialization to `Elementree`
 # Taken from ElementTree 1.3 preview with slight modifications
 #
 # Copyright (c) 1999-2007 by Fredrik Lundh.  All rights reserved.
@@ -36,22 +34,25 @@
 # OF THIS SOFTWARE.
 # --------------------------------------------------------------------
 
+"""
+Python-Markdown provides two serializers which render `ElementTree.Element`xml.etree.ElementTree.Element
+objects to a string of HTML. Both functions wrap the same underlying code with only a few minor
+differences as outlined below:
+
+1. Empty (self-closing) tags are rendered as `<tag>` for HTML and as `<tag />` for XHTML.
+2. Boolean attributes are rendered as `attrname` for HTML and as `attrname="attrname"` for XHTML.
+"""
+
+from __future__ import annotations
 
 from xml.etree.ElementTree import ProcessingInstruction
-from xml.etree.ElementTree import Comment, ElementTree, QName
+from xml.etree.ElementTree import Comment, ElementTree, Element, QName, HTML_EMPTY
 import re
 
 __all__ = 'to_html_string', 'to_xhtml_string'
 
-HTML_EMPTY = ("area", "base", "basefont", "br", "col", "frame", "hr",
-              "img", "input", "isindex", "link", "meta", "param")
 RE_AMP = re.compile(r'&(?!(?:\#0-9+|\#x0-9a-f+|0-9a-z+);)', re.I)
 
-try:
-    HTML_EMPTY = set(HTML_EMPTY)
-except NameError:  # pragma: no cover
-    pass
-
 
 def _raise_serialization_error(text):  # pragma: no cover
     raise TypeError(
@@ -128,7 +129,7 @@
     else:
         namespace_uri = None
         if isinstance(tag, QName):
-            # QNAME objects store their data as a string: `{uri}tag`
+            # `QNAME` objects store their data as a string: `{uri}tag`
             if tag.text:1 == "{":
                 namespace_uri, tag = tag.text1:.split("}", 1)
             else:
@@ -139,10 +140,10 @@
             items = sorted(items)  # lexical order
             for k, v in items:
                 if isinstance(k, QName):
-                    # Assume a text only QName
+                    # Assume a text only `QName`
                     k = k.text
                 if isinstance(v, QName):
-                    # Assume a text only QName
+                    # Assume a text only `QName`
                     v = v.text
                 else:
                     v = _escape_attrib_html(v)
@@ -181,9 +182,12 @@
 # --------------------------------------------------------------------
 # public functions
 
-def to_html_string(element):
+
+def to_html_string(element: Element) -> str:
+    """ Serialize element and its children to a string of HTML5. """
     return _write_html(ElementTree(element).getroot(), format="html")
 
 
-def to_xhtml_string(element):
+def to_xhtml_string(element: Element) -> str:
+    """ Serialize element and its children to a string of XHTML. """
     return _write_html(ElementTree(element).getroot(), format="xhtml")

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/test_tools.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/test_tools.py Changed

@@ -1,28 +1,31 @@
-"""
-Python Markdown
+# Python Markdown
 
-A Python implementation of John Gruber's Markdown.
+# A Python implementation of John Gruber's Markdown.
 
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
+# Documentation: https://python-markdown.github.io/
+# GitHub: https://github.com/Python-Markdown/markdown/
+# PyPI: https://pypi.org/project/Markdown/
 
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# Copyright 2004 Manfred Stienstra (the original version)
 
-License: BSD (see LICENSE.md for details).
-"""
+# License: BSD (see LICENSE.md for details).
+
+""" A collection of tools for testing the Markdown code base and extensions. """
+
+from __future__ import annotations
 
 import os
 import sys
 import unittest
 import textwrap
+from typing import Any
 from . import markdown, Markdown, util
 
 try:
@@ -35,30 +38,31 @@
 
 class TestCase(unittest.TestCase):
     """
-    A unittest.TestCase subclass with helpers for testing Markdown output.
+    A `unittest.TestCase` subclass with helpers for testing Markdown output.
 
-    Define `default_kwargs` as a dict of keywords to pass to Markdown for each
+    Define `default_kwargs` as a `dict` of keywords to pass to Markdown for each
     test. The defaults can be overridden on individual tests.
 
     The `assertMarkdownRenders` method accepts the source text, the expected
     output, and any keywords to pass to Markdown. The `default_kwargs` are used
     except where overridden by `kwargs`. The output and expected output are passed
-    to `TestCase.assertMultiLineEqual`. An AssertionError is raised with a diff
+    to `TestCase.assertMultiLineEqual`. An `AssertionError` is raised with a diff
     if the actual output does not equal the expected output.
 
     The `dedent` method is available to dedent triple-quoted strings if
     necessary.
 
-    In all other respects, behaves as unittest.TestCase.
+    In all other respects, behaves as `unittest.TestCase`.
     """
 
-    default_kwargs = {}
+    default_kwargs: dictstr, Any = {}
+    """ Default options to pass to Markdown for each test. """
 
     def assertMarkdownRenders(self, source, expected, expected_attrs=None, **kwargs):
         """
         Test that source Markdown text renders to expected output with given keywords.
 
-        `expected_attrs` accepts a dict. Each key should be the name of an attribute
+        `expected_attrs` accepts a `dict`. Each key should be the name of an attribute
         on the `Markdown` instance and the value should be the expected value after
         the source text is parsed by Markdown. After the expected output is tested,
         the expected value for each attribute is compared against the actual
@@ -80,7 +84,7 @@
         """
 
         # TODO: If/when actual output ends with a newline, then use:
-        # return textwrap.dedent(text.strip('/n'))
+        #     return textwrap.dedent(text.strip('/n'))
         return textwrap.dedent(text).strip()
 
 
@@ -93,10 +97,12 @@
 
     Example usage:
 
-        with recursionlimit(20):
-            # test code here
+    ``` python
+    with recursionlimit(20):
+        # test code here
+    ```
 
-    See https://stackoverflow.com/a/50120316/866026
+    See <https://stackoverflow.com/a/50120316/866026>.
     """
 
     def __init__(self, limit):
@@ -116,12 +122,12 @@
 
 
 class Kwargs(dict):
-    """ A dict like class for holding keyword arguments. """
+    """ A `dict` like class for holding keyword arguments. """
     pass
 
 
 def _normalize_whitespace(text):
-    """ Normalize whitespace for a string of html using tidylib. """
+    """ Normalize whitespace for a string of HTML using `tidylib`. """
     output, errors = tidylib.tidy_fragment(text, options={
         'drop_empty_paras': 0,
         'fix_backslash': 0,
@@ -189,22 +195,20 @@
 
 class LegacyTestCase(unittest.TestCase, metaclass=LegacyTestMeta):
     """
-    A `unittest.TestCase` subclass for running Markdown's legacy file-based tests.
+    A `unittest.TestCase` subclass for running Markdown's legacy file-based tests.
 
     A subclass should define various properties which point to a directory of
     text-based test files and define various behaviors/defaults for those tests.
     The following properties are supported:
 
-    location: A path to the directory of test files. An absolute path is preferred.
-    exclude: A list of tests to exclude. Each test name should comprise the filename
-             without an extension.
-    normalize: A boolean value indicating if the HTML should be normalized.
-               Default: `False`.
-    input_ext: A string containing the file extension of input files. Default: `.txt`.
-    ouput_ext: A string containing the file extension of expected output files.
-               Default: `html`.
-    default_kwargs: A `Kwargs` instance which stores the default set of keyword
-                    arguments for all test files in the directory.
+    Attributes:
+        location (str): A path to the directory of test files. An absolute path is preferred.
+        exclude (liststr): A list of tests to exclude. Each test name should comprise the filename
+            without an extension.
+        normalize (bool): A boolean value indicating if the HTML should be normalized. Default: `False`.
+        input_ext (str): A string containing the file extension of input files. Default: `.txt`.
+        output_ext (str): A string containing the file extension of expected output files. Default: `html`.
+        default_kwargs (Kwargsstr, Any): The default set of keyword arguments for all test files in the directory.
 
     In addition, properties can be defined for each individual set of test files within
     the directory. The property should be given the name of the file without the file
@@ -214,7 +218,7 @@
     test file. The keyword arguments will "update" the `default_kwargs`.
 
     When the class instance is created, it will walk the given directory and create
-    a separate unitttest for each set of test files using the naming scheme:
-    `test_filename`. One unittest will be run for each set of input and output files.
+    a separate `Unitttest` for each set of test files using the naming scheme:
+    `test_filename`. One `Unittest` will be run for each set of input and output files.
     """
     pass

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/treeprocessors.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/treeprocessors.py Changed

@@ -1,32 +1,43 @@
-"""
-Python Markdown
+# Python Markdown
+
+# A Python implementation of John Gruber's Markdown.
 
-A Python implementation of John Gruber's Markdown.
+# Documentation: https://python-markdown.github.io/
+# GitHub: https://github.com/Python-Markdown/markdown/
+# PyPI: https://pypi.org/project/Markdown/
 
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
+# Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# Copyright 2004 Manfred Stienstra (the original version)
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# License: BSD (see LICENSE.md for details).
 
-License: BSD (see LICENSE.md for details).
 """
+Tree processors manipulate the tree created by block processors. They can even create an entirely
+new `ElementTree` object. This is an excellent place for creating summaries, adding collected
+references, or last minute adjustments.
+
+"""
+
+from __future__ import annotations
 
 import re
 import xml.etree.ElementTree as etree
+from typing import TYPE_CHECKING, Any
 from . import util
 from . import inlinepatterns
 
+if TYPE_CHECKING:  # pragma: no cover
+    from markdown import Markdown
 
-def build_treeprocessors(md, **kwargs):
-    """ Build the default treeprocessors for Markdown. """
+
+def build_treeprocessors(md: Markdown, **kwargs: Any) -> util.RegistryTreeprocessor:
+    """ Build the default  `treeprocessors` for Markdown. """
     treeprocessors = util.Registry()
     treeprocessors.register(InlineProcessor(md), 'inline', 20)
     treeprocessors.register(PrettifyTreeprocessor(md), 'prettify', 10)
@@ -34,8 +45,8 @@
     return treeprocessors
 
 
-def isString(s):
-    """ Check if it's string """
+def isString(s: Any) -> bool:
+    """ Return `True` if object is a string but not an  `AtomicString`markdown.util.AtomicString. """
     if not isinstance(s, util.AtomicString):
         return isinstance(s, str)
     return False
@@ -43,28 +54,27 @@
 
 class Treeprocessor(util.Processor):
     """
-    Treeprocessors are run on the ElementTree object before serialization.
+    `Treeprocessor`s are run on the `ElementTree` object before serialization.
 
-    Each Treeprocessor implements a "run" method that takes a pointer to an
-    ElementTree, modifies it as necessary and returns an ElementTree
-    object.
+    Each `Treeprocessor` implements a `run` method that takes a pointer to an
+    `Element` and modifies it as necessary.
 
-    Treeprocessors must extend markdown.Treeprocessor.
+    `Treeprocessors` must extend `markdown.Treeprocessor`.
 
     """
-    def run(self, root):
+    def run(self, root: etree.Element) -> etree.Element | None:
         """
-        Subclasses of Treeprocessor should implement a `run` method, which
-        takes a root ElementTree. This method can return another ElementTree
-        object, and the existing root ElementTree will be replaced, or it can
-        modify the current tree and return None.
+        Subclasses of `Treeprocessor` should implement a `run` method, which
+        takes a root `Element`. This method can return another `Element`
+        object, and the existing root `Element` will be replaced, or it can
+        modify the current tree and return `None`.
         """
         pass  # pragma: no cover
 
 
 class InlineProcessor(Treeprocessor):
     """
-    A Treeprocessor that traverses a tree, applying inline patterns.
+    A `Treeprocessor` that traverses a tree, applying inline patterns.
     """
 
     def __init__(self, md):
@@ -77,22 +87,22 @@
         self.inlinePatterns = md.inlinePatterns
         self.ancestors = 
 
-    def __makePlaceholder(self, type):
+    def __makePlaceholder(self, type) -> tuplestr, str:
         """ Generate a placeholder """
         id = "%04d" % len(self.stashed_nodes)
         hash = util.INLINE_PLACEHOLDER % id
         return hash, id
 
-    def __findPlaceholder(self, data, index):
+    def __findPlaceholder(self, data: str, index: int) -> tuplestr | None, int:
         """
-        Extract id from data string, start from index
-
-        Keyword arguments:
+        Extract id from data string, start from index.
 
-        * data: string
-        * index: index, from which we start search
+        Arguments:
+            data: String.
+            index: Index, from which we start search.
 
-        Returns: placeholder id and string index, after the found placeholder.
+        Returns:
+            Placeholder id and string index, after the found placeholder.
 
         """
         m = self.__placeholder_re.search(data, index)
@@ -101,23 +111,22 @@
         else:
             return None, index + 1
 
-    def __stashNode(self, node, type):
-        """ Add node to stash """
+    def __stashNode(self, node, type) -> str:
+        """ Add node to stash. """
         placeholder, id = self.__makePlaceholder(type)
         self.stashed_nodesid = node
         return placeholder
 
-    def __handleInline(self, data, patternIndex=0):
+    def __handleInline(self, data: str, patternIndex: int = 0) -> str:
         """
-        Process string with inline patterns and replace it
-        with placeholders
-
-        Keyword arguments:
+        Process string with inline patterns and replace it with placeholders.
 
-        * data: A line of Markdown text
-        * patternIndex: The index of the inlinePattern to start with
+        Arguments:
+            data: A line of Markdown text.
+            patternIndex: The index of the `inlinePattern` to start with.
 
-        Returns: String with placeholders.
+        Returns:
+            String with placeholders.
 
         """
         if not isinstance(data, util.AtomicString):
@@ -131,18 +140,15 @@
                     patternIndex += 1
         return data
 
-    def __processElementText(self, node, subnode, isText=True):
+    def __processElementText(self, node: etree.Element, subnode: etree.Element, isText: bool = True):
         """
-        Process placeholders in Element.text or Element.tail
-        of Elements popped from self.stashed_nodes.
-
-        Keywords arguments:
-
-        * node: parent node
-        * subnode: processing node
-        * isText: bool variable, True - it's text, False - it's tail
+        Process placeholders in `Element.text` or `Element.tail`
+        of Elements popped from `self.stashed_nodes`.
 
-        Returns: None
+        Arguments:
+            node: Parent node.
+            subnode: Processing node.
+            isText: Boolean variable, True - it's text, False - it's a tail.
 
         """
         if isText:

_service:tar_scm:Markdown-3.4.1.tar.gz/markdown/util.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/markdown/util.py Changed

@@ -1,30 +1,40 @@
-"""
-Python Markdown
+# Python Markdown
+
+# A Python implementation of John Gruber's Markdown.
 
-A Python implementation of John Gruber's Markdown.
+# Documentation: https://python-markdown.github.io/
+# GitHub: https://github.com/Python-Markdown/markdown/
+# PyPI: https://pypi.org/project/Markdown/
 
-Documentation: https://python-markdown.github.io/
-GitHub: https://github.com/Python-Markdown/markdown/
-PyPI: https://pypi.org/project/Markdown/
+# Started by Manfred Stienstra (http://www.dwerg.net/).
+# Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
+# Currently maintained by Waylan Limberg (https://github.com/waylan),
+# Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Started by Manfred Stienstra (http://www.dwerg.net/).
-Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
-Currently maintained by Waylan Limberg (https://github.com/waylan),
-Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
+# Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
+# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
+# Copyright 2004 Manfred Stienstra (the original version)
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
-Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
-Copyright 2004 Manfred Stienstra (the original version)
+# License: BSD (see LICENSE.md for details).
 
-License: BSD (see LICENSE.md for details).
+"""
+This module contains various contacts, classes and functions which get referenced and used
+throughout the code base.
 """
 
+from __future__ import annotations
+
 import re
 import sys
 import warnings
-from collections import namedtuple
 from functools import wraps, lru_cache
 from itertools import count
+from typing import TYPE_CHECKING, Generic, Iterator, NamedTuple, TypeVar, overload
+
+if TYPE_CHECKING:  # pragma: no cover
+    from markdown import Markdown
+
+_T = TypeVar('_T')
 
 
 """
@@ -33,7 +43,7 @@
 """
 
 
-BLOCK_LEVEL_ELEMENTS = 
+BLOCK_LEVEL_ELEMENTS: liststr = 
     # Elements which are invalid to wrap in a `<p>` tag.
     # See https://w3c.github.io/html/grouping-content.html#the-p-element
     'address', 'article', 'aside', 'blockquote', 'details', 'div', 'dl',
@@ -41,27 +51,39 @@
     'h4', 'h5', 'h6', 'header', 'hgroup', 'hr', 'main', 'menu', 'nav', 'ol',
     'p', 'pre', 'section', 'table', 'ul',
     # Other elements which Markdown should not be mucking up the contents of.
-    'canvas', 'colgroup', 'dd', 'body', 'dt', 'group', 'iframe', 'li', 'legend',
+    'canvas', 'colgroup', 'dd', 'body', 'dt', 'group', 'html', 'iframe', 'li', 'legend',
     'math', 'map', 'noscript', 'output', 'object', 'option', 'progress', 'script',
-    'style', 'tbody', 'td', 'textarea', 'tfoot', 'th', 'thead', 'tr', 'video'
+    'style', 'summary', 'tbody', 'td', 'textarea', 'tfoot', 'th', 'thead', 'tr', 'video'
 
+"""
+List of HTML tags which get treated as block-level elements. Same as the `block_level_elements`
+attribute of the `Markdown`markdown.Markdown class. Generally one should use the
+attribute on the class. This remains for compatibility with older extensions.
+"""
 
 # Placeholders
-STX = '\u0002'  # Use STX ("Start of text") for start-of-placeholder
-ETX = '\u0003'  # Use ETX ("End of text") for end-of-placeholder
+STX = '\u0002'
+""" "Start of Text" marker for placeholder templates. """
+ETX = '\u0003'
+""" "End of Text" marker for placeholder templates. """
 INLINE_PLACEHOLDER_PREFIX = STX+"klzzwxh:"
+""" Prefix for inline placeholder template. """
 INLINE_PLACEHOLDER = INLINE_PLACEHOLDER_PREFIX + "%s" + ETX
+""" Placeholder template for stashed inline text. """
 INLINE_PLACEHOLDER_RE = re.compile(INLINE_PLACEHOLDER % r'(0-9+)')
+""" Regular Expression which matches inline placeholders. """
 AMP_SUBSTITUTE = STX+"amp"+ETX
+""" Placeholder template for HTML entities. """
 HTML_PLACEHOLDER = STX + "wzxhzdk:%s" + ETX
+""" Placeholder template for raw HTML. """
 HTML_PLACEHOLDER_RE = re.compile(HTML_PLACEHOLDER % r'(0-9+)')
+""" Regular expression which matches HTML placeholders. """
 TAG_PLACEHOLDER = STX + "hzzhzkh:%s" + ETX
+""" Placeholder template for tags. """
 
 
-"""
-Constants you probably do not need to change
------------------------------------------------------------------------------
-"""
+# Constants you probably do not need to change
+# -----------------------------------------------------------------------------
 
 RTL_BIDI_RANGES = (
     ('\u0590', '\u07FF'),
@@ -72,30 +94,32 @@
 )
 
 
-"""
-AUXILIARY GLOBAL FUNCTIONS
-=============================================================================
-"""
+# AUXILIARY GLOBAL FUNCTIONS
+# =============================================================================
 
 
 @lru_cache(maxsize=None)
 def get_installed_extensions():
+    """ Return all entry_points in the `markdown.extensions` group. """
     if sys.version_info >= (3, 10):
         from importlib import metadata
-    else:  # <PY310 use backport
+    else:  # `<PY310` use backport
         import importlib_metadata as metadata
     # Only load extension entry_points once.
     return metadata.entry_points(group='markdown.extensions')
 
 
-def deprecated(message, stacklevel=2):
+def deprecated(message: str, stacklevel: int = 2):
     """
-    Raise a DeprecationWarning when wrapped function/method is called.
+    Raise a `DeprecationWarning` when wrapped function/method is called.
 
     Usage:
-        @deprecated("This method will be removed in version X; use Y instead.")
-        def some_method()"
-            pass
+
+    ```python
+    @deprecated("This method will be removed in version X; use Y instead.")
+    def some_method():
+        pass
+    ```
     """
     def wrapper(func):
         @wraps(func)
@@ -110,11 +134,11 @@
     return wrapper
 
 
-def parseBoolValue(value, fail_on_errors=True, preserve_none=False):
-    """Parses a string representing bool value. If parsing was successful,
-       returns True or False. If preserve_none=True, returns True, False,
-       or None. If parsing was not successful, raises  ValueError, or, if
-       fail_on_errors=False, returns None."""
+def parseBoolValue(value: str | None, fail_on_errors: bool = True, preserve_none: bool = False) -> bool | None:
+    """Parses a string representing a boolean value. If parsing was successful,
+       returns `True` or `False`. If `preserve_none=True`, returns `True`, `False`,
+       or `None`. If parsing was not successful, raises `ValueError`, or, if
+       `fail_on_errors=False`, returns `None`."""
     if not isinstance(value, str):
         if preserve_none and value is None:
             return value
@@ -129,8 +153,8 @@
         raise ValueError('Cannot parse bool value: %r' % value)
 
 
-def code_escape(text):
-    """Escape code."""
+def code_escape(text: str) -> str:
+    """HTML escape a string of code."""
     if "&" in text:
         text = text.replace("&", "&amp;")
     if "<" in text:
@@ -151,15 +175,13 @@
             return size
 
 
-def nearing_recursion_limit():
+def nearing_recursion_limit() -> bool:
     """Return true if current stack depth is within 100 of maximum limit."""
     return sys.getrecursionlimit() - _get_stack_depth() < 100
 
 
-"""
-MISC AUXILIARY CLASSES
-=============================================================================
-"""
+# MISC AUXILIARY CLASSES
+# =============================================================================

_service:tar_scm:Markdown-3.4.1.tar.gz/mkdocs.yml -> _service:tar_scm:Markdown-3.5.1.tar.gz/mkdocs.yml Changed

@@ -2,9 +2,10 @@
 site_url: https://Python-Markdown.github.io/
 repo_url: https://github.com/Python-Markdown/markdown
 site_author: "The Python-Markdown Project"
-copyright: "Copyright &copy; 2010-2017"
+copyright: "Copyright &copy; 2010-2023"
 
 use_directory_urls: true
+watch: markdown, scripts
 
 theme:
   name: nature
@@ -12,6 +13,10 @@
   release: !!python/name:markdown.__version__
   issue_tracker: https://github.com/Python-Markdown/markdown/issues
 
+extra_css:
+  - custom.css
+  - mkdocstrings.css
+
 nav:
   - Python-Markdown: index.md
   - Installation: install.md
@@ -39,22 +44,14 @@
       - WikiLinks: extensions/wikilinks.md
   - Extension API: extensions/api.md
   - Test Tools: test_tools.md
+  - API Reference: reference/
   - Contributing to Python-Markdown: contributing.md
-  - Change Log: change_log/index.md
-  - Release Notes for v.3.4: change_log/release-3.4.md
-  - Release Notes for v.3.3: change_log/release-3.3.md
-  - Release Notes for v.3.2: change_log/release-3.2.md
-  - Release Notes for v.3.1: change_log/release-3.1.md
-  - Release Notes for v.3.0: change_log/release-3.0.md
-  - Release Notes for v.2.6: change_log/release-2.6.md
-  - Release Notes for v.2.5: change_log/release-2.5.md
-  - Release Notes for v.2.4: change_log/release-2.4.md
-  - Release Notes for v.2.3: change_log/release-2.3.md
-  - Release Notes for v.2.2: change_log/release-2.2.md
-  - Release Notes for v.2.1: change_log/release-2.1.md
-  - Release Notes for v.2.0: change_log/release-2.0.md
+  - Changelog: changelog.md
   - Authors: authors.md
 
+not_in_nav: |
+  change_log/
+
 markdown_extensions:
   - extra
   - admonition
@@ -62,3 +59,54 @@
   - codehilite
   - toc:
       permalink: true
+  - mdx_gh_links:
+      user: Python-Markdown
+      repo: markdown
+
+plugins:
+- gen-files:
+    scripts:
+    - scripts/gen_ref_nav.py
+- literate-nav:
+    nav_file: SUMMARY.md
+- section-index
+- mkdocstrings:
+    custom_templates: docs/templates
+    handlers:
+      python:
+        import:
+        - https://docs.python.org/3/objects.inv
+        options:
+          annotations_path: brief
+          docstring_options:
+            ignore_init_summary: true
+          docstring_style: google
+          docstring_section_style: list
+          extensions:
+          - scripts/griffe_extensions.py:DeprecatedExtension
+          - scripts/griffe_extensions.py:PriorityTableExtension:
+              paths:
+                - markdown.preprocessors.build_preprocessors
+                - markdown.blockprocessors.build_block_parser
+                - markdown.treeprocessors.build_treeprocessors
+                - markdown.inlinepatterns.build_inlinepatterns
+                - markdown.postprocessors.build_postprocessors
+          filters: "!^_"
+          group_by_category: false
+          heading_level: 1
+          inherited_members: true
+          members_order: source
+          merge_init_into_class: true
+          separate_signature: false
+          show_root_heading: true
+          show_object_full_path: true
+          show_signature_annotations: true
+          show_source: false
+          show_symbol_type_heading: true
+          show_symbol_type_toc: true
+          signature_crossrefs: false
+          summary: true
+          source:
+            repo: https://github.com/Python-Markdown/markdown
+            tag: !!python/name:markdown.__version__
+            title: "View source code on GitHub."

_service:tar_scm:Markdown-3.4.1.tar.gz/pyproject.toml -> _service:tar_scm:Markdown-3.5.1.tar.gz/pyproject.toml Changed

@@ -1,4 +1,99 @@
 build-system
 # Minimum requirements for the build system to execute.
-requires = "setuptools>=36.6", "wheel"
+requires = "setuptools>=61.2"
 build-backend = "setuptools.build_meta"
+
+project
+name = 'Markdown'
+dynamic = 'version'
+description = "Python implementation of John Gruber's Markdown."
+readme = {file = 'README.md', content-type='text/markdown'}
+authors = 
+    {name = 'Manfred Stienstra'},
+    {name = 'Yuri Takhteyev'},
+    {name = 'Waylan limberg', email = 'python.markdown@gmail.com'}
+
+maintainers = 
+    {name = 'Waylan Limberg', email = 'python.markdown@gmail.com'},
+    {name = 'Isaac Muse'}
+
+license = {file = 'LICENSE.md'}
+requires-python = '>=3.8'
+dependencies = 
+    "importlib-metadata>=4.4;python_version<'3.10'"
+
+keywords = 'markdown', 'markdown-parser', 'python-markdown', 'markdown-to-html'
+classifiers = 
+    'Development Status :: 5 - Production/Stable',
+    'License :: OSI Approved :: BSD License',
+    'Operating System :: OS Independent',
+    'Programming Language :: Python',
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.8',
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
+    'Programming Language :: Python :: 3 :: Only',
+    'Programming Language :: Python :: Implementation :: CPython',
+    'Programming Language :: Python :: Implementation :: PyPy',
+    'Topic :: Communications :: Email :: Filters',
+    'Topic :: Internet :: WWW/HTTP :: Dynamic Content :: CGI Tools/Libraries',
+    'Topic :: Internet :: WWW/HTTP :: Site Management',
+    'Topic :: Software Development :: Documentation',
+    'Topic :: Software Development :: Libraries :: Python Modules',
+    'Topic :: Text Processing :: Filters',
+    'Topic :: Text Processing :: Markup :: HTML',
+    'Topic :: Text Processing :: Markup :: Markdown'
+
+
+project.optional-dependencies
+testing = 
+    'coverage',
+    'pyyaml'
+
+docs = 
+    'mkdocs>=1.5',
+    'mkdocs-nature>=0.6',
+    'mdx_gh_links>=0.2',
+    "mkdocstringspython",
+    "mkdocs-gen-files",
+    "mkdocs-section-index",
+    "mkdocs-literate-nav",
+
+
+project.urls
+'Homepage' = 'https://Python-Markdown.github.io/'
+'Documentation' = 'https://Python-Markdown.github.io/'
+'Repository' = 'https://github.com/Python-Markdown/markdown'
+'Issue Tracker' = 'https://github.com/Python-Markdown/markdown/issues'
+'Changelog' = 'https://github.com/Python-Markdown/markdown/blob/master/docs/change_log/index.md'
+
+project.scripts
+markdown_py = 'markdown.__main__:run'
+
+project.entry-points.'markdown.extensions'
+abbr = 'markdown.extensions.abbr:AbbrExtension'
+admonition = 'markdown.extensions.admonition:AdmonitionExtension'
+attr_list = 'markdown.extensions.attr_list:AttrListExtension'
+codehilite = 'markdown.extensions.codehilite:CodeHiliteExtension'
+def_list = 'markdown.extensions.def_list:DefListExtension'
+extra = 'markdown.extensions.extra:ExtraExtension'
+fenced_code = 'markdown.extensions.fenced_code:FencedCodeExtension'
+footnotes = 'markdown.extensions.footnotes:FootnoteExtension'
+md_in_html = 'markdown.extensions.md_in_html:MarkdownInHtmlExtension'
+meta = 'markdown.extensions.meta:MetaExtension'
+nl2br = 'markdown.extensions.nl2br:Nl2BrExtension'
+sane_lists = 'markdown.extensions.sane_lists:SaneListExtension'
+smarty = 'markdown.extensions.smarty:SmartyExtension'
+tables = 'markdown.extensions.tables:TableExtension'
+toc = 'markdown.extensions.toc:TocExtension'
+wikilinks = 'markdown.extensions.wikilinks:WikiLinkExtension'
+legacy_attrs = 'markdown.extensions.legacy_attrs:LegacyAttrExtension'
+legacy_em = 'markdown.extensions.legacy_em:LegacyEmExtension'
+
+tool.setuptools
+packages = 'markdown', 'markdown.extensions'
+
+tool.setuptools.dynamic
+version = {attr = 'markdown.__meta__.__version__'}

_service:tar_scm:Markdown-3.4.1.tar.gz/setup.cfg -> _service:tar_scm:Markdown-3.5.1.tar.gz/setup.cfg Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/__init__.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/__init__.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_apis.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_apis.py Changed

@@ -12,7 +12,7 @@
 Currently maintained by Waylan Limberg (https://github.com/waylan),
 Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
+Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
 Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
 Copyright 2004 Manfred Stienstra (the original version)
 
@@ -21,7 +21,7 @@
 Python-Markdown Regression Tests
 ================================
 
-Tests of the various APIs with the python markdown lib.
+Tests of the various APIs with the Python Markdown library.
 """
 
 import unittest
@@ -122,7 +122,7 @@
         self.parser = markdown.Markdown().parser
 
     def testParseChunk(self):
-        """ Test BlockParser.parseChunk. """
+        """ Test `BlockParser.parseChunk`. """
         root = etree.Element("div")
         text = 'foo'
         self.parser.parseChunk(root, text)
@@ -132,7 +132,7 @@
         )
 
     def testParseDocument(self):
-        """ Test BlockParser.parseDocument. """
+        """ Test `BlockParser.parseDocument`. """
         lines = '#foo', '', 'bar', '', '    baz'
         tree = self.parser.parseDocument(lines)
         self.assertIsInstance(tree, etree.ElementTree)
@@ -144,7 +144,7 @@
 
 
 class TestBlockParserState(unittest.TestCase):
-    """ Tests of the State class for BlockParser. """
+    """ Tests of the State class for `BlockParser`. """
 
     def setUp(self):
         self.state = markdown.blockparser.State()
@@ -161,7 +161,7 @@
         self.assertEqual(self.state, 'a_state', 'state2')
 
     def testIsSate(self):
-        """ Test State.isstate(). """
+        """ Test `State.isstate()`. """
         self.assertEqual(self.state.isstate('anything'), False)
         self.state.set('a_state')
         self.assertEqual(self.state.isstate('a_state'), True)
@@ -171,7 +171,7 @@
         self.assertEqual(self.state.isstate('missing'), False)
 
     def testReset(self):
-        """ Test State.reset(). """
+        """ Test `State.reset()`. """
         self.state.set('a_state')
         self.state.reset()
         self.assertEqual(self.state, )
@@ -182,20 +182,20 @@
 
 
 class TestHtmlStash(unittest.TestCase):
-    """ Test Markdown's HtmlStash. """
+    """ Test Markdown's `HtmlStash`. """
 
     def setUp(self):
         self.stash = markdown.util.HtmlStash()
         self.placeholder = self.stash.store('foo')
 
     def testSimpleStore(self):
-        """ Test HtmlStash.store. """
+        """ Test `HtmlStash.store`. """
         self.assertEqual(self.placeholder, self.stash.get_placeholder(0))
         self.assertEqual(self.stash.html_counter, 1)
         self.assertEqual(self.stash.rawHtmlBlocks, 'foo')
 
     def testStoreMore(self):
-        """ Test HtmlStash.store with additional blocks. """
+        """ Test `HtmlStash.store` with additional blocks. """
         placeholder = self.stash.store('bar')
         self.assertEqual(placeholder, self.stash.get_placeholder(1))
         self.assertEqual(self.stash.html_counter, 2)
@@ -205,14 +205,14 @@
         )
 
     def testReset(self):
-        """ Test HtmlStash.reset. """
+        """ Test `HtmlStash.reset`. """
         self.stash.reset()
         self.assertEqual(self.stash.html_counter, 0)
         self.assertEqual(self.stash.rawHtmlBlocks, )
 
 
 class Item:
-    """ A dummy Registry item object for testing. """
+    """ A dummy `Registry` item object for testing. """
     def __init__(self, data):
         self.data = data
 
@@ -272,11 +272,11 @@
         self.assertEqual(len(r), 2)
         r.deregister('c', strict=False)
         self.assertEqual(len(r), 1)
-        # deregister non-existent item with strict=False
+        # deregister non-existent item with `strict=False`
         r.deregister('d', strict=False)
         self.assertEqual(len(r), 1)
         with self.assertRaises(ValueError):
-            # deregister non-existent item with strict=True
+            # deregister non-existent item with `strict=True`
             r.deregister('e')
         self.assertEqual(list(r), 'a')
 
@@ -396,7 +396,7 @@
         )
 
     def testBaseExtention(self):
-        """ Test that the base Extension class will raise NotImplemented. """
+        """ Test that the base Extension class will raise `NotImplemented`. """
         self.assertRaises(
             NotImplementedError,
             markdown.Markdown, extensions=markdown.extensions.Extension()
@@ -405,11 +405,11 @@
 
 class testETreeComments(unittest.TestCase):
     """
-    Test that ElementTree Comments work.
+    Test that `ElementTree` Comments work.
 
-    These tests should only be a concern when using cElementTree with third
+    These tests should only be a concern when using `cElementTree` with third
     party serializers (including markdown's (x)html serializer). While markdown
-    doesn't use ElementTree.Comment itself, we should certainly support any
+    doesn't use `ElementTree.Comment` itself, we should certainly support any
     third party extensions which may. Therefore, these tests are included to
     ensure such support is maintained.
     """
@@ -419,23 +419,23 @@
         self.comment = etree.Comment('foo')
 
     def testCommentIsComment(self):
-        """ Test that an ElementTree Comment passes the `is Comment` test. """
+        """ Test that an `ElementTree` `Comment` passes the `is Comment` test. """
         self.assertIs(self.comment.tag, etree.Comment)
 
     def testCommentIsBlockLevel(self):
-        """ Test that an ElementTree Comment is recognized as BlockLevel. """
+        """ Test that an `ElementTree` `Comment` is recognized as `BlockLevel`. """
         md = markdown.Markdown()
         self.assertIs(md.is_block_level(self.comment.tag), False)
 
     def testCommentSerialization(self):
-        """ Test that an ElementTree Comment serializes properly. """
+        """ Test that an `ElementTree` `Comment` serializes properly. """
         self.assertEqual(
             markdown.serializers.to_html_string(self.comment),
             ''
         )
 
     def testCommentPrettify(self):
-        """ Test that an ElementTree Comment is prettified properly. """
+        """ Test that an `ElementTree` `Comment` is prettified properly. """
         pretty = markdown.treeprocessors.PrettifyTreeprocessor(markdown.Markdown())
         pretty.run(self.comment)
         self.assertEqual(
@@ -450,7 +450,7 @@
         self.pretty = markdown.treeprocessors.PrettifyTreeprocessor(markdown.Markdown())
 
     def testBrTailNoNewline(self):
-        """ Test that last <br> in tree has a new line tail """
+        """ Test that last `<br>` in tree has a new line tail """
         root = etree.Element('root')
         br = etree.SubElement(root, 'br')
         self.assertEqual(br.tail, None)
@@ -459,7 +459,7 @@
 
 
 class testElementPreCodeTests(unittest.TestCase):
-    """ Element PreCode Tests """
+    """ Element `PreCode` Tests """
     def setUp(self):
         md = markdown.Markdown()
         self.pretty = markdown.treeprocessors.PrettifyTreeprocessor(md)
@@ -557,7 +557,7 @@
         )
 
     def testProsessingInstruction(self):
-        """ Test serialization of ProcessignInstruction. """
+        """ Test serialization of `ProcessignInstruction`. """
         pi = ProcessingInstruction('foo', text='<&"test\nescaping">')
         self.assertIs(pi.tag, ProcessingInstruction)
         self.assertEqual(
@@ -566,7 +566,7 @@
         )

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_extensions.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_extensions.py Changed

@@ -12,7 +12,7 @@
 Currently maintained by Waylan Limberg (https://github.com/waylan),
 Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
+Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
 Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
 Copyright 2004 Manfred Stienstra (the original version)
 
@@ -22,7 +22,7 @@
 ==========================================
 
 A collection of regression tests to confirm that the included extensions
-continue to work as advertised. This used to be accomplished by doctests.
+continue to work as advertised. This used to be accomplished by `doctests`.
 """
 
 import unittest
@@ -77,7 +77,7 @@
         self.assertEqual(self.ext.getConfigs(), {'foo': 'baz', 'bar': 'baz'})
 
     def testSetConfigWithBadKey(self):
-        # self.ext.setConfig('bad', 'baz) ==> KeyError
+        # `self.ext.setConfig('bad', 'baz)` => `KeyError`
         self.assertRaises(KeyError, self.ext.setConfig, 'bad', 'baz')
 
     def testConfigAsKwargsOnInit(self):
@@ -115,7 +115,7 @@
 
 
 class TestMetaData(unittest.TestCase):
-    """ Test MetaData extension. """
+    """ Test `MetaData` extension. """
 
     def setUp(self):
         self.md = markdown.Markdown(extensions='meta')
@@ -196,14 +196,14 @@
 
 
 class TestWikiLinks(unittest.TestCase):
-    """ Test Wikilinks Extension. """
+    """ Test `Wikilinks` Extension. """
 
     def setUp(self):
         self.md = markdown.Markdown(extensions='wikilinks')
         self.text = "Some text with a WikiLink."
 
     def testBasicWikilinks(self):
-        """ Test wikilinks. """
+        """ Test `wikilinks`. """
 
         self.assertEqual(
             self.md.convert(self.text),
@@ -212,7 +212,7 @@
         )
 
     def testWikilinkWhitespace(self):
-        """ Test whitespace in wikilinks. """
+        """ Test whitespace in `wikilinks`. """
         self.assertEqual(
             self.md.convert(' foo bar_baz '),
             '<p><a class="wikilink" href="/foo_bar_baz/">foo bar_baz</a></p>'
@@ -257,7 +257,7 @@
         )
 
     def testWikilinksMetaData(self):
-        """ test MetaData with Wikilinks Extension. """
+        """ test `MetaData` with `Wikilinks` Extension. """
 
         text = """wiki_base_url: http://example.com/
 wiki_end_url:   .html
@@ -271,7 +271,7 @@
             '<a href="http://example.com/WikiLink.html">WikiLink</a>.</p>'
         )
 
-        # MetaData should not carry over to next document:
+        # `MetaData` should not carry over to next document:
         self.assertEqual(
             md.convert("No MetaData here."),
             '<p>No <a class="wikilink" href="/MetaData/">MetaData</a> '
@@ -548,7 +548,7 @@
         )
 
     def testWithAttrList(self):
-        """ Test TOC with attr_list Extension. """
+        """ Test TOC with `attr_list` Extension. """
         md = markdown.Markdown(extensions='toc', 'attr_list')
         text = ('# Header 1\n\n'
                 '## Header 2 { #foo }\n\n'
@@ -630,6 +630,86 @@
             '<h1 id="toc"><em>TOC</em></h1>'          # noqa
         )
 
+    def testPermalink(self):
+        """ Test TOC `permalink` feature. """
+        text = '# Hd 1\n\n## Hd 2'
+        md = markdown.Markdown(
+            extensions=markdown.extensions.toc.TocExtension(
+                permalink=True, permalink_title="PL")
+        )
+        self.assertEqual(
+            md.convert(text),
+            '<h1 id="hd-1">'
+                'Hd 1'                                            # noqa
+                '<a class="headerlink" href="#hd-1" title="PL">'  # noqa
+                    '&para;'                                      # noqa
+                '</a>'                                            # noqa
+            '</h1>\n'
+            '<h2 id="hd-2">'
+                'Hd 2'                                            # noqa
+                '<a class="headerlink" href="#hd-2" title="PL">'  # noqa
+                    '&para;'                                      # noqa
+                '</a>'                                            # noqa
+            '</h2>'
+        )
+
+    def testPermalinkLeading(self):
+        """ Test TOC `permalink` with `permalink_leading` option. """
+        text = '# Hd 1\n\n## Hd 2'
+        md = markdown.Markdown(extensions=
+            markdown.extensions.toc.TocExtension(
+                permalink=True, permalink_title="PL", permalink_leading=True)
+        )
+        self.assertEqual(
+            md.convert(text),
+            '<h1 id="hd-1">'
+                '<a class="headerlink" href="#hd-1" title="PL">'  # noqa
+                    '&para;'                                      # noqa
+                '</a>'                                            # noqa
+                'Hd 1'                                            # noqa
+            '</h1>\n'
+            '<h2 id="hd-2">'
+                '<a class="headerlink" href="#hd-2" title="PL">'  # noqa
+                    '&para;'                                      # noqa
+                '</a>'                                            # noqa
+                'Hd 2'                                            # noqa
+            '</h2>'
+        )
+
+    def testInlineMarkupPermalink(self):
+        """ Test TOC `permalink` with headers containing markup. """
+        text = '# Code `in` hd'
+        md = markdown.Markdown(
+            extensions=markdown.extensions.toc.TocExtension(
+                permalink=True, permalink_title="PL")
+        )
+        self.assertEqual(
+            md.convert(text),
+            '<h1 id="code-in-hd">'
+                'Code <code>in</code> hd'                               # noqa
+                '<a class="headerlink" href="#code-in-hd" title="PL">'  # noqa
+                    '&para;'                                            # noqa
+                '</a>'                                                  # noqa
+            '</h1>'
+        )
+
+    def testInlineMarkupPermalinkLeading(self):
+        """ Test TOC `permalink_leading` with headers containing markup. """
+        text = '# Code `in` hd'
+        md = markdown.Markdown(extensions=
+            markdown.extensions.toc.TocExtension(
+                permalink=True, permalink_title="PL", permalink_leading=True)
+        )
+        self.assertEqual(
+            md.convert(text),
+            '<h1 id="code-in-hd">'
+                '<a class="headerlink" href="#code-in-hd" title="PL">'  # noqa
+                    '&para;'                                            # noqa
+                '</a>'                                                  # noqa
+                'Code <code>in</code> hd'                               # noqa
+            '</h1>'
+        )
+
 
 class TestSmarty(unittest.TestCase):
     def setUp(self):
@@ -640,7 +720,7 @@
                     'ndash': '\u2013',
                     'mdash': '\u2014',
                     'ellipsis': '\u2026',
-                    'left-single-quote': '&sbquo;',  # sb is not a typo!
+                    'left-single-quote': '&sbquo;',  # `sb` is not a typo!
                     'right-single-quote': '&lsquo;',
                     'left-double-quote': '&bdquo;',
                     'right-double-quote': '&ldquo;',

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_legacy.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_legacy.py Changed

@@ -12,7 +12,7 @@
 Currently maintained by Waylan Limberg (https://github.com/waylan),
 Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
+Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
 Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
 Copyright 2004 Manfred Stienstra (the original version)
 
@@ -46,27 +46,27 @@
 
     Quotes in attributes: attributes get output in different order
 
-    Inline HTML (Span): Backtick in raw HTML attribute TODO: fixme
+    Inline HTML (Span): Backtick in raw HTML attribute TODO: fix me
 
     Backslash escapes: Weird whitespace issue in output
 
-    Ins & del: Our behavior follows markdown.pl I think PHP is wrong here
+    `Ins` & `del`: Our behavior follows `markdown.pl`. I think PHP is wrong here
 
-    Auto Links: TODO: fix raw HTML so is doesn't match <hr@example.com> as a <hr>.
+    Auto Links: TODO: fix raw HTML so is doesn't match <hr@example.com> as a `<hr>`.
 
-    Empty List Item: We match markdown.pl here. Maybe someday we'll support this
+    Empty List Item: We match `markdown.pl` here. Maybe someday we'll support this
 
     Headers: TODO: fix headers to not require blank line before
 
-    Mixed OLs and ULs: We match markdown.pl here. I think PHP is wrong here
+    Mixed `OL`s and `UL`s: We match `markdown.pl` here. I think PHP is wrong here
 
     Emphasis: We have various minor differences in combined & incorrect em markup.
     Maybe fix a few of them - but most aren't too important
 
-    Code block in a list item: We match markdown.pl - not sure how php gets that output??
+    Code block in a list item: We match `markdown.pl` - not sure how PHP gets that output??
 
     PHP-Specific Bugs: Not sure what to make of the escaping stuff here.
-    Why is PHP not removing a blackslash?
+    Why is PHP not removing a backslash?
     """
     location = os.path.join(parent_test_dir, 'php')
     normalize = True
@@ -87,14 +87,6 @@
     
 
 
-# class TestPhpExtra(LegacyTestCase):
-#     location = os.path.join(parent_test_dir, 'php/extra')
-#     normalize = True
-#     input_ext = '.text'
-#     output_ext = '.xhtml'
-#     default_kwargs = Kwargs(extensions='extra')
-
-
 class TestPl2004(LegacyTestCase):
     location = os.path.join(parent_test_dir, 'pl/Tests_2004')
     normalize = True
@@ -110,11 +102,11 @@
 
     Code Blocks: some weird whitespace issue
 
-    Links, reference style: weird issue with nested brackets TODO: fixme
+    Links, reference style: weird issue with nested brackets TODO: fix me
 
-    Backslash escapes: backticks in raw html attributes TODO: fixme
+    Backslash escapes: backticks in raw html attributes TODO: fix me
 
-    Code Spans: more backticks in raw html attributes TODO: fixme
+    Code Spans: more backticks in raw html attributes TODO: fix me
     """
     location = os.path.join(parent_test_dir, 'pl/Tests_2007')
     normalize = True
@@ -164,11 +156,6 @@
 
     admonition = Kwargs(extensions='admonition')
 
-    smarty = Kwargs(
-        extensions='smarty',
-        extension_configs={'smarty': {'smart_angled_quotes': True}}
-    )
-
 
 class TestExtensionsExtra(LegacyTestCase):
     location = os.path.join(parent_test_dir, 'extensions/extra')

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_meta.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_meta.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/__init__.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/__init__.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/blocks/__init__.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/blocks/__init__.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/blocks/test_blockquotes.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/blocks/test_blockquotes.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/blocks/test_code_blocks.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/blocks/test_code_blocks.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/blocks/test_headers.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/blocks/test_headers.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/blocks/test_hr.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/blocks/test_hr.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/blocks/test_html_blocks.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/blocks/test_html_blocks.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/blocks/test_paragraphs.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/blocks/test_paragraphs.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/extensions/__init__.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/extensions/__init__.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/extensions/test_abbr.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/extensions/test_abbr.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/extensions/test_admonition.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/extensions/test_admonition.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/extensions/test_attr_list.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/extensions/test_attr_list.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/extensions/test_code_hilite.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/extensions/test_code_hilite.py Changed

@@ -29,9 +29,9 @@
 except ImportError:
     has_pygments = False
 
-# The version required by the tests is the version specified and installed in the 'pygments' tox env.
-# In any environment where the PYGMENTS_VERSION environment variable is either not defined or doesn't
-# match the version of Pygments installed, all tests which rely in pygments will be skipped.
+# The version required by the tests is the version specified and installed in the `pygments` tox environment.
+# In any environment where the `PYGMENTS_VERSION` environment variable is either not defined or doesn't
+# match the version of Pygments installed, all tests which rely in Pygments will be skipped.
 required_pygments_version = os.environ.get('PYGMENTS_VERSION', '')
 
 
@@ -54,7 +54,7 @@
 
     def test_codehilite_defaults(self):
         if has_pygments:
-            # Odd result as no lang given and a single comment is not enough for guessing.
+            # Odd result as no `lang` given and a single comment is not enough for guessing.
             expected = (
                 '<div class="codehilite"><pre><span></span><code><span class="err"># A Code Comment</span>\n'
                 '</code></pre></div>'
@@ -98,7 +98,7 @@
 
     def test_codehilite_set_lang(self):
         if has_pygments:
-            # Note an extra `<span class="x">` is added to end of code block when lang explicitly set.
+            # Note an extra `<span class="x">` is added to end of code block when `lang` explicitly set.
             # Compare with expected output for `test_guess_lang`. Not sure why this happens.
             expected = (
                 '<div class="codehilite"><pre><span></span><code><span class="cp">&lt;?php</span> '
@@ -122,7 +122,7 @@
                 '</code></pre></div>'
             )
         else:
-            # Note that without pygments there is no way to check that the language name is bad.
+            # Note that without Pygments there is no way to check that the language name is bad.
             expected = (
                 '<pre class="codehilite"><code class="language-unkown">'
                 '&lt;?php print(&quot;Hello World&quot;); ?&gt;\n'
@@ -273,7 +273,7 @@
                 '</code></pre></div>'
             )
         else:
-            # TODO: Implement linenostart for no-pygments. Will need to check what JS libs look for.
+            # TODO: Implement `linenostart` for no-Pygments. Will need to check what JavaScript libraries look for.
             expected = (
                 '<pre class="codehilite"><code class="language-text linenums">plain text\n'
                 '</code></pre>'
@@ -374,7 +374,7 @@
 
     def testBasicCodeHilite(self):
         if has_pygments:
-            # Odd result as no lang given and a single comment is not enough for guessing.
+            # Odd result as no `lang` given and a single comment is not enough for guessing.
             expected = (
                 '<div class="codehilite"><pre><span></span><code><span class="err"># A Code Comment</span>\n'
                 '</code></pre></div>'
@@ -645,7 +645,7 @@
 
     def testUnknownOption(self):
         if has_pygments:
-            # Odd result as no lang given and a single comment is not enough for guessing.
+            # Odd result as no `lang` given and a single comment is not enough for guessing.
             expected = (
                 '<div class="codehilite"><pre><span></span><code><span class="err"># A Code Comment</span>\n'
                 '</code></pre></div>'

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/extensions/test_fenced_code.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/extensions/test_fenced_code.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/extensions/test_footnotes.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/extensions/test_footnotes.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/extensions/test_legacy_attrs.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/extensions/test_legacy_attrs.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/extensions/test_legacy_em.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/extensions/test_legacy_em.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/extensions/test_md_in_html.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/extensions/test_md_in_html.py Changed

@@ -13,7 +13,7 @@
 Currently maintained by Waylan Limberg (https://github.com/waylan),
 Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
 
-Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
+Copyright 2007-2023 The Python Markdown Project (v. 1.7 and later)
 Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
 Copyright 2004 Manfred Stienstra (the original version)
 
@@ -32,7 +32,7 @@
 
     def test_stash_to_string(self):
         # There should be no known cases where this actually happens so we need to
-        # forcefully pass an etree Element to the method to ensure proper behavior.
+        # forcefully pass an `etree` `Element` to the method to ensure proper behavior.
         element = Element('div')
         element.text = 'Foo bar.'
         md = Markdown(extensions='md_in_html')
@@ -1208,7 +1208,7 @@
 
 
 def load_tests(loader, tests, pattern):
-    ''' Ensure TestHTMLBlocks doesn't get run twice by excluding it here. '''
+    """ Ensure `TestHTMLBlocks` doesn't get run twice by excluding it here. """
     suite = TestSuite()
     for test_class in TestDefaultwMdInHTML, TestMdInHTML, TestMarkdownInHTMLPostProcessor:
         tests = loader.loadTestsFromTestCase(test_class)

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/extensions/test_smarty.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/extensions/test_smarty.py Changed

@@ -27,10 +27,174 @@
 
     default_kwargs = {'extensions': 'smarty'}
 
+    def test_basic(self):
+        self.assertMarkdownRenders(
+            "It's fun. What's fun?",
+            '<p>It&rsquo;s fun. What&rsquo;s fun?</p>'
+        )
+        self.assertMarkdownRenders(
+            '"Isn\'t this fun"? --- she said...',
+            '<p>&ldquo;Isn&rsquo;t this fun&rdquo;? &mdash; she said&hellip;</p>'
+        )
+        self.assertMarkdownRenders(
+            '"\'Quoted\' words in a larger quote."',
+            '<p>&ldquo;&lsquo;Quoted&rsquo; words in a larger quote.&rdquo;</p>'
+        )
+        self.assertMarkdownRenders(
+            '\'Quoted "words" in a larger quote.\'',
+            '<p>&lsquo;Quoted &ldquo;words&rdquo; in a larger quote.&rsquo;</p>'
+        )
+        self.assertMarkdownRenders(
+            '"quoted" text and **bold "quoted" text**',
+            '<p>&ldquo;quoted&rdquo; text and <strong>bold &ldquo;quoted&rdquo; text</strong></p>'
+        )
+        self.assertMarkdownRenders(
+            "'quoted' text and **bold 'quoted' text**",
+            '<p>&lsquo;quoted&rsquo; text and <strong>bold &lsquo;quoted&rsquo; text</strong></p>'
+        )
+        self.assertMarkdownRenders(
+            'em-dashes (---) and ellipes (...)',
+            '<p>em-dashes (&mdash;) and ellipes (&hellip;)</p>'
+        )
+        self.assertMarkdownRenders(
+            '"Link(http://example.com)" --- she said.',
+            '<p>&ldquo;<a href="http://example.com">Link</a>&rdquo; &mdash; she said.</p>'
+        )
+        self.assertMarkdownRenders(
+            '"Ellipsis within quotes..."',
+            '<p>&ldquo;Ellipsis within quotes&hellip;&rdquo;</p>'
+        )
+        self.assertMarkdownRenders(
+            "*Custer*'s Last Stand",
+            "<p><em>Custer</em>&rsquo;s Last Stand</p>"
+        )
+
+    def test_years(self):
+        self.assertMarkdownRenders("1440--80's", '<p>1440&ndash;80&rsquo;s</p>')
+        self.assertMarkdownRenders("1440--'80s", '<p>1440&ndash;&rsquo;80s</p>')
+        self.assertMarkdownRenders("1440---'80s", '<p>1440&mdash;&rsquo;80s</p>')
+        self.assertMarkdownRenders("1960's", '<p>1960&rsquo;s</p>')
+        self.assertMarkdownRenders("one two '60s", '<p>one two &rsquo;60s</p>')
+        self.assertMarkdownRenders("'60s", '<p>&rsquo;60s</p>')
+
+    def test_wrapping_line(self):
+        text = (
+            "A line that 'wraps' with\n"
+            "*emphasis* at the beginning of the next line."
+        )
+        html = (
+            '<p>A line that &lsquo;wraps&rsquo; with\n'
+            '<em>emphasis</em> at the beginning of the next line.</p>'
+        )
+        self.assertMarkdownRenders(text, html)
+
+    def test_escaped(self):
+        self.assertMarkdownRenders(
+            'Escaped \\-- ndash',
+            '<p>Escaped -- ndash</p>'
+        )
+        self.assertMarkdownRenders(
+            '\\\'Escaped\\\' \\"quotes\\"',
+            '<p>\'Escaped\' "quotes"</p>'
+        )
+        self.assertMarkdownRenders(
+            'Escaped ellipsis\\...',
+            '<p>Escaped ellipsis...</p>'
+        )
+        self.assertMarkdownRenders(
+            '\'Escaped \\"quotes\\" in real ones\'',
+            '<p>&lsquo;Escaped "quotes" in real ones&rsquo;</p>'
+        )
+        self.assertMarkdownRenders(
+            '\\\'"Real" quotes in escaped ones\\\'',
+            "<p>'&ldquo;Real&rdquo; quotes in escaped ones'</p>"
+        )
+
     def test_escaped_attr(self):
         self.assertMarkdownRenders(
             '!x\"x(x)',
             '<p><img alt="x&quot;x" src="x" /></p>'
         )
 
-    # TODO: Move rest of smarty tests here.
+    def test_code_spans(self):
+        self.assertMarkdownRenders(
+            'Skip `"code" -- --- \'spans\' ...`.',
+            '<p>Skip <code>"code" -- --- \'spans\' ...</code>.</p>'
+        )
+
+    def test_code_blocks(self):
+        text = (
+            '    Also skip "code" \'blocks\'\n'
+            '    foo -- bar --- baz ...'
+        )
+        html = (
+            '<pre><code>Also skip "code" \'blocks\'\n'
+            'foo -- bar --- baz ...\n'
+            '</code></pre>'
+        )
+        self.assertMarkdownRenders(text, html)
+
+    def test_horizontal_rule(self):
+        self.assertMarkdownRenders('--- -- ---', '<hr />')
+
+
+class TestSmartyAngledQuotes(TestCase):
+
+    default_kwargs = {
+        'extensions': 'smarty',
+        'extension_configs': {
+            'smarty': {
+                'smart_angled_quotes': True,
+            },
+        },
+    }
+
+    def test_angled_quotes(self):
+        self.assertMarkdownRenders(
+            '<<hello>>',
+            '<p>&laquo;hello&raquo;</p>'
+        )
+        self.assertMarkdownRenders(
+            'Кавычки-<<ёлочки>>',
+            '<p>Кавычки-&laquo;ёлочки&raquo;</p>'
+        )
+        self.assertMarkdownRenders(
+            'Anführungszeichen->>Chevrons<<',
+            '<p>Anführungszeichen-&raquo;Chevrons&laquo;</p>'
+        )
+
+
+class TestSmartyCustomSubstitutions(TestCase):
+
+    default_kwargs = {
+        'extensions': 'smarty',
+        'extension_configs': {
+            'smarty': {
+                'smart_angled_quotes': True,
+                'substitutions': {
+                    'ndash': '\u2013',
+                    'mdash': '\u2014',
+                    'ellipsis': '\u2026',
+                    'left-single-quote': '&sbquo;',  # `sb` is not a typo!
+                    'right-single-quote': '&lsquo;',
+                    'left-double-quote': '&bdquo;',
+                    'right-double-quote': '&ldquo;',
+                    'left-angle-quote': '',
+                    'right-angle-quote': '',
+                },
+            },
+        },
+    }
+
+    def test_custom_substitutions(self):
+        text = (
+            '<< The "Unicode char of the year 2014"\n'
+            "is the 'mdash': ---\n"
+            "Must not be confused with 'ndash'  (--) ... >>"
+        )
+        html = (
+            '<p> The &bdquo;Unicode char of the year 2014&ldquo;\n'
+            'is the &sbquo;mdash&lsquo;: \u2014\n'
+            'Must not be confused with &sbquo;ndash&lsquo;  (\u2013) \u2026 </p>'
+        )
+        self.assertMarkdownRenders(text, html)

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/extensions/test_tables.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/extensions/test_tables.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/extensions/test_toc.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/extensions/test_toc.py Changed

@@ -442,6 +442,23 @@
         self.assertMarkdownRenders(
             r'# escaped\_character',
             '<h1 id="escaped_character">escaped_character</h1>',
+            expected_attrs={
+                'toc': (
+                    '<div class="toc">\n'
+                      '<ul>\n'                                                           # noqa
+                        '<li><a href="#escaped_character">escaped_character</a></li>\n'  # noqa
+                      '</ul>\n'                                                          # noqa
+                    '</div>\n'                                                           # noqa
+                ),
+                'toc_tokens': 
+                    {
+                        'level': 1,
+                        'id': 'escaped_character',
+                        'name': 'escaped_character',
+                        'children': 
+                    }
+                
+            },
             extensions='toc'
         )
 
@@ -612,3 +629,45 @@
             ),
             extensions=TocExtension(toc_class="custom1 custom2")
         )
+
+    def testTOCWithEmptyTitleClass(self):
+
+        self.assertMarkdownRenders(
+            self.dedent(
+                '''
+                TOC
+                # Header
+                '''
+            ),
+            self.dedent(
+                '''
+                <div class="toc"><span>ToC</span><ul>
+                <li><a href="#header">Header</a></li>
+                </ul>
+                </div>
+                <h1 id="header">Header</h1>
+                '''
+            ),
+            extensions=TocExtension(title_class="", title='ToC')
+        )
+
+    def testTOCWithCustomTitleClass(self):
+
+        self.assertMarkdownRenders(
+            self.dedent(
+                '''
+                TOC
+                # Header
+                '''
+            ),
+            self.dedent(
+                '''
+                <div class="toc"><span class="tocname">ToC</span><ul>
+                <li><a href="#header">Header</a></li>
+                </ul>
+                </div>
+                <h1 id="header">Header</h1>
+                '''
+            ),
+            extensions=TocExtension(title_class="tocname", title='ToC')
+        )

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/inline/__init__.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/inline/__init__.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/inline/test_emphasis.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/inline/test_emphasis.py Changed

@@ -36,6 +36,42 @@
             '<p>_</p>'
         )
 
+    def test_standalone_asterisks_consecutive(self):
+        self.assertMarkdownRenders(
+            'Foo * * * *',
+            '<p>Foo * * * *</p>'
+        )
+
+    def test_standalone_understore_consecutive(self):
+        self.assertMarkdownRenders(
+            'Foo _ _ _ _',
+            '<p>Foo _ _ _ _</p>'
+        )
+
+    def test_standalone_asterisks_pairs(self):
+        self.assertMarkdownRenders(
+            'Foo ** ** ** **',
+            '<p>Foo ** ** ** **</p>'
+        )
+
+    def test_standalone_understore_pairs(self):
+        self.assertMarkdownRenders(
+            'Foo __ __ __ __',
+            '<p>Foo __ __ __ __</p>'
+        )
+
+    def test_standalone_asterisks_triples(self):
+        self.assertMarkdownRenders(
+            'Foo *** *** *** ***',
+            '<p>Foo *** *** *** ***</p>'
+        )
+
+    def test_standalone_understore_triples(self):
+        self.assertMarkdownRenders(
+            'Foo ___ ___ ___ ___',
+            '<p>Foo ___ ___ ___ ___</p>'
+        )
+
     def test_standalone_asterisk_in_text(self):
         self.assertMarkdownRenders(
             'foo * bar',
@@ -72,10 +108,16 @@
             '<p>foo\n_ bar _\nbaz</p>'
         )
 
-    def test_standalone_asterisks_at_end(self):
+    def test_standalone_underscore_at_begin(self):
+        self.assertMarkdownRenders(
+            '_ foo_ bar',
+            '<p>_ foo_ bar</p>'
+        )
+
+    def test_standalone_asterisk_at_end(self):
         self.assertMarkdownRenders(
-            'foo * bar *',
-            '<p>foo * bar *</p>'
+            'foo *bar *',
+            '<p>foo *bar *</p>'
         )
 
     def test_standalone_understores_at_begin_end(self):

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/inline/test_entities.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/inline/test_entities.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/inline/test_images.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/inline/test_images.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/inline/test_links.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/inline/test_links.py Changed

_service:tar_scm:Markdown-3.4.1.tar.gz/tests/test_syntax/inline/test_raw_html.py -> _service:tar_scm:Markdown-3.5.1.tar.gz/tests/test_syntax/inline/test_raw_html.py Changed

_service:tar_scm:Markdown-3.5.1.tar.gz/tox.ini Added

@@ -0,0 +1,46 @@
+tox
+envlist = py{38, 39, 310, 311, 312}, pypy{38, 39, 310}, pygments, flake8, checkspelling, pep517check, checklinks
+isolated_build = True
+
+testenv
+extras = testing
+deps = pytidylib
+allowlist_externals = coverage
+commands =
+    coverage run --source=markdown -m unittest discover {toxinidir}/tests
+    coverage xml
+    coverage report --show-missing
+
+testenv:pygments
+# Run tests with pygments installed (override deps only).
+setenv =
+    PYGMENTS_VERSION = 2.7.1
+deps =
+    pytidylib
+    pygments=={env:PYGMENTS_VERSION}
+
+testenv:flake8
+deps = flake8
+allowlist_externals = flake8
+commands = flake8 {toxinidir}/markdown {toxinidir}/tests
+skip_install = true
+
+testenv:checkspelling
+extras = docs
+deps = pyspelling
+commands =
+    {envpython} -m mkdocs build --strict --config-file {toxinidir}/mkdocs.yml
+    {envpython} -m pyspelling --config {toxinidir}/.pyspelling.yml
+
+testenv:checklinks
+whitelist_externals = markdown-link-check
+deps =
+commands = {toxinidir}/checklinks.sh
+
+testenv:pep517check
+deps = pep517
+commands = python -m pep517.check {toxinidir}
+skip_install = true
+
+flake8
+max-line-length = 119

Changes of Revision 3