{

"$schema": "http://json-schema.org/draft-07/schema#",

"title": "Options",

"type": "object",

"properties": {

"allowed-confusables": {

"description": "A list of allowed \"confusable\" Unicode characters to ignore when\nenforcing `RUF001`, `RUF002`, and `RUF003`.",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"type": "string",

"maxLength": 1,

"minLength": 1

}

},

"analyze": {

"description": "Options to configure import map generation.",

"anyOf": [

{

"$ref": "#/definitions/AnalyzeOptions"

},

{

"type": "null"

}

]

},

"builtins": {

"description": "A list of builtins to treat as defined references, in addition to the\nsystem builtins.",

"type": [

"array",

"null"

],

"items": {

"type": "string"

}

},

"cache-dir": {

"description": "A path to the cache directory.\n\nBy default, Ruff stores cache results in a `.ruff_cache` directory in\nthe current project root.\n\nHowever, Ruff will also respect the `RUFF_CACHE_DIR` environment\nvariable, which takes precedence over that default.\n\nThis setting will override even the `RUFF_CACHE_DIR` environment\nvariable, if set.",

"type": [

"string",

"null"

]

},

"dummy-variable-rgx": {

"description": "A regular expression used to identify \"dummy\" variables, or those which\nshould be ignored when enforcing (e.g.) unused-variable rules. The\ndefault expression matches `_`, `__`, `_var`, and `_次`, but not `_var_`\nor `_次_`.",

"type": [

"string",

"null"

],

"deprecated": true

},

"exclude": {

"description": "A list of file patterns to exclude from formatting and linting.\n\nExclusions are based on globs, and can be either:\n\n- Single-path patterns, like `.mypy_cache` (to exclude any directory\n named `.mypy_cache` in the tree), `foo.py` (to exclude any file named\n `foo.py`), or `foo_*.py` (to exclude any file matching `foo_*.py` ).\n- Relative patterns, like `directory/foo.py` (to exclude that specific\n file) or `directory/*.py` (to exclude any Python files in\n `directory`). Note that these paths are relative to the project root\n (e.g., the directory containing your `pyproject.toml`).\n\nFor more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).\n\nNote that you'll typically want to use\n[`extend-exclude`](#extend-exclude) to modify the excluded paths.",

"type": [

"array",

"null"

],

"items": {

"type": "string"

}

},

"explicit-preview-rules": {

"description": "Whether to require exact codes to select preview rules. When enabled,\npreview rules will not be selected by prefixes — the full code of each\npreview rule will be required to enable the rule.",

"type": [

"boolean",

"null"

],

"deprecated": true

},

"extend": {

"description": "A path to a local `pyproject.toml` or `ruff.toml` file to merge into this\nconfiguration. User home directory and environment variables will be\nexpanded.\n\nTo resolve the current configuration file, Ruff will first load\nthis base configuration file, then merge in properties defined\nin the current configuration file. Most settings follow simple override\nbehavior where the child value replaces the parent value. However,\nrule selection (`lint.select` and `lint.ignore`) has special merging\nbehavior: if the child configuration specifies `lint.select`, it\nestablishes a new baseline rule set and the parent's `lint.ignore`\nrules are discarded; if the child configuration omits `lint.select`,\nthe parent's rule selection is inherited and both parent and child\n`lint.ignore` rules are accumulated together.",

"type": [

"string",

"null"

]

},

"extend-exclude": {

"description": "A list of file patterns to omit from formatting and linting, in addition to those\nspecified by [`exclude`](#exclude).\n\nExclusions are based on globs, and can be either:\n\n- Single-path patterns, like `.mypy_cache` (to exclude any directory\n named `.mypy_cache` in the tree), `foo.py` (to exclude any file named\n `foo.py`), or `foo_*.py` (to exclude any file matching `foo_*.py` ).\n- Relative patterns, like `directory/foo.py` (to exclude that specific\n file) or `directory/*.py` (to exclude any Python files in\n `directory`). Note that these paths are relative to the project root\n (e.g., the directory containing your `pyproject.toml`).\n\nFor more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).",

"type": [

"array",

"null"

],

"items": {

"type": "string"

}

},

"extend-fixable": {

"description": "A list of rule codes or prefixes to consider fixable, in addition to those\nspecified by [`fixable`](#lint_fixable).",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"$ref": "#/definitions/RuleSelector"

}

},

