Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add isort in pre commit configuration file #2805

Merged
7 changes: 7 additions & 0 deletions .isort.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[settings]
multi_line_output=3
line_length=88
known_third_party=astroid, sphinx, isort, pytest, mccabe, six,
include_trailing_comma=True
skip_glob=*/functional/**,*/input/**,*/test/extension/**,*/test/regrtest_data/**,*/test/data/**
project=pylint
8 changes: 6 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
repos:
- repo: https://github.com/ambv/black
rev: 18.6b4
rev: 19.3b0
hooks:
- id: black
args: [--safe, --quiet]
exclude: functional|input|test/extension|test/regrtest_data|test/data
python_version: python3.6
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v1.2.3
rev: v2.1.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- repo: https://github.com/pre-commit/mirrors-isort
Pierre-Sassoulas marked this conversation as resolved.
Show resolved Hide resolved
rev: v4.3.15
hooks:
- id: isort
1 change: 1 addition & 0 deletions bin/epylint
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python
from pylint import epylint

epylint.Run()
1 change: 1 addition & 0 deletions bin/pylint
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python
from pylint import run_pylint

run_pylint()
1 change: 1 addition & 0 deletions bin/pyreverse
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python
from pylint import run_pyreverse

run_pyreverse()
1 change: 1 addition & 0 deletions bin/symilar
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python
from pylint import run_symilar

run_symilar()
142 changes: 71 additions & 71 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,231 +11,231 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os
import sys
from datetime import datetime

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
from pylint.__pkginfo__ import version

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.append(os.path.abspath('exts'))
sys.path.append(os.path.abspath("exts"))

# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'pylint_features',
'pylint_extensions',
'sphinx.ext.autosectionlabel',
'sphinx.ext.intersphinx',
"pylint_features",
"pylint_extensions",
"sphinx.ext.autosectionlabel",
"sphinx.ext.intersphinx",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = ".rst"

# The encoding of source files.
#source_encoding = 'utf-8-sig'
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'
master_doc = "index"

# General information about the project.
project = 'Pylint'
project = "Pylint"
current_year = datetime.utcnow().year
copyright = '2003-{year}, Logilab, PyCQA and contributors'.format(year=current_year)
copyright = "2003-{year}, Logilab, PyCQA and contributors".format(year=current_year)

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
from pylint.__pkginfo__ import version
# The full version, including alpha/beta/rc tags.
release = version

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
exclude_patterns = ["_build"]

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# modindex_common_prefix = []


# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'python_docs_theme'
html_theme = "python_docs_theme"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
'collapsiblesidebar': True,
'issues_url': 'https://github.com/pycqa/pylint/issues/new',
'root_name': 'PyCQA',
'root_url': 'http://meta.pycqa.org/en/latest/',
"collapsiblesidebar": True,
"issues_url": "https://github.com/pycqa/pylint/issues/new",
"root_name": "PyCQA",
"root_url": "http://meta.pycqa.org/en/latest/",
}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# html_theme_path = []

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
#html_static_path = ['_static']
# html_static_path = ['_static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# html_last_updated_fmt = '%b %d, %Y'

smartquotes = False

# Custom sidebar templates, maps document names to template names.
html_sidebars = {
'**': [
'localtoc.html',
'globaltoc.html',
'relations.html',
'sourcelink.html'
]
"**": ["localtoc.html", "globaltoc.html", "relations.html", "sourcelink.html"]
}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True
# html_domain_indices = True

# If false, no index is generated.
#html_use_index = True
# html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False
# html_split_index = False

# If true, links to the reST sources are added to the pages.
html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'Pylintdoc'
htmlhelp_basename = "Pylintdoc"


# -- Options for LaTeX output --------------------------------------------------

# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# latex_paper_size = 'letter'

# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# latex_font_size = '10pt'

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Pylint.tex', 'Pylint Documentation',
'Logilab, PyCQA and contributors', 'manual'),
(
"index",
"Pylint.tex",
"Pylint Documentation",
"Logilab, PyCQA and contributors",
"manual",
)
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False
# latex_show_urls = False

# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# latex_preamble = ''

# Documents to append as an appendix to all manuals.
#latex_appendices = []
# latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True
# latex_domain_indices = True


# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'pylint', 'Pylint Documentation',
['Logilab, PyCQA and contributors'], 1)
("index", "pylint", "Pylint Documentation", ["Logilab, PyCQA and contributors"], 1)
]

intersphinx_mapping = {
'astroid': ('http://astroid.readthedocs.io/en/latest/', None),
'python': ('https://docs.python.org/3', None),
"astroid": ("http://astroid.readthedocs.io/en/latest/", None),
"python": ("https://docs.python.org/3", None),
}

# Prevent label issues due to colliding section names
Expand Down
3 changes: 2 additions & 1 deletion doc/development_guide/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ your patch gets accepted.

pytest pylint -k test_functional

* ``pylint`` uses black_ Python autoformatter for formatting its code.
* ``pylint`` uses black_ and isort_ Python autoformatter for formatting its code.
We have a pre-commit hook which should take care of the autoformatting for you
for when you are working on a patch. To enable it, do the following:

Expand Down Expand Up @@ -165,6 +165,7 @@ current environment in order to have faster feedback. Run with::
.. _tox: http://tox.readthedocs.io/en/latest/
.. _pytest: http://pytest.readthedocs.io/en/latest/
.. _black: https://github.com/ambv/black
.. _isort: https://github.com/timothycrosley/isort
.. _astroid: https://github.com/pycqa/astroid


Expand Down
Loading