Skip to content

Latest commit

 

History

History
65 lines (63 loc) · 7.35 KB

CONFIGURATION.md

File metadata and controls

65 lines (63 loc) · 7.35 KB

Python Language Server Configuration

This server can be configured using workspace/didChangeConfiguration method. Each configuration option is described below:

Configuration Key Type Description Default
pylsp.configurationSources array of unique string items List of configuration sources to use. ["pycodestyle"]
pylsp.plugins.flake8.config string Path to the config file that will be the authoritative config source. null
pylsp.plugins.flake8.enabled boolean Enable or disable the plugin. false
pylsp.plugins.flake8.exclude array List of files or directories to exclude. null
pylsp.plugins.flake8.executable string Path to the flake8 executable. "flake8"
pylsp.plugins.flake8.filename string Only check for filenames matching the patterns in this list. null
pylsp.plugins.flake8.hangClosing boolean Hang closing bracket instead of matching indentation of opening bracket's line. null
pylsp.plugins.flake8.ignore array List of errors and warnings to ignore (or skip). null
pylsp.plugins.flake8.maxLineLength integer Maximum allowed line length for the entirety of this run. null
pylsp.plugins.flake8.perFileIgnores array A pairing of filenames and violation codes that defines which violations to ignore in a particular file, for example: ["file_path.py:W305,W304"]). null
pylsp.plugins.flake8.select array List of errors and warnings to enable. null
pylsp.plugins.jedi.extra_paths array Define extra paths for jedi.Script. []
pylsp.plugins.jedi.env_vars object Define environment variables for jedi.Script and Jedi.names. null
pylsp.plugins.jedi.environment string Define environment for jedi.Script and Jedi.names. null
pylsp.plugins.jedi_completion.enabled boolean Enable or disable the plugin. true
pylsp.plugins.jedi_completion.include_params boolean Auto-completes methods and classes with tabstops for each parameter. true
pylsp.plugins.jedi_completion.include_class_objects boolean Adds class objects as a separate completion item. true
pylsp.plugins.jedi_completion.fuzzy boolean Enable fuzzy when requesting autocomplete. false
pylsp.plugins.jedi_completion.eager boolean Resolve documentation and detail eagerly. false
pylsp.plugins.jedi_completion.resolve_at_most_labels number How many labels (at most) should be resolved? 25
pylsp.plugins.jedi_completion.cache_labels_for array of string items Modules for which the labels should be cached. ["pandas", "numpy", "tensorflow", "matplotlib"]
pylsp.plugins.jedi_definition.enabled boolean Enable or disable the plugin. true
pylsp.plugins.jedi_definition.follow_imports boolean The goto call will follow imports. true
pylsp.plugins.jedi_definition.follow_builtin_imports boolean If follow_imports is True will decide if it follow builtin imports. true
pylsp.plugins.jedi_hover.enabled boolean Enable or disable the plugin. true
pylsp.plugins.jedi_references.enabled boolean Enable or disable the plugin. true
pylsp.plugins.jedi_signature_help.enabled boolean Enable or disable the plugin. true
pylsp.plugins.jedi_symbols.enabled boolean Enable or disable the plugin. true
pylsp.plugins.jedi_symbols.all_scopes boolean If True lists the names of all scopes instead of only the module namespace. true
pylsp.plugins.jedi_symbols.include_import_symbols boolean If True includes symbols imported from other libraries. true
pylsp.plugins.mccabe.enabled boolean Enable or disable the plugin. true
pylsp.plugins.mccabe.threshold number The minimum threshold that triggers warnings about cyclomatic complexity. 15
pylsp.plugins.preload.enabled boolean Enable or disable the plugin. true
pylsp.plugins.preload.modules array of unique string items List of modules to import on startup null
pylsp.plugins.pycodestyle.enabled boolean Enable or disable the plugin. true
pylsp.plugins.pycodestyle.exclude array of unique string items Exclude files or directories which match these patterns. null
pylsp.plugins.pycodestyle.filename array of unique string items When parsing directories, only check filenames matching these patterns. null
pylsp.plugins.pycodestyle.select array of unique string items Select errors and warnings null
pylsp.plugins.pycodestyle.ignore array of unique string items Ignore errors and warnings null
pylsp.plugins.pycodestyle.hangClosing boolean Hang closing bracket instead of matching indentation of opening bracket's line. null
pylsp.plugins.pycodestyle.maxLineLength number Set maximum allowed line length. null
pylsp.plugins.pydocstyle.enabled boolean Enable or disable the plugin. false
pylsp.plugins.pydocstyle.convention string Choose the basic list of checked errors by specifying an existing convention. null
pylsp.plugins.pydocstyle.addIgnore array of unique string items Ignore errors and warnings in addition to the specified convention. null
pylsp.plugins.pydocstyle.addSelect array of unique string items Select errors and warnings in addition to the specified convention. null
pylsp.plugins.pydocstyle.ignore array of unique string items Ignore errors and warnings null
pylsp.plugins.pydocstyle.select array of unique string items Select errors and warnings null
pylsp.plugins.pydocstyle.match string Check only files that exactly match the given regular expression; default is to match files that don't start with 'test_' but end with '.py'. "(?!test_).*\\.py"
pylsp.plugins.pydocstyle.matchDir string Search only dirs that exactly match the given regular expression; default is to match dirs which do not begin with a dot. "[^\\.].*"
pylsp.plugins.pyflakes.enabled boolean Enable or disable the plugin. true
pylsp.plugins.pylint.enabled boolean Enable or disable the plugin. false
pylsp.plugins.pylint.args array of non-unique string items Arguments to pass to pylint. null
pylsp.plugins.pylint.executable string Executable to run pylint with. Enabling this will run pylint on unsaved files via stdin. Can slow down workflow. Only works with python3. null
pylsp.plugins.rope_completion.enabled boolean Enable or disable the plugin. true
pylsp.plugins.rope_completion.eager boolean Resolve documentation and detail eagerly. false
pylsp.plugins.yapf.enabled boolean Enable or disable the plugin. true
pylsp.rope.extensionModules string Builtin and c-extension modules that are allowed to be imported and inspected by rope. null
pylsp.rope.ropeFolder array of unique string items The name of the folder in which rope stores project configurations and data. Pass null for not using such a folder at all. null

This documentation was generated from pylsp/config/schema.json. Please do not edit this file directly.