"extend-ignore": {

"description": "A list of rule codes or prefixes to ignore, in addition to those\nspecified by `ignore`.\n\nThis option is deprecated because it is now interchangeable with\n[`ignore`](#lint_ignore). In earlier versions of Ruff, `ignore` would\n_replace_ the set of ignored rules when using configuration inheritance\n(via the top-level [`extend`](https://docs.astral.sh/ruff/settings/#extend)\nsetting), while `extend-ignore` would _add_ to the inherited set. Ruff\nnow merges both `ignore` and `extend-ignore` into a single set, so the\ndistinction no longer applies. Use [`ignore`](#lint_ignore) instead.",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"$ref": "#/definitions/RuleSelector"

}

},

"extend-include": {

"description": "A list of file patterns to include when linting, in addition to those\nspecified by [`include`](#include).\n\nInclusion are based on globs, and should be single-path patterns, like\n`*.pyw`, to include any file with the `.pyw` extension.\n\nFor more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).",

"type": [

"array",

"null"

],

"items": {

"type": "string"

}

},

"extend-per-file-ignores": {

"description": "A list of mappings from file pattern to rule codes or prefixes to\nexclude, in addition to any rules excluded by [`per-file-ignores`](#lint_per-file-ignores).",

"type": [

"object",

"null"

],

"additionalProperties": {

"type": "array",

"items": {

"$ref": "#/definitions/RuleSelector"

}

},

"deprecated": true

},

"extend-safe-fixes": {

"description": "A list of rule codes or prefixes for which unsafe fixes should be considered\nsafe.",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"$ref": "#/definitions/RuleSelector"

}

},

"extend-select": {

"description": "A list of rule codes or prefixes to enable, in addition to those\nspecified by [`select`](#lint_select).\n\nUnlike [`select`](#lint_select), which _replaces_ the default rule set\nwhen specified, `extend-select` _adds_ to whatever rules are already\nactive. This makes `extend-select` the preferred option when you want\nto enable additional rules on top of the defaults without having to\nenumerate them.\n\nFor example, to enable the defaults plus flake8-bugbear:\n\n```toml\n[tool.ruff.lint]\n# Adds flake8-bugbear on top of the default rules.\nextend-select = [\"B\"]\n```\n\nUsing `select = [\"B\"]` instead would _replace_ the defaults, enabling\nonly flake8-bugbear.",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"$ref": "#/definitions/RuleSelector"

}

},

"extend-unfixable": {

"description": "A list of rule codes or prefixes to consider non-auto-fixable, in addition to those\nspecified by [`unfixable`](#lint_unfixable).",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"$ref": "#/definitions/RuleSelector"

}

},

"extend-unsafe-fixes": {

"description": "A list of rule codes or prefixes for which safe fixes should be considered\nunsafe.",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"$ref": "#/definitions/RuleSelector"

}

},

"extension": {

"description": "A mapping of custom file extensions to known file types (overridden\nby the `--extension` command-line flag).\n\nSupported file types include `python`, `pyi`, `ipynb`, and `markdown`.\n\nAny file extensions listed here will be automatically added to the\ndefault `include` list as a `*.{ext}` glob, so that they are linted\nand formatted without needing any additional configuration settings.",

"type": [

"object",

"null"

],

"additionalProperties": {

"$ref": "#/definitions/Language"

}

},

"external": {

"description": "A list of rule codes or prefixes that are unsupported by Ruff, but should be\npreserved when (e.g.) validating `# noqa` directives. Useful for\nretaining `# noqa` directives that cover plugins not yet implemented\nby Ruff.",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"type": "string"

}

},

