delta/python-packages/docutils.git/docutils/writers/docutils_xml.py, branch docutils-0.20.1

New function utils.xml_declaration()

2022-11-13T16:14:59+00:00

Return XML text declaration.
Include an encoding declaration if the intended encoding is known.

Used in XML (and soon also in HTML) writer.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9239 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Resolve linting warnings from flake8

2022-11-03T10:52:43+00:00

- Rename ``_output_encoding()`` to ``_encoding()`` to shorten line
  length below 80 characters
- Normalise indentation on continuation lines in manpage.py

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9206 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Partially revert r9167

2022-11-02T23:28:49+00:00

``docutils.core.publish_string`` uses Python 2 notion of a
bytestring, such that in the general case it returns Python 3's
``bytes`` type. Revision 9167 attempted to address this distinction
by introducing ``publish_bytes`` and changing ``publish_string`` to
always return unicode text data as Python's ``str`` type. This is a
backwards compatibility break, so in this commit we restore the
previous behaviour, whilst simultaneously deprecating support for
returning binary data from the ``docutils.core.publish_string``
function for at least two releases of Docutils.

As part of this, we also deprecate returning binary data from the
``docutils.io.StringOutput.encode`` method, docutils.io.BytesOutput``
should be used in its stead.

Finally, we update tests for the reversion to the previous behaviour.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9202 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Remove unused local variables

2022-03-05T23:31:46+00:00

flake rule F841: local variable 'foo' is assigned to but never used

In test_odt.py, a no-op class definition is removed completely.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9038 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Avoid multiple statements on one line. Fix redundant backslash

2022-03-05T23:29:06+00:00

Exceptions for sets of empty class definitions
and other cases where it improves comprehension.

flake8 rules
E502: the backslash is redundant between brackets
E701: multiple statements on one line (colon)
E704: multiple statements on one line (def)

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9032 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Avoid too long lines.

2022-03-05T23:28:32+00:00

flake8 rule E501: line too long (N > 79 characters)

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9030 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Remove excess blank lines.

2022-03-04T15:55:47+00:00

flakei rule E303: too many blank lines (N)

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9025 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Fix (some) missing blank lines

2022-03-04T15:55:26+00:00

flake8 rules
E301: expected 1 blank line, found 0
E306: expected 1 blank line before a nested definition, found 0

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9024 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Ensure comments start with '# '

2022-03-04T15:54:56+00:00

flake rules
E262: inline comment should start with '# '
E265: block comment should start with '# '
E266: too many leading '#' for block comment

Exception for latex2e (legacy convention to mark disabled code with ##).

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9022 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Ensure at least two spaces before inline comment.

2022-03-04T15:54:22+00:00

flake 8 rule E261

Exceptions for modules sheduled for removal or with
3rd-party origin and for data collections.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9021 929543f6-e4f2-0310-98a6-ba3bd3dd1d04