doc/ale-python.txt

   1 ===============================================================================
   2 ALE Python Integration                                     *ale-python-options*
   3
   4                                                *ale-options.python_auto_pipenv*
   5                                                      *g:ale_python_auto_pipenv*
   6                                                      *b:ale_python_auto_pipenv*
   7 python_auto_pipenv
   8 g:ale_python_auto_pipenv
   9   Type: |Number|
  10   Default: `0`
  11
  12   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
  13   if true. This is overridden by a manually-set executable.
  14
  15                                                *ale-options.python_auto_poetry*
  16                                                      *g:ale_python_auto_poetry*
  17                                                      *b:ale_python_auto_poetry*
  18 python_auto_poetry
  19 g:ale_python_auto_poetry
  20   Type: |Number|
  21   Default: `0`
  22
  23   Detect whether the file is inside a poetry, and set the executable to `poetry`
  24   if true. This is overridden by a manually-set executable.
  25
  26                                                    *ale-options.python_auto_uv*
  27                                                          *g:ale_python_auto_uv*
  28                                                          *b:ale_python_auto_uv*
  29 python_auto_uv
  30 g:ale_python_auto_uv
  31   Type: |Number|
  32   Default: `0`
  33
  34   Set the executable to `uv` if true. This is overridden by a manually-set
  35   executable.
  36
  37                                            *ale-options.python_auto_virtualenv*
  38                                                  *g:ale_python_auto_virtualenv*
  39                                                  *b:ale_python_auto_virtualenv*
  40 python_auto_virtualenv
  41 g:ale_python_auto_virtualenv
  42   Type: |Number|
  43   Default: `0`
  44
  45   If set to `1`, ALE will automatically set environment variables for commands
  46   such as `PATH` to attempt to make the experience of running Python linters
  47   via virtualenv easier, without the need for another plugin or some
  48   specialised setup.
  49
  50
  51 ===============================================================================
  52 ALE Python Project Root Behavior                              *ale-python-root*
  53
  54 For some linters, ALE will search for a Python project root by looking at the
  55 files in directories on or above where a file being checked is. ALE applies
  56 the following methods, in order:
  57
  58 1. Find the first directory containing a common Python configuration file.
  59 2. If no configuration file can be found, use the first directory which does
  60    not contain a readable file named `__init__.py`.
  61
  62 ALE will look for configuration files with the following filenames. >
  63
  64   MANIFEST.in
  65   setup.cfg
  66   pytest.ini
  67   tox.ini
  68   .pyre_configuration.local
  69   mypy.ini
  70   .mypy.ini
  71   pycodestyle.cfg
  72   .flake8
  73   .flake8rc
  74   pylama.ini
  75   pylintrc
  76   .pylintrc
  77   pyrightconfig.json
  78   pyrightconfig.toml
  79   Pipfile
  80   Pipfile.lock
  81   poetry.lock
  82   pyproject.toml
  83   .tool-versions
  84 <
  85
  86 The first directory containing any of the files named above will be used.
  87
  88
  89 ===============================================================================
  90 autoflake                                                *ale-python-autoflake*
  91
  92                                       *ale-options.python_autoflake_executable*
  93                                             *g:ale_python_autoflake_executable*
  94                                             *b:ale_python_autoflake_executable*
  95 python_autoflake_executable
  96 g:ale_python_autoflake_executable
  97   Type: |String|
  98   Default: `'autoflake'`
  99
 100   See |ale-integrations-local-executables|
 101
 102                                          *ale-options.python_autoflake_options*
 103                                                *g:ale_python_autoflake_options*
 104                                                *b:ale_python_autoflake_options*
 105 python_autoflake_options
 106 g:ale_python_autoflake_options
 107   Type: |String|
 108   Default: `''`
 109
 110   This variable can be set to pass extra options to autoflake.
 111
 112                                       *ale-options.python_autoflake_use_global*
 113                                             *g:ale_python_autoflake_use_global*
 114                                             *b:ale_python_autoflake_use_global*
 115 python_autoflake_use_global
 116 g:ale_python_autoflake_use_global
 117   Type: |Number|
 118   Default: `get(g:, 'ale_use_global_executables', 0)`
 119
 120   See |ale-integrations-local-executables|
 121
 122                                      *ale-options.python_autoflake_auto_pipenv*
 123                                            *g:ale_python_autoflake_auto_pipenv*
 124                                            *b:ale_python_autoflake_auto_pipenv*
 125 python_autoflake_auto_pipenv
 126 g:ale_python_autoflake_auto_pipenv
 127   Type: |Number|
 128   Default: `0`
 129
 130   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
 131   if true. This is overridden by a manually-set executable.
 132
 133                                      *ale-options.python_autoflake_auto_poetry*
 134                                            *g:ale_python_autoflake_auto_poetry*
 135                                            *b:ale_python_autoflake_auto_poetry*
 136 python_autoflake_auto_poetry
 137 g:ale_python_autoflake_auto_poetry
 138   Type: |Number|
 139   Default: `0`
 140
 141   Detect whether the file is inside a poetry, and set the executable to `poetry`
 142   if true. This is overridden by a manually-set executable.
 143
 144                                          *ale-options.python_autoflake_auto_uv*
 145                                                *g:ale_python_autoflake_auto_uv*
 146                                                *b:ale_python_autoflake_auto_uv*
 147 python_autoflake_auto_uv
 148 g:ale_python_autoflake_auto_uv
 149   Type: |Number|
 150   Default: `0`
 151
 152   Set the executable to `uv` if true. This is overridden by a manually-set
 153   executable.
 154
 155
 156 ===============================================================================
 157 autoimport                                              *ale-python-autoimport*
 158
 159                                      *ale-options.python_autoimport_executable*
 160                                            *g:ale_python_autoimport_executable*
 161                                            *b:ale_python_autoimport_executable*
 162 python_autoimport_executable
 163 g:ale_python_autoimport_executable
 164   Type: |String|
 165   Default: `'autoimport'`
 166
 167   See |ale-integrations-local-executables|
 168
 169                                         *ale-options.python_autoimport_options*
 170                                               *g:ale_python_autoimport_options*
 171                                               *b:ale_python_autoimport_options*
 172 python_autoimport_options
 173 g:ale_python_autoimport_options
 174   Type: |String|
 175   Default: `''`
 176
 177   This variable can be set to pass extra options to autoimport.
 178
 179                                      *ale-options.python_autoimport_use_global*
 180                                            *g:ale_python_autoimport_use_global*
 181                                            *b:ale_python_autoimport_use_global*
 182 python_autoimport_use_global
 183 g:ale_python_autoimport_use_global
 184   Type: |Number|
 185   Default: `get(g:, 'ale_use_global_executables', 0)`
 186
 187   See |ale-integrations-local-executables|
 188
 189
 190                                     *ale-options.python_autoimport_auto_pipenv*
 191                                           *g:ale_python_autoimport_auto_pipenv*
 192                                           *b:ale_python_autoimport_auto_pipenv*
 193 python_autoimport_auto_pipenv
 194 g:ale_python_autoimport_auto_pipenv
 195   Type: |Number|
 196   Default: `0`
 197
 198   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
 199   if true. This is overridden by a manually-set executable.
 200
 201                                     *ale-options.python_autoimport_auto_poetry*
 202                                           *g:ale_python_autoimport_auto_poetry*
 203                                           *b:ale_python_autoimport_auto_poetry*
 204 python_autoimport_auto_poetry
 205 g:ale_python_autoimport_auto_poetry
 206   Type: |Number|
 207   Default: `0`
 208
 209   Detect whether the file is inside a poetry, and set the executable to `poetry`
 210   if true. This is overridden by a manually-set executable.
 211
 212                                         *ale-options.python_autoimport_auto_uv*
 213                                               *g:ale_python_autoimport_auto_uv*
 214                                               *b:ale_python_autoimport_auto_uv*
 215 python_autoimport_auto_uv
 216 g:ale_python_autoimport_auto_uv
 217   Type: |Number|
 218   Default: `0`
 219
 220   Set the executable to `uv` if true. This is overridden by a manually-set
 221   executable.
 222
 223
 224 ===============================================================================
 225 autopep8                                                  *ale-python-autopep8*
 226
 227                                        *ale-options.python_autopep8_executable*
 228                                              *g:ale_python_autopep8_executable*
 229                                              *b:ale_python_autopep8_executable*
 230 python_autopep8_executable
 231 g:ale_python_autopep8_executable
 232   Type: |String|
 233   Default: `'autopep8'`
 234
 235   See |ale-integrations-local-executables|
 236
 237                                           *ale-options.python_autopep8_options*
 238                                                 *g:ale_python_autopep8_options*
 239                                                 *b:ale_python_autopep8_options*
 240 python_autopep8_options
 241 g:ale_python_autopep8_options
 242   Type: |String|
 243   Default: `''`
 244
 245   This variable can be set to pass extra options to autopep8.
 246
 247                                        *ale-options.python_autopep8_use_global*
 248                                              *g:ale_python_autopep8_use_global*
 249                                              *b:ale_python_autopep8_use_global*
 250 python_autopep8_use_global
 251 g:ale_python_autopep8_use_global
 252   Type: |Number|
 253   Default: `get(g:, 'ale_use_global_executables', 0)`
 254
 255   See |ale-integrations-local-executables|
 256
 257                                       *ale-options.python_autopep8_auto_pipenv*
 258                                             *g:ale_python_autopep8_auto_pipenv*
 259                                             *b:ale_python_autopep8_auto_pipenv*
 260 python_autopep8_auto_pipenv
 261 g:ale_python_autopep8_auto_pipenv
 262   Type: |Number|
 263   Default: `0`
 264
 265   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
 266   if true. This is overridden by a manually-set executable.
 267
 268                                       *ale-options.python_autopep8_auto_poetry*
 269                                             *g:ale_python_autopep8_auto_poetry*
 270                                             *b:ale_python_autopep8_auto_poetry*
 271 python_autopep8_auto_poetry
 272 g:ale_python_autopep8_auto_poetry
 273   Type: |Number|
 274   Default: `0`
 275
 276   Detect whether the file is inside a poetry, and set the executable to `poetry`
 277   if true. This is overridden by a manually-set executable.
 278
 279                                           *ale-options.python_autopep8_auto_uv*
 280                                                 *g:ale_python_autopep8_auto_uv*
 281                                                 *b:ale_python_autopep8_auto_uv*
 282 python_autopep8_auto_uv
 283 g:ale_python_autopep8_auto_uv
 284   Type: |Number|
 285   Default: `0`
 286
 287   Set the executable to `uv` if true. This is overridden by a manually-set
 288   executable.
 289
 290
 291 ===============================================================================
 292 bandit                                                      *ale-python-bandit*
 293
 294                                          *ale-options.python_bandit_executable*
 295                                                *g:ale_python_bandit_executable*
 296                                                *b:ale_python_bandit_executable*
 297 python_bandit_executable
 298 g:ale_python_bandit_executable
 299   Type: |String|
 300   Default: `'bandit'`
 301
 302   See |ale-integrations-local-executables|
 303
 304   Set this to `'pipenv'` to invoke `'pipenv` `run` `bandit'`.
 305   Set this to `'poetry'` to invoke `'poetry` `run` `bandit'`.
 306
 307                                             *ale-options.python_bandit_options*
 308                                                   *g:ale_python_bandit_options*
 309                                                   *b:ale_python_bandit_options*
 310 python_bandit_options
 311 g:ale_python_bandit_options
 312   Type: |String|
 313   Default: `''`
 314
 315   This variable can be changed to add command-line arguments to the
 316   bandit invocation.
 317
 318                                          *ale-options.python_bandit_use_config*
 319                                                *g:ale_python_bandit_use_config*
 320                                                *b:ale_python_bandit_use_config*
 321 python_bandit_use_config
 322 g:ale_python_bandit_use_config
 323   Type: |Number|
 324   Default: `1`
 325
 326   If this variable is true and a `.bandit` file exists in the directory of the
 327   file being checked or a parent directory, an `--ini` option is added to the
 328   `bandit` command for the nearest `.bandit` file.  Set this variable false to
 329   disable adding the `--ini` option automatically.
 330
 331                                          *ale-options.python_bandit_use_global*
 332                                                *g:ale_python_bandit_use_global*
 333                                                *b:ale_python_bandit_use_global*
 334 python_bandit_use_global
 335 g:ale_python_bandit_use_global
 336   Type: |Number|
 337   Default: `get(g:, 'ale_use_global_executables', 0)`
 338
 339   See |ale-integrations-local-executables|
 340
 341                                         *ale-options.python_bandit_auto_pipenv*
 342                                               *g:ale_python_bandit_auto_pipenv*
 343                                               *b:ale_python_bandit_auto_pipenv*
 344 python_bandit_auto_pipenv
 345 g:ale_python_bandit_auto_pipenv
 346   Type: |Number|
 347   Default: `0`
 348
 349   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
 350   if true. This is overridden by a manually-set executable.
 351
 352                                         *ale-options.python_bandit_auto_poetry*
 353                                               *g:ale_python_bandit_auto_poetry*
 354                                               *b:ale_python_bandit_auto_poetry*
 355 python_bandit_auto_poetry
 356 g:ale_python_bandit_auto_poetry
 357   Type: |Number|
 358   Default: `0`
 359
 360   Detect whether the file is inside a poetry, and set the executable to `poetry`
 361   if true. This is overridden by a manually-set executable.
 362
 363                                             *ale-options.python_bandit_auto_uv*
 364                                                   *g:ale_python_bandit_auto_uv*
 365                                                   *b:ale_python_bandit_auto_uv*
 366 python_bandit_auto_uv
 367 g:ale_python_bandit_auto_uv
 368   Type: |Number|
 369   Default: `0`
 370
 371   Set the executable to `uv` if true. This is overridden by a manually-set
 372   executable.
 373
 374
 375 ===============================================================================
 376 black                                                        *ale-python-black*
 377
 378                                           *ale-options.python_black_executable*
 379                                                 *g:ale_python_black_executable*
 380                                                 *b:ale_python_black_executable*
 381 python_black_executable
 382 g:ale_python_black_executable
 383   Type: |String|
 384   Default: `'black'`
 385
 386   See |ale-integrations-local-executables|
 387
 388                                              *ale-options.python_black_options*
 389                                                    *g:ale_python_black_options*
 390                                                    *b:ale_python_black_options*
 391 python_black_options
 392 g:ale_python_black_options
 393   Type: |String|
 394   Default: `''`
 395
 396   This variable can be set to pass extra options to black.
 397
 398                                           *ale-options.python_black_use_global*
 399                                                 *g:ale_python_black_use_global*
 400                                                 *b:ale_python_black_use_global*
 401 python_black_use_global
 402 g:ale_python_black_use_global
 403   Type: |Number|
 404   Default: `get(g:, 'ale_use_global_executables', 0)`
 405
 406   See |ale-integrations-local-executables|
 407
 408                                          *ale-options.python_black_auto_pipenv*
 409                                                *g:ale_python_black_auto_pipenv*
 410                                                *b:ale_python_black_auto_pipenv*
 411 python_black_auto_pipenv
 412 g:ale_python_black_auto_pipenv
 413   Type: |Number|
 414   Default: `0`
 415
 416   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
 417   if true. This is overridden by a manually-set executable.
 418
 419                                          *ale-options.python_black_auto_poetry*
 420                                                *g:ale_python_black_auto_poetry*
 421                                                *b:ale_python_black_auto_poetry*
 422 python_black_auto_poetry
 423 g:ale_python_black_auto_poetry
 424   Type: |Number|
 425   Default: `0`
 426
 427   Detect whether the file is inside a poetry, and set the executable to `poetry`
 428   if true. This is overridden by a manually-set executable.
 429
 430                                              *ale-options.python_black_auto_uv*
 431                                                    *g:ale_python_black_auto_uv*
 432                                                    *b:ale_python_black_auto_uv*
 433 python_black_auto_uv
 434 g:ale_python_black_auto_uv
 435   Type: |Number|
 436   Default: `0`
 437
 438   Set the executable to `uv` if true. This is overridden by a manually-set
 439   executable.
 440
 441                                     *ale-options.python_black_change_directory*
 442                                           *g:ale_python_black_change_directory*
 443                                           *b:ale_python_black_change_directory*
 444 python_black_change_directory
 445 g:ale_python_black_change_directory
 446   Type: |Number|
 447   Default: `1`
 448
 449   If set to `1`, ALE will switch to the directory the Python file being
 450   checked with `black` is in before checking it. This helps `black` find
 451   configuration files more easily. This option can be turned off if you want
 452   to control the directory Python is executed from yourself.
 453
 454
 455 ===============================================================================
 456 cspell                                                      *ale-python-cspell*
 457
 458 See |ale-cspell-options|
 459
 460
 461 ===============================================================================
 462 flake8                                                      *ale-python-flake8*
 463
 464                                    *ale-options.python_flake8_change_directory*
 465                                          *g:ale_python_flake8_change_directory*
 466                                          *b:ale_python_flake8_change_directory*
 467 python_flake8_change_directory
 468 g:ale_python_flake8_change_directory
 469   Type: |String|
 470   Default: `'project'`
 471
 472   If set to `project`, ALE will switch to the project root before checking file.
 473   If set to `file`, ALE will first switch to the directory containing the
 474   Python file being checked with `flake8` before checking it.
 475   You can turn it off with `off` option if you want to control the directory
 476   Python is executed from yourself.
 477
 478                                          *ale-options.python_flake8_executable*
 479                                                *g:ale_python_flake8_executable*
 480                                                *b:ale_python_flake8_executable*
 481 python_flake8_executable
 482 g:ale_python_flake8_executable
 483   Type: |String|
 484   Default: `'flake8'`
 485
 486   This variable can be changed to modify the executable used for flake8. Set
 487   this to `'pipenv'` to invoke `'pipenv` `run` `flake8'`. Set this to
 488   `'poetry'` to invoke `'poetry` `run` `flake8'`.
 489
 490                                             *ale-options.python_flake8_options*
 491                                                   *g:ale_python_flake8_options*
 492                                                   *b:ale_python_flake8_options*
 493 python_flake8_options
 494 g:ale_python_flake8_options
 495   Type: |String|
 496   Default: `''`
 497
 498   This variable can be changed to add command-line arguments to the flake8
 499   invocation.
 500
 501   For example, to dynamically switch between programs targeting Python 2 and
 502   Python 3, you may want to set >
 503
 504   let g:ale_python_flake8_executable = 'python3'   " or 'python' for Python 2
 505   let g:ale_python_flake8_options = '-m flake8'
 506 <
 507   after making sure it's installed for the appropriate Python versions (e.g.
 508   `python3 -m pip install --user flake8`).
 509
 510                                          *ale-options.python_flake8_use_global*
 511                                                *g:ale_python_flake8_use_global*
 512                                                *b:ale_python_flake8_use_global*
 513 python_flake8_use_global
 514 g:ale_python_flake8_use_global
 515   Type: |Number|
 516   Default: `get(g:, 'ale_use_global_executables', 0)`
 517
 518   This variable controls whether or not ALE will search for flake8 in a
 519   virtualenv directory first. If this variable is set to `1`, then ALE will
 520   always use |g:ale_python_flake8_executable| for the executable path.
 521
 522   Both variables can be set with `b:` buffer variables instead.
 523
 524                                         *ale-options.python_flake8_auto_pipenv*
 525                                               *g:ale_python_flake8_auto_pipenv*
 526                                               *b:ale_python_flake8_auto_pipenv*
 527 python_flake8_auto_pipenv
 528 g:ale_python_flake8_auto_pipenv
 529   Type: |Number|
 530   Default: `0`
 531
 532   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
 533   if true. This is overridden by a manually-set executable.
 534
 535                                         *ale-options.python_flake8_auto_poetry*
 536                                               *g:ale_python_flake8_auto_poetry*
 537                                               *b:ale_python_flake8_auto_poetry*
 538 python_flake8_auto_poetry
 539 g:ale_python_flake8_auto_poetry
 540   Type: |Number|
 541   Default: `0`
 542
 543   Detect whether the file is inside a poetry, and set the executable to `poetry`
 544   if true. This is overridden by a manually-set executable.
 545
 546                                             *ale-options.python_flake8_auto_uv*
 547                                                   *g:ale_python_flake8_auto_uv*
 548                                                   *b:ale_python_flake8_auto_uv*
 549 python_flake8_auto_uv
 550 g:ale_python_flake8_auto_uv
 551   Type: |Number|
 552   Default: `0`
 553
 554   Set the executable to `uv` if true. This is overridden by a manually-set
 555   executable.
 556
 557
 558 ===============================================================================
 559 flakehell                                                *ale-python-flakehell*
 560
 561                                 *ale-options.python_flakehell_change_directory*
 562                                       *g:ale_python_flakehell_change_directory*
 563                                       *b:ale_python_flakehell_change_directory*
 564 python_flakehell_change_directory
 565 g:ale_python_flakehell_change_directory
 566   Type: |String|
 567   Default: `project`
 568
 569   If set to `project`, ALE will switch to the project root before checking file.
 570   If set to `file`, ALE will switch to directory the Python file being
 571   checked with `flakehell` is in before checking it.
 572   You can turn it off with `off` option if you want to control the directory
 573   Python is executed from yourself.
 574
 575                                       *ale-options.python_flakehell_executable*
 576                                             *g:ale_python_flakehell_executable*
 577                                             *b:ale_python_flakehell_executable*
 578 python_flakehell_executable
 579 g:ale_python_flakehell_executable
 580   Type: |String|
 581   Default: `'flakehell'`
 582
 583   This variable can be changed to modify the executable used for flakehell. Set
 584   this to `'pipenv'` to invoke `'pipenv` `run` `flakehell'`. Set this to
 585   `'poetry'` to invoke `'poetry` `run` `flakehell'`. Set this to `'python'` to
 586   invoke `'python` `-m` `flakehell'`.
 587
 588                                          *ale-options.python_flakehell_options*
 589                                                *g:ale_python_flakehell_options*
 590                                                *b:ale_python_flakehell_options*
 591 python_flakehell_options
 592 g:ale_python_flakehell_options
 593   Type: |String|
 594   Default: `''`
 595
 596   This variable can be changed to add command-line arguments to the flakehell
 597   lint invocation.
 598
 599                                       *ale-options.python_flakehell_use_global*
 600                                             *g:ale_python_flakehell_use_global*
 601                                             *b:ale_python_flakehell_use_global*
 602 python_flakehell_use_global
 603 g:ale_python_flakehell_use_global
 604   Type: |Number|
 605   Default: `get(g:, 'ale_use_global_executables', 0)`
 606
 607   This variable controls whether or not ALE will search for flakehell in a
 608   virtualenv directory first. If this variable is set to `1`, then ALE will
 609   always use |g:ale_python_flakehell_executable| for the executable path.
 610
 611   Both variables can be set with `b:` buffer variables instead.
 612
 613                                      *ale-options.python_flakehell_auto_pipenv*
 614                                            *g:ale_python_flakehell_auto_pipenv*
 615                                            *b:ale_python_flakehell_auto_pipenv*
 616 python_flakehell_auto_pipenv
 617 g:ale_python_flakehell_auto_pipenv
 618   Type: |Number|
 619   Default: `0`
 620
 621   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
 622   if true. This is overridden by a manually-set executable.
 623
 624                                      *ale-options.python_flakehell_auto_poetry*
 625                                            *g:ale_python_flakehell_auto_poetry*
 626                                            *b:ale_python_flakehell_auto_poetry*
 627 python_flakehell_auto_poetry
 628 g:ale_python_flakehell_auto_poetry
 629   Type: |Number|
 630   Default: `0`
 631
 632   Detect whether the file is inside a poetry, and set the executable to `poetry`
 633   if true. This is overridden by a manually-set executable.
 634
 635                                          *ale-options.python_flakehell_auto_uv*
 636                                                *g:ale_python_flakehell_auto_uv*
 637                                                *b:ale_python_flakehell_auto_uv*
 638 python_flakehell_auto_uv
 639 g:ale_python_flakehell_auto_uv
 640   Type: |Number|
 641   Default: `0`
 642
 643   Set the executable to `uv` if true. This is overridden by a manually-set
 644   executable.
 645
 646
 647 ===============================================================================
 648 isort                                                        *ale-python-isort*
 649
 650                                           *ale-options.python_isort_executable*
 651                                                 *g:ale_python_isort_executable*
 652                                                 *b:ale_python_isort_executable*
 653 python_isort_executable
 654 g:ale_python_isort_executable
 655   Type: |String|
 656   Default: `'isort'`
 657
 658   See |ale-integrations-local-executables|
 659
 660                                              *ale-options.python_isort_options*
 661                                                    *g:ale_python_isort_options*
 662                                                    *b:ale_python_isort_options*
 663 python_isort_options
 664 g:ale_python_isort_options
 665   Type: |String|
 666   Default: `''`
 667
 668   This variable can be set to pass extra options to isort.
 669
 670                                           *ale-options.python_isort_use_global*
 671                                                 *g:ale_python_isort_use_global*
 672                                                 *b:ale_python_isort_use_global*
 673 python_isort_use_global
 674 g:ale_python_isort_use_global
 675   Type: |Number|
 676   Default: `get(g:, 'ale_use_global_executables', 0)`
 677
 678   See |ale-integrations-local-executables|
 679
 680                                          *ale-options.python_isort_auto_pipenv*
 681                                                *g:ale_python_isort_auto_pipenv*
 682                                                *b:ale_python_isort_auto_pipenv*
 683 python_isort_auto_pipenv
 684 g:ale_python_isort_auto_pipenv
 685   Type: |Number|
 686   Default: `0`
 687
 688   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
 689   if true. This is overridden by a manually-set executable.
 690
 691                                          *ale-options.python_isort_auto_poetry*
 692                                                *g:ale_python_isort_auto_poetry*
 693                                                *b:ale_python_isort_auto_poetry*
 694 python_isort_auto_poetry
 695 g:ale_python_isort_auto_poetry
 696   Type: |Number|
 697   Default: `0`
 698
 699   Detect whether the file is inside a poetry, and set the executable to `poetry`
 700   if true. This is overridden by a manually-set executable.
 701
 702                                              *ale-options.python_isort_auto_uv*
 703                                                    *g:ale_python_isort_auto_uv*
 704                                                    *b:ale_python_isort_auto_uv*
 705 python_isort_auto_uv
 706 g:ale_python_isort_auto_uv
 707   Type: |Number|
 708   Default: `0`
 709
 710   Set the executable to `uv` if true. This is overridden by a manually-set
 711   executable.
 712
 713
 714 ===============================================================================
 715 mypy                                                          *ale-python-mypy*
 716
 717 The minimum supported version of mypy that ALE supports is v0.4.4. This is
 718 the first version containing the `--shadow-file` option ALE needs to be able
 719 to check for errors while you type.
 720
 721 `mypy` will be run from a detected project root, per |ale-python-root|.
 722
 723                                           *ale-options.python_mypy_auto_pipenv*
 724                                                 *g:ale_python_mypy_auto_pipenv*
 725                                                 *b:ale_python_mypy_auto_pipenv*
 726 python_mypy_auto_pipenv
 727 g:ale_python_mypy_auto_pipenv
 728   Type: |Number|
 729   Default: `0`
 730
 731   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
 732   if true. This is overridden by a manually-set executable.
 733
 734                                           *ale-options.python_mypy_auto_poetry*
 735                                                 *g:ale_python_mypy_auto_poetry*
 736                                                 *b:ale_python_mypy_auto_poetry*
 737 python_mypy_auto_poetry
 738 g:ale_python_mypy_auto_poetry
 739   Type: |Number|
 740   Default: `0`
 741
 742   Detect whether the file is inside a poetry, and set the executable to `poetry`
 743   if true. This is overridden by a manually-set executable.
 744
 745                                               *ale-options.python_mypy_auto_uv*
 746                                                     *g:ale_python_mypy_auto_uv*
 747                                                     *b:ale_python_mypy_auto_uv*
 748 python_mypy_auto_uv
 749 g:ale_python_mypy_auto_uv
 750   Type: |Number|
 751   Default: `0`
 752
 753   Set the executable to `uv` if true. This is overridden by a manually-set
 754   executable.
 755
 756                                            *ale-options.python_mypy_executable*
 757                                                  *g:ale_python_mypy_executable*
 758                                                  *b:ale_python_mypy_executable*
 759 python_mypy_executable
 760 g:ale_python_mypy_executable
 761   Type: |String|
 762   Default: `'mypy'`
 763
 764   See |ale-integrations-local-executables|
 765
 766   Set this to `'pipenv'` to invoke `'pipenv` `run` `mypy'`.
 767   Set this to `'poetry'` to invoke `'poetry` `run` `mypy'`.
 768
 769                                 *ale-options.python_mypy_ignore_invalid_syntax*
 770                                       *g:ale_python_mypy_ignore_invalid_syntax*
 771                                       *b:ale_python_mypy_ignore_invalid_syntax*
 772 python_mypy_ignore_invalid_syntax
 773 g:ale_python_mypy_ignore_invalid_syntax
 774   Type: |Number|
 775   Default: `0`
 776
 777   When set to `1`, syntax error messages for mypy will be ignored. This option
 778   can be used when running other Python linters which check for syntax errors,
 779   as mypy can take a while to finish executing.
 780
 781                                               *ale-options.python_mypy_options*
 782                                                     *g:ale_python_mypy_options*
 783                                                     *b:ale_python_mypy_options*
 784 python_mypy_options
 785 g:ale_python_mypy_options
 786   Type: |String|
 787   Default: `''`
 788
 789   This variable can be changed to add command-line arguments to the mypy
 790   invocation.
 791
 792                                            *ale-options.python_mypy_show_notes*
 793                                                  *g:ale_python_mypy_show_notes*
 794                                                  *b:ale_python_mypy_show_notes*
 795 python_mypy_show_notes
 796 g:ale_python_mypy_show_notes
 797   Type: |Number|
 798   Default: `1`
 799
 800   If enabled, notes on lines will be displayed as 'I' (info) messages.
 801
 802                                            *ale-options.python_mypy_use_global*
 803                                                  *g:ale_python_mypy_use_global*
 804                                                  *b:ale_python_mypy_use_global*
 805 python_mypy_use_global
 806 g:ale_python_mypy_use_global
 807   Type: |Number|
 808   Default: `get(g:, 'ale_use_global_executables', 0)`
 809
 810   See |ale-integrations-local-executables|
 811
 812
 813 ===============================================================================
 814 prospector                                              *ale-python-prospector*
 815
 816                                      *ale-options.python_prospector_executable*
 817                                            *g:ale_python_prospector_executable*
 818                                            *b:ale_python_prospector_executable*
 819 python_prospector_executable
 820 g:ale_python_prospector_executable
 821   Type: |String|
 822   Default: `'prospector'`
 823
 824   See |ale-integrations-local-executables|
 825
 826   Set this to `'pipenv'` to invoke `'pipenv` `run` `prospector'`.
 827   Set this to `'poetry'` to invoke `'poetry` `run` `prospector'`.
 828
 829                                         *ale-options.python_prospector_options*
 830                                               *g:ale_python_prospector_options*
 831                                               *b:ale_python_prospector_options*
 832 python_prospector_options
 833 g:ale_python_prospector_options
 834   Type: |String|
 835   Default: `''`
 836
 837   This variable can be changed to add command-line arguments to the prospector
 838   invocation.
 839
 840   For example, to dynamically switch between programs targeting Python 2 and
 841   Python 3, you may want to set >
 842
 843   let g:ale_python_prospector_executable = 'python3'
 844   " or 'python' for Python 2
 845   let g:ale_python_prospector_options = '--rcfile /path/to/.prospector.yaml'
 846   " The virtualenv detection needs to be disabled.
 847   let g:ale_python_prospector_use_global = 0
 848
 849   after making sure it's installed for the appropriate Python versions (e.g.
 850   `python3 -m pip install --user prospector`).
 851 <
 852                                      *ale-options.python_prospector_use_global*
 853                                            *g:ale_python_prospector_use_global*
 854                                            *b:ale_python_prospector_use_global*
 855 python_prospector_use_global
 856 g:ale_python_prospector_use_global
 857   Type: |Number|
 858   Default: `get(g:, 'ale_use_global_executables', 0)`
 859
 860   See |ale-integrations-local-executables|
 861
 862                                     *ale-options.python_prospector_auto_pipenv*
 863                                           *g:ale_python_prospector_auto_pipenv*
 864                                           *b:ale_python_prospector_auto_pipenv*
 865 python_prospector_auto_pipenv
 866 g:ale_python_prospector_auto_pipenv
 867   Type: |Number|
 868   Default: `0`
 869
 870   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
 871   if true. This is overridden by a manually-set executable.
 872
 873                                     *ale-options.python_prospector_auto_poetry*
 874                                           *g:ale_python_prospector_auto_poetry*
 875                                           *b:ale_python_prospector_auto_poetry*
 876 python_prospector_auto_poetry
 877 g:ale_python_prospector_auto_poetry
 878   Type: |Number|
 879   Default: `0`
 880
 881   Detect whether the file is inside a poetry, and set the executable to `poetry`
 882   if true. This is overridden by a manually-set executable.
 883
 884                                         *ale-options.python_prospector_auto_uv*
 885                                               *g:ale_python_prospector_auto_uv*
 886                                               *b:ale_python_prospector_auto_uv*
 887 python_prospector_auto_uv
 888 g:ale_python_prospector_auto_uv
 889   Type: |Number|
 890   Default: `0`
 891
 892   Set the executable to `uv` if true. This is overridden by a manually-set
 893   executable.
 894
 895
 896 ===============================================================================
 897 pycln                                                        *ale-python-pycln*
 898
 899                                     *ale-options.python_pycln_change_directory*
 900                                           *g:ale_python_pycln_change_directory*
 901                                           *b:ale_python_pycln_change_directory*
 902 python_pycln_change_directory
 903 g:ale_python_pycln_change_directory
 904   Type: |Number|
 905   Default: `1`
 906
 907   If set to `1`, `pycln` will be run from a detected project root, per
 908   |ale-python-root|. if set to `0` or no project root detected,
 909   `pycln` will be run from the buffer's directory.
 910
 911                                           *ale-options.python_pycln_executable*
 912                                                 *g:ale_python_pycln_executable*
 913                                                 *b:ale_python_pycln_executable*
 914 python_pycln_executable
 915 g:ale_python_pycln_executable
 916   Type: |String|
 917   Default: `'pycln'`
 918
 919   See |ale-integrations-local-executables|
 920
 921   Set this to `'pipenv'` to invoke `'pipenv` `run` `pycln'`.
 922   Set this to `'poetry'` to invoke `'poetry` `run` `pycln'`.
 923
 924                                              *ale-options.python_pycln_options*
 925                                                    *g:ale_python_pycln_options*
 926                                                    *b:ale_python_pycln_options*
 927 python_pycln_options
 928 g:ale_python_pycln_options
 929   Type: |String|
 930   Default: `''`
 931
 932   This variable can be changed to add command-line arguments to the pycln
 933   invocation.
 934
 935   For example, to select/enable and/or disable some error codes,
 936   you may want to set the following: >
 937
 938   let g:ale_python_pycln_options = '--expand-stars'
 939 <
 940                                          *ale-options.python_pycln_config_file*
 941                                                *g:ale_python_pycln_config_file*
 942                                                *b:ale_python_pycln_config_file*
 943 python_pycln_config_file
 944 g:ale_python_pycln_config_file
 945   Type: |String|
 946   Default: `''`
 947
 948   Use this variable to set the configuration file.
 949   If `'--config' ` is found in the |g:ale_python_pycln_options|, then that
 950   option value will override the value in this variable.
 951
 952                                           *ale-options.python_pycln_use_global*
 953                                                 *g:ale_python_pycln_use_global*
 954                                                 *b:ale_python_pycln_use_global*
 955 python_pycln_use_global
 956 g:ale_python_pycln_use_global
 957   Type: |Number|
 958   Default: `get(g:, 'ale_use_global_executables', 0)`
 959
 960   See |ale-integrations-local-executables|
 961
 962                                          *ale-options.python_pycln_auto_pipenv*
 963                                                *g:ale_python_pycln_auto_pipenv*
 964                                                *b:ale_python_pycln_auto_pipenv*
 965 python_pycln_auto_pipenv
 966 g:ale_python_pycln_auto_pipenv
 967   Type: |Number|
 968   Default: `0`
 969
 970   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
 971   if true. This is overridden by a manually-set executable.
 972
 973                                          *ale-options.python_pycln_auto_poetry*
 974                                                *g:ale_python_pycln_auto_poetry*
 975                                                *b:ale_python_pycln_auto_poetry*
 976 python_pycln_auto_poetry
 977 g:ale_python_pycln_auto_poetry
 978   Type: |Number|
 979   Default: `0`
 980
 981   Detect whether the file is inside a poetry, and set the executable to `poetry`
 982   if true. This is overridden by a manually-set executable.
 983
 984                                              *ale-options.python_pycln_auto_uv*
 985                                                    *g:ale_python_pycln_auto_uv*
 986                                                    *b:ale_python_pycln_auto_uv*
 987 python_pycln_auto_uv
 988 g:ale_python_pycln_auto_uv
 989   Type: |Number|
 990   Default: `0`
 991
 992   Set the executable to `uv` if true. This is overridden by a manually-set
 993   executable.
 994
 995
 996 ===============================================================================
 997 pycodestyle                                            *ale-python-pycodestyle*
 998
 999                                     *ale-options.python_pycodestyle_executable*
