1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
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 `table` extension now uses a `style` attribute instead of `align` attribute for alignment.
The [HTML4 spec][spec4] specifically
deprecates the use of the `align` attribute and it does not appear at all in the
[HTML5 spec][spec5]. Therefore, by default, the [table] 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
The former behavior is available by setting the setting `use_align_attribute` configuration
option to `True` when adding 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)])
```
In addition, tests were moved to the modern test environment.
### 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 object
which remained in version 3.3 have been removed from the codebase in version 3.4
and will now raise errors. A summary of the objects are provided 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:
* Use `style` attribute in tables for alignment instead of `align` for better CSS
inter-operation. The old behavior is available by setting `use_align_attribute=True` when
adding the extension.
* 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 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 to specify a custom
placeholder for the footnote itself in the text.
Ex: `[{}]` will give <sup>[1]</sup>, `({})` will give <sup>(1)</sup>,
or just 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
use a custom formatter class with Pygments (#1187). Additionally, the specified
Pygments formatter is passed an extra option `lang_str` to denote the language of
the code block (#1258).
- If set to a string like `'html'`, we get the default formatter by that name.
- If set to a class (or any callable), it is called with all the options to get a
formatter instance.
## 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).
|
