Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
0.7.13
->1.0.0
24.2.0
->24.3.0
1.7.10
->1.8.0
24.8.0
->24.10.0
v4
->v5
1.13.0
->1.14.1
3.5.0
->4.0.1
3.2.7
->3.3.3
5.0.0
->6.0.0
7.1.2
->8.1.3
2.2.3
->2.3.0
Release Notes
sphinx-doc/alabaster (alabaster)
v1.0.0
: Alabaster 1.0.0Compare Source
Changelog: https://alabaster.readthedocs.io/en/latest/changelog.html
v0.7.16
: Alabaster 0.7.16Compare Source
Changelog: https://alabaster.readthedocs.io/en/latest/changelog.html
v0.7.15
: Alabaster 0.7.15Compare Source
Changelog: https://alabaster.readthedocs.io/en/latest/changelog.html
v0.7.14
: Alabaster 0.7.14Compare Source
Changelog: https://alabaster.readthedocs.io/en/latest/changelog.html
python-attrs/attrs (attrs)
v24.3.0
Compare Source
Backwards-incompatible Changes
#1340
Changes
attrs.NothingType
, for annotating types consistent withattrs.NOTHING
.#1358
__suppress_context__
and__notes__
on frozen exceptions.#1365
attrs.converters.optional()
works again when takingattrs.converters.pipe()
or another Converter as its argument.#1372
copy.replace()
.#1383
attrs.validators.instance_of()
's type hints now allow for union types.For example:
instance_of(str | int)
#1385
PyCQA/bandit (bandit)
v1.8.0
Compare Source
What's Changed
Full Changelog: PyCQA/bandit@1.7.10...1.8.0
psf/black (black)
v24.10.0
Compare Source
Highlights
mypyc-compiled wheels. (#4436) (#4449)
safety issue in Python 3.12.5 that can cause Black's AST safety checks to fail. Please
use Python 3.12.6 or Python 3.12.4 instead. (#4447)
Stable style
X | Y
style unions.(#4453)
%%
magic (#4462)Preview style
def fn(*args: *tuple[*Ts, T]) -> None: pass
) (#4440)Caching
--unstable
(#4466)Packaging
blackd
now requires a newer version of aiohttp. (#4451)Output
codecov/codecov-action (codecov/codecov-action)
v5
Compare Source
What's Changed
${{ inputs.token }}
inaction.yml
by @jwodder in https://github.com/codecov/codecov-action/pull/1721Full Changelog: https://github.com/codecov/codecov-action/compare/v5.1.1..v5.1.2
python/mypy (mypy)
v1.14.1
Compare Source
v1.14.0
Compare Source
pre-commit/pre-commit (pre-commit)
v4.0.1
Compare Source
==================
Fixes
pre-commit migrate-config
for unquoted deprecated stages names withpurelib
pyyaml
.v4.0.0
Compare Source
==================
Features
pre-commit migrate-config
to handle more yaml formats.stages
deprecation inpre-commit migrate-config
.ruby-build
.repo: meta
.stages
(commit
->pre-commit
,push
->pre-push
,merge-commit
->pre-merge-commit
).Migrating
language: python_venv
has been removed -- uselanguage: python
instead.v3.8.0
Compare Source
==================
Features
language: r
so environments are recreated ifthe system version of R changes.
v3.7.1
Compare Source
==================
Fixes
language: rust
default language version check whenrust-toolchain.toml
is present.
v3.7.0
Compare Source
==================
Features
docker
anddocker_image
hooks when--color
is specified.Fixes
fail_fast
for individual hooks stopping when previous hooks had failed.Updating
fail_fast
was fixed. If you want the pre-3.7.0behaviour, add
fail_fast: true
to all hooks before the lastfail_fast
hook.
v3.6.2
Compare Source
==================
Fixes
git commit --all
.v3.6.1
Compare Source
==================
Fixes
PYTHONEXECUTABLE
from environment when running.v3.6.0
Compare Source
==================
Features
minimum_pre_commit_version
first when parsing configs.Fixes
importlib.resources
.Updating
pylint-dev/pylint (pylint)
v3.3.3
Compare Source
What's new in Pylint 3.3.3?
Release date: 2024-12-23
False Positives Fixed
Fix false positives for
undefined-variable
for classes using Python 3.12generic type syntax.
Closes #9335
Fix a false positive for
use-implicit-booleaness-not-len
. No lint should be emitted forgenerators (
len
is not defined for generators).Refs #10100
Other Bug Fixes
Fix
Unable to import 'collections.abc' (import-error)
on Python 3.13.1.Closes #10112
v3.3.2
Compare Source
False Positives Fixed
Fix a false positive for
potential-index-error
when an indexed iterablecontains a starred element that evaluates to more than one item.
Closes #10076
Other Bug Fixes
Fixes the issue with --source-root option not working when the source files are in a subdirectory of the source root (e.g. when using a /src layout).
Closes #10026
v3.3.1
Compare Source
What's new in Pylint 3.3.1?
Release date: 2024-09-24
False Positives Fixed
Fix regression causing some f-strings to not be inferred as strings.
Closes #9947
v3.3.0
Compare Source
Release date: 2024-09-20
Changes requiring user actions
We migrated
symilar
to argparse, from getopt, so the error and help output changed(for the better). We exit with 2 instead of sometime 1, sometime 2. The error output
is not captured by the runner anymore. It's not possible to use a value for the
boolean options anymore (
--ignore-comments 1
should become--ignore-comments
).Refs #9731
New Features
Add new
declare-non-slot
error which reports when a class has a__slots__
member and a type hint on the class is not present in__slots__
.Refs #9499
New Checks
Added
too-many-positional-arguments
to allow distinguishing the configuration for too manytotal arguments (with keyword-only params specified after
*
) from the configurationfor too many positional-or-keyword or positional-only arguments.
As part of evaluating whether this check makes sense for your project, ensure you
adjust the value of
--max-positional-arguments
.Closes #9099
Add
using-exception-groups-in-unsupported-version
andusing-generic-type-syntax-in-unsupported-version
for uses of Python 3.11+ or3.12+ features on lower supported versions provided with
--py-version
.Closes #9791
Add
using-assignment-expression-in-unsupported-version
for uses of:=
(walrus operator)on Python versions below 3.8 provided with
--py-version
.Closes #9820
Add
using-positional-only-args-in-unsupported-version
for uses of positional-only args onPython versions below 3.8 provided with
--py-version
.Closes #9823
Add
unnecessary-default-type-args
to thetyping
extension to detect the useof unnecessary default type args for
typing.Generator
andtyping.AsyncGenerator
.Refs #9938
False Negatives Fixed
Fix computation of never-returning function:
Never
is handled in addition toNoReturn
, and priority is given to the explicit--never-returning-functions
option.Closes #7565.
Fix a false negative for
await-outside-async
when await is inside Lambda.Refs #9653
Fix a false negative for
duplicate-argument-name
by includingpositional-only
,*args
and**kwargs
arguments in the check.Closes #9669
Fix false negative for
multiple-statements
when multiple statements are present onelse
andfinally
lines oftry
.Refs #9759
Fix false negatives when
isinstance
does not have exactly two arguments.pylint now emits a
too-many-function-args
orno-value-for-parameter
appropriately for
isinstance
calls.Closes #9847
Other Bug Fixes
--enable
with--disable=all
now produces an error, when an unknown msg code is used. Internalpylint
messages are no longer affected by--disable=all
.Closes #9403
Impossible to compile regexes for paths in the configuration or argument given to pylint won't crash anymore but
raise an argparse error and display the error message from
re.compile
instead.Closes #9680
Fix a bug where a
tox.ini
file with pylint configuration was ignored and it exists in the current directory..cfg
and.ini
files containing aPylint
configuration may now use a section named[pylint]
. This enhancement impacts the scenario where these file types are used as defaults when they are present and have not been explicitly referred to, using the--rcfile
option.Closes #9727
Improve file discovery for directories that are not python packages.
Closes #9764
Other Changes
Remove support for launching pylint with Python 3.8.
Code that supports Python 3.8 can still be linted with the
--py-version=3.8
setting.Refs #9774
Add support for Python 3.13.
Refs #9852
Internal Changes
All variables, classes, functions and file names containing the word 'similar', when it was,
in fact, referring to 'symilar' (the standalone program for the duplicate-code check) were renamed
to 'symilar'.
Closes #9734
Remove old-style classes (Python 2) code and remove check for new-style class since everything is new-style in Python 3. Updated doc for exception checker to remove reference to new style class.
Refs #9925
pytest-dev/pytest-cov (pytest-cov)
v6.0.0
Compare Source
Now it will perform the check just like
coverage report
would.--cov-precision
cli option that can override the value set in your coverage configuration.sphinx-doc/sphinx (sphinx)
v8.1.3
: Sphinx 8.1.3Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
Bugs fixed
cut_lines()
with no object type. Patch by Adam Turner.v8.1.2
: Sphinx 8.1.2Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Bugs fixed
sphinx.errors.ExtensionError
insphinx.util
for backwards compatibility. This will be removed in Sphinx 9, as exposing the exception insphinx.util
was never intentional.ExtensionError
has been part ofsphinx.errors
since Sphinx 0.9. Patch by Adam Turner.v8.1.1
: Sphinx 8.1.1Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Bugs fixed
the
:cve:
role.Patch by Hugo van Kemenade.
fontawesome
orfontawesome5
packages are not installed.Patch by Jean-François B.
v8.1.0
Compare Source
=====================================
Dependencies
sphinxcontrib-*
dependencies.Patch by Adam Turner.
parskip
package from 2001 to 2018.Patch by Jean-François B.
Incompatible changes
sphinx.util.Tee
.Patch by Adam Turner.
fvset
default is changed to'\\fvset{fontsize=auto}'
from'\\fvset{fontsize=\\small}'
.Code-blocks are unchanged as FreeMono is now loaded with
Scale=0.9
.An adjustment to existing projects is needed only if they used a custom
:ref:
fontpkg
configuration and did not set :ref:fvset
.Patch by Jean-François B.
zh_CN
andzh_TW
by default.Patch by A. Rafey Khan.
Deprecated
sphinx.util.import_object
.Use :py:func:
importlib.import_module
instead.Patch by Adam Turner.
sphinx.util.FilenameUniqDict
and
sphinx.util.DownloadFiles
.Patch by Adam Turner.
Features added
output files.
Patch by James Addison.
contents <table-of-contents>
, :dudir:topic
,and :dudir:
sidebar
directives separately customizable for PDF output.Patch by Jean-François B. and Bénédikt Tran.
Patch by Tim Hoffmann.
math_numsep
support to latex builder.Patch by Thomas Fanning and Jean-François B.
:option:
--fail-on-warning <sphinx-build --fail-on-warning>
is used.Instead, exit with a non-zero status if any warnings were generated
during the build.
Patch by Adam Turner.
sphinx-build --exception-on-warning
,to raise an exception when warnings are emitted during the build.
Patch by Adam Turner and Jeremy Maitin-Shepard.
html_last_updated_use_utc
to allow usinguniversal time (GMT/UTC) instead of local time for the date-time
supplied to :confval:
html_last_updated_fmt
.Patch by Adam Turner.
'%Y'
placeholderto substitute the current year.
This is helpful for reducing the reliance on Python modules
such as :py:mod:
time
or :py:mod:datetime
in :file:conf.py
.See :ref:
the docs <config-copyright>
for further detail.Patch by Adam Turner.
:cve: <cve>
)and CWEs (:rst:role:
:cwe: <cwe>
).Patch by Hugo van Kemenade.
Patch by Jakub Stasiak and Adam Turner.
.Builder.supported_linkcode
attributefor builders to enable use of :mod:
sphinx.ext.linkcode
-generatedreferences.
Patch by James Knight.
This can be helpful in diagnosing the cause of a full rebuild.
Patch by Adam Turner.
Bugs fixed
:confval:
intersphinx_cache_limit
.Patch by Shengyu Zhang.
Overfull \hbox
from too longstrings in a codeline when the problem has actually been solved thanks
to :ref:
latexsphinxsetupforcewraps
.Patch by Jean-François B.
UnreferencedFootnotesDetector
transform has been improvedto more consistently detect unreferenced footnotes.
Note, the priority of the transform has been changed from 200 to 622,
so that it now runs after the docutils
Footnotes
resolution transform.Patch by Chris Sewell.
'sphinxsetup' <latexsphinxsetup>
div.topic_box-shadow
key if used with only one dimension set bothx-offset and y-offset as per documentation.
Patch by Jean-François B.
resolution occurs due to duplicate targets that differ case-insensitively.
Patch by James Addison.
Patch by Hugo van Kemenade.
Patch by Jeremy Bowman.
-q <sphinx-build -q>
(quiet) option for:program:
sphinx-build -M latexpdf
or :program:make latexpdf
(O=-q
)get passed to :program:
latexmk
. Let :option:-Q <sphinx-build -Q>
(silent) apply as well to the PDF build phase.
Patch by Jean-François B.
rise to nested
\DUrole
's, rather than a single one with comma separatedclasses.
Patch by Jean-François B.
Patch by Jean-François B.
references in the sense of :rfc:
RFC 3986, §4.4 <3986#section-4.4>
,e.g.,
index.html#foo
becomes#foo
.(note: continuation of a partial fix added in Sphinx 7.3.0)
Patch by James Addison (with reference to prior work by Eric Norige).
695
generic classes LaTeX output formatting.Patch by Jean-François B. and Bénédikt Tran.
file URL (user-defined base URL of an intersphinx project are left untouched
even if they end with double forward slashes).
Patch by Bénédikt Tran.
even if there are fewer than 6 documents.
Patch by Matthias Geier.
:noindex:
for the :rst:dir:js:module
and :rst:dir:
py:module
directives.Patch by Stephen Finucane.
_t
suffix during
apidoc
RST rendering (regression in 7.4.0).Patch by James Addison.
SOURCE_DATE_EPOCH
for entries that match the current system clock year,and disallow substitution of future years.
Patch by James Addison and Adam Turner.
intersphinx_cache_limit
,which always kept the cache for positive values, and always refreshed it for
negative ones.
Patch by Nico Madysa.
and ensure deterministic resolution of global toctree in parallel builds
by choosing the lexicographically greatest parent document.
Patch by A. Rafey Khan
for Chinese languages.
Patch by Adam Turner.
.Builder.write
is typed asfinal
, meaning that the:event:
write-started
event may be relied upon by extensions.A new :py:meth:
.Builder.write_documents
method has been added tocontrol how documents are written.
This is intended for builders that do not output a file for each document.
Patch by Adam Turner.
Testing
karma
JavaScript test framework tothe actively-maintained
jasmine
framework. Test coverage is unaffected.Patch by James Addison.
v8.0.2
: Sphinx 8.0.2Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v8.0.1
: Sphinx 8.0.1Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v8.0.0
: Sphinx 8.0.0Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Dependencies
Incompatible changes
Remove deprecated functions from
sphinx.util
:sphinx.util.path_stabilize
(use
sphinx.util.osutil.path_stabilize
).sphinx.util.display_chunk
(use
sphinx.util.display.display_chunk
).sphinx.util.status_iterator
(use
sphinx.util.display.status_iterator
).sphinx.util.SkipProgressMessage
(use
sphinx.util.display.SkipProgressMessage
).sphinx.util.progress_message
(use
sphinx.util.display.progress_message
).sphinx.util.epoch_to_rfc1123
(use
sphinx.http_date.epoch_to_rfc1123
).sphinx.util.rfc1123_to_epoch
(use
sphinx.http_date.rfc1123_to_epoch
).sphinx.util.save_traceback
(use
sphinx.exceptions.save_traceback
).sphinx.util.format_exception_cut_frames
(use
sphinx.exceptions.format_exception_cut_frames
).sphinx.util.xmlname_checker
(use
sphinx.builders.epub3._XML_NAME_PATTERN
).Patch by Adam Turner.
Removed
sphinx.util.osutil.cd
(use
contextlib.chdir
).Patch by Adam Turner.
Removed
sphinx.util.typing.stringify
(use
sphinx.util.typing.stringify_annotation
).Patch by Adam Turner.
#12593: Raise an error for invalid
html_sidebars
values.Patch by Adam Turner.
#12593: Raise an error in
Theme.get_config
for invalid sections.Patch by Adam Turner.
#11693: Remove support for old-style
Makefile
andmake.bat
output in
sphinx-quickstart
.#11693: Remove the
--no-use-make-mode
,-M
,--use-make-mode
, and-m
optionsfrom
sphinx-quickstart
.Patch by Adam Turner.
Removed the tuple interface to
sphinx.ext.autodoc.ObjectMember
.Patch by Adam Turner.
#12630: Sphinx 8 makes two changes to the
linkcheck
configuration defaults:linkcheck_allow_unauthorized
is nowFalse
by default.linkcheck_report_timeouts_as_broken
is nowFalse
by default.Patch by James Addison.
#12597: Change the default of
show_warning_types
from
False
toTrue
.Patch by Chris Sewell.
#12083: Remove support for the old (2008--2010) Sphinx 0.5 and Sphinx 0.6
intersphinx_mapping
format.Patch by Bénédikt Tran and Adam Turner.
#12096: Do not overwrite user-supplied files when copying assets
unless forced with
force=True
.Patch by Adam Turner.
#12646: Remove
sphinx.util.inspect.isNewType
.Use
isinstance(obj, typing.NewType)
instead on Python 3.10 and newer.Patch by Adam Turner.
Remove the long-deprecated (since Sphinx 2) alias
to
VersionChange
insphinx.directives.other
(Deprecated since Sphinx 2).
Use
sphinx.domains.changeset.VersionChange
directly.Patch by Adam Turner.
Deprecated
sphinx.ext.intersphinx.normalize_intersphinx_mapping
to
sphinx.ext.intersphinx.validate_intersphinx_mapping
.The old name will be removed in Sphinx 10.
Patch by Adam Turner.
pathlib.Path
objects to Sphinx 9.Use
os.fspath
to convert :py:class:~pathlib.Path
objects to strings,or
pathlib.Path
's methods to work with path objects.Patch by Adam Turner.
v7.4.7
Compare Source
=====================================
Bugs fixed
Patch by Adam Turner and Bénédikt Tran.
Patch by Adam Turner.
~typing.Annotated
typemetadata in the Python domain.
Patch by Adam Turner.
~typing.Annotated
warnings withsphinx.ext.autodoc
,especially when using :mod:
dataclasses
as type metadata.Patch by Adam Turner.
!autolink
.Patch by Adam Turner.
v7.4.6
Compare Source
=====================================
Bugs fixed
generating autosummary directives for modules within a package.
Patch by Adam Turner.
Patch by James Addison.
v7.4.5
Compare Source
=====================================
Bugs fixed
html_sidebars
values to a list.
Log an error message when string values are detected.
Patch by Adam Turner.
seealso
and other "light" admonitionsnow break PDF builds if they contain a :dudir:
figure
directive; and alsoif they are contained in a table cell (rendered by
tabulary
).Patch by Jean-François B.
v7.4.4
Compare Source
=====================================
Bugs fixed
case-insensitively ambiguous duplicate items.
Patch by James Addison.
v7.4.3
Compare Source
=====================================
Bugs fixed
source_suffix
valueswith extensions that register parsers.
Patch by Adam Turner.
v7.4.2
Compare Source
=====================================
Bugs fixed
with Sphinx 7.3.7 and earlier.
Patch by Adam Turner.
v7.4.1
Compare Source
=====================================
Bugs fixed
heading-level
is used.Patch by Adam Turner.
typing.ParamSpec
in autodoc.Patch by Adam Turner.
v7.4.0
Compare Source
=====================================
Dependencies
Configuration
📅 Schedule: Branch creation - "every weekend" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR was generated by Mend Renovate. View the repository job log.