"fix": {

"description": "Enable fix behavior by-default when running `ruff` (overridden\nby the `--fix` and `--no-fix` command-line flags).\nOnly includes automatic fixes unless `--unsafe-fixes` is provided.",

"type": [

"boolean",

"null"

]

},

"fix-only": {

"description": "Like [`fix`](#fix), but disables reporting on leftover violation. Implies [`fix`](#fix).",

"type": [

"boolean",

"null"

]

},

"fixable": {

"description": "A list of rule codes or prefixes to consider fixable. By default,\nall rules are considered fixable.",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"$ref": "#/definitions/RuleSelector"

}

},

"flake8-annotations": {

"description": "Options for the `flake8-annotations` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8AnnotationsOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-bandit": {

"description": "Options for the `flake8-bandit` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8BanditOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-boolean-trap": {

"description": "Options for the `flake8-boolean-trap` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8BooleanTrapOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-bugbear": {

"description": "Options for the `flake8-bugbear` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8BugbearOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-builtins": {

"description": "Options for the `flake8-builtins` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8BuiltinsOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-comprehensions": {

"description": "Options for the `flake8-comprehensions` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8ComprehensionsOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-copyright": {

"description": "Options for the `flake8-copyright` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8CopyrightOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-errmsg": {

"description": "Options for the `flake8-errmsg` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8ErrMsgOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-gettext": {

"description": "Options for the `flake8-gettext` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8GetTextOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-implicit-str-concat": {

"description": "Options for the `flake8-implicit-str-concat` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8ImplicitStrConcatOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-import-conventions": {

"description": "Options for the `flake8-import-conventions` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8ImportConventionsOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-pytest-style": {

"description": "Options for the `flake8-pytest-style` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8PytestStyleOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-quotes": {

"description": "Options for the `flake8-quotes` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8QuotesOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-self": {

"description": "Options for the `flake8_self` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8SelfOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-tidy-imports": {

"description": "Options for the `flake8-tidy-imports` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8TidyImportsOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-type-checking": {

"description": "Options for the `flake8-type-checking` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8TypeCheckingOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"flake8-unused-arguments": {

"description": "Options for the `flake8-unused-arguments` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Flake8UnusedArgumentsOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"force-exclude": {

"description": "Whether to enforce [`exclude`](#exclude) and [`extend-exclude`](#extend-exclude) patterns,\neven for paths that are passed to Ruff explicitly. Typically, Ruff will lint\nany paths passed in directly, even if they would typically be\nexcluded. Setting `force-exclude = true` will cause Ruff to\nrespect these exclusions unequivocally.\n\nThis is useful for [`pre-commit`](https://pre-commit.com/), which explicitly passes all\nchanged files to the [`ruff-pre-commit`](https://github.com/astral-sh/ruff-pre-commit)\nplugin, regardless of whether they're marked as excluded by Ruff's own\nsettings.",

"type": [

"boolean",

"null"

]

},

"format": {

"description": "Options to configure code formatting.",

"anyOf": [

{

"$ref": "#/definitions/FormatOptions"

},

{

"type": "null"

}

]

},

"ignore": {

"description": "A list of rule codes or prefixes to ignore. Prefixes can specify exact\nrules (like `F841`), entire groups (like `F`), or anything in\nbetween.\n\nWhen breaking ties between enabled and disabled rules (via `select` and\n`ignore`, respectively), more specific prefixes override less\nspecific prefixes. `ignore` takes precedence over `select` if the same\nprefix appears in both.\n\nIn preview, categories like `correctness` and `suspicious` can be used\nin addition to rule codes and linter group prefixes.",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"$ref": "#/definitions/RuleSelector"

}

},

"ignore-init-module-imports": {

"description": "Avoid automatically removing unused imports in `__init__.py` files. Such\nimports will still be flagged, but with a dedicated message suggesting\nthat the import is either added to the module's `__all__` symbol, or\nre-exported with a redundant alias (e.g., `import os as os`).\n\nThis option is enabled by default, but you can opt-in to removal of imports\nvia an unsafe fix.",

"type": [

"boolean",

"null"

],

"deprecated": true

},

"include": {

"description": "A list of file patterns to include when linting.\n\nInclusion are based on globs, and should be single-path patterns, like\n`*.pyw`, to include any file with the `.pyw` extension.\n`pyproject.toml`, `ruff.toml`, and `.ruff.toml` are included here not for\nconfiguration but because we lint whether e.g. the `[project]` matches\nthe schema in `pyproject.toml` or that rule names are used as selectors.\n\nNotebook files (`.ipynb` extension) are included by default on Ruff 0.6.0+.\n\nFor more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).",

"type": [

"array",

"null"

],

"items": {

"type": "string"

}

},

"indent-width": {

"description": "The number of spaces per indentation level (tab).\n\nUsed by the formatter and when enforcing long-line violations (like `E501`) to determine the visual\nwidth of a tab.\n\nThis option changes the number of spaces the formatter inserts when\nusing soft-tabs (`indent-style = space`).\n\nPEP 8 recommends using 4 spaces per [indentation level](https://peps.python.org/pep-0008/#indentation).",

"anyOf": [

{

"$ref": "#/definitions/IndentWidth"

},

{

"type": "null"

}

]

},

"isort": {

"description": "Options for the `isort` plugin.",

"anyOf": [

{

"$ref": "#/definitions/IsortOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"line-length": {

"description": "The line length to use when enforcing long-lines violations (like `E501`)\nand at which `isort` and the formatter prefers to wrap lines.\n\nThe length is determined by the number of characters per line, except for lines containing East Asian characters or emojis.\nFor these lines, the [unicode width](https://unicode.org/reports/tr11/) of each character is added up to determine the length.\n\nThe value must be greater than `0`.\n\nNote: While the formatter will attempt to format lines such that they remain\nwithin the `line-length`, it isn't a hard upper bound, and formatted lines may\nexceed the `line-length`.\n\nSee [`pycodestyle.max-line-length`](#lint_pycodestyle_max-line-length) to configure different lengths for `E501` and the formatter.",

"anyOf": [

{

"$ref": "#/definitions/LineLength"

},

{

"type": "null"

}

]

},

"lint": {

"anyOf": [

{

"$ref": "#/definitions/LintOptions"

},

{

"type": "null"

}

]

},

"logger-objects": {

"description": "A list of objects that should be treated equivalently to a\n`logging.Logger` object.\n\nThis is useful for ensuring proper diagnostics (e.g., to identify\n`logging` deprecations and other best-practices) for projects that\nre-export a `logging.Logger` object from a common module.\n\nFor example, if you have a module `logging_setup.py` with the following\ncontents:\n```python\nimport logging\n\nlogger = logging.getLogger(__name__)\n```\n\nAdding `\"logging_setup.logger\"` to `logger-objects` will ensure that\n`logging_setup.logger` is treated as a `logging.Logger` object when\nimported from other modules (e.g., `from logging_setup import logger`).",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"type": "string"

}

},

"mccabe": {

"description": "Options for the `mccabe` plugin.",

"anyOf": [

{

"$ref": "#/definitions/McCabeOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"namespace-packages": {

"description": "Mark the specified directories as namespace packages. For the purpose of\nmodule resolution, Ruff will treat those directories and all their subdirectories\nas if they contained an `__init__.py` file.",

"type": [

"array",

"null"

],

"items": {

"type": "string"

}

},

"output-format": {

"description": "The style in which violation messages should be formatted: `\"full\"` (default)\n(shows source), `\"concise\"`, `\"grouped\"` (group messages by file), `\"json\"`\n(machine-readable), `\"junit\"` (machine-readable XML), `\"github\"` (GitHub\nActions annotations), `\"gitlab\"` (GitLab CI code quality report),\n`\"pylint\"` (Pylint text format) or `\"azure\"` (Azure Pipeline logging commands).",

"anyOf": [

{

"$ref": "#/definitions/OutputFormat"

},

{

"type": "null"

}

]

},

"output-prefer-rule-codes": {

"description": "Whether to prefer rule codes over human-readable rule names in diagnostic output, even\nwhen preview mode is enabled.\n\nDiagnostics without rule codes, such as syntax errors and formatting diagnostics, will\ncontinue to use the human-readable name, but those corresponding to lint rules will use the\nrule's code. For example, the concise diagnostic for an unused import will use the code\n`F401` instead of the name `unused-import`:\n\n```console\n$ ruff check --preview --config 'output-prefer-rule-codes = true' --output-format=concise example.py\nexample.py:1:8: F401 [*] `math` imported but unused\n$ ruff check --preview --config 'output-prefer-rule-codes = false' --output-format=concise example.py\nexample.py:1:8: unused-import: [*] `math` imported but unused\n```",

"type": [

"boolean",

"null"

]

},

"pep8-naming": {

"description": "Options for the `pep8-naming` plugin.",

"anyOf": [

{

"$ref": "#/definitions/Pep8NamingOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"per-file-ignores": {

"description": "A list of mappings from file pattern to rule codes or prefixes to\nexclude, when considering any matching files. An initial '!' negates\nthe file pattern.\n\nFor more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).",

"type": [

"object",

"null"

],

"additionalProperties": {

"type": "array",

"items": {

"$ref": "#/definitions/RuleSelector"

}

},

"deprecated": true

},

"per-file-target-version": {

"description": "A list of mappings from glob-style file pattern to Python version to use when checking the\ncorresponding file(s).\n\nThis may be useful for overriding the global Python version settings in `target-version` or\n`requires-python` for a subset of files. For example, if you have a project with a minimum\nsupported Python version of 3.9 but a subdirectory of developer scripts that want to use a\nnewer feature like the `match` statement from Python 3.10, you can use\n`per-file-target-version` to specify `\"developer_scripts/*.py\" = \"py310\"`.\n\nThis setting is used by the linter to enforce any enabled version-specific lint rules, as\nwell as by the formatter for any version-specific formatting options, such as parenthesizing\ncontext managers on Python 3.10+.",

"type": [

"object",

"null"

],

"additionalProperties": {

"$ref": "#/definitions/PythonVersion"

}

},

"preview": {

"description": "Whether to enable preview mode. When preview mode is enabled, Ruff will\nuse unstable rules, fixes, and formatting.",

"type": [

"boolean",

"null"

]

},

"pycodestyle": {

"description": "Options for the `pycodestyle` plugin.",

"anyOf": [

{

"$ref": "#/definitions/PycodestyleOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"pydocstyle": {

"description": "Options for the `pydocstyle` plugin.",

"anyOf": [

{

"$ref": "#/definitions/PydocstyleOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"pyflakes": {

"description": "Options for the `pyflakes` plugin.",

"anyOf": [

{

"$ref": "#/definitions/PyflakesOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"pylint": {

"description": "Options for the `pylint` plugin.",

"anyOf": [

{

"$ref": "#/definitions/PylintOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"pyupgrade": {

"description": "Options for the `pyupgrade` plugin.",

"anyOf": [

{

"$ref": "#/definitions/PyUpgradeOptions"

},

{

"type": "null"

}

],

"deprecated": true

},

"required-version": {

"description": "Enforce a requirement on the version of Ruff, to enforce at runtime.\nIf the version of Ruff does not meet the requirement, Ruff will exit\nwith an error.\n\nUseful for unifying results across many environments, e.g., with a\n`pyproject.toml` file.\n\nAccepts a [PEP 440](https://peps.python.org/pep-0440/) specifier, like `==0.3.1` or `>=0.3.1`.",

"anyOf": [

{

"$ref": "#/definitions/RequiredVersion"

},

{

"type": "null"

}

]

},

"respect-gitignore": {

"description": "Whether to automatically exclude files that are ignored by `.ignore`,\n`.gitignore`, `.git/info/exclude`, and global `gitignore` files.\nEnabled by default.",

"type": [

"boolean",

"null"

]

},

"select": {

"description": "A list of rule codes or prefixes to enable. Prefixes can specify exact\nrules (like `F841`), entire groups (like `F`), or anything in\nbetween.\n\nWhen breaking ties between enabled and disabled rules (via `select` and\n`ignore`, respectively), more specific prefixes override less\nspecific prefixes. `ignore` takes precedence over `select` if the\nsame prefix appears in both.\n\nIn preview, categories like `correctness` and `suspicious` can be used\nin addition to rule codes and linter group prefixes.",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"$ref": "#/definitions/RuleSelector"

}

},

"show-fixes": {

"description": "Whether to show an enumeration of all fixed lint violations\n(overridden by the `--show-fixes` command-line flag).",

"type": [

"boolean",

"null"

]

},

"src": {

"description": "The directories to consider when resolving first- vs. third-party\nimports.\n\nWhen omitted, the `src` directory will typically default to including both:\n\n1. The directory containing the nearest `pyproject.toml`, `ruff.toml`, or `.ruff.toml` file (the \"project root\").\n2. The `\"src\"` subdirectory of the project root.\n\nThese defaults ensure that Ruff supports both flat layouts and `src` layouts out-of-the-box.\n(If a configuration file is explicitly provided (e.g., via the `--config` command-line\nflag), the current working directory will be considered the project root.)\n\nAs an example, consider an alternative project structure, like:\n\n```text\nmy_project\n├── pyproject.toml\n└── lib\n └── my_package\n ├── __init__.py\n ├── foo.py\n └── bar.py\n```\n\nIn this case, the `./lib` directory should be included in the `src` option\n(e.g., `src = [\"lib\"]`), such that when resolving imports, `my_package.foo`\nis considered first-party.\n\nThis field supports globs. For example, if you have a series of Python\npackages in a `python_modules` directory, `src = [\"python_modules/*\"]`\nwould expand to incorporate all packages in that directory. User home\ndirectory and environment variables will also be expanded.",

"type": [

"array",

"null"

],

"items": {

"type": "string"

}

},

"target-version": {

"description": "The minimum Python version to target, e.g., when considering automatic\ncode upgrades, like rewriting type annotations. Ruff will not propose\nchanges using features that are not available in the given version.\n\nFor example, to represent supporting Python >=3.12 or ==3.12\nspecify `target-version = \"py312\"`.\n\nIf you're already using a `pyproject.toml` file, we recommend\n`project.requires-python` instead, as it's based on Python packaging\nstandards, and will be respected by other tools. For example, Ruff\ntreats the following as identical to `target-version = \"py38\"`:\n\n```toml\n[project]\nrequires-python = \">=3.8\"\n```\n\nIf both are specified, `target-version` takes precedence over\n`requires-python`. See [_Inferring the Python version_](https://docs.astral.sh/ruff/configuration/#inferring-the-python-version)\nfor a complete description of how the `target-version` is determined\nwhen left unspecified.\n\nNote that a stub file can [sometimes make use of a typing feature](https://typing.python.org/en/latest/spec/distributing.html#syntax)\nbefore it is available at runtime, as long as the stub does not make\nuse of new *syntax*. For example, a type checker will understand\n`int | str` in a stub as being a `Union` type annotation, even if the\ntype checker is run using Python 3.9, despite the fact that the `|`\noperator can only be used to create union types at runtime on Python\n3.10+. As such, Ruff will often recommend newer features in a stub\nfile than it would for an equivalent runtime file with the same target\nversion.",

"anyOf": [

{

"$ref": "#/definitions/PythonVersion"

},

{

"type": "null"

}

]

},

"task-tags": {

"description": "A list of task tags to recognize (e.g., \"TODO\", \"FIXME\", \"XXX\").\n\nComments starting with these tags will be ignored by commented-out code\ndetection (`ERA`), and skipped by line-length rules (`E501`) if\n[`ignore-overlong-task-comments`](#lint_pycodestyle_ignore-overlong-task-comments) is set to `true`.",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"type": "string"

}

},

"typing-modules": {

"description": "A list of modules whose exports should be treated equivalently to\nmembers of the `typing` module.\n\nThis is useful for ensuring proper type annotation inference for\nprojects that re-export `typing` and `typing_extensions` members\nfrom a compatibility module. If omitted, any members imported from\nmodules apart from `typing` and `typing_extensions` will be treated\nas ordinary Python objects.",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"type": "string"

}

},

"unfixable": {

"description": "A list of rule codes or prefixes to consider non-fixable.",

"type": [

"array",

"null"

],

"deprecated": true,

"items": {

"$ref": "#/definitions/RuleSelector"

}

},

"unsafe-fixes": {

"description": "Enable application of unsafe fixes.\nIf excluded, a hint will be displayed when unsafe fixes are available.\nIf set to false, the hint will be hidden.",

"type": [

"boolean",

"null"

]

}

},

"additionalProperties": false,

"definitions": {

"Alias": {

"type": "string"

},

"AllImports": {

"type": "string",

"enum": [

"all"

]

},

"AnalyzeOptions": {

"description": "Configures Ruff's `analyze` command.",

"type": "object",

"properties": {

"detect-string-imports": {

"description": "Whether to detect imports from string literals. When enabled, Ruff will search for string\nliterals that \"look like\" import paths, and include them in the import map, if they resolve\nto valid Python modules.",

"type": [

"boolean",

"null"

]

},

"direction": {

"description": "Whether to generate a map from file to files that it depends on (dependencies) or files that\ndepend on it (dependents).",

"anyOf": [

{

"$ref": "#/definitions/Direction"

},

{

"type": "null"

}

]

},

"exclude": {

"description": "A list of file patterns to exclude from analysis in addition to the files excluded globally (see [`exclude`](#exclude), and [`extend-exclude`](#extend-exclude)).\n\nExclusions are based on globs, and can be either:\n\n- Single-path patterns, like `.mypy_cache` (to exclude any directory\n named `.mypy_cache` in the tree), `foo.py` (to exclude any file named\n `foo.py`), or `foo_*.py` (to exclude any file matching `foo_*.py` ).\n- Relative patterns, like `directory/foo.py` (to exclude that specific\n file) or `directory/*.py` (to exclude any Python files in\n `directory`). Note that these paths are relative to the project root\n (e.g., the directory containing your `pyproject.toml`).\n\nFor more information on the glob syntax, refer to the [`globset` documentation](https://docs.rs/globset/latest/globset/#syntax).",

"type": [

"array",

"null"

],

"items": {

"type": "string"

}

},

"include-dependencies": {

"description": "A map from file path to the list of Python or non-Python file paths or globs that should be\nconsidered dependencies of that file, regardless of whether relevant imports are detected.",

"type": [

"object",

"null"

],

"additionalProperties": {

"type": "array",

"items": {

"type": "string"

}

}

},

"preview": {

"description": "Whether to enable preview mode. When preview mode is enabled, Ruff will expose unstable\ncommands.",

"type": [

"boolean",

"null"

]

},

"string-imports-min-dots": {

"description": "The minimum number of dots in a string to consider it a valid import.\n\nThis setting is only relevant when [`detect-string-imports`](#detect-string-imports) is enabled.\nFor example, if this is set to `2`, then only strings with at least two dots (e.g., `\"path.to.module\"`)\nwould be considered valid imports.",

"type": [

"integer",

"null"

],

"format": "uint",

"minimum": 0

},

"type-checking-imports": {

"description": "Whether to include imports that are only used for type checking (i.e., imports within `if TYPE_CHECKING:` blocks).\nWhen enabled (default), type-checking-only imports are included in the import graph.\nWhen disabled, they are excluded.",

"type": [

"boolean",

"null"

]

}

},

"additionalProperties": false

},

"AnnotationSemanticsSelection": {

"anyOf": [

{

"type": "object",

"additionalProperties": {

"$ref": "#/definitions/RuntimeSemantics"

}

},

{

"type": "array",

"items": {

"type": "string"

}

}

]

},

"ApiBan": {

"type": "object",

"properties": {

"msg": {

"description": "The message to display when the API is used.",

"type": "string"

}

},

"additionalProperties": false,

"required": [

"msg"

]

},

"BannedAliases": {

"type": "array",

"items": {

"type": "string"

}

},

"ConstantType": {

"type": "string",

"enum": [

"bytes",

"complex",

"float",

"int",

"str"

]

},

"Convention": {

"oneOf": [

{

"description": "Use Google-style docstrings.",

"type": "string",

"const": "google"

},

{

"description": "Use NumPy-style docstrings.",

"type": "string",

"const": "numpy"

},

{

"description": "Use PEP257-style docstrings.",

"type": "string",

"const": "pep257"

}

]

},

"Direction": {

"oneOf": [

{

"description": "Construct a map from module to its dependencies (i.e., the modules that it imports).",

"type": "string",

"const": "dependencies"

},

{

"description": "Construct a map from module to its dependents (i.e., the modules that import it).",

"type": "string",

"const": "dependents"

}

]

},

"DocstringCodeLineWidth": {

"anyOf": [

{

"description": "Wrap docstring code examples at a fixed line width.",

"oneOf": [

{

"$ref": "#/definitions/LineWidth"

}

]

},

{

"description": "Respect the line length limit setting for the surrounding Python code.",

"const": "dynamic"

}

]

},

"Flake8AnnotationsOptions": {

"description": "Options for the `flake8-annotations` plugin.",

"type": "object",

"properties": {

"allow-star-arg-any": {

"description": "Whether to suppress `ANN401` for dynamically typed `*args` and\n`**kwargs` arguments.",

"type": [

"boolean",

"null"

]

},

"ignore-fully-untyped": {

"description": "Whether to suppress `ANN*` rules for any declaration\nthat hasn't been typed at all.\nThis makes it easier to gradually add types to a codebase.",

"type": [

"boolean",

"null"

]

},

"mypy-init-return": {

"description": "Whether to allow the omission of a return type hint for `__init__` if at\nleast one argument is annotated.",

"type": [

"boolean",

"null"

]

},

"suppress-dummy-args": {

"description": "Whether to suppress `ANN000`-level violations for arguments matching the\n\"dummy\" variable regex (like `_`).",

"type": [

"boolean",

"null"

]

},

"suppress-none-returning": {

"description": "Whether to suppress `ANN200`-level violations for functions that meet\neither of the following criteria:\n\n- Contain no `return` statement.\n- Explicit `return` statement(s) all return `None` (explicitly or\n implicitly).",

"type": [

"boolean",

"null"

]

}

},

"additionalProperties": false

},

"Flake8BanditOptions": {

"description": "Options for the `flake8-bandit` plugin.",

"type": "object",

"properties": {

"allowed-markup-calls": {

"description": "A list of callable names, whose result may be safely passed into\n[`markupsafe.Markup`](https://markupsafe.palletsprojects.com/en/stable/escaping/#markupsafe.Markup).\n\nExpects to receive a list of fully-qualified names (e.g., `bleach.clean`, rather than `clean`).\n\nThis setting helps you avoid false positives in code like:\n\n```python\nfrom bleach import clean\nfrom markupsafe import Markup\n\ncleaned_markup = Markup(clean(some_user_input))\n```\n\nWhere the use of [`bleach.clean`](https://bleach.readthedocs.io/en/latest/clean.html)\nusually ensures that there's no XSS vulnerability.\n\nAlthough it is not recommended, you may also use this setting to whitelist other\nkinds of calls, e.g. calls to i18n translation functions, where how safe that is\nwill depend on the implementation and how well the translations are audited.\n\nAnother common use-case is to wrap the output of functions that generate markup\nlike [`xml.etree.ElementTree.tostring`](https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostring)\nor template rendering engines where sanitization of potential user input is either\nalready baked in or has to happen before rendering.",

"type": [

"array",

"null"

],