1000                                           *g:ale_python_pycodestyle_executable*
1001                                           *b:ale_python_pycodestyle_executable*
1002 python_pycodestyle_executable
1003 g:ale_python_pycodestyle_executable
1004   Type: |String|
1005   Default: `'pycodestyle'`
1006
1007   See |ale-integrations-local-executables|
1008
1009   Set this to `'pipenv'` to invoke `'pipenv` `run` `pycodestyle'`.
1010   Set this to `'poetry'` to invoke `'poetry` `run` `pycodestyle'`.
1011
1012                                        *ale-options.python_pycodestyle_options*
1013                                              *g:ale_python_pycodestyle_options*
1014                                              *b:ale_python_pycodestyle_options*
1015 python_pycodestyle_options
1016 g:ale_python_pycodestyle_options
1017   Type: |String|
1018   Default: `''`
1019
1020   This variable can be changed to add command-line arguments to the
1021   pycodestyle invocation.
1022
1023                                     *ale-options.python_pycodestyle_use_global*
1024                                           *g:ale_python_pycodestyle_use_global*
1025                                           *b:ale_python_pycodestyle_use_global*
1026 python_pycodestyle_use_global
1027 g:ale_python_pycodestyle_use_global
1028   Type: |Number|
1029   Default: `get(g:, 'ale_use_global_executables', 0)`
1030
1031   See |ale-integrations-local-executables|
1032
1033                                    *ale-options.python_pycodestyle_auto_pipenv*
1034                                          *g:ale_python_pycodestyle_auto_pipenv*
1035                                          *b:ale_python_pycodestyle_auto_pipenv*
1036 python_pycodestyle_auto_pipenv
1037 g:ale_python_pycodestyle_auto_pipenv
1038   Type: |Number|
1039   Default: `0`
1040
1041   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
1042   if true. This is overridden by a manually-set executable.
1043
1044                                    *ale-options.python_pycodestyle_auto_poetry*
1045                                          *g:ale_python_pycodestyle_auto_poetry*
1046                                          *b:ale_python_pycodestyle_auto_poetry*
1047 python_pycodestyle_auto_poetry
1048 g:ale_python_pycodestyle_auto_poetry
1049   Type: |Number|
1050   Default: `0`
1051
1052   Detect whether the file is inside a poetry, and set the executable to `poetry`
1053   if true. This is overridden by a manually-set executable.
1054
1055                                        *ale-options.python_pycodestyle_auto_uv*
1056                                              *g:ale_python_pycodestyle_auto_uv*
1057                                              *b:ale_python_pycodestyle_auto_uv*
1058 python_pycodestyle_auto_uv
1059 g:ale_python_pycodestyle_auto_uv
1060   Type: |Number|
1061   Default: `0`
1062
1063   Set the executable to `uv` if true. This is overridden by a manually-set
1064   executable.
1065
1066
1067 ===============================================================================
1068 pydocstyle                                              *ale-python-pydocstyle*
1069
1070                                      *ale-options.python_pydocstyle_executable*
1071                                            *g:ale_python_pydocstyle_executable*
1072                                            *b:ale_python_pydocstyle_executable*
1073 python_pydocstyle_executable
1074 g:ale_python_pydocstyle_executable
1075   Type: |String|
1076   Default: `'pydocstyle'`
1077
1078   See |ale-integrations-local-executables|
1079
1080   Set this to `'pipenv'` to invoke `'pipenv` `run` `pydocstyle'`.
1081   Set this to `'poetry'` to invoke `'poetry` `run` `pydocstyle'`.
1082
1083                                         *ale-options.python_pydocstyle_options*
1084                                               *g:ale_python_pydocstyle_options*
1085                                               *b:ale_python_pydocstyle_options*
1086 python_pydocstyle_options
1087 g:ale_python_pydocstyle_options
1088   Type: |String|
1089   Default: `''`
1090
1091   This variable can be changed to add command-line arguments to the
1092   pydocstyle invocation.
1093
1094                                      *ale-options.python_pydocstyle_use_global*
1095                                            *g:ale_python_pydocstyle_use_global*
1096                                            *b:ale_python_pydocstyle_use_global*
1097 python_pydocstyle_use_global
1098 g:ale_python_pydocstyle_use_global
1099   Type: |Number|
1100   Default: `get(g:, 'ale_use_global_executables', 0)`
1101
1102   See |ale-integrations-local-executables|
1103
1104                                     *ale-options.python_pydocstyle_auto_pipenv*
1105                                           *g:ale_python_pydocstyle_auto_pipenv*
1106                                           *b:ale_python_pydocstyle_auto_pipenv*
1107 python_pydocstyle_auto_pipenv
1108 g:ale_python_pydocstyle_auto_pipenv
1109   Type: |Number|
1110   Default: `0`
1111
1112   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
1113   if true. This is overridden by a manually-set executable.
1114
1115                                     *ale-options.python_pydocstyle_auto_poetry*
1116                                           *g:ale_python_pydocstyle_auto_poetry*
1117                                           *b:ale_python_pydocstyle_auto_poetry*
1118 python_pydocstyle_auto_poetry
1119 g:ale_python_pydocstyle_auto_poetry
1120   Type: |Number|
1121   Default: `0`
1122
1123   Detect whether the file is inside a poetry, and set the executable to `poetry`
1124   if true. This is overridden by a manually-set executable.
1125
1126                                         *ale-options.python_pydocstyle_auto_uv*
1127                                               *g:ale_python_pydocstyle_auto_uv*
1128                                               *b:ale_python_pydocstyle_auto_uv*
1129 python_pydocstyle_auto_uv
1130 g:ale_python_pydocstyle_auto_uv
1131   Type: |Number|
1132   Default: `0`
1133
1134   Set the executable to `uv` if true. This is overridden by a manually-set
1135   executable.
1136
1137
1138 ===============================================================================
1139 pyflakes                                                  *ale-python-pyflakes*
1140
1141                                        *ale-options.python_pyflakes_executable*
1142                                              *g:ale_python_pyflakes_executable*
1143                                              *b:ale_python_pyflakes_executable*
1144 python_pyflakes_executable
1145 g:ale_python_pyflakes_executable
1146   Type: |String|
1147   Default: `'pyflakes'`
1148
1149   See |ale-integrations-local-executables|
1150
1151   Set this to `'pipenv'` to invoke `'pipenv` `run` `pyflakes'`.
1152   Set this to `'poetry'` to invoke `'poetry` `run` `pyflakes'`.
1153
1154                                       *ale-options.python_pyflakes_auto_pipenv*
1155                                             *g:ale_python_pyflakes_auto_pipenv*
1156                                             *b:ale_python_pyflakes_auto_pipenv*
1157 python_pyflakes_auto_pipenv
1158 g:ale_python_pyflakes_auto_pipenv
1159   Type: |Number|
1160   Default: `0`
1161
1162   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
1163   if true. This is overridden by a manually-set executable.
1164
1165                                       *ale-options.python_pyflakes_auto_poetry*
1166                                             *g:ale_python_pyflakes_auto_poetry*
1167                                             *b:ale_python_pyflakes_auto_poetry*
1168 python_pyflakes_auto_poetry
1169 g:ale_python_pyflakes_auto_poetry
1170   Type: |Number|
1171   Default: `0`
1172
1173   Detect whether the file is inside a poetry, and set the executable to `poetry`
1174   if true. This is overridden by a manually-set executable.
1175
1176                                           *ale-options.python_pyflakes_auto_uv*
1177                                                 *g:ale_python_pyflakes_auto_uv*
1178                                                 *b:ale_python_pyflakes_auto_uv*
1179 python_pyflakes_auto_uv
1180 g:ale_python_pyflakes_auto_uv
1181   Type: |Number|
1182   Default: `0`
1183
1184   Set the executable to `uv` if true. This is overridden by a manually-set
1185   executable.
1186
1187
1188 ===============================================================================
1189 pyflyby                                                    *ale-python-pyflyby*
1190
1191                                         *ale-options.python_pyflyby_executable*
1192                                               *g:ale_python_pyflyby_executable*
1193                                               *b:ale_python_pyflyby_executable*
1194 python_pyflyby_executable
1195 g:ale_python_pyflyby_executable
1196   Type: |String|
1197   Default: `'tidy-imports'`
1198
1199   See |ale-integrations-local-executables|
1200
1201                                            *ale-options.python_pyflyby_options*
1202                                                  *g:ale_python_pyflyby_options*
1203                                                  *b:ale_python_pyflyby_options*
1204 python_pyflyby_options
1205 g:ale_python_pyflyby_options
1206   Type: |String|
1207   Default: `''`
1208
1209   This variable can be changed to add command-line arguments to the pyflyby
1210   tidy-imports invocation.
1211
1212                                         *ale-options.python_pyflyby_use_global*
1213                                               *g:ale_python_pyflyby_use_global*
1214                                               *b:ale_python_pyflyby_use_global*
1215 python_pyflyby_use_global
1216 g:ale_python_pyflyby_use_global
1217   Type: |Number|
1218   Default: `get(g:, 'ale_use_global_executables', 0)`
1219
1220   See |ale-integrations-local-executables|
1221
1222                                        *ale-options.python_pyflyby_auto_pipenv*
1223                                              *g:ale_python_pyflyby_auto_pipenv*
1224                                              *b:ale_python_pyflyby_auto_pipenv*
1225 python_pyflyby_auto_pipenv
1226 g:ale_python_pyflyby_auto_pipenv
1227   Type: |Number|
1228   Default: `0`
1229
1230   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
1231   if true. This is overridden by a manually-set executable.
1232
1233                                        *ale-options.python_pyflyby_auto_poetry*
1234                                              *g:ale_python_pyflyby_auto_poetry*
1235                                              *b:ale_python_pyflyby_auto_poetry*
1236 python_pyflyby_auto_poetry
1237 g:ale_python_pyflyby_auto_poetry
1238   Type: |Number|
1239   Default: `0`
1240
1241   Detect whether the file is inside a poetry, and set the executable to `poetry`
1242   if true. This is overridden by a manually-set executable.
1243
1244                                            *ale-options.python_pyflyby_auto_uv*
1245                                                  *g:ale_python_pyflyby_auto_uv*
1246                                                  *b:ale_python_pyflyby_auto_uv*
1247 python_pyflyby_auto_uv
1248 g:ale_python_pyflyby_auto_uv
1249   Type: |Number|
1250   Default: `0`
1251
1252   Set the executable to `uv` if true. This is overridden by a manually-set
1253   executable.
1254
1255
1256 ===============================================================================
1257 pylama                                                      *ale-python-pylama*
1258
1259                                    *ale-options.python_pylama_change_directory*
1260                                          *g:ale_python_pylama_change_directory*
1261                                          *b:ale_python_pylama_change_directory*
1262 python_pylama_change_directory
1263 g:ale_python_pylama_change_directory
1264   Type: |Number|
1265   Default: `1`
1266
1267   If set to `1`, `pylama` will be run from a detected project root, per
1268   |ale-python-root|.  This is useful because `pylama` only searches for
1269   configuration files in its current directory and applies file masks using
1270   paths relative to its current directory.  This option can be turned off if
1271   you want to control the directory in which `pylama` is executed.
1272
1273                                          *ale-options.python_pylama_executable*
1274                                                *g:ale_python_pylama_executable*
1275                                                *b:ale_python_pylama_executable*
1276 python_pylama_executable
1277 g:ale_python_pylama_executable
1278   Type: |String|
1279   Default: `'pylama'`
1280
1281   This variable can be changed to modify the executable used for pylama. Set
1282   this to `'pipenv'` to invoke `'pipenv` `run` `pylama'`. Set this to
1283   `'poetry'` to invoke `'poetry` `run` `pylama'`.
1284
1285                                             *ale-options.python_pylama_options*
1286                                                   *g:ale_python_pylama_options*
1287                                                   *b:ale_python_pylama_options*
1288 python_pylama_options
1289 g:ale_python_pylama_options
1290   Type: |String|
1291   Default: `''`
1292
1293   This variable can be changed to add command-line arguments to the pylama
1294   invocation.
1295
1296                                          *ale-options.python_pylama_use_global*
1297                                                *g:ale_python_pylama_use_global*
1298                                                *b:ale_python_pylama_use_global*
1299 python_pylama_use_global
1300 g:ale_python_pylama_use_global
1301   Type: |Number|
1302   Default: `get(g:, 'ale_use_global_executables', 0)`
1303
1304   This variable controls whether or not ALE will search for pylama in a
1305   virtualenv directory first. If this variable is set to `1`, then ALE will
1306   always use |g:ale_python_pylama_executable| for the executable path.
1307
1308   Both variables can be set with `b:` buffer variables instead.
1309
1310                                         *ale-options.python_pylama_auto_pipenv*
1311                                               *g:ale_python_pylama_auto_pipenv*
1312                                               *b:ale_python_pylama_auto_pipenv*
1313 python_pylama_auto_pipenv
1314 g:ale_python_pylama_auto_pipenv
1315   Type: |Number|
1316   Default: `0`
1317
1318   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
1319   if true. This is overridden by a manually-set executable.
1320
1321                                         *ale-options.python_pylama_auto_poetry*
1322                                               *g:ale_python_pylama_auto_poetry*
1323                                               *b:ale_python_pylama_auto_poetry*
1324 python_pylama_auto_poetry
1325 g:ale_python_pylama_auto_poetry
1326   Type: |Number|
1327   Default: `0`
1328
1329   Detect whether the file is inside a poetry, and set the executable to `poetry`
1330   if true. This is overridden by a manually-set executable.
1331
1332                                             *ale-options.python_pylama_auto_uv*
1333                                                   *g:ale_python_pylama_auto_uv*
1334                                                   *b:ale_python_pylama_auto_uv*
1335 python_pylama_auto_uv
1336 g:ale_python_pylama_auto_uv
1337   Type: |Number|
1338   Default: `0`
1339
1340   Set the executable to `uv` if true. This is overridden by a manually-set
1341   executable.
1342
1343
1344 ===============================================================================
1345 pylint                                                      *ale-python-pylint*
1346
1347                                    *ale-options.python_pylint_change_directory*
1348                                          *g:ale_python_pylint_change_directory*
1349                                          *b:ale_python_pylint_change_directory*
1350 python_pylint_change_directory
1351 g:ale_python_pylint_change_directory
1352   Type: |Number|
1353   Default: `1`
1354
1355   If set to `1`, `pylint` will be run from a detected project root, per
1356   |ale-python-root|.  Since `pylint` only checks for `pylintrc` in the packages
1357   above its current directory before falling back to user and global `pylintrc`
1358   files, this is necessary for `pylint` to use a project `pylintrc` file, if
1359   present.  This option can be turned off if you want to control the directory
1360   Python is executed from yourself.
1361
1362                                          *ale-options.python_pylint_executable*
1363                                                *g:ale_python_pylint_executable*
1364                                                *b:ale_python_pylint_executable*
1365 python_pylint_executable
1366 g:ale_python_pylint_executable
1367   Type: |String|
1368   Default: `'pylint'`
1369
1370   See |ale-integrations-local-executables|
1371
1372   Set this to `'pipenv'` to invoke `'pipenv` `run` `pylint'`.
1373   Set this to `'poetry'` to invoke `'poetry` `run` `pylint'`.
1374
1375                                             *ale-options.python_pylint_options*
1376                                                   *g:ale_python_pylint_options*
1377                                                   *b:ale_python_pylint_options*
1378 python_pylint_options
1379 g:ale_python_pylint_options
1380   Type: |String|
1381   Default: `''`
1382
1383   This variable can be changed to add command-line arguments to the pylint
1384   invocation.
1385
1386   For example, to dynamically switch between programs targeting Python 2 and
1387   Python 3, you may want to set >
1388
1389   let g:ale_python_pylint_executable = 'python3'   " or 'python' for Python 2
1390   let g:ale_python_pylint_options = '--rcfile /path/to/pylint.rc'
1391   " The virtualenv detection needs to be disabled.
1392   let g:ale_python_pylint_use_global = 0
1393
1394   after making sure it's installed for the appropriate Python versions (e.g.
1395   `python3 -m pip install --user pylint`).
1396 <
1397                                          *ale-options.python_pylint_use_global*
1398                                                *g:ale_python_pylint_use_global*
1399                                                *b:ale_python_pylint_use_global*
1400 python_pylint_use_global
1401 g:ale_python_pylint_use_global
1402   Type: |Number|
1403   Default: `get(g:, 'ale_use_global_executables', 0)`
1404
1405   See |ale-integrations-local-executables|
1406
1407                                         *ale-options.python_pylint_auto_pipenv*
1408                                               *g:ale_python_pylint_auto_pipenv*
1409                                               *b:ale_python_pylint_auto_pipenv*
1410 python_pylint_auto_pipenv
1411 g:ale_python_pylint_auto_pipenv
1412   Type: |Number|
1413   Default: `0`
1414
1415   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
1416   if true. This is overridden by a manually-set executable.
1417
1418                                         *ale-options.python_pylint_auto_poetry*
1419                                               *g:ale_python_pylint_auto_poetry*
1420                                               *b:ale_python_pylint_auto_poetry*
1421 python_pylint_auto_poetry
1422 g:ale_python_pylint_auto_poetry
1423   Type: |Number|
1424   Default: `0`
1425
1426   Detect whether the file is inside a poetry, and set the executable to `poetry`
1427   if true. This is overridden by a manually-set executable.
1428
1429                                             *ale-options.python_pylint_auto_uv*
1430                                                   *g:ale_python_pylint_auto_uv*
1431                                                   *b:ale_python_pylint_auto_uv*
1432 python_pylint_auto_uv
1433 g:ale_python_pylint_auto_uv
1434   Type: |Number|
1435   Default: `0`
1436
1437   Set the executable to `uv` if true. This is overridden by a manually-set
1438   executable.
1439
1440                                          *ale-options.python_pylint_use_msg_id*
1441                                                *g:ale_python_pylint_use_msg_id*
1442                                                *b:ale_python_pylint_use_msg_id*
1443 python_pylint_use_msg_id
1444 g:ale_python_pylint_use_msg_id
1445   Type: |Number|
1446   Default: `0`
1447
1448   Use message for output (e.g. I0011) instead of symbolic name of the message
1449   (e.g. locally-disabled).
1450
1451
1452 ===============================================================================
1453 pylsp                                                        *ale-python-pylsp*
1454
1455 `pylsp` will be run from a detected project root, per |ale-python-root|.
1456
1457                                           *ale-options.python_pylsp_executable*
1458                                                 *g:ale_python_pylsp_executable*
1459                                                 *b:ale_python_pylsp_executable*
1460 python_pylsp_executable
1461 g:ale_python_pylsp_executable
1462   Type: |String|
1463   Default: `'pylsp'`
1464
1465   See |ale-integrations-local-executables|
1466
1467   Set this to `'pipenv'` to invoke `'pipenv` `run` `pylsp'`.
1468   Set this to `'poetry'` to invoke `'poetry` `run` `pyls'`.
1469
1470                                           *ale-options.python_pylsp_use_global*
1471                                                 *g:ale_python_pylsp_use_global*
1472                                                 *b:ale_python_pylsp_use_global*
1473 python_pylsp_use_global
1474 g:ale_python_pylsp_use_global
1475   Type: |Number|
1476   Default: `get(g:, 'ale_use_global_executables', 0)`
1477
1478   See |ale-integrations-local-executables|
1479
1480                                          *ale-options.python_pylsp_auto_pipenv*
1481                                                *g:ale_python_pylsp_auto_pipenv*
1482                                                *b:ale_python_pylsp_auto_pipenv*
1483 python_pylsp_auto_pipenv
1484 g:ale_python_pylsp_auto_pipenv
1485   Type: |Number|
1486   Default: `0`
1487
1488   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
1489   if true. This is overridden by a manually-set executable.
1490
1491                                          *ale-options.python_pylsp_auto_poetry*
1492                                                *g:ale_python_pylsp_auto_poetry*
1493                                                *b:ale_python_pylsp_auto_poetry*
1494 python_pylsp_auto_poetry
1495 g:ale_python_pylsp_auto_poetry
1496   Type: |Number|
1497   Default: `0`
1498
1499   Detect whether the file is inside a poetry, and set the executable to `poetry`
1500   if true. This is overridden by a manually-set executable.
1501
1502                                              *ale-options.python_pylsp_auto_uv*
1503                                                    *g:ale_python_pylsp_auto_uv*
1504                                                    *b:ale_python_pylsp_auto_uv*
1505 python_pylsp_auto_uv
1506 g:ale_python_pylsp_auto_uv
1507   Type: |Number|
1508   Default: `0`
1509
1510   Set the executable to `uv` if true. This is overridden by a manually-set
1511   executable.
1512
1513                                               *ale-options.python_pylsp_config*
1514                                                     *g:ale_python_pylsp_config*
1515                                                     *b:ale_python_pylsp_config*
1516 python_pylsp_config
1517 g:ale_python_pylsp_config
1518   Type: |Dictionary|
1519   Default: `{}`
1520
1521   Dictionary with configuration settings for pylsp. For example, to disable
1522   the pycodestyle linter: >
1523
1524   let g:ale_python_pylsp_config = {
1525   \   'pylsp': {
1526   \       'plugins': {
1527   \           'pycodestyle': {
1528   \               'enabled': v:false
1529   \           }
1530   \       }
1531   \   },
1532   \}
1533 <
1534                                              *ale-options.python_pylsp_options*
1535                                                    *g:ale_python_pylsp_options*
1536                                                    *b:ale_python_pylsp_options*
1537 python_pylsp_options
1538 g:ale_python_pylsp_options
1539   Type: |String|
1540   Default: `''`
1541
1542   This variable can be changed to add command-line arguments to the pylsp
1543   invocation. Note that this is not the same thing as ale_python_pylsp_config,
1544   which allows configuration of how pylsp functions; this is intended to
1545   provide flexibility in how the pylsp command is invoked.
1546
1547   For example, if you had installed `pylsp` but your `pylsp` executable was not
1548   on your `PATH` for some reason, an alternative way to run the pylsp server
1549   would be:
1550   let g:ale_python_pylsp_executable = 'python3'
1551   let g:ale_python_pylsp_options = '-m pylsp'
1552
1553   An example strategy for installing `pylsp`:
1554     `python3 -m pip install --user pylsp`
1555
1556
1557 ===============================================================================
1558 pyre                                                          *ale-python-pyre*
1559
1560 `pyre` will be run from a detected project root, per |ale-python-root|.
1561
1562                                            *ale-options.python_pyre_executable*
1563                                                  *g:ale_python_pyre_executable*
1564                                                  *b:ale_python_pyre_executable*
1565 python_pyre_executable
1566 g:ale_python_pyre_executable
1567   Type: |String|
1568   Default: `'pyre'`
1569
1570   See |ale-integrations-local-executables|
1571
1572   Set this to `'pipenv'` to invoke `'pipenv` `run` `pyre'`.
1573   Set this to `'poetry'` to invoke `'poetry` `run` `pyre'`.
1574
1575                                            *ale-options.python_pyre_use_global*
1576                                                  *g:ale_python_pyre_use_global*
1577                                                  *b:ale_python_pyre_use_global*
1578 python_pyre_use_global
1579 g:ale_python_pyre_use_global
1580   Type: |Number|
1581   Default: `get(g:, 'ale_use_global_executables', 0)`
1582
1583   See |ale-integrations-local-executables|
1584
1585                                           *ale-options.python_pyre_auto_pipenv*
1586                                                 *g:ale_python_pyre_auto_pipenv*
1587                                                 *b:ale_python_pyre_auto_pipenv*
1588 python_pyre_auto_pipenv
1589 g:ale_python_pyre_auto_pipenv
1590   Type: |Number|
1591   Default: `0`
1592
1593   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
1594   if true. This is overridden by a manually-set executable.
1595
1596                                           *ale-options.python_pyre_auto_poetry*
1597                                                 *g:ale_python_pyre_auto_poetry*
1598                                                 *b:ale_python_pyre_auto_poetry*
1599 python_pyre_auto_poetry
1600 g:ale_python_pyre_auto_poetry
1601   Type: |Number|
1602   Default: `0`
1603
1604   Detect whether the file is inside a poetry, and set the executable to `poetry`
1605   if true. This is overridden by a manually-set executable.
1606
1607                                               *ale-options.python_pyre_auto_uv*
1608                                                     *g:ale_python_pyre_auto_uv*
1609                                                     *b:ale_python_pyre_auto_uv*
1610 python_pyre_auto_uv
1611 g:ale_python_pyre_auto_uv
1612   Type: |Number|
1613   Default: `0`
1614
1615   Set the executable to `uv` if true. This is overridden by a manually-set
1616   executable.
1617
1618
1619 ===============================================================================
1620 pyright                                                    *ale-python-pyright*
1621
1622 The `pyright` linter requires a recent version of `pyright` which includes
1623 the `pyright-langserver` executable. You can install `pyright` on your system
1624 through `npm` with `sudo npm install -g pyright` or similar.
1625
1626 Refer to their README for installation instructions:
1627 https://github.com/Microsoft/pyright
1628
1629 `pyright` needs to know the path to your Python executable and probably a
1630 virtualenv to run. ALE will try to detect these automatically.
1631 See |g:ale_python_pyright_config|.
1632
1633                                         *ale-options.python_pyright_executable*
1634                                               *g:ale_python_pyright_executable*
1635                                               *b:ale_python_pyright_executable*
1636 python_pyright_executable
1637 g:ale_python_pyright_executable
1638   Type: |String|
1639   Default: `'pyright-langserver'`
1640
1641   The executable for running `pyright`, which is typically installed globally.
1642
1643                                             *ale-options.python_pyright_config*
1644                                                   *g:ale_python_pyright_config*
1645                                                   *b:ale_python_pyright_config*
1646 python_pyright_config
1647 g:ale_python_pyright_config
1648   Type: |Dictionary|
1649   Default: `{}`
1650
1651   Settings for configuring the `pyright` language server.
1652
1653   See pyright's documentation for a full list of options:
1654   https://github.com/microsoft/pyright/blob/master/docs/settings.md
1655
1656   ALE will automatically try to set defaults for `venvPath` and `pythonPath`
1657   so your project can automatically be checked with the right libraries.
1658   You can override these settings with whatever you want in your ftplugin
1659   file like so: >
1660
1661   let b:ale_python_pyright_config = {
1662   \ 'python': {
1663   \   'pythonPath': '/bin/python',
1664   \   'venvPath': '/other/dir',
1665   \ },
1666   \}
1667 <
1668   If `venvPath` is set, but `pythonPath` is not,
1669   ALE will use `venvPath . '/bin/python'` or similar as `pythonPath`.
1670
1671   A commonly used setting for `pyright` is disabling language services
1672   apart from type checking and "hover" (|ale-hover|), you can set this
1673   setting like so, or use whatever other settings you want: >
1674
1675   let b:ale_python_pyright_config = {
1676   \ 'pyright': {
1677   \   'disableLanguageServices': v:true,
1678   \ },
1679   \}
1680 <
1681                                        *ale-options.python_pyright_auto_pipenv*
1682                                              *g:ale_python_pyright_auto_pipenv*
1683                                              *b:ale_python_pyright_auto_pipenv*
1684 python_pyright_auto_pipenv
1685 g:ale_python_pyright_auto_pipenv
1686   Type: |Number|
1687   Default: `0`
1688
1689   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
1690   if true. This is overridden by a manually-set executable.
1691
1692                                        *ale-options.python_pyright_auto_poetry*
1693                                              *g:ale_python_pyright_auto_poetry*
1694                                              *b:ale_python_pyright_auto_poetry*
1695 python_pyright_auto_poetry
1696 g:ale_python_pyright_auto_poetry
1697   Type: |Number|
1698   Default: `0`
1699
1700   Detect whether the file is inside a poetry, and set the executable to `poetry`
1701   if true. This is overridden by a manually-set executable.
1702
1703                                            *ale-options.python_pyright_auto_uv*
1704                                                  *g:ale_python_pyright_auto_uv*
1705                                                  *b:ale_python_pyright_auto_uv*
1706 python_pyright_auto_uv
1707 g:ale_python_pyright_auto_uv
1708   Type: |Number|
1709   Default: `0`
1710
1711   Set the executable to `uv` if true. This is overridden by a manually-set
1712   executable.
1713
1714
1715 ===============================================================================
1716 refurb                                                      *ale-python-refurb*
1717
1718                                    *ale-options.python_refurb_change_directory*
1719                                          *g:ale_python_refurb_change_directory*
1720                                          *b:ale_python_refurb_change_directory*
1721 python_refurb_change_directory
1722 g:ale_python_refurb_change_directory
1723   Type: |Number|
1724   Default: `1`
1725
1726   If set to `1`, `refurb` will be run from a detected project root, per
1727   |ale-python-root|. if set to `0` or no project root detected,
1728   `refurb` will be run from the buffer's directory.
1729
1730                                          *ale-options.python_refurb_executable*
1731                                                *g:ale_python_refurb_executable*
1732                                                *b:ale_python_refurb_executable*
1733 python_refurb_executable
1734 g:ale_python_refurb_executable
1735   Type: |String|
1736   Default: `'refurb'`
1737
1738   See |ale-integrations-local-executables|
1739
1740   Set this to `'pipenv'` to invoke `'pipenv` `run` `refurb'`.
1741   Set this to `'poetry'` to invoke `'poetry` `run` `refurb'`.
1742
1743                                             *ale-options.python_refurb_options*
1744                                                   *g:ale_python_refurb_options*
1745                                                   *b:ale_python_refurb_options*
1746 python_refurb_options
1747 g:ale_python_refurb_options
1748   Type: |String|
1749   Default: `''`
1750
1751   This variable can be changed to add command-line arguments to the refurb
1752   invocation.
1753
1754   For example, to select/enable and/or disable some error codes,
1755   you may want to set >
1756
1757   let g:ale_python_refurb_options = '--ignore 100'
1758 <
1759                                          *ale-options.python_refurb_use_global*
1760                                                *g:ale_python_refurb_use_global*
1761                                                *b:ale_python_refurb_use_global*
1762 python_refurb_use_global
1763 g:ale_python_refurb_use_global
1764   Type: |Number|
1765   Default: `get(g:, 'ale_use_global_executables', 0)`
1766
1767   See |ale-integrations-local-executables|
1768
1769                                         *ale-options.python_refurb_auto_pipenv*
1770                                               *g:ale_python_refurb_auto_pipenv*
1771                                               *b:ale_python_refurb_auto_pipenv*
1772 python_refurb_auto_pipenv
1773 g:ale_python_refurb_auto_pipenv
1774   Type: |Number|
1775   Default: `0`
1776
1777   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
1778   if true. This is overridden by a manually-set executable.
1779
1780                                         *ale-options.python_refurb_auto_poetry*
1781                                               *g:ale_python_refurb_auto_poetry*
1782                                               *b:ale_python_refurb_auto_poetry*
1783 python_refurb_auto_poetry
1784 g:ale_python_refurb_auto_poetry
1785   Type: |Number|
1786   Default: `0`
1787
1788   Detect whether the file is inside a poetry, and set the executable to `poetry`
1789   if true. This is overridden by a manually-set executable.
1790
1791                                             *ale-options.python_refurb_auto_uv*
1792                                                   *g:ale_python_refurb_auto_uv*
1793                                                   *b:ale_python_refurb_auto_uv*
1794 python_refurb_auto_uv
1795 g:ale_python_refurb_auto_uv
1796   Type: |Number|
1797   Default: `0`
1798
1799   Set the executable to `uv` if true. This is overridden by a manually-set
1800   executable.
1801
1802
1803 ===============================================================================
1804 reorder-python-imports                      *ale-python-reorder_python_imports*
1805
1806                          *ale-options.python_reorder_python_imports_executable*
1807                                *g:ale_python_reorder_python_imports_executable*
1808                                *b:ale_python_reorder_python_imports_executable*
1809 python_reorder_python_imports_executable
1810 g:ale_python_reorder_python_imports_executable
1811   Type: |String|
1812   Default: `'reorder-python-imports'`
1813
1814   See |ale-integrations-local-executables|
1815
1816                             *ale-options.python_reorder_python_imports_options*
1817                                   *g:ale_python_reorder_python_imports_options*
1818                                   *b:ale_python_reorder_python_imports_options*
1819 python_reorder_python_imports_options
1820 g:ale_python_reorder_python_imports_options
1821   Type: |String|
1822   Default: `''`
1823
1824   This variable can be set to pass extra options to reorder-python-imports.
1825
1826                          *ale-options.python_reorder_python_imports_use_global*
1827                                *g:ale_python_reorder_python_imports_use_global*
1828                                *b:ale_python_reorder_python_imports_use_global*
1829 python_reorder_python_imports_use_global
1830 g:ale_python_reorder_python_imports_use_global
1831   Type: |Number|
1832   Default: `get(g:, 'ale_use_global_executables', 0)`
1833
1834   See |ale-integrations-local-executables|
1835
1836                         *ale-options.python_reorder_python_imports_auto_pipenv*
1837                               *g:ale_python_reorder_python_imports_auto_pipenv*
1838                               *b:ale_python_reorder_python_imports_auto_pipenv*
1839 python_reorder_python_imports_auto_pipenv
1840 g:ale_python_reorder_python_imports_auto_pipenv
1841   Type: |Number|
1842   Default: `0`
1843
1844   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
1845   if true. This is overridden by a manually-set executable.
1846
1847                         *ale-options.python_reorder_python_imports_auto_poetry*
1848                               *g:ale_python_reorder_python_imports_auto_poetry*
1849                               *b:ale_python_reorder_python_imports_auto_poetry*
1850 python_reorder_python_imports_auto_poetry
1851 g:ale_python_reorder_python_imports_auto_poetry
1852   Type: |Number|
1853   Default: `0`
1854
1855   Detect whether the file is inside a poetry, and set the executable to `poetry`
1856   if true. This is overridden by a manually-set executable.
1857
1858                             *ale-options.python_reorder_python_imports_auto_uv*
1859                                   *g:ale_python_reorder_python_imports_auto_uv*
1860                                   *b:ale_python_reorder_python_imports_auto_uv*
1861 python_reorder_python_imports_auto_uv
1862 g:ale_python_reorder_python_imports_auto_uv
1863   Type: |Number|
1864   Default: `0`
1865
1866   Set the executable to `uv` if true. This is overridden by a manually-set
1867   executable.
1868
1869
1870 ===============================================================================
1871 ruff                                                          *ale-python-ruff*
1872
1873                                      *ale-options.python_ruff_change_directory*
1874                                            *g:ale_python_ruff_change_directory*
1875                                            *b:ale_python_ruff_change_directory*
1876 python_ruff_change_directory
1877 g:ale_python_ruff_change_directory
1878   Type: |Number|
1879   Default: `1`
1880
1881   If set to `1`, `ruff` will be run from a detected project root, per
1882   |ale-python-root|. if set to `0` or no project root detected,
1883   `ruff` will be run from the buffer's directory.
1884
1885                                            *ale-options.python_ruff_executable*
1886                                                  *g:ale_python_ruff_executable*
1887                                                  *b:ale_python_ruff_executable*
1888 python_ruff_executable
1889 g:ale_python_ruff_executable
1890   Type: |String|
1891   Default: `'ruff'`
1892
1893   See |ale-integrations-local-executables|
1894
1895   Set this to `'pipenv'` to invoke `'pipenv` `run` `ruff'`.
1896   Set this to `'poetry'` to invoke `'poetry` `run` `ruff'`.
1897
1898                                               *ale-options.python_ruff_options*
1899                                                     *g:ale_python_ruff_options*
1900                                                     *b:ale_python_ruff_options*
1901 python_ruff_options
1902 g:ale_python_ruff_options
1903   Type: |String|
1904   Default: `''`
1905
1906   This variable can be changed to add command-line arguments to the ruff
1907   invocation.
1908
1909   For example, to select/enable and/or disable some error codes,
1910   you may want to set: >
1911
1912   let g:ale_python_ruff_options = '--ignore F401'
1913 <
1914                                            *ale-options.python_ruff_use_global*
1915                                                  *g:ale_python_ruff_use_global*
1916                                                  *b:ale_python_ruff_use_global*
1917 python_ruff_use_global
1918 g:ale_python_ruff_use_global
1919   Type: |Number|
1920   Default: `get(g:, 'ale_use_global_executables', 0)`
1921
1922   See |ale-integrations-local-executables|
1923
1924                                           *ale-options.python_ruff_auto_pipenv*
1925                                                 *g:ale_python_ruff_auto_pipenv*
1926                                                 *b:ale_python_ruff_auto_pipenv*
1927 python_ruff_auto_pipenv
1928 g:ale_python_ruff_auto_pipenv
1929   Type: |Number|
1930   Default: `0`
1931
1932   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
1933   if true. This is overridden by a manually-set executable.
1934
1935                                           *ale-options.python_ruff_auto_poetry*
1936                                                 *g:ale_python_ruff_auto_poetry*
1937                                                 *b:ale_python_ruff_auto_poetry*
1938 python_ruff_auto_poetry
1939 g:ale_python_ruff_auto_poetry
1940   Type: |Number|
1941   Default: `0`
1942
1943   Detect whether the file is inside a poetry, and set the executable to `poetry`
1944   if true. This is overridden by a manually-set executable.
1945
1946                                               *ale-options.python_ruff_auto_uv*
1947                                                     *g:ale_python_ruff_auto_uv*
1948                                                     *b:ale_python_ruff_auto_uv*
1949 python_ruff_auto_uv
1950 g:ale_python_ruff_auto_uv
1951   Type: |Number|
1952   Default: `0`
1953
1954   Set the executable to `uv` if true. This is overridden by a manually-set
1955   executable.
1956
1957
1958 ===============================================================================
1959 ruff-format                                            *ale-python-ruff-format*
1960
1961                               *ale-options.python_ruff_format_change_directory*
1962                                     *g:ale_python_ruff_format_change_directory*
1963                                     *b:ale_python_ruff_format_change_directory*
1964 python_ruff_format_change_directory
1965 g:ale_python_ruff_format_change_directory
1966   Type: |Number|
1967   Default: `1`
1968
1969   If set to `1`, `ruff` will be run from a detected project root, per
1970   |ale-python-root|. if set to `0` or no project root detected,
1971   `ruff` will be run from the buffer's directory.
1972
1973                                     *ale-options.python_ruff_format_executable*
1974                                           *g:ale_python_ruff_format_executable*
1975                                           *b:ale_python_ruff_format_executable*
1976 python_ruff_format_executable
1977 g:ale_python_ruff_format_executable
1978   Type: |String|
1979   Default: `'ruff'`
1980
1981   See |ale-integrations-local-executables|
1982
1983   Set this to `'pipenv'` to invoke `'pipenv` `run` `ruff'`.
1984   Set this to `'poetry'` to invoke `'poetry` `run` `ruff'`.
1985
1986                                        *ale-options.python_ruff_format_options*
1987                                              *g:ale_python_ruff_format_options*
1988                                              *b:ale_python_ruff_format_options*
1989 python_ruff_format_options
1990 g:ale_python_ruff_format_options
1991   Type: |String|
1992   Default: `''`
1993
1994   This variable can be changed to add command-line arguments to the ruff
1995   invocation.
1996
1997   For example, to select/enable and/or disable some error codes,
1998   you may want to set >
1999
2000   let g:ale_python_ruff_format_options = '--ignore F401'
2001 <
2002                                     *ale-options.python_ruff_format_use_global*
2003                                           *g:ale_python_ruff_format_use_global*
2004                                           *b:ale_python_ruff_format_use_global*
2005 python_ruff_format_use_global
2006 g:ale_python_ruff_format_use_global
2007   Type: |Number|
2008   Default: `get(g:, 'ale_use_global_executables', 0)`
2009
2010   See |ale-integrations-local-executables|
2011
2012                                    *ale-options.python_ruff_format_auto_pipenv*
2013                                          *g:ale_python_ruff_format_auto_pipenv*
2014                                          *b:ale_python_ruff_format_auto_pipenv*
2015 python_ruff_format_auto_pipenv
2016 g:ale_python_ruff_format_auto_pipenv
2017   Type: |Number|
2018   Default: `0`
2019
2020   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
2021   if true. This is overridden by a manually-set executable.
2022
2023                                    *ale-options.python_ruff_format_auto_poetry*
2024                                          *g:ale_python_ruff_format_auto_poetry*
2025                                          *b:ale_python_ruff_format_auto_poetry*
2026 python_ruff_format_auto_poetry
2027 g:ale_python_ruff_format_auto_poetry
2028   Type: |Number|
2029   Default: `0`
2030
2031   Detect whether the file is inside a poetry, and set the executable to `poetry`
2032   if true. This is overridden by a manually-set executable.
2033
2034                                        *ale-options.python_ruff_format_auto_uv*
2035                                              *g:ale_python_ruff_format_auto_uv*
2036                                              *b:ale_python_ruff_format_auto_uv*
2037 python_ruff_format_auto_uv
2038 g:ale_python_ruff_format_auto_uv
2039   Type: |Number|
2040   Default: `0`
2041
2042   Set the executable to `uv` if true. This is overridden by a manually-set
2043   executable.
2044
2045
2046 ===============================================================================
2047 unimport                                                  *ale-python-unimport*
2048
2049 `unimport` will be run from a detected project root, per |ale-python-root|.
2050
2051                                       *ale-options.python_unimport_auto_pipenv*
2052                                             *g:ale_python_unimport_auto_pipenv*
2053                                             *b:ale_python_unimport_auto_pipenv*
2054 python_unimport_auto_pipenv
2055 g:ale_python_unimport_auto_pipenv
2056   Type: |Number|
2057   Default: `0`
2058
2059   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
2060   if true. This is overridden by a manually-set executable.
2061
2062                                       *ale-options.python_unimport_auto_poetry*
2063                                             *g:ale_python_unimport_auto_poetry*
2064                                             *b:ale_python_unimport_auto_poetry*
2065 python_unimport_auto_poetry
2066 g:ale_python_unimport_auto_poetry
2067   Type: |Number|
2068   Default: `0`
2069
2070   Detect whether the file is inside a poetry, and set the executable to `poetry`
2071   if true. This is overridden by a manually-set executable.
2072
2073                                           *ale-options.python_unimport_auto_uv*
2074                                                 *g:ale_python_unimport_auto_uv*
2075                                                 *b:ale_python_unimport_auto_uv*
2076 python_unimport_auto_uv
2077 g:ale_python_unimport_auto_uv
2078   Type: |Number|
2079   Default: `0`
2080
2081   Set the executable to `uv` if true. This is overridden by a manually-set
2082   executable.
2083
2084                                        *ale-options.python_unimport_executable*
2085                                              *g:ale_python_unimport_executable*
2086                                              *b:ale_python_unimport_executable*
2087 python_unimport_executable
2088 g:ale_python_unimport_executable
2089   Type: |String|
2090   Default: `'unimport'`
2091
2092   See |ale-integrations-local-executables|
2093
2094   Set this to `'pipenv'` to invoke `'pipenv` `run` `unimport'`.
2095   Set this to `'poetry'` to invoke `'poetry` `run` `unimport'`.
2096
2097                                           *ale-options.python_unimport_options*
2098                                                 *g:ale_python_unimport_options*
2099                                                 *b:ale_python_unimport_options*
2100 python_unimport_options
2101 g:ale_python_unimport_options
2102   Type: |String|
2103   Default: `''`
2104
2105   This variable can be changed to add command-line arguments to the unimport
2106   invocation.
2107
2108                                        *ale-options.python_unimport_use_global*
2109                                              *g:ale_python_unimport_use_global*
2110                                              *b:ale_python_unimport_use_global*
2111 python_unimport_use_global
2112 g:ale_python_unimport_use_global
2113   Type: |Number|
2114   Default: `get(g:, 'ale_use_global_executables', 0)`
2115
2116   See |ale-integrations-local-executables|
2117
2118
2119 ===============================================================================
2120 vulture                                                    *ale-python-vulture*
2121
2122                                   *ale-options.python_vulture_change_directory*
2123                                         *g:ale_python_vulture_change_directory*
2124                                         *b:ale_python_vulture_change_directory*
2125 python_vulture_change_directory
2126 g:ale_python_vulture_change_directory
2127   Type: |Number|
2128   Default: `1`
2129
2130   If set to `1`, ALE will switch to the directory the Python file being
2131   checked with `vulture` is in before checking it and check the whole project
2132   directory instead of checking only the file opened in the current buffer.
2133   This helps `vulture` to know the context and avoid false-negative results.
2134
2135                                         *ale-options.python_vulture_executable*
2136                                               *g:ale_python_vulture_executable*
2137                                               *b:ale_python_vulture_executable*
2138 python_vulture_executable
2139 g:ale_python_vulture_executable
2140   Type: |String|
2141   Default: `'vulture'`
2142
2143   See |ale-integrations-local-executables|
2144
2145                                            *ale-options.python_vulture_options*
2146                                                  *g:ale_python_vulture_options*
2147                                                  *b:ale_python_vulture_options*
2148 python_vulture_options
2149 g:ale_python_vulture_options
2150   Type: |String|
2151   Default: `''`
2152
2153   This variable can be changed to add command-line arguments to the vulture
2154   invocation.
2155
2156                                         *ale-options.python_vulture_use_global*
2157                                               *g:ale_python_vulture_use_global*
2158                                               *b:ale_python_vulture_use_global*
2159 python_vulture_use_global
2160 g:ale_python_vulture_use_global
2161   Type: |Number|
2162   Default: `get(g:, 'ale_use_global_executables', 0)`
2163
2164   See |ale-integrations-local-executables|
2165
2166                                        *ale-options.python_vulture_auto_pipenv*
2167                                              *g:ale_python_vulture_auto_pipenv*
2168                                              *b:ale_python_vulture_auto_pipenv*
2169 python_vulture_auto_pipenv
2170 g:ale_python_vulture_auto_pipenv
2171   Type: |Number|
2172   Default: `0`
2173
2174   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
2175   if true. This is overridden by a manually-set executable.
2176
2177                                        *ale-options.python_vulture_auto_poetry*
2178                                              *g:ale_python_vulture_auto_poetry*
2179                                              *b:ale_python_vulture_auto_poetry*
2180 python_vulture_auto_poetry
2181 g:ale_python_vulture_auto_poetry
2182   Type: |Number|
2183   Default: `0`
2184
2185   Detect whether the file is inside a poetry, and set the executable to `poetry`
2186   if true. This is overridden by a manually-set executable.
2187
2188                                            *ale-options.python_vulture_auto_uv*
2189                                                  *g:ale_python_vulture_auto_uv*
2190                                                  *b:ale_python_vulture_auto_uv*
2191 python_vulture_auto_uv
2192 g:ale_python_vulture_auto_uv
2193   Type: |Number|
2194   Default: `0`
2195
2196   Set the executable to `uv` if true. This is overridden by a manually-set
2197   executable.
2198
2199
2200 ===============================================================================
2201 yapf                                                          *ale-python-yapf*
2202
2203                                            *ale-options.python_yapf_executable*
2204                                                  *g:ale_python_yapf_executable*
2205                                                  *b:ale_python_yapf_executable*
2206 python_yapf_executable
2207 g:ale_python_yapf_executable
2208   Type: |String|
2209   Default: `'yapf'`
2210
2211   See |ale-integrations-local-executables|
2212
2213                                            *ale-options.python_yapf_use_global*
2214                                                  *g:ale_python_yapf_use_global*
2215                                                  *b:ale_python_yapf_use_global*
2216 python_yapf_use_global
2217 g:ale_python_yapf_use_global
2218   Type: |Number|
2219   Default: `get(g:, 'ale_use_global_executables', 0)`
2220
2221   See |ale-integrations-local-executables|
2222
2223                                           *ale-options.python_yapf_auto_pipenv*
2224                                                 *g:ale_python_yapf_auto_pipenv*
2225                                                 *b:ale_python_yapf_auto_pipenv*
2226 python_yapf_auto_pipenv
2227 g:ale_python_yapf_auto_pipenv
2228   Type: |Number|
2229   Default: `0`
2230
2231   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
2232   if true. This is overridden by a manually-set executable.
2233
2234                                           *ale-options.python_yapf_auto_poetry*
2235                                                 *g:ale_python_yapf_auto_poetry*
2236                                                 *b:ale_python_yapf_auto_poetry*
2237 python_yapf_auto_poetry
2238 g:ale_python_yapf_auto_poetry
2239   Type: |Number|
2240   Default: `0`
2241
2242   Detect whether the file is inside a poetry, and set the executable to `poetry`
2243   if true. This is overridden by a manually-set executable.
2244
2245                                               *ale-options.python_yapf_auto_uv*
2246                                                     *g:ale_python_yapf_auto_uv*
2247                                                     *b:ale_python_yapf_auto_uv*
2248 python_yapf_auto_uv
2249 g:ale_python_yapf_auto_uv
2250   Type: |Number|
2251   Default: `0`
2252
2253   Set the executable to `uv` if true. This is overridden by a manually-set
2254   executable.
2255
2256
2257 ===============================================================================
2258   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: