Skip to content

Added reporting extras option to setup.py #11777

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Jan 2, 2022
Merged

Added reporting extras option to setup.py #11777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c7ca8e3
Added lxml and reporting extras option
jamesbraza Dec 17, 2021
ff005a9
Changed extras name from reporting to reports
jamesbraza Jan 1, 2022
00e991c
Testing what updated docs look like in browser
jamesbraza Jan 1, 2022
4f6f857
Made changes to rest of lxml mentions since change was a success
jamesbraza Jan 1, 2022
1f4d81d
Changed in config_file as well
jamesbraza Jan 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions docs/source/command_line.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -853,13 +853,17 @@ format into the specified directory.

Causes mypy to generate a Cobertura XML type checking coverage report.

You must install the `lxml`_ library to generate this report.
To generate this report, you must either manually install the `lxml`_
library or specify mypy installation with the setuptools extra
``mypy[reports]``.

.. option:: --html-report / --xslt-html-report DIR

Causes mypy to generate an HTML type checking coverage report.

You must install the `lxml`_ library to generate this report.
To generate this report, you must either manually install the `lxml`_
library or specify mypy installation with the setuptools extra
``mypy[reports]``.

.. option:: --linecount-report DIR

Expand All @@ -881,13 +885,17 @@ format into the specified directory.

Causes mypy to generate a text file type checking coverage report.

You must install the `lxml`_ library to generate this report.
To generate this report, you must either manually install the `lxml`_
library or specify mypy installation with the setuptools extra
``mypy[reports]``.

.. option:: --xml-report DIR

Causes mypy to generate an XML type checking coverage report.

You must install the `lxml`_ library to generate this report.
To generate this report, you must either manually install the `lxml`_
library or specify mypy installation with the setuptools extra
``mypy[reports]``.

Miscellaneous
*************
Expand Down
16 changes: 12 additions & 4 deletions docs/source/config_file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -820,15 +820,19 @@ format into the specified directory.

Causes mypy to generate a Cobertura XML type checking coverage report.

You must install the `lxml`_ library to generate this report.
To generate this report, you must either manually install the `lxml`_
library or specify mypy installation with the setuptools extra
``mypy[reports]``.

.. confval:: html_report / xslt_html_report

:type: string

Causes mypy to generate an HTML type checking coverage report.

You must install the `lxml`_ library to generate this report.
To generate this report, you must either manually install the `lxml`_
library or specify mypy installation with the setuptools extra
``mypy[reports]``.

.. confval:: linecount_report

Expand Down Expand Up @@ -858,15 +862,19 @@ format into the specified directory.

Causes mypy to generate a text file type checking coverage report.

You must install the `lxml`_ library to generate this report.
To generate this report, you must either manually install the `lxml`_
library or specify mypy installation with the setuptools extra
``mypy[reports]``.

.. confval:: xml_report

:type: string

Causes mypy to generate an XML type checking coverage report.

You must install the `lxml`_ library to generate this report.
To generate this report, you must either manually install the `lxml`_
library or specify mypy installation with the setuptools extra
``mypy[reports]``.


Miscellaneous
Expand Down
6 changes: 5 additions & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,11 @@ def run(self):
'tomli>=1.1.0',
],
# Same here.
extras_require={'dmypy': 'psutil >= 4.0', 'python2': 'typed_ast >= 1.4.0, < 2'},
extras_require={
'dmypy': 'psutil >= 4.0',
'python2': 'typed_ast >= 1.4.0, < 2',
'reports': 'lxml'
},
python_requires=">=3.6",
include_package_data=True,
project_urls={
Expand Down