IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add some recent Ruff rules (#11833)

Browse Source
This commit is contained in:
Dimitri Papadopoulos Orfanos 2024-01-02 02:22:08 +01:00 committed by GitHub
parent 002098b51f
commit b9691c0ce6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.ruff.toml
View File

@ -188,6 +188,7 @@ select = [
# "Q001", # Single quote multiline found but double quotes preferred # "Q001", # Single quote multiline found but double quotes preferred
"Q002", # Single quote docstring found but double quotes preferred "Q002", # Single quote docstring found but double quotes preferred
"Q003", # Change outer quotes to avoid escaping inner quotes "Q003", # Change outer quotes to avoid escaping inner quotes
"Q004", # Unnecessary escape on inner quote character
# flake8-return ('RET') # flake8-return ('RET')
"RET501", # Do not explicitly `return None` in function if it is the only possible return value "RET501", # Do not explicitly `return None` in function if it is the only possible return value
"RET502", # Do not implicitly `return None` in function able to return non-`None` value "RET502", # Do not implicitly `return None` in function able to return non-`None` value
@ -265,6 +266,7 @@ select = [
"S609", # Possible wildcard injection in call due to `*` usage "S609", # Possible wildcard injection in call due to `*` usage
"S612", # Use of insecure `logging.config.listen` detected "S612", # Use of insecure `logging.config.listen` detected
# "S701", # Using jinja2 templates with `autoescape=False` is dangerous and can lead to XSS. Ensure `autoescape=True` or use the `select_autoescape` function. # "S701", # Using jinja2 templates with `autoescape=False` is dangerous and can lead to XSS. Ensure `autoescape=True` or use the `select_autoescape` function.
# "S702", # Mako templates allow HTML and JavaScript rendering by default and are inherently open to XSS attacks
# flake8-simplify ('SIM') # flake8-simplify ('SIM')
"SIM101", # Multiple `isinstance` calls for `{name}`, merge into a single call "SIM101", # Multiple `isinstance` calls for `{name}`, merge into a single call
# "SIM102", # Use a single `if` statement instead of nested `if` statements # "SIM102", # Use a single `if` statement instead of nested `if` statements
@ -310,6 +312,7 @@ select = [
"TCH003", # Move standard library import `{}` into a type-checking block "TCH003", # Move standard library import `{}` into a type-checking block
"TCH004", # Move import `{qualified_name}` out of type-checking block. Import is used for more than type hinting. "TCH004", # Move import `{qualified_name}` out of type-checking block. Import is used for more than type hinting.
"TCH005", # Found empty type-checking block "TCH005", # Found empty type-checking block
"TCH006", # Invalid string member in `X | Y`-style union type
# flake8-todos ('TD') # flake8-todos ('TD')
# "TD001", # Invalid TODO tag: `{tag}` # "TD001", # Invalid TODO tag: `{tag}`
# "TD003", # Missing issue link on the line following this TODO # "TD003", # Missing issue link on the line following this TODO
@ -320,6 +323,7 @@ select = [
# flake8-tidy-imports ('TID') # flake8-tidy-imports ('TID')
"TID251", # `{name}` is banned: {message} "TID251", # `{name}` is banned: {message}
"TID252", # Relative imports from parent modules are banned "TID252", # Relative imports from parent modules are banned
"TID253", # `{name}` is banned at the module level
# tryceratops ('TRY') # tryceratops ('TRY')
# NOT YET USED # NOT YET USED
# pyupgrade ('UP') # pyupgrade ('UP')
@ -361,6 +365,7 @@ select = [
"UP038", # Use `X | Y` in `{}` call instead of `(X, Y)` "UP038", # Use `X | Y` in `{}` call instead of `(X, Y)`
"UP039", # Unnecessary parentheses after class definition "UP039", # Unnecessary parentheses after class definition
"UP040", # Type alias `{name}` uses `TypeAlias` annotation instead of the `type` keyword "UP040", # Type alias `{name}` uses `TypeAlias` annotation instead of the `type` keyword
"UP041", # Replace aliased errors with `TimeoutError`
# pycodestyle ('W') # pycodestyle ('W')
"W191", # Indentation contains tabs "W191", # Indentation contains tabs
# "W291", # Trailing whitespace # "W291", # Trailing whitespace

2
tests/test_ext_inheritance_diagram.py
View File

@ -216,7 +216,7 @@ def test_inheritance_diagram_svg_html(tmp_path, app):
'<div class="graphviz">' '<div class="graphviz">'
'<object data="_images/inheritance-\\w+.svg" ' '<object data="_images/inheritance-\\w+.svg" '
'type="image/svg\\+xml" class="inheritance graphviz">\n' 'type="image/svg\\+xml" class="inheritance graphviz">\n'
'<p class=\"warning\">Inheritance diagram of test.Foo</p>' '<p class="warning">Inheritance diagram of test.Foo</p>'
'</object></div>\n<figcaption>\n<p><span class="caption-text">' '</object></div>\n<figcaption>\n<p><span class="caption-text">'
'Test Foo!</span><a class="headerlink" href="#id1" ' 'Test Foo!</span><a class="headerlink" href="#id1" '
'title="Link to this image">\xb6</a></p>\n</figcaption>\n</figure>\n') 'title="Link to this image">\xb6</a></p>\n</figcaption>\n</figure>\n')