Changelog
### 2.8.5
```
^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Fixed use of `!connection_factory` and `!cursor_factory` together
(:ticket:`1019`).
- Added support for `~logging.LoggerAdapter` in
`~psycopg2.extras.LoggingConnection` (:ticket:`1026`).
- `~psycopg2.extensions.Column` objects in `cursor.description` can be sliced
(:ticket:`1034`).
- Added AIX support (:ticket:`1061`).
- Fixed `~copy.copy()` of `~psycopg2.extras.DictCursor` rows (:ticket:`1073`).
```
### 2.8.4
```
^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Fixed building with Python 3.8 (:ticket:`854`).
- Don't swallow keyboard interrupts on connect when a password is specified
in the connection string (:ticket:`898`).
- Don't advance replication cursor when the message wasn't confirmed
(:ticket:`940`).
- Fixed inclusion of ``time.h`` on linux (:ticket:`951`).
- Fixed int overflow for large values in `~psycopg2.extensions.Column.table_oid`
and `~psycopg2.extensions.Column.type_code` (:ticket:`961`).
- `~psycopg2.errorcodes` map and `~psycopg2.errors` classes updated to
PostgreSQL 12.
- Wheel package compiled against OpenSSL 1.1.1d and PostgreSQL at least 11.4.
```
### 2.8.3
```
^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Added *interval_status* parameter to
`~psycopg2.extras.ReplicationCursor.start_replication()` method and other
facilities to send automatic replication keepalives at periodic intervals
(:ticket:`913`).
- Fixed namedtuples caching introduced in 2.8 (:ticket:`928`).
```
Links
- PyPI: https://pypi.org/project/psycopg2
- Changelog: https://pyup.io/changelogs/psycopg2/
- Homepage: https://psycopg.org/
Changelog
### 3.0.4
```
=====================================
Bugs fixed
----------
* 7567: autodoc: parametrized types are shown twice for generic types
* 7637: autodoc: system defined TypeVars are shown in Python 3.9
* 7696: html: Updated jQuery version from 3.4.1 to 3.5.1 for security reasons
* 7611: md5 fails when OpenSSL FIPS is enabled
* 7626: release package does not contain ``CODE_OF_CONDUCT``
```
### 3.0.3
```
=====================================
Features added
--------------
* C, parse array declarators with static, qualifiers, and VLA specification.
Bugs fixed
----------
* 7516: autodoc: crashes if target object raises an error on accessing
its attributes
```
### 3.0.2
```
=====================================
Features added
--------------
* C, parse attributes and add :confval:`c_id_attributes`
and :confval:`c_paren_attributes` to support user-defined attributes.
Bugs fixed
----------
* 7461: py domain: fails with IndexError for empty tuple in type annotation
* 7510: py domain: keyword-only arguments are documented as having a default of
None
* 7418: std domain: :rst:role:`term` role could not match case-insensitively
* 7461: autodoc: empty tuple in type annotation is not shown correctly
* 7479: autodoc: Sphinx builds has been slower since 3.0.0 on mocking
* C++, fix spacing issue in east-const declarations.
* 7414: LaTeX: Xindy language options were incorrect
* sphinx crashes with ImportError on python3.5.1
```
### 3.0.1
```
=====================================
Incompatible changes
--------------------
* 7418: std domain: :rst:dir:`term` role becomes case sensitive
Bugs fixed
----------
* 7428: py domain: a reference to class ``None`` emits a nitpicky warning
* 7445: py domain: a return annotation ``None`` in the function signature is
not converted to a hyperlink when using intersphinx
* 7418: std domain: duplication warning for glossary terms is case insensitive
* 7438: C++, fix merging overloaded functions in parallel builds.
* 7422: autodoc: fails with ValueError when using autodoc_mock_imports
* 7435: autodoc: ``autodoc_typehints='description'`` doesn't suppress typehints
in signature for classes/methods
* 7451: autodoc: fails with AttributeError when an object returns non-string
object as a ``__doc__`` member
* 7423: crashed when giving a non-string object to logger
* 7479: html theme: Do not include xmlns attribute with HTML 5 doctype
* 7426: html theme: Escape some links in HTML templates
```
### 3.0.0
```
* 7364: autosummary: crashed when :confval:`autosummary_generate` is False
* 7370: autosummary: raises UnboundLocalError when unknown module given
* 7367: C++, alternate operator spellings are now supported.
* C, alternate operator spellings are now supported.
* 7368: C++, comma operator in expressions, pack expansion in template
argument lists, and more comprehensive error messages in some cases.
* C, C++, fix crash and wrong duplicate warnings related to anon symbols.
* 6477: Escape first "!" in a cross reference linking no longer possible
* 7219: py domain: The index entry generated by ``py:function`` directive is
different with one from ``index`` directive with "builtin" type
* 7301: capital characters are not allowed for node_id
* 7301: epub: duplicated node_ids are generated
* 6564: html: a width of table was ignored on HTML builder
* 7401: Incorrect argument is passed for :event:`env-get-outdated` handlers
* 7355: autodoc: a signature of cython-function is not recognized well
* 7222: autodoc: ``__wrapped__`` functions are not documented correctly
* 7409: intersphinx: ValueError is raised when an extension sets up
:confval:`intersphinx_mapping` on :event:`config-inited` event
* 7343: Sphinx builds has been slower since 2.4.0 on debug mode
```
### 3.0.0b1
```
* C++, fix cross reference lookup in certain cases involving
function overloads.
* 5078: C++, fix cross reference lookup when a directive contains multiple
declarations.
* C++, suppress warnings for directly dependent typenames in cross references
generated automatically in signatures.
* 5637: autodoc: Incorrect handling of nested class names on show-inheritance
* 7267: autodoc: error message for invalid directive options has wrong location
* 7329: autodoc: info-field-list is wrongly generated from type hints into the
class description even if ``autoclass_content='class'`` set
* 7331: autodoc: a cython-function is not recognized as a function
* 5637: inheritance_diagram: Incorrect handling of nested class names
* 7139: ``code-block:: guess`` does not work
* 7325: html: source_suffix containing dot leads to wrong source link
* 7357: html: Resizing SVG image fails with ValueError
* 7278: html search: Fix use of ``html_file_suffix`` instead of
``html_link_suffix`` in search results
* 7297: html theme: ``bizstyle`` does not support ``sidebarwidth``
* 3842: singlehtml: Path to images broken when master doc is not in source root
* 7179: std domain: Fix whitespaces are suppressed on referring GenericObject
* 7289: console: use bright colors instead of bold
* 1539: C, parse array types.
* 2377: C, parse function pointers even in complex types.
* 7345: sphinx-build: Sphinx crashes if output directory exists as a file
* 7290: sphinx-build: Ignore bdb.BdbQuit when handling exceptions
* 6240: napoleon: Attributes and Methods sections ignore :noindex: option
```
### 2.4.4
```
=====================================
Bugs fixed
----------
* 7197: LaTeX: platex cause error to build image directive with target url
* 7223: Sphinx builds has been slower since 2.4.0
```
### 2.4.3
```
=====================================
Bugs fixed
----------
* 7184: autodoc: ``*args`` and ``**kwarg`` in type comments are not handled
properly
* 7189: autodoc: classmethod coroutines are not detected
* 7183: intersphinx: ``:attr:`` reference to property is broken
* 6244, 6387: html search: Search breaks/hangs when built with dirhtml builder
* 7195: todo: emit doctree-resolved event with non-document node incorrectly
```
### 2.4.2
```
=====================================
Bugs fixed
----------
* 7138: autodoc: ``autodoc.typehints`` crashed when variable has unbound object
as a value
* 7156: autodoc: separator for keyword only arguments is not shown
* 7146: autodoc: IndexError is raised on suppressed type_comment found
* 7161: autodoc: typehints extension does not support parallel build
* 7178: autodoc: TypeError is raised on fetching type annotations
* 7151: crashed when extension assigns a value to ``env.indexentries``
* 7170: text: Remove debug print
* 7137: viewcode: Avoid to crash when non-python code given
```
### 2.4.1
```
=====================================
Bugs fixed
----------
* 7120: html: crashed when on scaling SVG images which have float dimentions
* 7126: autodoc: TypeError: 'getset_descriptor' object is not iterable
```
### 2.4.0
```
=====================================
Deprecated
----------
* The ``decode`` argument of ``sphinx.pycode.ModuleAnalyzer()``
* ``sphinx.directives.other.Index``
* ``sphinx.environment.temp_data['gloss_entries']``
* ``sphinx.environment.BuildEnvironment.indexentries``
* ``sphinx.environment.collectors.indexentries.IndexEntriesCollector``
* ``sphinx.ext.apidoc.INITPY``
* ``sphinx.ext.apidoc.shall_skip()``
* ``sphinx.io.FiletypeNotFoundError``
* ``sphinx.io.get_filetype()``
* ``sphinx.pycode.ModuleAnalyzer.encoding``
* ``sphinx.roles.Index``
* ``sphinx.util.detect_encoding()``
* ``sphinx.util.get_module_source()``
* ``sphinx.util.inspect.Signature``
* ``sphinx.util.inspect.safe_getmembers()``
* ``sphinx.writers.latex.LaTeXTranslator.settings.author``
* ``sphinx.writers.latex.LaTeXTranslator.settings.contentsname``
* ``sphinx.writers.latex.LaTeXTranslator.settings.docclass``
* ``sphinx.writers.latex.LaTeXTranslator.settings.docname``
* ``sphinx.writers.latex.LaTeXTranslator.settings.title``
* ``sphinx.writers.latex.ADDITIONAL_SETTINGS``
* ``sphinx.writers.latex.DEFAULT_SETTINGS``
* ``sphinx.writers.latex.LUALATEX_DEFAULT_FONTPKG``
* ``sphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKG``
* ``sphinx.writers.latex.XELATEX_DEFAULT_FONTPKG``
* ``sphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKG``
Features added
--------------
* 6910: inheritance_diagram: Make the background of diagrams transparent
* 6446: duration: Add ``sphinx.ext.durations`` to inspect which documents slow
down the build
* 6837: LaTeX: Support a nested table
* 7115: LaTeX: Allow to override LATEXOPTS and LATEXMKOPTS via environment
variable
* 6966: graphviz: Support ``:class:`` option
* 6696: html: ``:scale:`` option of image/figure directive not working for SVG
images (imagesize-1.2.0 or above is required)
* 6994: imgconverter: Support illustrator file (.ai) to .png conversion
* autodoc: Support Positional-Only Argument separator (PEP-570 compliant)
* autodoc: Support type annotations for variables
* 2755: autodoc: Add new event: :event:`autodoc-before-process-signature`
* 2755: autodoc: Support type_comment style (ex. `` type: (str) -> str``)
annotation (python3.8+ or `typed_ast <https://github.com/python/typed_ast>`_
is required)
* 7051: autodoc: Support instance variables without defaults (PEP-526)
* 6418: autodoc: Add a new extension ``sphinx.ext.autodoc.typehints``. It shows
typehints as object description if ``autodoc_typehints = "description"`` set.
This is an experimental extension and it will be integrated into autodoc core
in Sphinx-3.0
* SphinxTranslator now calls visitor/departure method for super node class if
visitor/departure method for original node class not found
* 6418: Add new event: :event:`object-description-transform`
* py domain: :rst:dir:`py:data` and :rst:dir:`py:attribute` take new options
named ``:type:`` and ``:value:`` to describe its type and initial value
* 6785: py domain: ``:py:attr:`` is able to refer properties again
* 6772: apidoc: Add ``-q`` option for quiet mode
Bugs fixed
----------
* 6925: html: Remove redundant type="text/javascript" from <script> elements
* 7112: html: SVG image is not layouted as float even if aligned
* 6906, 6907: autodoc: failed to read the source codes encoeded in cp1251
* 6961: latex: warning for babel shown twice
* 7059: latex: LaTeX compilation falls into infinite loop (wrapfig issue)
* 6581: latex: ``:reversed:`` option for toctree does not effect to LaTeX build
* 6559: Wrong node-ids are generated in glossary directive
* 6986: apidoc: misdetects module name for .so file inside module
* 6899: apidoc: private members are not shown even if ``--private`` given
* 6327: apidoc: Support a python package consisted of __init__.so file
* 6999: napoleon: fails to parse tilde in :exc: role
* 7019: gettext: Absolute path used in message catalogs
* 7023: autodoc: nested partial functions are not listed
* 7023: autodoc: partial functions imported from other modules are listed as
module members without :impoprted-members: option
* 6889: autodoc: Trailing comma in ``:members::`` option causes cryptic warning
* 6568: autosummary: ``autosummary_imported_members`` is ignored on generating
a stub file for submodule
* 7055: linkcheck: redirect is treated as an error
* 7088: HTML template: If ``navigation_with_keys`` option is activated,
modifier keys are ignored, which means the feature can interfere with browser
features
* 7090: std domain: Can't assign numfig-numbers for custom container nodes
* 7106: std domain: enumerated nodes are marked as duplicated when extensions
call ``note_explicit_target()``
* 7095: dirhtml: Cross references are broken via intersphinx and ``:doc:`` role
* C++:
- Don't crash when using the ``struct`` role in some cases.
- Don't warn when using the ``var``/``member`` role for function
parameters.
- Render call and braced-init expressions correctly.
* 7097: Filenames of images generated by
``sphinx.transforms.post_transforms.images.ImageConverter``
or its subclasses (used for latex build) are now sanitized,
to prevent broken paths
```
### 2.3.1
```
=====================================
Bugs fixed
----------
* 6936: sphinx-autogen: raises AttributeError
```
### 2.3.0
```
=====================================
Incompatible changes
--------------------
* 6742: ``end-before`` option of :rst:dir:`literalinclude` directive does not
match the first line of the code block.
* 1331: Change default User-Agent header to ``"Sphinx/X.Y.Z requests/X.Y.Z
python/X.Y.Z"``. It can be changed via :confval:`user_agent`.
* 6867: text: content of admonitions starts after a blank line
Deprecated
----------
* ``sphinx.builders.gettext.POHEADER``
* ``sphinx.io.SphinxStandaloneReader.app``
* ``sphinx.io.SphinxStandaloneReader.env``
* ``sphinx.util.texescape.tex_escape_map``
* ``sphinx.util.texescape.tex_hl_escape_map_new``
* ``sphinx.writers.latex.LaTeXTranslator.no_contractions``
Features added
--------------
* 6707: C++, support bit-fields.
* 267: html: Eliminate prompt characters of doctest block from copyable text
* 6548: html: Use favicon for OpenSearch if available
* 6729: html theme: agogo theme now supports ``rightsidebar`` option
* 6780: Add PEP-561 Support
* 6762: latex: Allow to load additonal LaTeX packages via ``extrapackages`` key
of :confval:`latex_elements`
* 1331: Add new config variable: :confval:`user_agent`
* 6000: LaTeX: have backslash also be an inline literal word wrap break
character
* 4186: LaTeX: Support upLaTeX as a new :confval:`latex_engine` (experimental)
* 6812: Improve a warning message when extensions are not parallel safe
* 6818: Improve Intersphinx performance for multiple remote inventories.
* 2546: apidoc: .so file support
* 6798: autosummary: emit ``autodoc-skip-member`` event on generating stub file
* 6483: i18n: make explicit titles in toctree translatable
* 6816: linkcheck: Add :confval:`linkcheck_auth` option to provide
authentication information when doing ``linkcheck`` builds
* 6872: linkcheck: Handles HTTP 308 Permanent Redirect
* 6613: html: Wrap section number in span tag
* 6781: gettext: Add :confval:`gettext_last_translator' and
:confval:`gettext_language_team` to customize headers of POT file
Bugs fixed
----------
* 6668: LaTeX: Longtable before header has incorrect distance
(refs: `latex3/latex2e173`_)
.. _latex3/latex2e173: https://github.com/latex3/latex2e/issues/173
* 6618: LaTeX: Avoid section names at the end of a page
* 6738: LaTeX: Do not replace unicode characters by LaTeX macros on unicode
supported LaTeX engines: ¶, §, €, ∞, ±, →, ‣, –, superscript and subscript
digits go through "as is" (as default OpenType font supports them)
* 6704: linkcheck: Be defensive and handle newly defined HTTP error code
* 6806: linkcheck: Failure on parsing content
* 6655: image URLs containing ``data:`` causes gettext builder crashed
* 6584: i18n: Error when compiling message catalogs on Hindi
* 6718: i18n: KeyError is raised if section title and table title are same
* 6743: i18n: :confval:`rst_prolog` breaks the translation
* 6708: mathbase: Some deprecated functions have removed
* 6709: autodoc: mock object does not work as a class decorator
* 5070: epub: Wrong internal href fragment links
* 6712: Allow not to install sphinx.testing as runtime (mainly for ALT Linux)
* 6741: html: search result was broken with empty :confval:`html_file_suffix`
* 6001: LaTeX does not wrap long code lines at backslash character
* 6804: LaTeX: PDF build breaks if admonition of danger type contains
code-block long enough not to fit on one page
* 6809: LaTeX: code-block in a danger type admonition can easily spill over
bottom of page
* 6793: texinfo: Code examples broken following "sidebar"
* 6813: An orphan warning is emitted for included document on Windows. Thanks
to drillan
* 6850: Fix smartypants module calls re.sub() with wrong options
* 6824: HTML search: If a search term is partially matched in the title and
fully matched in a text paragraph on the same page, the search does not
include this match.
* 6848: config.py shouldn't pop extensions from overrides
* 6867: text: extra spaces are inserted to hyphenated words on folding lines
* 6886: LaTeX: xelatex converts straight double quotes into right curly ones
(shows when :confval:`smartquotes` is ``False``)
* 6890: LaTeX: even with smartquotes off, PDF output transforms straight
quotes and consecutive hyphens into curly quotes and dashes
* 6876: LaTeX: multi-line display of authors on title page has ragged edges
* 6887: Sphinx crashes with docutils-0.16b0
* 6920: sphinx-build: A console message is wrongly highlighted
* 6900: sphinx-build: ``-D`` option does not considers ``0`` and ``1`` as a
boolean value
```
### 2.2.2
```
=====================================
Incompatible changes
--------------------
* 6803: For security reason of python, parallel mode is disabled on macOS and
Python3.8+
Bugs fixed
----------
* 6776: LaTeX: 2019-10-01 LaTeX release breaks :file:`sphinxcyrillic.sty`
* 6815: i18n: French, Hindi, Chinese, Japanese and Korean translation messages
has been broken
* 6803: parallel build causes AttributeError on macOS and Python3.8
```
### 2.2.1
```
=====================================
Bugs fixed
----------
* 6641: LaTeX: Undefined control sequence ``\sphinxmaketitle``
* 6710: LaTeX not well configured for Greek language as main language
* 6759: validation of html static paths and extra paths no longer throws
an error if the paths are in different directories
```
### 2.2.0
```
=====================================
Incompatible changes
--------------------
* apidoc: template files are renamed to ``.rst_t``
* html: Field lists will be styled by grid layout
Deprecated
----------
* ``sphinx.domains.math.MathDomain.add_equation()``
* ``sphinx.domains.math.MathDomain.get_next_equation_number()``
* The ``info`` and ``warn`` arguments of
``sphinx.ext.autosummary.generate.generate_autosummary_docs()``
* ``sphinx.ext.autosummary.generate._simple_info()``
* ``sphinx.ext.autosummary.generate._simple_warn()``
* ``sphinx.ext.todo.merge_info()``
* ``sphinx.ext.todo.process_todo_nodes()``
* ``sphinx.ext.todo.process_todos()``
* ``sphinx.ext.todo.purge_todos()``
Features added
--------------
* 5124: graphviz: ``:graphviz_dot:`` option is renamed to ``:layout:``
* 1464: html: emit a warning if :confval:`html_static_path` and
:confval:`html_extra_path` directories are inside output directory
* 6514: html: Add a label to search input for accessability purposes
* 5602: apidoc: Add ``--templatedir`` option
* 6475: Add ``override`` argument to ``app.add_autodocumenter()``
* 6310: imgmath: let :confval:`imgmath_use_preview` work also with the SVG
format for images rendering inline math
* 6533: LaTeX: refactor visit_enumerated_list() to use ``\sphinxsetlistlabels``
* 6628: quickstart: Use ``https://docs.python.org/3/`` for default setting of
:confval:`intersphinx_mapping`
* 6419: sphinx-build: give reasons why rebuilded
Bugs fixed
----------
* py domain: duplicated warning does not point the location of source code
* 6499: html: Sphinx never updates a copy of :confval:`html_logo` even if
original file has changed
* 1125: html theme: scrollbar is hard to see on classic theme and macOS
* 5502: linkcheck: Consider HTTP 503 response as not an error
* 6439: Make generated download links reproducible
* 6486: UnboundLocalError is raised if broken extension installed
* 6567: autodoc: :confval:`autodoc_inherit_docstrings` does not effect to
``__init__()`` and ``__new__()``
* 6574: autodoc: :confval:`autodoc_member_order` does not refer order of
imports when ``'bysource'`` order
* 6574: autodoc: missing type annotation for variadic and keyword parameters
* 6589: autodoc: Formatting issues with autodoc_typehints='none'
* 6605: autodoc: crashed when target code contains custom method-like objects
* 6498: autosummary: crashed with wrong autosummary_generate setting
* 6507: autosummary: crashes without no autosummary_generate setting
* 6511: LaTeX: autonumbered list can not be customized in LaTeX
since Sphinx 1.8.0 (refs: 6533)
* 6531: Failed to load last environment object when extension added
* 736: Invalid sort in pair index
* 6527: :confval:`last_updated` wrongly assumes timezone as UTC
* 5592: std domain: :rst:dir:`option` directive registers an index entry for
each comma separated option
* 6549: sphinx-build: Escaped characters in error messages
* 6545: doctest comments not getting trimmed since Sphinx 1.8.0
* 6561: glossary: Wrong hyperlinks are generated for non alphanumeric terms
* 6620: i18n: classifiers of definition list are not translated with
docutils-0.15
* 6474: ``DocFieldTransformer`` raises AttributeError when given directive is
not a subclass of ObjectDescription
```
### 2.1.2
```
=====================================
Bugs fixed
----------
* 6497: custom lexers fails highlighting when syntax error
* 6478, 6488: info field lists are incorrectly recognized
```
### 2.1.1
```
=====================================
Incompatible changes
--------------------
* 6447: autodoc: Stop to generate document for undocumented module variables
Bugs fixed
----------
* 6442: LaTeX: admonitions of :rst:dir:`note` type can get separated from
immediately preceding section title by pagebreak
* 6448: autodoc: crashed when autodocumenting classes with ``__slots__ = None``
* 6451: autodoc: generates docs for "optional import"ed modules as variables
* 6452: autosummary: crashed when generating document of properties
* 6455: napoleon: docstrings for properties are not processed
* 6436: napoleon: "Unknown target name" error if variable name ends with
underscore
* 6440: apidoc: missing blank lines between modules
```
### 2.1.0
```
=====================================
Incompatible changes
--------------------
* Ignore filenames without file extension given to ``Builder.build_specific()``
API directly
* 6230: The anchor of term in glossary directive is changed if it is consisted
by non-ASCII characters
* 4550: html: Centering tables by default using CSS
* 6239: latex: xelatex and xeCJK are used for Chinese documents by default
* ``Sphinx.add_lexer()`` now takes a Lexer class instead of instance. An
instance of lexers are still supported until Sphinx-3.x.
Deprecated
----------
* ``sphinx.builders.latex.LaTeXBuilder.apply_transforms()``
* ``sphinx.builders._epub_base.EpubBuilder.esc()``
* ``sphinx.directives.Acks``
* ``sphinx.directives.Author``
* ``sphinx.directives.Centered``
* ``sphinx.directives.Class``
* ``sphinx.directives.CodeBlock``
* ``sphinx.directives.Figure``
* ``sphinx.directives.HList``
* ``sphinx.directives.Highlight``
* ``sphinx.directives.Include``
* ``sphinx.directives.Index``
* ``sphinx.directives.LiteralInclude``
* ``sphinx.directives.Meta``
* ``sphinx.directives.Only``
* ``sphinx.directives.SeeAlso``
* ``sphinx.directives.TabularColumns``
* ``sphinx.directives.TocTree``
* ``sphinx.directives.VersionChange``
* ``sphinx.domains.python.PyClassmember``
* ``sphinx.domains.python.PyModulelevel``
* ``sphinx.domains.std.StandardDomain._resolve_citation_xref()``
* ``sphinx.domains.std.StandardDomain.note_citations()``
* ``sphinx.domains.std.StandardDomain.note_citation_refs()``
* ``sphinx.domains.std.StandardDomain.note_labels()``
* ``sphinx.environment.NoUri``
* ``sphinx.ext.apidoc.format_directive()``
* ``sphinx.ext.apidoc.format_heading()``
* ``sphinx.ext.apidoc.makename()``
* ``sphinx.ext.autodoc.importer.MockFinder``
* ``sphinx.ext.autodoc.importer.MockLoader``
* ``sphinx.ext.autodoc.importer.mock()``
* ``sphinx.ext.autosummary.autolink_role()``
* ``sphinx.ext.imgmath.DOC_BODY``
* ``sphinx.ext.imgmath.DOC_BODY_PREVIEW``
* ``sphinx.ext.imgmath.DOC_HEAD``
* ``sphinx.transforms.CitationReferences``
* ``sphinx.transforms.SmartQuotesSkipper``
* ``sphinx.util.docfields.DocFieldTransformer.preprocess_fieldtypes()``
* ``sphinx.util.node.find_source_node()``
* ``sphinx.util.i18n.find_catalog()``
* ``sphinx.util.i18n.find_catalog_files()``
* ``sphinx.util.i18n.find_catalog_source_files()``
For more details, see :ref:`deprecation APIs list <dev-deprecated-apis>`.
Features added
--------------
* Add a helper class ``sphinx.transforms.post_transforms.SphinxPostTransform``
* Add helper methods
- ``PythonDomain.note_module()``
- ``PythonDomain.note_object()``
- ``SphinxDirective.set_source_info()``
* 6180: Support ``--keep-going`` with BuildDoc setup command
* ``math`` directive now supports ``:class:`` option
* todo: ``todo`` directive now supports ``:name:`` option
* Enable override via environment of ``SPHINXOPTS`` and ``SPHINXBUILD`` Makefile
variables (refs: 6232, 6303)
* 6287: autodoc: Unable to document bound instance methods exported as module
functions
* 6289: autodoc: :confval:`autodoc_default_options` now supports
``imported-members`` option
* 4777: autodoc: Support coroutine
* 744: autodoc: Support abstractmethod
* 6325: autodoc: Support attributes in __slots__. For dict-style __slots__,
autodoc considers values as a docstring of the attribute
* 6361: autodoc: Add :confval:`autodoc_typehints` to suppress typehints from
signature
* 1063: autodoc: ``automodule`` directive now handles undocumented module level
variables
* 6212 autosummary: Add :confval:`autosummary_imported_members` to display
imported members on autosummary
* 6271: ``make clean`` is catastrophically broken if building into '.'
* 6363: Support ``%O%`` environment variable in make.bat
* 4777: py domain: Add ``:async:`` option to :rst:dir:`py:function` directive
* py domain: Add new options to :rst:dir:`py:method` directive
- ``:abstractmethod:``
- ``:async:``
- ``:classmethod:``
- ``:property:``
- ``:staticmethod:``
* rst domain: Add :rst:dir:`directive:option` directive to describe the option
for directive
* 6306: html: Add a label to search form for accessability purposes
* 4390: html: Consistent and semantic CSS for signatures
* 6358: The ``rawsource`` property of ``production`` nodes now contains the
full production rule
* 6373: autosectionlabel: Allow suppression of warnings
* coverage: Support a new ``coverage_ignore_pyobjects`` option
* 6239: latex: Support to build Chinese documents
Bugs fixed
----------
* 6230: Inappropriate node_id has been generated by glossary directive if term
is consisted by non-ASCII characters
* 6213: ifconfig: contents after headings are not shown
* commented term in glossary directive is wrongly recognized
* 6299: rst domain: rst:directive directive generates waste space
* 6379: py domain: Module index (py-modindex.html) has duplicate titles
* 6331: man: invalid output when doctest follows rubric
* 6351: "Hyperlink target is not referenced" message is shown even if
referenced
* 6165: autodoc: ``tab_width`` setting of docutils has been ignored
* 6347: autodoc: crashes with a plain Tuple on Python 3.6 and 3.5
* 6311: autosummary: autosummary table gets confused by complex type hints
* 6350: autosummary: confused by an argument having some kind of default value
* Generated Makefiles lack a final EOL (refs: 6232)
* 6375: extlinks: Cannot escape angle brackets in link caption
* 6378: linkcheck: Send commonly used User-Agent
* 6387: html search: failed to search document with haiku and scrolls themes
* 6408: html search: Fix the ranking of search results
* 6406: Wrong year is returned for ``SOURCE_DATE_EPOCH``
* 6402: image directive crashes by unknown image format
* 6286: C++, allow 8 and 9 in hexadecimal integer literals.
* 6305: Fix the string in quickstart for 'path' argument of parser
* LaTeX: Figures in admonitions produced errors (refs: 6364)
```
### 2.0.1
```
=====================================
Bugs fixed
----------
* LaTeX: some system labels are not translated
* RemovedInSphinx30Warning is marked as pending
* deprecation warnings are not emitted
- sphinx.application.CONFIG_FILENAME
- sphinx.builders.htmlhelp
- :confval:`viewcode_import`
* 6208: C++, properly parse full xrefs that happen to have a short xref as
prefix
* 6220, 6225: napoleon: AttributeError is raised for raised section having
references
* 6245: circular import error on importing SerializingHTMLBuilder
* 6243: LaTeX: 'releasename' setting for latex_elements is ignored
* 6244: html: Search function is broken with 3rd party themes
* 6263: html: HTML5Translator crashed with invalid field node
* 6262: html theme: The style of field lists has changed in bizstyle theme
```
### 2.0.0
```
* 6196: py domain: unexpected prefix is generated
Testing
--------
```
### 2.0.0b2
```
* Add a helper function: ``sphinx.testing.restructuredtext.parse()``
```
### 2.0.0b1
```
* Stop to use ``SPHINX_TEST_TEMPDIR`` envvar
```
Links
- PyPI: https://pypi.org/project/sphinx
- Changelog: https://pyup.io/changelogs/sphinx/
- Homepage: http://sphinx-doc.org/
Changelog
### 2.9.0
```
------------------
* Fixed ``RemovedInPytest4Warning`` when using Pytest 3.10.
Contributed by Michael Manganiello in `354 <https://github.com/pytest-dev/pytest-cov/pull/354>`_.
* Made pytest startup faster when plugin not active by lazy-importing.
Contributed by Anders Hovmöller in `339 <https://github.com/pytest-dev/pytest-cov/pull/339>`_.
* Various CI improvements.
Contributed by Daniel Hahler in `363 <https://github.com/pytest-dev/pytest-cov/pull/>`_ and
`364 <https://github.com/pytest-dev/pytest-cov/pull/364>`_.
* Various Python support updates (drop EOL 3.4, test against 3.8 final).
Contributed by Hugo van Kemenade in
`336 <https://github.com/pytest-dev/pytest-cov/pull/336>`_ and
`367 <https://github.com/pytest-dev/pytest-cov/pull/367>`_.
* Changed ``--cov-append`` to always enable ``data_suffix`` (a coverage setting).
Contributed by Harm Geerts in
`387 <https://github.com/pytest-dev/pytest-cov/pull/387>`_.
* Changed ``--cov-append`` to handle loading previous data better
(fixes various path aliasing issues).
* Various other testing improvements, github issue templates, example updates.
* Fixed internal failures that are caused by tests that change the current working directory by
ensuring a consistent working directory when coverage is called.
See `306 <https://github.com/pytest-dev/pytest-cov/issues/306>`_ and
`coveragepy881 <https://github.com/nedbat/coveragepy/issues/881>`_
```
### 2.8.1
```
------------------
* Fixed `348 <https://github.com/pytest-dev/pytest-cov/issues/348>`_ -
regression when only certain reports (html or xml) are used then ``--cov-fail-under`` always fails.
```
### 2.8.0
```
------------------
* Fixed ``RecursionError`` that can occur when using
`cleanup_on_signal <https://pytest-cov.readthedocs.io/en/latest/subprocess-support.htmlif-you-got-custom-signal-handling>`__ or
`cleanup_on_sigterm <https://pytest-cov.readthedocs.io/en/latest/subprocess-support.htmlif-you-got-custom-signal-handling>`__.
See: `294 <https://github.com/pytest-dev/pytest-cov/issues/294>`_.
The 2.7.x releases of pytest-cov should be considered broken regarding aforementioned cleanup API.
* Added compatibility with future xdist release that deprecates some internals
(match pytest-xdist master/worker terminology).
Contributed by Thomas Grainger in `321 <https://github.com/pytest-dev/pytest-cov/pull/321>`_
* Fixed breakage that occurs when multiple reporting options are used.
Contributed by Thomas Grainger in `338 <https://github.com/pytest-dev/pytest-cov/pull/338>`_.
* Changed internals to use a stub instead of ``os.devnull``.
Contributed by Thomas Grainger in `332 <https://github.com/pytest-dev/pytest-cov/pull/332>`_.
* Added support for Coverage 5.0.
Contributed by Ned Batchelder in `319 <https://github.com/pytest-dev/pytest-cov/pull/319>`_.
* Added support for float values in ``--cov-fail-under``.
Contributed by Martín Gaitán in `311 <https://github.com/pytest-dev/pytest-cov/pull/311>`_.
* Various documentation fixes. Contributed by
Juanjo Bazán,
Andrew Murray and
Albert Tugushev in
`298 <https://github.com/pytest-dev/pytest-cov/pull/298>`_,
`299 <https://github.com/pytest-dev/pytest-cov/pull/299>`_ and
`307 <https://github.com/pytest-dev/pytest-cov/pull/307>`_.
* Various testing improvements. Contributed by
Ned Batchelder,
Daniel Hahler,
Ionel Cristian Mărieș and
Hugo van Kemenade in
`313 <https://github.com/pytest-dev/pytest-cov/pull/313>`_,
`314 <https://github.com/pytest-dev/pytest-cov/pull/314>`_,
`315 <https://github.com/pytest-dev/pytest-cov/pull/315>`_,
`316 <https://github.com/pytest-dev/pytest-cov/pull/316>`_,
`325 <https://github.com/pytest-dev/pytest-cov/pull/325>`_,
`326 <https://github.com/pytest-dev/pytest-cov/pull/326>`_,
`334 <https://github.com/pytest-dev/pytest-cov/pull/334>`_ and
`335 <https://github.com/pytest-dev/pytest-cov/pull/335>`_.
* Added the ``--cov-context`` CLI options that enables coverage contexts. Only works with coverage 5.0+.
Contributed by Ned Batchelder in `345 <https://github.com/pytest-dev/pytest-cov/pull/345>`_.
```
### 2.7.1
```
------------------
* Fixed source distribution manifest so that garbage ain't included in the tarball.
```
### 2.7.0
```
------------------
* Fixed ``AttributeError: 'NoneType' object has no attribute 'configure_node'`` error when ``--no-cov`` is used.
Contributed by Alexander Shadchin in `263 <https://github.com/pytest-dev/pytest-cov/pull/263>`_.
* Various testing and CI improvements. Contributed by Daniel Hahler in
`255 <https://github.com/pytest-dev/pytest-cov/pull/255>`_,
`266 <https://github.com/pytest-dev/pytest-cov/pull/266>`_,
`272 <https://github.com/pytest-dev/pytest-cov/pull/272>`_,
`271 <https://github.com/pytest-dev/pytest-cov/pull/271>`_ and
`269 <https://github.com/pytest-dev/pytest-cov/pull/269>`_.
* Improved documentation regarding subprocess and multiprocessing.
Contributed in `265 <https://github.com/pytest-dev/pytest-cov/pull/265>`_.
* Improved ``pytest_cov.embed.cleanup_on_sigterm`` to be reentrant (signal deliveries while signal handling is
running won't break stuff).
* Added ``pytest_cov.embed.cleanup_on_signal`` for customized cleanup.
* Improved cleanup code and fixed various issues with leftover data files. All contributed in
`265 <https://github.com/pytest-dev/pytest-cov/pull/265>`_ or
`262 <https://github.com/pytest-dev/pytest-cov/pull/262>`_.
* Improved examples. Now there are two examples for the common project layouts, complete with working coverage
configuration. The examples have CI testing. Contributed in
`267 <https://github.com/pytest-dev/pytest-cov/pull/267>`_.
* Improved help text for CLI options.
```
Links
- PyPI: https://pypi.org/project/pytest-cov
- Changelog: https://pyup.io/changelogs/pytest-cov/
- Repo: https://github.com/pytest-dev/pytest-cov
Changelog
### 2.0.0
```
Compatiblity (BREAKING CHANGES)
* We have now dropped support for End-Of-Life'd versions of Python and
particularly old versions of the `coverage` library; if you are still using
Python v2.7 or v3.4, or you are using `coverage<4.1`, this library will no
longer be compatible starting from this release -- please pin to
`coveralls<2.0.0`.
<a name="1.11.1"></a>
```
### 1.11.1
```
Bug Fixes
* **github:** rename to github-actions ([9e65a059](9e65a059))
This fixes a regression introduced with v1.11.0, which may have prevented
usage of this library on Github Actions.
<a name="1.11.0"></a>
```
### 1.11.0
```
Fixes
* **github:** add `service_number` for github actions ([9f93bd8e](9f93bd8e))
This should fix support for parallel builds.
Compatibility
* Python 2.7 and 3.4 are now officially End-Of-Life'd. Consider them deprecated
from the perspective of this package -- we'll remove them in an upcoming
release (likely the first one which requires non-trivial work to continue
supporting them!).
<a name="1.10.0"></a>
```
### 1.10.0
```
Features
* support coverage>=5.0 (214) ([4a917402](4a917402))
<a name="1.9.2"></a>
```
### 1.9.2
```
Bug Fixes
* **github:** fixup incorrect API usage (209) ([c338cab4](c338cab4))
<a name="1.9.1"></a>
```
### 1.9.1
```
Compatibility
* this release marks Python 3.8 as officially supported. Earlier versions probably
supported Python 3.8 too, but now we're *sure*.
<a name="1.9.0"></a>
```
### 1.9.0
```
Features
* **support:** support Github Actions CI (207) ([817119c3](817119c3))
Bug Fixes
* **compatibility:** fixup coverage.__version__ comparisons (208) ([03a57a9a](03a57a9a))
<a name="1.8.2"></a>
```
### 1.8.2
```
Internal
* **dependencies**: update pass urllib3<1.25 pin, now that that's fixed.
<a name="1.8.1"></a>
```
### 1.8.1
```
Bug Fixes
* **dependencies:** pin `coverage` to `< 5.0`, since the current `5.0` alphas are
introducing breaking changes. Once `5.0` is stable, we'll
remove the pin.
<a name="1.8.0"></a>
```
### 1.8.0
```
Features
* **flag:** allow disabling SSL verification ([2e3b5c61](2e3b5c61))
Bug Fixes
* **git:** fix support for case where git binary is missing ([5bbceaae](5bbceaae))
<a name="1.7.0"></a>
```
Links
- PyPI: https://pypi.org/project/coveralls
- Changelog: https://pyup.io/changelogs/coveralls/
- Repo: http://github.com/coveralls-clients/coveralls-python
Changelog
### 3.8.2
```
-------------------
You can view the `3.8.2 milestone`_ on GitLab for more details.
Bugs Fixed
~~~~~~~~~~
- Improve performance by eliminating unncessary sort (See also `GitLab!429`_)
- Improve messaging of ``--jobs`` argument by utilizing ``argparse`` (See also
`GitLab!428`_, `GitLab567`_)
- Fix file configuration options to be relative to the config passed on the
command line (See also `GitLab!431`_, `GitLab651`_)
- Fix incorrect handling of ``--extend-exclude`` by treating its values as
files (See also `GitLab!432`_, `GitLab653`_)
.. all links
.. _3.8.2 milestone:
https://gitlab.com/pycqa/flake8/-/milestones/35
.. issue links
.. _GitLab567:
https://gitlab.com/pycqa/flake8/issues/567
.. _GitLab651:
https://gitlab.com/pycqa/flake8/issues/651
.. _GitLab653:
https://gitlab.com/pycqa/flake8/issues/653
.. merge request links
.. _GitLab!428:
https://gitlab.com/pycqa/flake8/merge_requests/428
.. _GitLab!429:
https://gitlab.com/pycqa/flake8/merge_requests/429
.. _GitLab!431:
https://gitlab.com/pycqa/flake8/merge_requests/431
.. _GitLab!432:
https://gitlab.com/pycqa/flake8/merge_requests/432
```
### 3.8.1
```
-------------------
You can view the `3.8.1 milestone`_ on GitLab for more details.
Bugs Fixed
~~~~~~~~~~
- Fix ``--output-file`` (regression in 3.8.0) (See also `GitLab!427`_,
`GitLab637`_)
.. all links
.. _3.8.1 milestone:
https://gitlab.com/pycqa/flake8/-/milestones/34
.. issue links
.. _GitLab637:
https://gitlab.com/pycqa/flake8/issues/637
.. merge request links
.. _GitLab!427:
https://gitlab.com/pycqa/flake8/merge_requests/427
```
### 3.8.0
```
-------------------
You can view the `3.8.0 milestone`_ on GitLab for more details.
Bugs Fixed
~~~~~~~~~~
- Fix logical checks which report positions out of bounds (See also
`GitLab!422`_, `GitLab635`_)
- Fix ``--exclude=.*`` accidentally matching ``.`` and ``..`` (See also
`GitLab!424`_, `GitLab632`_)
Deprecations
~~~~~~~~~~~~
- Add deprecation message for vcs hooks (See also `GitLab!420`_,
`GitLab568`_)
```
### 3.8.0a2
```
---------------------
You can view the `3.8.0 milestone`_ on GitLab for more details.
Bugs Fixed
~~~~~~~~~~
- Fix ``type="str"`` optparse options (See also `GitLab!419`_)
```
### 3.8.0a1
```
---------------------
You can view the `3.8.0 milestone`_ on GitLab for more details.
New Dependency Information
~~~~~~~~~~~~~~~~~~~~~~~~~~
- Remove dependency on ``entrypoints`` and add dependency on
``importlib-metadata`` (only for ``python<3.8``) (See also `GitLab!388`_,
`GitLab569`_)
- Pyflakes has been updated to >= 2.2.0, < 2.3.0 (See also `GitLab!417`_)
- pycodestyle has been updated to >= 2.6.0a1, < 2.7.0 (See also `GitLab!418`_)
Features
~~~~~~~~
- Add ``--extend-exclude`` option to add to ``--exclude`` without overwriting
(See also `GitLab!315`_, `GitLab535`_)
- Move argument parsing from ``optparse`` to ``argparse`` (See also
`GitLab!341`_
- Group plugin options in ``--help`` (See also `GitLab!342`_, `GitLab565`_)
- Remove parsing of ``verbose`` from configuration files as it was not
consistently applied (See also `GitLab!360`_, `GitLab439`_)
- Remove parsing of ``output_file`` from configuration files as it was not
consistently applied (See also `GitLab!361`_)
- Resolve configuration files relative to ``cwd`` instead of common prefix of
passed filenames. You may need to change ``flake8 subproject`` to
``cd subproject && flake8 .`` (See also `GitLab!363`_)
- Officially support python3.8 (See also `GitLab!377`_)
- ``--disable-noqa`` now also disables `` flake8: noqa`` (See also
`GitLab!380`_, `GitLab590`_)
- Ensure that a missing file produces a ``E902`` error (See also `GitLab!404`_,
`GitLab600`_)
- `` noqa`` comments now apply to all of the lines in an explicit ``\``
continuation or in a line continued by a multi-line string (See also
`GitLab!413`_, `GitLab375`_)
Bugs Fixed
~~~~~~~~~~
- Fix ``--exclude=./t.py`` to only match ``t.py`` at the top level (See also
`GitLab!311`_, `GitLab382`_)
- Fix ``--show-source`` when a file is indented with tabs (See also
`GitLab!339`_, `GitLab563`_)
- Fix crash when ``--max-line-length`` is given a non-integer (See also
`GitLab!341`_, `GitLab541`_)
- Prevent flip-flopping of ``indent_char`` causing extra ``E101`` errors (See
also `GitLab!357`_, `pycodestyle886`_)
- Only enable multiprocessing when the method is ``fork`` fixing issues
on macos with python3.8+ (See also `GitLab!366`_, `GitLab587`_) (note: this
fix also landed in 3.7.9)
- ``noqa`` is now only handled by flake8 fixing specific-noqa. Plugins
requesting this parameter will always receive ``False`` (See also
`GitLab!331`_, `GitLab552`_)
- Fix duplicate loading of plugins when invoked via ``python -m flake8`` (See
also `GitLab!388`_)
- Fix early exit when ``--exit-zero`` and ``--diff`` are provided and the diff
is empty (See also `GitLab!391`_)
- Consistently split lines when ``\f`` is present when reading from stdin (See
also `GitLab!406`_, `GitLab270`_)
Deprecations
~~~~~~~~~~~~
- ``python setup.py flake8`` (setuptools integration) is now deprecated and
will be removed in a future version (See also `GitLab!330`_, `GitLab544`_)
- ``type='string'`` (optparse) types are deprecated, use
``type=callable`` (argparse) instead. Support for ``type='string'`` will
be removed in a future version (See also `GitLab!341`_)
- ``%default`` in plugin option help text is deprecated, use ``%(default)s``
instead. Support for ``%default`` will be removed in a future version (See
also `GitLab!341`_)
- optparse-style ``action='callback'`` setting for options is deprecated, use
argparse action classes instead. This will be removed in a future version
(See also `GitLab!341`_)
.. all links
.. _3.8.0 milestone:
https://gitlab.com/pycqa/flake8/-/milestones/32
.. merge request links
.. _GitLab270:
https://gitlab.com/pycqa/flake8/-/issues/270
.. _GitLab375:
https://gitlab.com/pycqa/flake8/-/issues/375
.. _GitLab382:
https://gitlab.com/pycqa/flake8/-/issues/382
.. _GitLab439:
https://gitlab.com/pycqa/flake8/-/issues/439
.. _GitLab535:
https://gitlab.com/pycqa/flake8/-/issues/535
.. _GitLab541:
https://gitlab.com/pycqa/flake8/-/issues/541
.. _GitLab544:
https://gitlab.com/pycqa/flake8/-/issues/544
.. _GitLab552:
https://gitlab.com/pycqa/flake8/-/issues/552
.. _GitLab563:
https://gitlab.com/pycqa/flake8/-/issues/563
.. _GitLab565:
https://gitlab.com/pycqa/flake8/-/issues/565
.. _GitLab568:
https://gitlab.com/pycqa/flake8/-/issues/568
.. _GitLab569:
https://gitlab.com/pycqa/flake8/-/issues/569
.. _GitLab587:
https://gitlab.com/pycqa/flake8/-/issues/587
.. _GitLab590:
https://gitlab.com/pycqa/flake8/-/issues/590
.. _GitLab600:
https://gitlab.com/pycqa/flake8/-/issues/600
.. _GitLab632:
https://gitlab.com/pycqa/flake8/-/issues/632
.. _GitLab635:
https://gitlab.com/pycqa/flake8/-/issues/635
.. _pycodestyle886:
https://github.com/PyCQA/pycodestyle/issues/886
.. issue links
.. _GitLab!311:
https://gitlab.com/pycqa/flake8/-/merge_requests/311
.. _GitLab!315:
https://gitlab.com/pycqa/flake8/-/merge_requests/315
.. _GitLab!330:
https://gitlab.com/pycqa/flake8/-/merge_requests/330
.. _GitLab!331:
https://gitlab.com/pycqa/flake8/-/merge_requests/331
.. _GitLab!339:
https://gitlab.com/pycqa/flake8/-/merge_requests/339
.. _GitLab!341:
https://gitlab.com/pycqa/flake8/-/merge_requests/341
.. _GitLab!342:
https://gitlab.com/pycqa/flake8/-/merge_requests/342
.. _GitLab!357:
https://gitlab.com/pycqa/flake8/-/merge_requests/357
.. _GitLab!360:
https://gitlab.com/pycqa/flake8/-/merge_requests/360
.. _GitLab!361:
https://gitlab.com/pycqa/flake8/-/merge_requests/361
.. _GitLab!363:
https://gitlab.com/pycqa/flake8/-/merge_requests/363
.. _GitLab!366:
https://gitlab.com/pycqa/flake8/-/merge_requests/366
.. _GitLab!377:
https://gitlab.com/pycqa/flake8/-/merge_requests/377
.. _GitLab!380:
https://gitlab.com/pycqa/flake8/-/merge_requests/380
.. _GitLab!388:
https://gitlab.com/pycqa/flake8/-/merge_requests/388
.. _GitLab!391:
https://gitlab.com/pycqa/flake8/-/merge_requests/391
.. _GitLab!404:
https://gitlab.com/pycqa/flake8/-/merge_requests/404
.. _GitLab!406:
https://gitlab.com/pycqa/flake8/-/merge_requests/406
.. _GitLab!413:
https://gitlab.com/pycqa/flake8/-/merge_requests/413
.. _GitLab!417:
https://gitlab.com/pycqa/flake8/-/merge_requests/417
.. _GitLab!418:
https://gitlab.com/pycqa/flake8/-/merge_requests/418
.. _GitLab!419:
https://gitlab.com/pycqa/flake8/-/merge_requests/419
.. _GitLab!420:
https://gitlab.com/pycqa/flake8/-/merge_requests/420
.. _GitLab!422:
https://gitlab.com/pycqa/flake8/-/merge_requests/422
.. _GitLab!424:
https://gitlab.com/pycqa/flake8/-/merge_requests/424
```
### 3.7.9
```
-------------------
You can view the `3.7.9 milestone`_ on GitLab for more details.
Bugs Fixed
~~~~~~~~~~
- Disable multiprocessing when the multiprocessing method is ``spawn`` (such
as on macos in python3.8) (See also `GitLab!367`_, `GitLab587`_)
.. all links
.. _3.7.9 milestone:
https://gitlab.com/pycqa/flake8/milestones/33
.. issue links
.. _GitLab587:
https://gitlab.com/pycqa/flake8/issues/587
.. merge request links
.. _GitLab!367:
https://gitlab.com/pycqa/flake8/merge_requests/367
```
### 3.7.8
```
-------------------
You can view the `3.7.8 milestone`_ on GitLab for more details.
Bugs Fixed
~~~~~~~~~~
- Fix handling of ``Application.parse_preliminary_options_and_args`` when
argv is an empty list (See also `GitLab!310`_, `GitLab518`_)
- Fix crash when a file parses but fails to tokenize (See also `GitLab!314`_,
`GitLab532`_)
- Log the full traceback on plugin exceptions (See also `GitLab!317`_)
- Fix `` noqa: ...`` comments with multi-letter codes (See also `GitLab!326`_,
`GitLab549`_)
.. all links
.. _3.7.8 milestone:
https://gitlab.com/pycqa/flake8/milestones/31
.. issue links
.. _GitLab518:
https://gitlab.com/pycqa/flake8/issues/518
.. _GitLab532:
https://gitlab.com/pycqa/flake8/issues/532
.. _GitLab549:
https://gitlab.com/pycqa/flake8/issues/549
.. merge request links
.. _GitLab!310:
https://gitlab.com/pycqa/flake8/merge_requests/310
.. _GitLab!314:
https://gitlab.com/pycqa/flake8/merge_requests/314
.. _GitLab!317:
https://gitlab.com/pycqa/flake8/merge_requests/317
.. _GitLab!326:
https://gitlab.com/pycqa/flake8/merge_requests/326
```
Links
- PyPI: https://pypi.org/project/flake8
- Changelog: https://pyup.io/changelogs/flake8/
- Repo: https://gitlab.com/pycqa/flake8
Changelog
### 2.2.0
```
- Include column information in error messages
- Fix ``overload`` detection with other decorators and in non-global scopes
- Fix return-type annotation being a class member
- Fix assignment to ``_`` in doctests with existing ``_`` name
- Namespace attributes which are attached to ast nodes with ``_pyflakes_`` to
avoid conflicts with other libraries (notably bandit)
- Add check for f-strings without placeholders
- Add check for unused/extra/invalid ``'string literal'.format(...)``
- Add check for unused/extra/invalid ``'string literal % ...``
- Improve python shebang detection
- Allow type ignore to be followed by a code `` type: ignore[attr-defined]``
- Add support for assignment expressions (PEP 572)
- Support ``overload`` detection from ``typing_extensions`` as well
- Fix ``overload`` detection for async functions
- Allow ``continue`` inside ``finally`` in python 3.8+
- Fix handling of annotations in positional-only arguments
- Make pyflakes more resistant to future syntax additions
- Fix false positives in partially quoted type annotations
- Warn about ``is`` comparison to tuples
- Fix ``Checker`` usage with async function subtrees
- Add check for ``if`` of non-empty tuple
- Switch from ``optparse`` to ``argparse``
- Fix false positives in partially quoted type annotations in unusual contexts
- Be more cautious when identifying ``Literal`` type expressions
```
Links
- PyPI: https://pypi.org/project/pyflakes
- Changelog: https://pyup.io/changelogs/pyflakes/
- Repo: https://github.com/PyCQA/pyflakes
Changelog
### 1.3.17
```
:released: May 13, 2020
.. change::
:tags: bug, oracle
:tickets: 5246
Some modifications to how the cx_oracle dialect sets up per-column
outputtype handlers for LOB and numeric datatypes to adjust for potential
changes coming in cx_Oracle 8.
.. change::
:tags: bug, orm
:tickets: 5288
Fixed bug where using :func:`.with_polymorphic` as the target of a join via
:meth:`.RelationshipComparator.of_type` on a mapper that already has a
subquery-based with_polymorphic setting that's equivalent to the one
requested would not correctly alias the ON clause in the join.
.. change::
:tags: bug, oracle, performance
:tickets: 5314
Changed the implementation of fetching CLOB and BLOB objects to use
cx_Oracle's native implementation which fetches CLOB/BLOB objects inline
with other result columns, rather than performing a separate fetch. As
always, this can be disabled by setting auto_convert_lobs to False.
As part of this change, the behavior of a CLOB that was given a blank
string on INSERT now returns None on SELECT, which is now consistent with
that of VARCHAR on Oracle.
.. change::
:tags: usecase, postgresql
:tickets: 5265
Added support for columns or type :class:`.ARRAY` of :class:`.Enum`,
:class:`.JSON` or :class:`_postgresql.JSONB` in PostgreSQL.
Previously a workaround was required in these use cases.
.. change::
:tags: schema
:tickets: 4138
Add ``comment`` attribute to :class:`_schema.Column` ``__repr__`` method.
.. change::
:tags: bug, orm
:tickets: 5303
Fixed issue in the area of where loader options such as selectinload()
interact with the baked query system, such that the caching of a query is
not supposed to occur if the loader options themselves have elements such
as with_polymorphic() objects in them that currently are not
cache-compatible. The baked loader could sometimes not fully invalidate
itself in these some of these scenarios leading to missed eager loads.
.. change::
:tags: bug, engine
:tickets: 5326
Fixed fairly critical issue where the DBAPI connection could be returned to
the connection pool while still in an un-rolled-back state. The reset agent
responsible for rolling back the connection could be corrupted in the case
that the transaction was "closed" without being rolled back or committed,
which can occur in some scenarios when using ORM sessions and emitting
.close() in a certain pattern involving savepoints. The fix ensures that
the reset agent is always active.
.. change::
:tags: bug, orm
:tickets: 5304
Modified the internal "identity set" implementation, which is a set that
hashes objects on their id() rather than their hash values, to not actually
call the ``__hash__()`` method of the objects, which are typically
user-mapped objects. Some methods were calling this method as a side
effect of the implementation.
.. change::
:tags: usecase, postgresql
:tickets: 5266
Raise an explicit :class:`.exc.CompileError` when adding a table with a
column of type :class:`.ARRAY` of :class:`.Enum` configured with
:paramref:`.Enum.native_enum` set to ``False`` when
:paramref:`.Enum.create_constraint` is not set to ``False``
.. change::
:tags: bug, schema
:tickets: 5298
Fixed issue where an :class:`.Index` that is deferred in being associated
with a table, such as as when it contains a :class:`.Column` that is not
associated with any :class:`.Table` yet, would fail to attach correctly if
it also contained a non table-oriented expession.
.. change::
:tags: change, firebird
:tickets: 5278
Adjusted dialect loading for ``firebird://`` URIs so the external
sqlalchemy-firebird dialect will be used if it has been installed,
otherwise fall back to the (now deprecated) internal Firebird dialect.
.. change::
:tags: bug, mssql, reflection
:tickets: 5255
Fix a regression introduced by the reflection of computed column in
MSSQL when using the legacy TDS version 4.2. The dialect will try
to detect the protocol version of first connect and run in compatibility
mode if it cannot detect it.
.. change::
:tags: bug, mssql, reflection
:tickets: 5271
Fix a regression introduced by the reflection of computed column in
MSSQL when using SQL server versions before 2012, which does not support
the ``concat`` function.
.. change::
:tags: bug, orm
:tickets: 5269
An informative error message is raised when an ORM many-to-one comparison
is attempted against an object that is not an actual mapped instance.
Comparisons such as those to scalar subqueries aren't supported;
generalized comparison with subqueries is better achieved using
:meth:`~.RelationshipProperty.Comparator.has`.
.. change::
:tags: usecase, orm
:tickets: 5262
Added an accessor :attr:`.ColumnProperty.Comparator.expressions` which
provides access to the group of columns mapped under a multi-column
:class:`.ColumnProperty` attribute.
.. change::
:tags: bug, schema
:tickets: 5316
A warning is emitted when making use of the :attr:`.MetaData.sorted_tables`
attribute as well as the :func:`_schema.sort_tables` function, and the
given tables cannot be correctly sorted due to a cyclic dependency between
foreign key constraints. In this case, the functions will no longer sort
the involved tables by foreign key, and a warning will be emitted. Other
tables that are not part of the cycle will still be returned in dependency
order. Previously, the sorted_table routines would return a collection that
would unconditionally omit all foreign keys when a cycle was detected, and
no warning was emitted.
.. change::
:tags: orm, usecase
:tickets: 5237
Introduce :paramref:`_orm.relationship.sync_backref` flag in a relationship
to control if the synchronization events that mutate the in-Python
attributes are added. This supersedes the previous change :ticket:`5149`,
which warned that ``viewonly=True`` relationship target of a
back_populates or backref configuration would be disallowed.
.. changelog::
```
### 1.3.16
```
:released: April 7, 2020
.. change::
:tags: oracle, usecase
:tickets: 5200
Implemented AUTOCOMMIT isolation level for Oracle when using cx_Oracle.
Also added a fixed default isolation level of READ COMMITTED for Oracle.
.. change::
:tags: bug, mysql
:tickets: 5239
Fixed issue in MySQL dialect when connecting to a psuedo-MySQL database
such as that provided by ProxySQL, the up front check for isolation level
when it returns no row will not prevent the dialect from continuing to
connect. A warning is emitted that the isolation level could not be
detected.
.. change::
:tags: bug, tests
:tickets: 5201
Fixed an issue that prevented the test suite from running with the
recently released py.test 5.4.0.
.. change::
:tags: bug, oracle, reflection
:tickets: 5146
Fixed regression / incorrect fix caused by fix for :ticket:`5146` where the
Oracle dialect reads from the "all_tab_comments" view to get table comments
but fails to accommodate for the current owner of the table being
requested, causing it to read the wrong comment if multiple tables of the
same name exist in multiple schemas.
.. change::
:tags: types, enum
:tickets: 5183
The :class:`.Enum` type now supports the parameter :paramref:`.Enum.length`
to specify the length of the VARCHAR column to create when using
non native enums by setting :paramref:`.Enum.native_enum` to ``False``
.. change::
:tags: bug, orm
:tickets: 5228
Fixed bug in :func:`_orm.selectinload` loading option where two or more
loaders that represent different relationships with the same string key
name as referenced from a single :func:`_orm.with_polymorphic` construct
with multiple subclass mappers would fail to invoke each subqueryload
separately, instead making use of a single string-based slot that would
prevent the other loaders from being invoked.
.. change::
:tags: schema, reflection
:tickets: 5063
Added support for reflection of "computed" columns, which are now returned
as part of the structure returned by :meth:`_reflection.Inspector.get_columns`.
When reflecting full :class:`_schema.Table` objects, computed columns will
be represented using the :class:`.Computed` construct.
.. change::
:tags: orm, performance
:tickets: 5162
Modified the queries used by subqueryload and selectinload to no longer
ORDER BY the primary key of the parent entity; this ordering was there to
allow the rows as they come in to be copied into lists directly with a
minimal level of Python-side collation. However, these ORDER BY clauses
can negatively impact the performance of the query as in many scenarios
these columns are derived from a subquery or are otherwise not actual
primary key columns such that SQL planners cannot make use of indexes. The
Python-side collation uses the native itertools.group_by() to collate the
incoming rows, and has been modified to allow multiple
row-groups-per-parent to be assembled together using list.extend(), which
should still allow for relatively fast Python-side performance. There will
still be an ORDER BY present for a relationship that includes an explicit
order_by parameter, however this is the only ORDER BY that will be added to
the query for both kinds of loading.
.. change::
:tags: mssql, mysql, oracle, usecase
:tickets: 5137
Added support for :meth:`.ColumnOperators.is_distinct_from` and
:meth:`.ColumnOperators.isnot_distinct_from` to SQL Server,
MySQL, and Oracle.
.. change::
:tags: sqlite, usecase
:tickets: 5164
Implemented AUTOCOMMIT isolation level for SQLite when using pysq
Coverage remained the same at 98.785% when pulling b0d308c7edb7718799973a923cf56e260ac75ede on pyup-scheduled-update-2020-06-01 into f92d5ba68c370118523dd3edb5888f4cb1e989a9 on master.
Update psycopg2 from 2.8.2 to 2.8.5.
Changelog
### 2.8.5 ``` ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Fixed use of `!connection_factory` and `!cursor_factory` together (:ticket:`1019`). - Added support for `~logging.LoggerAdapter` in `~psycopg2.extras.LoggingConnection` (:ticket:`1026`). - `~psycopg2.extensions.Column` objects in `cursor.description` can be sliced (:ticket:`1034`). - Added AIX support (:ticket:`1061`). - Fixed `~copy.copy()` of `~psycopg2.extras.DictCursor` rows (:ticket:`1073`). ``` ### 2.8.4 ``` ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Fixed building with Python 3.8 (:ticket:`854`). - Don't swallow keyboard interrupts on connect when a password is specified in the connection string (:ticket:`898`). - Don't advance replication cursor when the message wasn't confirmed (:ticket:`940`). - Fixed inclusion of ``time.h`` on linux (:ticket:`951`). - Fixed int overflow for large values in `~psycopg2.extensions.Column.table_oid` and `~psycopg2.extensions.Column.type_code` (:ticket:`961`). - `~psycopg2.errorcodes` map and `~psycopg2.errors` classes updated to PostgreSQL 12. - Wheel package compiled against OpenSSL 1.1.1d and PostgreSQL at least 11.4. ``` ### 2.8.3 ``` ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Added *interval_status* parameter to `~psycopg2.extras.ReplicationCursor.start_replication()` method and other facilities to send automatic replication keepalives at periodic intervals (:ticket:`913`). - Fixed namedtuples caching introduced in 2.8 (:ticket:`928`). ```Links
- PyPI: https://pypi.org/project/psycopg2 - Changelog: https://pyup.io/changelogs/psycopg2/ - Homepage: https://psycopg.org/Update Sphinx from 1.8.5 to 3.0.4.
Changelog
### 3.0.4 ``` ===================================== Bugs fixed ---------- * 7567: autodoc: parametrized types are shown twice for generic types * 7637: autodoc: system defined TypeVars are shown in Python 3.9 * 7696: html: Updated jQuery version from 3.4.1 to 3.5.1 for security reasons * 7611: md5 fails when OpenSSL FIPS is enabled * 7626: release package does not contain ``CODE_OF_CONDUCT`` ``` ### 3.0.3 ``` ===================================== Features added -------------- * C, parse array declarators with static, qualifiers, and VLA specification. Bugs fixed ---------- * 7516: autodoc: crashes if target object raises an error on accessing its attributes ``` ### 3.0.2 ``` ===================================== Features added -------------- * C, parse attributes and add :confval:`c_id_attributes` and :confval:`c_paren_attributes` to support user-defined attributes. Bugs fixed ---------- * 7461: py domain: fails with IndexError for empty tuple in type annotation * 7510: py domain: keyword-only arguments are documented as having a default of None * 7418: std domain: :rst:role:`term` role could not match case-insensitively * 7461: autodoc: empty tuple in type annotation is not shown correctly * 7479: autodoc: Sphinx builds has been slower since 3.0.0 on mocking * C++, fix spacing issue in east-const declarations. * 7414: LaTeX: Xindy language options were incorrect * sphinx crashes with ImportError on python3.5.1 ``` ### 3.0.1 ``` ===================================== Incompatible changes -------------------- * 7418: std domain: :rst:dir:`term` role becomes case sensitive Bugs fixed ---------- * 7428: py domain: a reference to class ``None`` emits a nitpicky warning * 7445: py domain: a return annotation ``None`` in the function signature is not converted to a hyperlink when using intersphinx * 7418: std domain: duplication warning for glossary terms is case insensitive * 7438: C++, fix merging overloaded functions in parallel builds. * 7422: autodoc: fails with ValueError when using autodoc_mock_imports * 7435: autodoc: ``autodoc_typehints='description'`` doesn't suppress typehints in signature for classes/methods * 7451: autodoc: fails with AttributeError when an object returns non-string object as a ``__doc__`` member * 7423: crashed when giving a non-string object to logger * 7479: html theme: Do not include xmlns attribute with HTML 5 doctype * 7426: html theme: Escape some links in HTML templates ``` ### 3.0.0 ``` * 7364: autosummary: crashed when :confval:`autosummary_generate` is False * 7370: autosummary: raises UnboundLocalError when unknown module given * 7367: C++, alternate operator spellings are now supported. * C, alternate operator spellings are now supported. * 7368: C++, comma operator in expressions, pack expansion in template argument lists, and more comprehensive error messages in some cases. * C, C++, fix crash and wrong duplicate warnings related to anon symbols. * 6477: Escape first "!" in a cross reference linking no longer possible * 7219: py domain: The index entry generated by ``py:function`` directive is different with one from ``index`` directive with "builtin" type * 7301: capital characters are not allowed for node_id * 7301: epub: duplicated node_ids are generated * 6564: html: a width of table was ignored on HTML builder * 7401: Incorrect argument is passed for :event:`env-get-outdated` handlers * 7355: autodoc: a signature of cython-function is not recognized well * 7222: autodoc: ``__wrapped__`` functions are not documented correctly * 7409: intersphinx: ValueError is raised when an extension sets up :confval:`intersphinx_mapping` on :event:`config-inited` event * 7343: Sphinx builds has been slower since 2.4.0 on debug mode ``` ### 3.0.0b1 ``` * C++, fix cross reference lookup in certain cases involving function overloads. * 5078: C++, fix cross reference lookup when a directive contains multiple declarations. * C++, suppress warnings for directly dependent typenames in cross references generated automatically in signatures. * 5637: autodoc: Incorrect handling of nested class names on show-inheritance * 7267: autodoc: error message for invalid directive options has wrong location * 7329: autodoc: info-field-list is wrongly generated from type hints into the class description even if ``autoclass_content='class'`` set * 7331: autodoc: a cython-function is not recognized as a function * 5637: inheritance_diagram: Incorrect handling of nested class names * 7139: ``code-block:: guess`` does not work * 7325: html: source_suffix containing dot leads to wrong source link * 7357: html: Resizing SVG image fails with ValueError * 7278: html search: Fix use of ``html_file_suffix`` instead of ``html_link_suffix`` in search results * 7297: html theme: ``bizstyle`` does not support ``sidebarwidth`` * 3842: singlehtml: Path to images broken when master doc is not in source root * 7179: std domain: Fix whitespaces are suppressed on referring GenericObject * 7289: console: use bright colors instead of bold * 1539: C, parse array types. * 2377: C, parse function pointers even in complex types. * 7345: sphinx-build: Sphinx crashes if output directory exists as a file * 7290: sphinx-build: Ignore bdb.BdbQuit when handling exceptions * 6240: napoleon: Attributes and Methods sections ignore :noindex: option ``` ### 2.4.4 ``` ===================================== Bugs fixed ---------- * 7197: LaTeX: platex cause error to build image directive with target url * 7223: Sphinx builds has been slower since 2.4.0 ``` ### 2.4.3 ``` ===================================== Bugs fixed ---------- * 7184: autodoc: ``*args`` and ``**kwarg`` in type comments are not handled properly * 7189: autodoc: classmethod coroutines are not detected * 7183: intersphinx: ``:attr:`` reference to property is broken * 6244, 6387: html search: Search breaks/hangs when built with dirhtml builder * 7195: todo: emit doctree-resolved event with non-document node incorrectly ``` ### 2.4.2 ``` ===================================== Bugs fixed ---------- * 7138: autodoc: ``autodoc.typehints`` crashed when variable has unbound object as a value * 7156: autodoc: separator for keyword only arguments is not shown * 7146: autodoc: IndexError is raised on suppressed type_comment found * 7161: autodoc: typehints extension does not support parallel build * 7178: autodoc: TypeError is raised on fetching type annotations * 7151: crashed when extension assigns a value to ``env.indexentries`` * 7170: text: Remove debug print * 7137: viewcode: Avoid to crash when non-python code given ``` ### 2.4.1 ``` ===================================== Bugs fixed ---------- * 7120: html: crashed when on scaling SVG images which have float dimentions * 7126: autodoc: TypeError: 'getset_descriptor' object is not iterable ``` ### 2.4.0 ``` ===================================== Deprecated ---------- * The ``decode`` argument of ``sphinx.pycode.ModuleAnalyzer()`` * ``sphinx.directives.other.Index`` * ``sphinx.environment.temp_data['gloss_entries']`` * ``sphinx.environment.BuildEnvironment.indexentries`` * ``sphinx.environment.collectors.indexentries.IndexEntriesCollector`` * ``sphinx.ext.apidoc.INITPY`` * ``sphinx.ext.apidoc.shall_skip()`` * ``sphinx.io.FiletypeNotFoundError`` * ``sphinx.io.get_filetype()`` * ``sphinx.pycode.ModuleAnalyzer.encoding`` * ``sphinx.roles.Index`` * ``sphinx.util.detect_encoding()`` * ``sphinx.util.get_module_source()`` * ``sphinx.util.inspect.Signature`` * ``sphinx.util.inspect.safe_getmembers()`` * ``sphinx.writers.latex.LaTeXTranslator.settings.author`` * ``sphinx.writers.latex.LaTeXTranslator.settings.contentsname`` * ``sphinx.writers.latex.LaTeXTranslator.settings.docclass`` * ``sphinx.writers.latex.LaTeXTranslator.settings.docname`` * ``sphinx.writers.latex.LaTeXTranslator.settings.title`` * ``sphinx.writers.latex.ADDITIONAL_SETTINGS`` * ``sphinx.writers.latex.DEFAULT_SETTINGS`` * ``sphinx.writers.latex.LUALATEX_DEFAULT_FONTPKG`` * ``sphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKG`` * ``sphinx.writers.latex.XELATEX_DEFAULT_FONTPKG`` * ``sphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKG`` Features added -------------- * 6910: inheritance_diagram: Make the background of diagrams transparent * 6446: duration: Add ``sphinx.ext.durations`` to inspect which documents slow down the build * 6837: LaTeX: Support a nested table * 7115: LaTeX: Allow to override LATEXOPTS and LATEXMKOPTS via environment variable * 6966: graphviz: Support ``:class:`` option * 6696: html: ``:scale:`` option of image/figure directive not working for SVG images (imagesize-1.2.0 or above is required) * 6994: imgconverter: Support illustrator file (.ai) to .png conversion * autodoc: Support Positional-Only Argument separator (PEP-570 compliant) * autodoc: Support type annotations for variables * 2755: autodoc: Add new event: :event:`autodoc-before-process-signature` * 2755: autodoc: Support type_comment style (ex. `` type: (str) -> str``) annotation (python3.8+ or `typed_ast <https://github.com/python/typed_ast>`_ is required) * 7051: autodoc: Support instance variables without defaults (PEP-526) * 6418: autodoc: Add a new extension ``sphinx.ext.autodoc.typehints``. It shows typehints as object description if ``autodoc_typehints = "description"`` set. This is an experimental extension and it will be integrated into autodoc core in Sphinx-3.0 * SphinxTranslator now calls visitor/departure method for super node class if visitor/departure method for original node class not found * 6418: Add new event: :event:`object-description-transform` * py domain: :rst:dir:`py:data` and :rst:dir:`py:attribute` take new options named ``:type:`` and ``:value:`` to describe its type and initial value * 6785: py domain: ``:py:attr:`` is able to refer properties again * 6772: apidoc: Add ``-q`` option for quiet mode Bugs fixed ---------- * 6925: html: Remove redundant type="text/javascript" from <script> elements * 7112: html: SVG image is not layouted as float even if aligned * 6906, 6907: autodoc: failed to read the source codes encoeded in cp1251 * 6961: latex: warning for babel shown twice * 7059: latex: LaTeX compilation falls into infinite loop (wrapfig issue) * 6581: latex: ``:reversed:`` option for toctree does not effect to LaTeX build * 6559: Wrong node-ids are generated in glossary directive * 6986: apidoc: misdetects module name for .so file inside module * 6899: apidoc: private members are not shown even if ``--private`` given * 6327: apidoc: Support a python package consisted of __init__.so file * 6999: napoleon: fails to parse tilde in :exc: role * 7019: gettext: Absolute path used in message catalogs * 7023: autodoc: nested partial functions are not listed * 7023: autodoc: partial functions imported from other modules are listed as module members without :impoprted-members: option * 6889: autodoc: Trailing comma in ``:members::`` option causes cryptic warning * 6568: autosummary: ``autosummary_imported_members`` is ignored on generating a stub file for submodule * 7055: linkcheck: redirect is treated as an error * 7088: HTML template: If ``navigation_with_keys`` option is activated, modifier keys are ignored, which means the feature can interfere with browser features * 7090: std domain: Can't assign numfig-numbers for custom container nodes * 7106: std domain: enumerated nodes are marked as duplicated when extensions call ``note_explicit_target()`` * 7095: dirhtml: Cross references are broken via intersphinx and ``:doc:`` role * C++: - Don't crash when using the ``struct`` role in some cases. - Don't warn when using the ``var``/``member`` role for function parameters. - Render call and braced-init expressions correctly. * 7097: Filenames of images generated by ``sphinx.transforms.post_transforms.images.ImageConverter`` or its subclasses (used for latex build) are now sanitized, to prevent broken paths ``` ### 2.3.1 ``` ===================================== Bugs fixed ---------- * 6936: sphinx-autogen: raises AttributeError ``` ### 2.3.0 ``` ===================================== Incompatible changes -------------------- * 6742: ``end-before`` option of :rst:dir:`literalinclude` directive does not match the first line of the code block. * 1331: Change default User-Agent header to ``"Sphinx/X.Y.Z requests/X.Y.Z python/X.Y.Z"``. It can be changed via :confval:`user_agent`. * 6867: text: content of admonitions starts after a blank line Deprecated ---------- * ``sphinx.builders.gettext.POHEADER`` * ``sphinx.io.SphinxStandaloneReader.app`` * ``sphinx.io.SphinxStandaloneReader.env`` * ``sphinx.util.texescape.tex_escape_map`` * ``sphinx.util.texescape.tex_hl_escape_map_new`` * ``sphinx.writers.latex.LaTeXTranslator.no_contractions`` Features added -------------- * 6707: C++, support bit-fields. * 267: html: Eliminate prompt characters of doctest block from copyable text * 6548: html: Use favicon for OpenSearch if available * 6729: html theme: agogo theme now supports ``rightsidebar`` option * 6780: Add PEP-561 Support * 6762: latex: Allow to load additonal LaTeX packages via ``extrapackages`` key of :confval:`latex_elements` * 1331: Add new config variable: :confval:`user_agent` * 6000: LaTeX: have backslash also be an inline literal word wrap break character * 4186: LaTeX: Support upLaTeX as a new :confval:`latex_engine` (experimental) * 6812: Improve a warning message when extensions are not parallel safe * 6818: Improve Intersphinx performance for multiple remote inventories. * 2546: apidoc: .so file support * 6798: autosummary: emit ``autodoc-skip-member`` event on generating stub file * 6483: i18n: make explicit titles in toctree translatable * 6816: linkcheck: Add :confval:`linkcheck_auth` option to provide authentication information when doing ``linkcheck`` builds * 6872: linkcheck: Handles HTTP 308 Permanent Redirect * 6613: html: Wrap section number in span tag * 6781: gettext: Add :confval:`gettext_last_translator' and :confval:`gettext_language_team` to customize headers of POT file Bugs fixed ---------- * 6668: LaTeX: Longtable before header has incorrect distance (refs: `latex3/latex2e173`_) .. _latex3/latex2e173: https://github.com/latex3/latex2e/issues/173 * 6618: LaTeX: Avoid section names at the end of a page * 6738: LaTeX: Do not replace unicode characters by LaTeX macros on unicode supported LaTeX engines: ¶, §, €, ∞, ±, →, ‣, –, superscript and subscript digits go through "as is" (as default OpenType font supports them) * 6704: linkcheck: Be defensive and handle newly defined HTTP error code * 6806: linkcheck: Failure on parsing content * 6655: image URLs containing ``data:`` causes gettext builder crashed * 6584: i18n: Error when compiling message catalogs on Hindi * 6718: i18n: KeyError is raised if section title and table title are same * 6743: i18n: :confval:`rst_prolog` breaks the translation * 6708: mathbase: Some deprecated functions have removed * 6709: autodoc: mock object does not work as a class decorator * 5070: epub: Wrong internal href fragment links * 6712: Allow not to install sphinx.testing as runtime (mainly for ALT Linux) * 6741: html: search result was broken with empty :confval:`html_file_suffix` * 6001: LaTeX does not wrap long code lines at backslash character * 6804: LaTeX: PDF build breaks if admonition of danger type contains code-block long enough not to fit on one page * 6809: LaTeX: code-block in a danger type admonition can easily spill over bottom of page * 6793: texinfo: Code examples broken following "sidebar" * 6813: An orphan warning is emitted for included document on Windows. Thanks to drillan * 6850: Fix smartypants module calls re.sub() with wrong options * 6824: HTML search: If a search term is partially matched in the title and fully matched in a text paragraph on the same page, the search does not include this match. * 6848: config.py shouldn't pop extensions from overrides * 6867: text: extra spaces are inserted to hyphenated words on folding lines * 6886: LaTeX: xelatex converts straight double quotes into right curly ones (shows when :confval:`smartquotes` is ``False``) * 6890: LaTeX: even with smartquotes off, PDF output transforms straight quotes and consecutive hyphens into curly quotes and dashes * 6876: LaTeX: multi-line display of authors on title page has ragged edges * 6887: Sphinx crashes with docutils-0.16b0 * 6920: sphinx-build: A console message is wrongly highlighted * 6900: sphinx-build: ``-D`` option does not considers ``0`` and ``1`` as a boolean value ``` ### 2.2.2 ``` ===================================== Incompatible changes -------------------- * 6803: For security reason of python, parallel mode is disabled on macOS and Python3.8+ Bugs fixed ---------- * 6776: LaTeX: 2019-10-01 LaTeX release breaks :file:`sphinxcyrillic.sty` * 6815: i18n: French, Hindi, Chinese, Japanese and Korean translation messages has been broken * 6803: parallel build causes AttributeError on macOS and Python3.8 ``` ### 2.2.1 ``` ===================================== Bugs fixed ---------- * 6641: LaTeX: Undefined control sequence ``\sphinxmaketitle`` * 6710: LaTeX not well configured for Greek language as main language * 6759: validation of html static paths and extra paths no longer throws an error if the paths are in different directories ``` ### 2.2.0 ``` ===================================== Incompatible changes -------------------- * apidoc: template files are renamed to ``.rst_t`` * html: Field lists will be styled by grid layout Deprecated ---------- * ``sphinx.domains.math.MathDomain.add_equation()`` * ``sphinx.domains.math.MathDomain.get_next_equation_number()`` * The ``info`` and ``warn`` arguments of ``sphinx.ext.autosummary.generate.generate_autosummary_docs()`` * ``sphinx.ext.autosummary.generate._simple_info()`` * ``sphinx.ext.autosummary.generate._simple_warn()`` * ``sphinx.ext.todo.merge_info()`` * ``sphinx.ext.todo.process_todo_nodes()`` * ``sphinx.ext.todo.process_todos()`` * ``sphinx.ext.todo.purge_todos()`` Features added -------------- * 5124: graphviz: ``:graphviz_dot:`` option is renamed to ``:layout:`` * 1464: html: emit a warning if :confval:`html_static_path` and :confval:`html_extra_path` directories are inside output directory * 6514: html: Add a label to search input for accessability purposes * 5602: apidoc: Add ``--templatedir`` option * 6475: Add ``override`` argument to ``app.add_autodocumenter()`` * 6310: imgmath: let :confval:`imgmath_use_preview` work also with the SVG format for images rendering inline math * 6533: LaTeX: refactor visit_enumerated_list() to use ``\sphinxsetlistlabels`` * 6628: quickstart: Use ``https://docs.python.org/3/`` for default setting of :confval:`intersphinx_mapping` * 6419: sphinx-build: give reasons why rebuilded Bugs fixed ---------- * py domain: duplicated warning does not point the location of source code * 6499: html: Sphinx never updates a copy of :confval:`html_logo` even if original file has changed * 1125: html theme: scrollbar is hard to see on classic theme and macOS * 5502: linkcheck: Consider HTTP 503 response as not an error * 6439: Make generated download links reproducible * 6486: UnboundLocalError is raised if broken extension installed * 6567: autodoc: :confval:`autodoc_inherit_docstrings` does not effect to ``__init__()`` and ``__new__()`` * 6574: autodoc: :confval:`autodoc_member_order` does not refer order of imports when ``'bysource'`` order * 6574: autodoc: missing type annotation for variadic and keyword parameters * 6589: autodoc: Formatting issues with autodoc_typehints='none' * 6605: autodoc: crashed when target code contains custom method-like objects * 6498: autosummary: crashed with wrong autosummary_generate setting * 6507: autosummary: crashes without no autosummary_generate setting * 6511: LaTeX: autonumbered list can not be customized in LaTeX since Sphinx 1.8.0 (refs: 6533) * 6531: Failed to load last environment object when extension added * 736: Invalid sort in pair index * 6527: :confval:`last_updated` wrongly assumes timezone as UTC * 5592: std domain: :rst:dir:`option` directive registers an index entry for each comma separated option * 6549: sphinx-build: Escaped characters in error messages * 6545: doctest comments not getting trimmed since Sphinx 1.8.0 * 6561: glossary: Wrong hyperlinks are generated for non alphanumeric terms * 6620: i18n: classifiers of definition list are not translated with docutils-0.15 * 6474: ``DocFieldTransformer`` raises AttributeError when given directive is not a subclass of ObjectDescription ``` ### 2.1.2 ``` ===================================== Bugs fixed ---------- * 6497: custom lexers fails highlighting when syntax error * 6478, 6488: info field lists are incorrectly recognized ``` ### 2.1.1 ``` ===================================== Incompatible changes -------------------- * 6447: autodoc: Stop to generate document for undocumented module variables Bugs fixed ---------- * 6442: LaTeX: admonitions of :rst:dir:`note` type can get separated from immediately preceding section title by pagebreak * 6448: autodoc: crashed when autodocumenting classes with ``__slots__ = None`` * 6451: autodoc: generates docs for "optional import"ed modules as variables * 6452: autosummary: crashed when generating document of properties * 6455: napoleon: docstrings for properties are not processed * 6436: napoleon: "Unknown target name" error if variable name ends with underscore * 6440: apidoc: missing blank lines between modules ``` ### 2.1.0 ``` ===================================== Incompatible changes -------------------- * Ignore filenames without file extension given to ``Builder.build_specific()`` API directly * 6230: The anchor of term in glossary directive is changed if it is consisted by non-ASCII characters * 4550: html: Centering tables by default using CSS * 6239: latex: xelatex and xeCJK are used for Chinese documents by default * ``Sphinx.add_lexer()`` now takes a Lexer class instead of instance. An instance of lexers are still supported until Sphinx-3.x. Deprecated ---------- * ``sphinx.builders.latex.LaTeXBuilder.apply_transforms()`` * ``sphinx.builders._epub_base.EpubBuilder.esc()`` * ``sphinx.directives.Acks`` * ``sphinx.directives.Author`` * ``sphinx.directives.Centered`` * ``sphinx.directives.Class`` * ``sphinx.directives.CodeBlock`` * ``sphinx.directives.Figure`` * ``sphinx.directives.HList`` * ``sphinx.directives.Highlight`` * ``sphinx.directives.Include`` * ``sphinx.directives.Index`` * ``sphinx.directives.LiteralInclude`` * ``sphinx.directives.Meta`` * ``sphinx.directives.Only`` * ``sphinx.directives.SeeAlso`` * ``sphinx.directives.TabularColumns`` * ``sphinx.directives.TocTree`` * ``sphinx.directives.VersionChange`` * ``sphinx.domains.python.PyClassmember`` * ``sphinx.domains.python.PyModulelevel`` * ``sphinx.domains.std.StandardDomain._resolve_citation_xref()`` * ``sphinx.domains.std.StandardDomain.note_citations()`` * ``sphinx.domains.std.StandardDomain.note_citation_refs()`` * ``sphinx.domains.std.StandardDomain.note_labels()`` * ``sphinx.environment.NoUri`` * ``sphinx.ext.apidoc.format_directive()`` * ``sphinx.ext.apidoc.format_heading()`` * ``sphinx.ext.apidoc.makename()`` * ``sphinx.ext.autodoc.importer.MockFinder`` * ``sphinx.ext.autodoc.importer.MockLoader`` * ``sphinx.ext.autodoc.importer.mock()`` * ``sphinx.ext.autosummary.autolink_role()`` * ``sphinx.ext.imgmath.DOC_BODY`` * ``sphinx.ext.imgmath.DOC_BODY_PREVIEW`` * ``sphinx.ext.imgmath.DOC_HEAD`` * ``sphinx.transforms.CitationReferences`` * ``sphinx.transforms.SmartQuotesSkipper`` * ``sphinx.util.docfields.DocFieldTransformer.preprocess_fieldtypes()`` * ``sphinx.util.node.find_source_node()`` * ``sphinx.util.i18n.find_catalog()`` * ``sphinx.util.i18n.find_catalog_files()`` * ``sphinx.util.i18n.find_catalog_source_files()`` For more details, see :ref:`deprecation APIs list <dev-deprecated-apis>`. Features added -------------- * Add a helper class ``sphinx.transforms.post_transforms.SphinxPostTransform`` * Add helper methods - ``PythonDomain.note_module()`` - ``PythonDomain.note_object()`` - ``SphinxDirective.set_source_info()`` * 6180: Support ``--keep-going`` with BuildDoc setup command * ``math`` directive now supports ``:class:`` option * todo: ``todo`` directive now supports ``:name:`` option * Enable override via environment of ``SPHINXOPTS`` and ``SPHINXBUILD`` Makefile variables (refs: 6232, 6303) * 6287: autodoc: Unable to document bound instance methods exported as module functions * 6289: autodoc: :confval:`autodoc_default_options` now supports ``imported-members`` option * 4777: autodoc: Support coroutine * 744: autodoc: Support abstractmethod * 6325: autodoc: Support attributes in __slots__. For dict-style __slots__, autodoc considers values as a docstring of the attribute * 6361: autodoc: Add :confval:`autodoc_typehints` to suppress typehints from signature * 1063: autodoc: ``automodule`` directive now handles undocumented module level variables * 6212 autosummary: Add :confval:`autosummary_imported_members` to display imported members on autosummary * 6271: ``make clean`` is catastrophically broken if building into '.' * 6363: Support ``%O%`` environment variable in make.bat * 4777: py domain: Add ``:async:`` option to :rst:dir:`py:function` directive * py domain: Add new options to :rst:dir:`py:method` directive - ``:abstractmethod:`` - ``:async:`` - ``:classmethod:`` - ``:property:`` - ``:staticmethod:`` * rst domain: Add :rst:dir:`directive:option` directive to describe the option for directive * 6306: html: Add a label to search form for accessability purposes * 4390: html: Consistent and semantic CSS for signatures * 6358: The ``rawsource`` property of ``production`` nodes now contains the full production rule * 6373: autosectionlabel: Allow suppression of warnings * coverage: Support a new ``coverage_ignore_pyobjects`` option * 6239: latex: Support to build Chinese documents Bugs fixed ---------- * 6230: Inappropriate node_id has been generated by glossary directive if term is consisted by non-ASCII characters * 6213: ifconfig: contents after headings are not shown * commented term in glossary directive is wrongly recognized * 6299: rst domain: rst:directive directive generates waste space * 6379: py domain: Module index (py-modindex.html) has duplicate titles * 6331: man: invalid output when doctest follows rubric * 6351: "Hyperlink target is not referenced" message is shown even if referenced * 6165: autodoc: ``tab_width`` setting of docutils has been ignored * 6347: autodoc: crashes with a plain Tuple on Python 3.6 and 3.5 * 6311: autosummary: autosummary table gets confused by complex type hints * 6350: autosummary: confused by an argument having some kind of default value * Generated Makefiles lack a final EOL (refs: 6232) * 6375: extlinks: Cannot escape angle brackets in link caption * 6378: linkcheck: Send commonly used User-Agent * 6387: html search: failed to search document with haiku and scrolls themes * 6408: html search: Fix the ranking of search results * 6406: Wrong year is returned for ``SOURCE_DATE_EPOCH`` * 6402: image directive crashes by unknown image format * 6286: C++, allow 8 and 9 in hexadecimal integer literals. * 6305: Fix the string in quickstart for 'path' argument of parser * LaTeX: Figures in admonitions produced errors (refs: 6364) ``` ### 2.0.1 ``` ===================================== Bugs fixed ---------- * LaTeX: some system labels are not translated * RemovedInSphinx30Warning is marked as pending * deprecation warnings are not emitted - sphinx.application.CONFIG_FILENAME - sphinx.builders.htmlhelp - :confval:`viewcode_import` * 6208: C++, properly parse full xrefs that happen to have a short xref as prefix * 6220, 6225: napoleon: AttributeError is raised for raised section having references * 6245: circular import error on importing SerializingHTMLBuilder * 6243: LaTeX: 'releasename' setting for latex_elements is ignored * 6244: html: Search function is broken with 3rd party themes * 6263: html: HTML5Translator crashed with invalid field node * 6262: html theme: The style of field lists has changed in bizstyle theme ``` ### 2.0.0 ``` * 6196: py domain: unexpected prefix is generated Testing -------- ``` ### 2.0.0b2 ``` * Add a helper function: ``sphinx.testing.restructuredtext.parse()`` ``` ### 2.0.0b1 ``` * Stop to use ``SPHINX_TEST_TEMPDIR`` envvar ```Links
- PyPI: https://pypi.org/project/sphinx - Changelog: https://pyup.io/changelogs/sphinx/ - Homepage: http://sphinx-doc.org/Update pytest from 4.4.1 to 5.4.2.
The bot wasn't able to find a changelog for this release. Got an idea?
Links
- PyPI: https://pypi.org/project/pytest - Homepage: https://docs.pytest.org/en/latest/Update pytest-cov from 2.6.1 to 2.9.0.
Changelog
### 2.9.0 ``` ------------------ * Fixed ``RemovedInPytest4Warning`` when using Pytest 3.10. Contributed by Michael Manganiello in `354 <https://github.com/pytest-dev/pytest-cov/pull/354>`_. * Made pytest startup faster when plugin not active by lazy-importing. Contributed by Anders Hovmöller in `339 <https://github.com/pytest-dev/pytest-cov/pull/339>`_. * Various CI improvements. Contributed by Daniel Hahler in `363 <https://github.com/pytest-dev/pytest-cov/pull/>`_ and `364 <https://github.com/pytest-dev/pytest-cov/pull/364>`_. * Various Python support updates (drop EOL 3.4, test against 3.8 final). Contributed by Hugo van Kemenade in `336 <https://github.com/pytest-dev/pytest-cov/pull/336>`_ and `367 <https://github.com/pytest-dev/pytest-cov/pull/367>`_. * Changed ``--cov-append`` to always enable ``data_suffix`` (a coverage setting). Contributed by Harm Geerts in `387 <https://github.com/pytest-dev/pytest-cov/pull/387>`_. * Changed ``--cov-append`` to handle loading previous data better (fixes various path aliasing issues). * Various other testing improvements, github issue templates, example updates. * Fixed internal failures that are caused by tests that change the current working directory by ensuring a consistent working directory when coverage is called. See `306 <https://github.com/pytest-dev/pytest-cov/issues/306>`_ and `coveragepy881 <https://github.com/nedbat/coveragepy/issues/881>`_ ``` ### 2.8.1 ``` ------------------ * Fixed `348 <https://github.com/pytest-dev/pytest-cov/issues/348>`_ - regression when only certain reports (html or xml) are used then ``--cov-fail-under`` always fails. ``` ### 2.8.0 ``` ------------------ * Fixed ``RecursionError`` that can occur when using `cleanup_on_signal <https://pytest-cov.readthedocs.io/en/latest/subprocess-support.htmlif-you-got-custom-signal-handling>`__ or `cleanup_on_sigterm <https://pytest-cov.readthedocs.io/en/latest/subprocess-support.htmlif-you-got-custom-signal-handling>`__. See: `294 <https://github.com/pytest-dev/pytest-cov/issues/294>`_. The 2.7.x releases of pytest-cov should be considered broken regarding aforementioned cleanup API. * Added compatibility with future xdist release that deprecates some internals (match pytest-xdist master/worker terminology). Contributed by Thomas Grainger in `321 <https://github.com/pytest-dev/pytest-cov/pull/321>`_ * Fixed breakage that occurs when multiple reporting options are used. Contributed by Thomas Grainger in `338 <https://github.com/pytest-dev/pytest-cov/pull/338>`_. * Changed internals to use a stub instead of ``os.devnull``. Contributed by Thomas Grainger in `332 <https://github.com/pytest-dev/pytest-cov/pull/332>`_. * Added support for Coverage 5.0. Contributed by Ned Batchelder in `319 <https://github.com/pytest-dev/pytest-cov/pull/319>`_. * Added support for float values in ``--cov-fail-under``. Contributed by Martín Gaitán in `311 <https://github.com/pytest-dev/pytest-cov/pull/311>`_. * Various documentation fixes. Contributed by Juanjo Bazán, Andrew Murray and Albert Tugushev in `298 <https://github.com/pytest-dev/pytest-cov/pull/298>`_, `299 <https://github.com/pytest-dev/pytest-cov/pull/299>`_ and `307 <https://github.com/pytest-dev/pytest-cov/pull/307>`_. * Various testing improvements. Contributed by Ned Batchelder, Daniel Hahler, Ionel Cristian Mărieș and Hugo van Kemenade in `313 <https://github.com/pytest-dev/pytest-cov/pull/313>`_, `314 <https://github.com/pytest-dev/pytest-cov/pull/314>`_, `315 <https://github.com/pytest-dev/pytest-cov/pull/315>`_, `316 <https://github.com/pytest-dev/pytest-cov/pull/316>`_, `325 <https://github.com/pytest-dev/pytest-cov/pull/325>`_, `326 <https://github.com/pytest-dev/pytest-cov/pull/326>`_, `334 <https://github.com/pytest-dev/pytest-cov/pull/334>`_ and `335 <https://github.com/pytest-dev/pytest-cov/pull/335>`_. * Added the ``--cov-context`` CLI options that enables coverage contexts. Only works with coverage 5.0+. Contributed by Ned Batchelder in `345 <https://github.com/pytest-dev/pytest-cov/pull/345>`_. ``` ### 2.7.1 ``` ------------------ * Fixed source distribution manifest so that garbage ain't included in the tarball. ``` ### 2.7.0 ``` ------------------ * Fixed ``AttributeError: 'NoneType' object has no attribute 'configure_node'`` error when ``--no-cov`` is used. Contributed by Alexander Shadchin in `263 <https://github.com/pytest-dev/pytest-cov/pull/263>`_. * Various testing and CI improvements. Contributed by Daniel Hahler in `255 <https://github.com/pytest-dev/pytest-cov/pull/255>`_, `266 <https://github.com/pytest-dev/pytest-cov/pull/266>`_, `272 <https://github.com/pytest-dev/pytest-cov/pull/272>`_, `271 <https://github.com/pytest-dev/pytest-cov/pull/271>`_ and `269 <https://github.com/pytest-dev/pytest-cov/pull/269>`_. * Improved documentation regarding subprocess and multiprocessing. Contributed in `265 <https://github.com/pytest-dev/pytest-cov/pull/265>`_. * Improved ``pytest_cov.embed.cleanup_on_sigterm`` to be reentrant (signal deliveries while signal handling is running won't break stuff). * Added ``pytest_cov.embed.cleanup_on_signal`` for customized cleanup. * Improved cleanup code and fixed various issues with leftover data files. All contributed in `265 <https://github.com/pytest-dev/pytest-cov/pull/265>`_ or `262 <https://github.com/pytest-dev/pytest-cov/pull/262>`_. * Improved examples. Now there are two examples for the common project layouts, complete with working coverage configuration. The examples have CI testing. Contributed in `267 <https://github.com/pytest-dev/pytest-cov/pull/267>`_. * Improved help text for CLI options. ```Links
- PyPI: https://pypi.org/project/pytest-cov - Changelog: https://pyup.io/changelogs/pytest-cov/ - Repo: https://github.com/pytest-dev/pytest-covUpdate coveralls from 1.7.0 to 2.0.0.
Changelog
### 2.0.0 ``` Compatiblity (BREAKING CHANGES) * We have now dropped support for End-Of-Life'd versions of Python and particularly old versions of the `coverage` library; if you are still using Python v2.7 or v3.4, or you are using `coverage<4.1`, this library will no longer be compatible starting from this release -- please pin to `coveralls<2.0.0`. <a name="1.11.1"></a> ``` ### 1.11.1 ``` Bug Fixes * **github:** rename to github-actions ([9e65a059](9e65a059)) This fixes a regression introduced with v1.11.0, which may have prevented usage of this library on Github Actions. <a name="1.11.0"></a> ``` ### 1.11.0 ``` Fixes * **github:** add `service_number` for github actions ([9f93bd8e](9f93bd8e)) This should fix support for parallel builds. Compatibility * Python 2.7 and 3.4 are now officially End-Of-Life'd. Consider them deprecated from the perspective of this package -- we'll remove them in an upcoming release (likely the first one which requires non-trivial work to continue supporting them!). <a name="1.10.0"></a> ``` ### 1.10.0 ``` Features * support coverage>=5.0 (214) ([4a917402](4a917402)) <a name="1.9.2"></a> ``` ### 1.9.2 ``` Bug Fixes * **github:** fixup incorrect API usage (209) ([c338cab4](c338cab4)) <a name="1.9.1"></a> ``` ### 1.9.1 ``` Compatibility * this release marks Python 3.8 as officially supported. Earlier versions probably supported Python 3.8 too, but now we're *sure*. <a name="1.9.0"></a> ``` ### 1.9.0 ``` Features * **support:** support Github Actions CI (207) ([817119c3](817119c3)) Bug Fixes * **compatibility:** fixup coverage.__version__ comparisons (208) ([03a57a9a](03a57a9a)) <a name="1.8.2"></a> ``` ### 1.8.2 ``` Internal * **dependencies**: update pass urllib3<1.25 pin, now that that's fixed. <a name="1.8.1"></a> ``` ### 1.8.1 ``` Bug Fixes * **dependencies:** pin `coverage` to `< 5.0`, since the current `5.0` alphas are introducing breaking changes. Once `5.0` is stable, we'll remove the pin. <a name="1.8.0"></a> ``` ### 1.8.0 ``` Features * **flag:** allow disabling SSL verification ([2e3b5c61](2e3b5c61)) Bug Fixes * **git:** fix support for case where git binary is missing ([5bbceaae](5bbceaae)) <a name="1.7.0"></a> ```Links
- PyPI: https://pypi.org/project/coveralls - Changelog: https://pyup.io/changelogs/coveralls/ - Repo: http://github.com/coveralls-clients/coveralls-pythonUpdate flake8 from 3.7.7 to 3.8.2.
Changelog
### 3.8.2 ``` ------------------- You can view the `3.8.2 milestone`_ on GitLab for more details. Bugs Fixed ~~~~~~~~~~ - Improve performance by eliminating unncessary sort (See also `GitLab!429`_) - Improve messaging of ``--jobs`` argument by utilizing ``argparse`` (See also `GitLab!428`_, `GitLab567`_) - Fix file configuration options to be relative to the config passed on the command line (See also `GitLab!431`_, `GitLab651`_) - Fix incorrect handling of ``--extend-exclude`` by treating its values as files (See also `GitLab!432`_, `GitLab653`_) .. all links .. _3.8.2 milestone: https://gitlab.com/pycqa/flake8/-/milestones/35 .. issue links .. _GitLab567: https://gitlab.com/pycqa/flake8/issues/567 .. _GitLab651: https://gitlab.com/pycqa/flake8/issues/651 .. _GitLab653: https://gitlab.com/pycqa/flake8/issues/653 .. merge request links .. _GitLab!428: https://gitlab.com/pycqa/flake8/merge_requests/428 .. _GitLab!429: https://gitlab.com/pycqa/flake8/merge_requests/429 .. _GitLab!431: https://gitlab.com/pycqa/flake8/merge_requests/431 .. _GitLab!432: https://gitlab.com/pycqa/flake8/merge_requests/432 ``` ### 3.8.1 ``` ------------------- You can view the `3.8.1 milestone`_ on GitLab for more details. Bugs Fixed ~~~~~~~~~~ - Fix ``--output-file`` (regression in 3.8.0) (See also `GitLab!427`_, `GitLab637`_) .. all links .. _3.8.1 milestone: https://gitlab.com/pycqa/flake8/-/milestones/34 .. issue links .. _GitLab637: https://gitlab.com/pycqa/flake8/issues/637 .. merge request links .. _GitLab!427: https://gitlab.com/pycqa/flake8/merge_requests/427 ``` ### 3.8.0 ``` ------------------- You can view the `3.8.0 milestone`_ on GitLab for more details. Bugs Fixed ~~~~~~~~~~ - Fix logical checks which report positions out of bounds (See also `GitLab!422`_, `GitLab635`_) - Fix ``--exclude=.*`` accidentally matching ``.`` and ``..`` (See also `GitLab!424`_, `GitLab632`_) Deprecations ~~~~~~~~~~~~ - Add deprecation message for vcs hooks (See also `GitLab!420`_, `GitLab568`_) ``` ### 3.8.0a2 ``` --------------------- You can view the `3.8.0 milestone`_ on GitLab for more details. Bugs Fixed ~~~~~~~~~~ - Fix ``type="str"`` optparse options (See also `GitLab!419`_) ``` ### 3.8.0a1 ``` --------------------- You can view the `3.8.0 milestone`_ on GitLab for more details. New Dependency Information ~~~~~~~~~~~~~~~~~~~~~~~~~~ - Remove dependency on ``entrypoints`` and add dependency on ``importlib-metadata`` (only for ``python<3.8``) (See also `GitLab!388`_, `GitLab569`_) - Pyflakes has been updated to >= 2.2.0, < 2.3.0 (See also `GitLab!417`_) - pycodestyle has been updated to >= 2.6.0a1, < 2.7.0 (See also `GitLab!418`_) Features ~~~~~~~~ - Add ``--extend-exclude`` option to add to ``--exclude`` without overwriting (See also `GitLab!315`_, `GitLab535`_) - Move argument parsing from ``optparse`` to ``argparse`` (See also `GitLab!341`_ - Group plugin options in ``--help`` (See also `GitLab!342`_, `GitLab565`_) - Remove parsing of ``verbose`` from configuration files as it was not consistently applied (See also `GitLab!360`_, `GitLab439`_) - Remove parsing of ``output_file`` from configuration files as it was not consistently applied (See also `GitLab!361`_) - Resolve configuration files relative to ``cwd`` instead of common prefix of passed filenames. You may need to change ``flake8 subproject`` to ``cd subproject && flake8 .`` (See also `GitLab!363`_) - Officially support python3.8 (See also `GitLab!377`_) - ``--disable-noqa`` now also disables `` flake8: noqa`` (See also `GitLab!380`_, `GitLab590`_) - Ensure that a missing file produces a ``E902`` error (See also `GitLab!404`_, `GitLab600`_) - `` noqa`` comments now apply to all of the lines in an explicit ``\`` continuation or in a line continued by a multi-line string (See also `GitLab!413`_, `GitLab375`_) Bugs Fixed ~~~~~~~~~~ - Fix ``--exclude=./t.py`` to only match ``t.py`` at the top level (See also `GitLab!311`_, `GitLab382`_) - Fix ``--show-source`` when a file is indented with tabs (See also `GitLab!339`_, `GitLab563`_) - Fix crash when ``--max-line-length`` is given a non-integer (See also `GitLab!341`_, `GitLab541`_) - Prevent flip-flopping of ``indent_char`` causing extra ``E101`` errors (See also `GitLab!357`_, `pycodestyle886`_) - Only enable multiprocessing when the method is ``fork`` fixing issues on macos with python3.8+ (See also `GitLab!366`_, `GitLab587`_) (note: this fix also landed in 3.7.9) - ``noqa`` is now only handled by flake8 fixing specific-noqa. Plugins requesting this parameter will always receive ``False`` (See also `GitLab!331`_, `GitLab552`_) - Fix duplicate loading of plugins when invoked via ``python -m flake8`` (See also `GitLab!388`_) - Fix early exit when ``--exit-zero`` and ``--diff`` are provided and the diff is empty (See also `GitLab!391`_) - Consistently split lines when ``\f`` is present when reading from stdin (See also `GitLab!406`_, `GitLab270`_) Deprecations ~~~~~~~~~~~~ - ``python setup.py flake8`` (setuptools integration) is now deprecated and will be removed in a future version (See also `GitLab!330`_, `GitLab544`_) - ``type='string'`` (optparse) types are deprecated, use ``type=callable`` (argparse) instead. Support for ``type='string'`` will be removed in a future version (See also `GitLab!341`_) - ``%default`` in plugin option help text is deprecated, use ``%(default)s`` instead. Support for ``%default`` will be removed in a future version (See also `GitLab!341`_) - optparse-style ``action='callback'`` setting for options is deprecated, use argparse action classes instead. This will be removed in a future version (See also `GitLab!341`_) .. all links .. _3.8.0 milestone: https://gitlab.com/pycqa/flake8/-/milestones/32 .. merge request links .. _GitLab270: https://gitlab.com/pycqa/flake8/-/issues/270 .. _GitLab375: https://gitlab.com/pycqa/flake8/-/issues/375 .. _GitLab382: https://gitlab.com/pycqa/flake8/-/issues/382 .. _GitLab439: https://gitlab.com/pycqa/flake8/-/issues/439 .. _GitLab535: https://gitlab.com/pycqa/flake8/-/issues/535 .. _GitLab541: https://gitlab.com/pycqa/flake8/-/issues/541 .. _GitLab544: https://gitlab.com/pycqa/flake8/-/issues/544 .. _GitLab552: https://gitlab.com/pycqa/flake8/-/issues/552 .. _GitLab563: https://gitlab.com/pycqa/flake8/-/issues/563 .. _GitLab565: https://gitlab.com/pycqa/flake8/-/issues/565 .. _GitLab568: https://gitlab.com/pycqa/flake8/-/issues/568 .. _GitLab569: https://gitlab.com/pycqa/flake8/-/issues/569 .. _GitLab587: https://gitlab.com/pycqa/flake8/-/issues/587 .. _GitLab590: https://gitlab.com/pycqa/flake8/-/issues/590 .. _GitLab600: https://gitlab.com/pycqa/flake8/-/issues/600 .. _GitLab632: https://gitlab.com/pycqa/flake8/-/issues/632 .. _GitLab635: https://gitlab.com/pycqa/flake8/-/issues/635 .. _pycodestyle886: https://github.com/PyCQA/pycodestyle/issues/886 .. issue links .. _GitLab!311: https://gitlab.com/pycqa/flake8/-/merge_requests/311 .. _GitLab!315: https://gitlab.com/pycqa/flake8/-/merge_requests/315 .. _GitLab!330: https://gitlab.com/pycqa/flake8/-/merge_requests/330 .. _GitLab!331: https://gitlab.com/pycqa/flake8/-/merge_requests/331 .. _GitLab!339: https://gitlab.com/pycqa/flake8/-/merge_requests/339 .. _GitLab!341: https://gitlab.com/pycqa/flake8/-/merge_requests/341 .. _GitLab!342: https://gitlab.com/pycqa/flake8/-/merge_requests/342 .. _GitLab!357: https://gitlab.com/pycqa/flake8/-/merge_requests/357 .. _GitLab!360: https://gitlab.com/pycqa/flake8/-/merge_requests/360 .. _GitLab!361: https://gitlab.com/pycqa/flake8/-/merge_requests/361 .. _GitLab!363: https://gitlab.com/pycqa/flake8/-/merge_requests/363 .. _GitLab!366: https://gitlab.com/pycqa/flake8/-/merge_requests/366 .. _GitLab!377: https://gitlab.com/pycqa/flake8/-/merge_requests/377 .. _GitLab!380: https://gitlab.com/pycqa/flake8/-/merge_requests/380 .. _GitLab!388: https://gitlab.com/pycqa/flake8/-/merge_requests/388 .. _GitLab!391: https://gitlab.com/pycqa/flake8/-/merge_requests/391 .. _GitLab!404: https://gitlab.com/pycqa/flake8/-/merge_requests/404 .. _GitLab!406: https://gitlab.com/pycqa/flake8/-/merge_requests/406 .. _GitLab!413: https://gitlab.com/pycqa/flake8/-/merge_requests/413 .. _GitLab!417: https://gitlab.com/pycqa/flake8/-/merge_requests/417 .. _GitLab!418: https://gitlab.com/pycqa/flake8/-/merge_requests/418 .. _GitLab!419: https://gitlab.com/pycqa/flake8/-/merge_requests/419 .. _GitLab!420: https://gitlab.com/pycqa/flake8/-/merge_requests/420 .. _GitLab!422: https://gitlab.com/pycqa/flake8/-/merge_requests/422 .. _GitLab!424: https://gitlab.com/pycqa/flake8/-/merge_requests/424 ``` ### 3.7.9 ``` ------------------- You can view the `3.7.9 milestone`_ on GitLab for more details. Bugs Fixed ~~~~~~~~~~ - Disable multiprocessing when the multiprocessing method is ``spawn`` (such as on macos in python3.8) (See also `GitLab!367`_, `GitLab587`_) .. all links .. _3.7.9 milestone: https://gitlab.com/pycqa/flake8/milestones/33 .. issue links .. _GitLab587: https://gitlab.com/pycqa/flake8/issues/587 .. merge request links .. _GitLab!367: https://gitlab.com/pycqa/flake8/merge_requests/367 ``` ### 3.7.8 ``` ------------------- You can view the `3.7.8 milestone`_ on GitLab for more details. Bugs Fixed ~~~~~~~~~~ - Fix handling of ``Application.parse_preliminary_options_and_args`` when argv is an empty list (See also `GitLab!310`_, `GitLab518`_) - Fix crash when a file parses but fails to tokenize (See also `GitLab!314`_, `GitLab532`_) - Log the full traceback on plugin exceptions (See also `GitLab!317`_) - Fix `` noqa: ...`` comments with multi-letter codes (See also `GitLab!326`_, `GitLab549`_) .. all links .. _3.7.8 milestone: https://gitlab.com/pycqa/flake8/milestones/31 .. issue links .. _GitLab518: https://gitlab.com/pycqa/flake8/issues/518 .. _GitLab532: https://gitlab.com/pycqa/flake8/issues/532 .. _GitLab549: https://gitlab.com/pycqa/flake8/issues/549 .. merge request links .. _GitLab!310: https://gitlab.com/pycqa/flake8/merge_requests/310 .. _GitLab!314: https://gitlab.com/pycqa/flake8/merge_requests/314 .. _GitLab!317: https://gitlab.com/pycqa/flake8/merge_requests/317 .. _GitLab!326: https://gitlab.com/pycqa/flake8/merge_requests/326 ```Links
- PyPI: https://pypi.org/project/flake8 - Changelog: https://pyup.io/changelogs/flake8/ - Repo: https://gitlab.com/pycqa/flake8Update pyflakes from 2.1.1 to 2.2.0.
Changelog
### 2.2.0 ``` - Include column information in error messages - Fix ``overload`` detection with other decorators and in non-global scopes - Fix return-type annotation being a class member - Fix assignment to ``_`` in doctests with existing ``_`` name - Namespace attributes which are attached to ast nodes with ``_pyflakes_`` to avoid conflicts with other libraries (notably bandit) - Add check for f-strings without placeholders - Add check for unused/extra/invalid ``'string literal'.format(...)`` - Add check for unused/extra/invalid ``'string literal % ...`` - Improve python shebang detection - Allow type ignore to be followed by a code `` type: ignore[attr-defined]`` - Add support for assignment expressions (PEP 572) - Support ``overload`` detection from ``typing_extensions`` as well - Fix ``overload`` detection for async functions - Allow ``continue`` inside ``finally`` in python 3.8+ - Fix handling of annotations in positional-only arguments - Make pyflakes more resistant to future syntax additions - Fix false positives in partially quoted type annotations - Warn about ``is`` comparison to tuples - Fix ``Checker`` usage with async function subtrees - Add check for ``if`` of non-empty tuple - Switch from ``optparse`` to ``argparse`` - Fix false positives in partially quoted type annotations in unusual contexts - Be more cautious when identifying ``Literal`` type expressions ```Links
- PyPI: https://pypi.org/project/pyflakes - Changelog: https://pyup.io/changelogs/pyflakes/ - Repo: https://github.com/PyCQA/pyflakesUpdate SQLAlchemy from 1.3.3 to 1.3.17.
Changelog
### 1.3.17 ``` :released: May 13, 2020 .. change:: :tags: bug, oracle :tickets: 5246 Some modifications to how the cx_oracle dialect sets up per-column outputtype handlers for LOB and numeric datatypes to adjust for potential changes coming in cx_Oracle 8. .. change:: :tags: bug, orm :tickets: 5288 Fixed bug where using :func:`.with_polymorphic` as the target of a join via :meth:`.RelationshipComparator.of_type` on a mapper that already has a subquery-based with_polymorphic setting that's equivalent to the one requested would not correctly alias the ON clause in the join. .. change:: :tags: bug, oracle, performance :tickets: 5314 Changed the implementation of fetching CLOB and BLOB objects to use cx_Oracle's native implementation which fetches CLOB/BLOB objects inline with other result columns, rather than performing a separate fetch. As always, this can be disabled by setting auto_convert_lobs to False. As part of this change, the behavior of a CLOB that was given a blank string on INSERT now returns None on SELECT, which is now consistent with that of VARCHAR on Oracle. .. change:: :tags: usecase, postgresql :tickets: 5265 Added support for columns or type :class:`.ARRAY` of :class:`.Enum`, :class:`.JSON` or :class:`_postgresql.JSONB` in PostgreSQL. Previously a workaround was required in these use cases. .. change:: :tags: schema :tickets: 4138 Add ``comment`` attribute to :class:`_schema.Column` ``__repr__`` method. .. change:: :tags: bug, orm :tickets: 5303 Fixed issue in the area of where loader options such as selectinload() interact with the baked query system, such that the caching of a query is not supposed to occur if the loader options themselves have elements such as with_polymorphic() objects in them that currently are not cache-compatible. The baked loader could sometimes not fully invalidate itself in these some of these scenarios leading to missed eager loads. .. change:: :tags: bug, engine :tickets: 5326 Fixed fairly critical issue where the DBAPI connection could be returned to the connection pool while still in an un-rolled-back state. The reset agent responsible for rolling back the connection could be corrupted in the case that the transaction was "closed" without being rolled back or committed, which can occur in some scenarios when using ORM sessions and emitting .close() in a certain pattern involving savepoints. The fix ensures that the reset agent is always active. .. change:: :tags: bug, orm :tickets: 5304 Modified the internal "identity set" implementation, which is a set that hashes objects on their id() rather than their hash values, to not actually call the ``__hash__()`` method of the objects, which are typically user-mapped objects. Some methods were calling this method as a side effect of the implementation. .. change:: :tags: usecase, postgresql :tickets: 5266 Raise an explicit :class:`.exc.CompileError` when adding a table with a column of type :class:`.ARRAY` of :class:`.Enum` configured with :paramref:`.Enum.native_enum` set to ``False`` when :paramref:`.Enum.create_constraint` is not set to ``False`` .. change:: :tags: bug, schema :tickets: 5298 Fixed issue where an :class:`.Index` that is deferred in being associated with a table, such as as when it contains a :class:`.Column` that is not associated with any :class:`.Table` yet, would fail to attach correctly if it also contained a non table-oriented expession. .. change:: :tags: change, firebird :tickets: 5278 Adjusted dialect loading for ``firebird://`` URIs so the external sqlalchemy-firebird dialect will be used if it has been installed, otherwise fall back to the (now deprecated) internal Firebird dialect. .. change:: :tags: bug, mssql, reflection :tickets: 5255 Fix a regression introduced by the reflection of computed column in MSSQL when using the legacy TDS version 4.2. The dialect will try to detect the protocol version of first connect and run in compatibility mode if it cannot detect it. .. change:: :tags: bug, mssql, reflection :tickets: 5271 Fix a regression introduced by the reflection of computed column in MSSQL when using SQL server versions before 2012, which does not support the ``concat`` function. .. change:: :tags: bug, orm :tickets: 5269 An informative error message is raised when an ORM many-to-one comparison is attempted against an object that is not an actual mapped instance. Comparisons such as those to scalar subqueries aren't supported; generalized comparison with subqueries is better achieved using :meth:`~.RelationshipProperty.Comparator.has`. .. change:: :tags: usecase, orm :tickets: 5262 Added an accessor :attr:`.ColumnProperty.Comparator.expressions` which provides access to the group of columns mapped under a multi-column :class:`.ColumnProperty` attribute. .. change:: :tags: bug, schema :tickets: 5316 A warning is emitted when making use of the :attr:`.MetaData.sorted_tables` attribute as well as the :func:`_schema.sort_tables` function, and the given tables cannot be correctly sorted due to a cyclic dependency between foreign key constraints. In this case, the functions will no longer sort the involved tables by foreign key, and a warning will be emitted. Other tables that are not part of the cycle will still be returned in dependency order. Previously, the sorted_table routines would return a collection that would unconditionally omit all foreign keys when a cycle was detected, and no warning was emitted. .. change:: :tags: orm, usecase :tickets: 5237 Introduce :paramref:`_orm.relationship.sync_backref` flag in a relationship to control if the synchronization events that mutate the in-Python attributes are added. This supersedes the previous change :ticket:`5149`, which warned that ``viewonly=True`` relationship target of a back_populates or backref configuration would be disallowed. .. changelog:: ``` ### 1.3.16 ``` :released: April 7, 2020 .. change:: :tags: oracle, usecase :tickets: 5200 Implemented AUTOCOMMIT isolation level for Oracle when using cx_Oracle. Also added a fixed default isolation level of READ COMMITTED for Oracle. .. change:: :tags: bug, mysql :tickets: 5239 Fixed issue in MySQL dialect when connecting to a psuedo-MySQL database such as that provided by ProxySQL, the up front check for isolation level when it returns no row will not prevent the dialect from continuing to connect. A warning is emitted that the isolation level could not be detected. .. change:: :tags: bug, tests :tickets: 5201 Fixed an issue that prevented the test suite from running with the recently released py.test 5.4.0. .. change:: :tags: bug, oracle, reflection :tickets: 5146 Fixed regression / incorrect fix caused by fix for :ticket:`5146` where the Oracle dialect reads from the "all_tab_comments" view to get table comments but fails to accommodate for the current owner of the table being requested, causing it to read the wrong comment if multiple tables of the same name exist in multiple schemas. .. change:: :tags: types, enum :tickets: 5183 The :class:`.Enum` type now supports the parameter :paramref:`.Enum.length` to specify the length of the VARCHAR column to create when using non native enums by setting :paramref:`.Enum.native_enum` to ``False`` .. change:: :tags: bug, orm :tickets: 5228 Fixed bug in :func:`_orm.selectinload` loading option where two or more loaders that represent different relationships with the same string key name as referenced from a single :func:`_orm.with_polymorphic` construct with multiple subclass mappers would fail to invoke each subqueryload separately, instead making use of a single string-based slot that would prevent the other loaders from being invoked. .. change:: :tags: schema, reflection :tickets: 5063 Added support for reflection of "computed" columns, which are now returned as part of the structure returned by :meth:`_reflection.Inspector.get_columns`. When reflecting full :class:`_schema.Table` objects, computed columns will be represented using the :class:`.Computed` construct. .. change:: :tags: orm, performance :tickets: 5162 Modified the queries used by subqueryload and selectinload to no longer ORDER BY the primary key of the parent entity; this ordering was there to allow the rows as they come in to be copied into lists directly with a minimal level of Python-side collation. However, these ORDER BY clauses can negatively impact the performance of the query as in many scenarios these columns are derived from a subquery or are otherwise not actual primary key columns such that SQL planners cannot make use of indexes. The Python-side collation uses the native itertools.group_by() to collate the incoming rows, and has been modified to allow multiple row-groups-per-parent to be assembled together using list.extend(), which should still allow for relatively fast Python-side performance. There will still be an ORDER BY present for a relationship that includes an explicit order_by parameter, however this is the only ORDER BY that will be added to the query for both kinds of loading. .. change:: :tags: mssql, mysql, oracle, usecase :tickets: 5137 Added support for :meth:`.ColumnOperators.is_distinct_from` and :meth:`.ColumnOperators.isnot_distinct_from` to SQL Server, MySQL, and Oracle. .. change:: :tags: sqlite, usecase :tickets: 5164 Implemented AUTOCOMMIT isolation level for SQLite when using pysq