diff options
Diffstat (limited to 'python-pysen.spec')
| -rw-r--r-- | python-pysen.spec | 959 |
1 files changed, 959 insertions, 0 deletions
diff --git a/python-pysen.spec b/python-pysen.spec new file mode 100644 index 0000000..1b03654 --- /dev/null +++ b/python-pysen.spec @@ -0,0 +1,959 @@ +%global _empty_manifest_terminate_build 0 +Name: python-pysen +Version: 0.10.4 +Release: 1 +Summary: Python linting made easy. Also a casual yet honorific way to address individuals who have entered an organization prior to you. +License: MIT License +URL: https://github.com/pfnet/pysen +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/e5/0a/c0666c0c364e29437a60c5e783bb9eb48095f644f7c816cf068876375b46/pysen-0.10.4.tar.gz +BuildArch: noarch + +Requires: python3-GitPython +Requires: python3-colorlog +Requires: python3-dacite +Requires: python3-tomlkit +Requires: python3-unidiff +Requires: python3-dataclasses +Requires: python3-black +Requires: python3-flake8-bugbear +Requires: python3-flake8 +Requires: python3-isort +Requires: python3-mypy + +%description +# pysen + + + +## Install + +### PyPI + +#### If you have no preference of linter versions (recommended for newbies) + +```sh +pip install "pysen[lint]" +``` + +#### Install pysen with your choice of linter versions + +```sh +pip install pysen +pip install black==21.10b0 flake8==4.0.1 isort==5.10.1 mypy==0.910 +``` + +### Other installation examples + +```sh +# pipenv +pipenv install --dev "pysen[lint]==0.10.4" +# poetry +poetry add -D pysen==0.10.4 -E lint +``` + +## Quickstart: Set up linters using pysen + +Put the following pysen configuration to either `pysen.toml` or `pyproject.toml` of your python package: +```toml +[tool.pysen] +version = "0.10" + +[tool.pysen.lint] +enable_black = true +enable_flake8 = true +enable_isort = true +enable_mypy = true +mypy_preset = "strict" +line_length = 88 +py_version = "py37" +[[tool.pysen.lint.mypy_targets]] + paths = ["."] +``` + +then, execute the following command: +```sh +$ pysen run lint +$ pysen run format # corrects errors with compatible commands (black, isort) +``` + +That's it! +pysen, or more accurately pysen tasks that support the specified linters, generate setting files for black, isort, mypy, and flake8 +and run them with the appropriate configuration. +For more details about the configuration items that you can write in a config file, please refer to `pysen/pyproject_model.py`. + +You can also add custom setup commands to your Python package by adding the following lines to its `setup.py`: +```py +import pysen +setup = pysen.setup_from_pyproject(__file__) +``` + +```sh +$ python setup.py lint +``` + +We also provide a Python interface for customizing our configuration and extending pysen. +For more details, please refer to the following two examples: +- Example configuration from Python: `examples/advanced_example/config.py` +- Example plugin for pysen: `examples/plugin_example/plugin.py` + +## Frequently Asked Questions + +Q. How do I use `mypy >= 0.800`? +A. See [Install pysen with your choice of linter versions](#install-pysen-with-your-choice-of-linter-versions) + +Q. mypy reports the error `Source file found twice under different module names`. +A. Add `tool.pysen.lint.mypy_targets` section(s) so file names are unique in each section. + +Q. How do I change specific settings for linter X? +A. We prioritize convention over configuration. However you can always create your own plugin. See: [Create a plugin to customize pysen](#create-a-plugin-to-customize-pysen) + +Q. pysen seems to ignore some files. +A. pysen only checks files that are tracked in git. Try `git add`ing the file under question. +You can also disable this behavior by setting the environment variable `PYSEN_IGNORE_GIT=1`. + +Q. How do I run only [flake8|black|isort|mypy]? +A. Try the `--enable` and `--disable` options, for example, `pysen --enable flake --enable black run lint`. + +Q. Files without filename extensions are not checked. +A. Explicitly add those files under the include section in `tool.pysen.lint.source`. + +Q. How do I add additional settings to my `pyproject.toml`, e.g., [pydantic-mypy](https://pydantic-docs.helpmanual.io/mypy_plugin/#configuring-the-plugin)? +A. Add `settings_dir="."` under the `[tool.pysen-cli]` section. + +## What is pysen? + +pysen aims to provide a unified platform to configure and run day-to-day development tools. +We envision the following scenarios in the future: + +- You open any project and `pysen run lint`, `pysen run format` will check and format the entire codebase +- Standardized coding styles are setup with a few lines in a single config file + +pysen centralizes the code and knowledge related to development tools that teams have accumulated, most notably for python linters. +You can make tasks that can be executed from both `setup.py` and our command-line tool. +We currently provide tasks that manage setting files for the following tools: + +- linters + - flake8 + - isort + - mypy + - black +- utilities + - (planned) protoc + +## What isn't pysen? + +* pysen is not a linting tool per se. Rather, `pysen run lint` orchestrates multiple python linting tools by automatically setting up their configurations from a more abstract setting for pysen. +* pysen does not manage your dependencies and packages. We recommend using package managers such as [pipenv](https://github.com/pypa/pipenv) or [poetry](https://python-poetry.org/) to lock your dependency versions, **including the versions for the linting tools that pysen coordinates** (i.e., isort, mypy, flake8, black). The _confirmed_ versions for these tools can be found in the `extra_requires/lint` section in pysen's [setup.py](https://github.com/pfnet/pysen/blob/main/setup.py), although higher versions may work. You should **not** rely on `pip install pysen[lint]` to control the versions of your linting tools. +* pysen is not limited to linting purposes or python. See the [plugin section](README.md#create-a-plugin-to-customize-pysen) for details. + +## How it works: Settings file directory + +Under the hood, whenever you run pysen, it generates the setting files as ephemeral temporary files to be used by linters. +You may want to keep those setting files on your disk, e.g. when you want to use them for your editor. +If that is the case, run the following command to generate the setting files to your directory of choice: + +```sh +$ pysen generate [out_dir] +``` + +You can specify the settings directory that pysen uses when you `pysen run`. +To do so add the following section to your config: + +```toml +[tool.pysen-cli] +settings_dir = "path/to/generate/settings" +``` + +When you specify a directory that already contains some configurations, pysen merges the contents. The resulting behavior may differ from when you don't specify `settings_dir`. + +Also keep in mind that this option is honored only when you use pysen through its CLI. When using pre-commit or setuptools you need to specify `settings_dir` as arguments. + +## Tips: IDE / Text editor integration + +### vim + +You can add errors that pysen reports to your quickfix window by: + +``` +:cex system("pysen run_files lint --error-format gnu ".expand('%:p')) +``` + +Another way is to set pysen to `makeprg`: + +``` +set makeprg=pysen\ run_files\ --error-format\ gnu\ lint\ % +``` + +Then running `:make` will populate your quickfix window with errors. +This also works with [`vim-dispatch`](https://github.com/tpope/vim-dispatch) as long as you invoke `:Make` instead of `:Dispatch` (for [this reason](https://github.com/tpope/vim-dispatch/issues/41#issuecomment-20555488)) + +The result will look like the following: + + + +A third party plugin is also available. +- [pysen.vim](https://github.com/bonprosoft/pysen.vim) + +### Emacs + +Refer to the [Compilation mode](https://www.gnu.org/software/emacs/manual/html_node/emacs/Compilation-Mode.html). +The following is an example hook for python. +```el +(add-hook 'python-mode-hook + (lambda () + (set (make-local-variable 'compile-command) + (concat "pysen run_files lint --error-format gnu " buffer-file-name)))) +``` + +### VSCode + +A [third party plugin](https://marketplace.visualstudio.com/items?itemName=bonprosoft.pysen-vscode) is available. + +Note that this may report duplicate errors if you have configured linters like `flake8` directly through your VSCode python extension. + +## Configure pysen + +We provide two methods to write configuration for pysen. + +One is the `[tool.pysen.lint]` section in the config. +It is the most simple way to configure pysen, but the settings we provide are limited. + +The other method is to write a python script that configures pysen directly. +If you want to customize configuration files that pysen generates, command-line arguments that pysen takes, or whatever actions pysen performs, we recommend you use this method. +For more examples, please refer to `pysen/examples`. + +### Configuration model + +Please refer to `pysen/pyproject_model.py` for the latest model. + +Here is an example of a basic configuration: +```toml +[tool.pysen] +version = "0.10" + +[tool.pysen.lint] +enable_black = true +enable_flake8 = true +enable_isort = true +enable_mypy = true +mypy_preset = "strict" +line_length = 88 +py_version = "py37" +isort_known_third_party = ["numpy"] +isort_known_first_party = ["pysen"] +mypy_ignore_packages = ["pysen.generated.*"] +mypy_path = ["stubs"] +[[tool.pysen.lint.mypy_targets]] + paths = [".", "tests/"] + +[tool.pysen.lint.source] + includes = ["."] + include_globs = ["**/*.template"] + excludes = ["third_party/"] + exclude_globs = ["**/*_grpc.py"] + +[tool.pysen.lint.mypy_modules."pysen.scripts"] + preset = "entry" + +[tool.pysen.lint.mypy_modules."numpy"] + ignore_errors = true +``` + +pysen looks for a configuration file in the following order: +1. `pysen.toml` with a `tool.pysen` section +2. `pyproject.toml` with a `tool.pysen` section + +### Create a plugin to customize pysen + +We provide a plugin interface for customizing our tool support, setting files management, setup commands and so on. +For more details, please refer to `pysen/examples/plugin_example`. + +## Development + +`pipenv` is required for managing our development environment. +```sh +# setup your environment +$ pipenv sync +# activate the environment +$ pipenv shell +``` + +- Update dependencies in `Pipfile.lock` +```sh +$ pipenv lock --pre +``` +- Run all tests +```sh +$ pipenv run tox +``` + +## mypy presets + +The mypy preset `strict` aims to make life easier for developers using the following packages: + +* OpenCV +* PyTorch +* scikit-learn + +We recommend developers mitigate some rules from the `very strict` preset to avoid some hassles. +If you use these packages with the `strict` preset and still have inconveniences, please let us know. + +## Contributing + +Our main priority is to fulfil the demands from projects within Preferred Networks. +Therefore, we must assess whether each feature/pull request is in the best interest of our projects. +In principle, we are open to minor things like the following: + +* Issues that report bugs +* Small PRs that fix typos or minor glitches + +As for new features or major feature enhancements, +the core developers will determine whether the proposed idea is in line with the +goals and concepts of `pysen` for each case. +When in doubt, don't hesitate to open an Issue first. + + + + +%package -n python3-pysen +Summary: Python linting made easy. Also a casual yet honorific way to address individuals who have entered an organization prior to you. +Provides: python-pysen +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-pysen +# pysen + + + +## Install + +### PyPI + +#### If you have no preference of linter versions (recommended for newbies) + +```sh +pip install "pysen[lint]" +``` + +#### Install pysen with your choice of linter versions + +```sh +pip install pysen +pip install black==21.10b0 flake8==4.0.1 isort==5.10.1 mypy==0.910 +``` + +### Other installation examples + +```sh +# pipenv +pipenv install --dev "pysen[lint]==0.10.4" +# poetry +poetry add -D pysen==0.10.4 -E lint +``` + +## Quickstart: Set up linters using pysen + +Put the following pysen configuration to either `pysen.toml` or `pyproject.toml` of your python package: +```toml +[tool.pysen] +version = "0.10" + +[tool.pysen.lint] +enable_black = true +enable_flake8 = true +enable_isort = true +enable_mypy = true +mypy_preset = "strict" +line_length = 88 +py_version = "py37" +[[tool.pysen.lint.mypy_targets]] + paths = ["."] +``` + +then, execute the following command: +```sh +$ pysen run lint +$ pysen run format # corrects errors with compatible commands (black, isort) +``` + +That's it! +pysen, or more accurately pysen tasks that support the specified linters, generate setting files for black, isort, mypy, and flake8 +and run them with the appropriate configuration. +For more details about the configuration items that you can write in a config file, please refer to `pysen/pyproject_model.py`. + +You can also add custom setup commands to your Python package by adding the following lines to its `setup.py`: +```py +import pysen +setup = pysen.setup_from_pyproject(__file__) +``` + +```sh +$ python setup.py lint +``` + +We also provide a Python interface for customizing our configuration and extending pysen. +For more details, please refer to the following two examples: +- Example configuration from Python: `examples/advanced_example/config.py` +- Example plugin for pysen: `examples/plugin_example/plugin.py` + +## Frequently Asked Questions + +Q. How do I use `mypy >= 0.800`? +A. See [Install pysen with your choice of linter versions](#install-pysen-with-your-choice-of-linter-versions) + +Q. mypy reports the error `Source file found twice under different module names`. +A. Add `tool.pysen.lint.mypy_targets` section(s) so file names are unique in each section. + +Q. How do I change specific settings for linter X? +A. We prioritize convention over configuration. However you can always create your own plugin. See: [Create a plugin to customize pysen](#create-a-plugin-to-customize-pysen) + +Q. pysen seems to ignore some files. +A. pysen only checks files that are tracked in git. Try `git add`ing the file under question. +You can also disable this behavior by setting the environment variable `PYSEN_IGNORE_GIT=1`. + +Q. How do I run only [flake8|black|isort|mypy]? +A. Try the `--enable` and `--disable` options, for example, `pysen --enable flake --enable black run lint`. + +Q. Files without filename extensions are not checked. +A. Explicitly add those files under the include section in `tool.pysen.lint.source`. + +Q. How do I add additional settings to my `pyproject.toml`, e.g., [pydantic-mypy](https://pydantic-docs.helpmanual.io/mypy_plugin/#configuring-the-plugin)? +A. Add `settings_dir="."` under the `[tool.pysen-cli]` section. + +## What is pysen? + +pysen aims to provide a unified platform to configure and run day-to-day development tools. +We envision the following scenarios in the future: + +- You open any project and `pysen run lint`, `pysen run format` will check and format the entire codebase +- Standardized coding styles are setup with a few lines in a single config file + +pysen centralizes the code and knowledge related to development tools that teams have accumulated, most notably for python linters. +You can make tasks that can be executed from both `setup.py` and our command-line tool. +We currently provide tasks that manage setting files for the following tools: + +- linters + - flake8 + - isort + - mypy + - black +- utilities + - (planned) protoc + +## What isn't pysen? + +* pysen is not a linting tool per se. Rather, `pysen run lint` orchestrates multiple python linting tools by automatically setting up their configurations from a more abstract setting for pysen. +* pysen does not manage your dependencies and packages. We recommend using package managers such as [pipenv](https://github.com/pypa/pipenv) or [poetry](https://python-poetry.org/) to lock your dependency versions, **including the versions for the linting tools that pysen coordinates** (i.e., isort, mypy, flake8, black). The _confirmed_ versions for these tools can be found in the `extra_requires/lint` section in pysen's [setup.py](https://github.com/pfnet/pysen/blob/main/setup.py), although higher versions may work. You should **not** rely on `pip install pysen[lint]` to control the versions of your linting tools. +* pysen is not limited to linting purposes or python. See the [plugin section](README.md#create-a-plugin-to-customize-pysen) for details. + +## How it works: Settings file directory + +Under the hood, whenever you run pysen, it generates the setting files as ephemeral temporary files to be used by linters. +You may want to keep those setting files on your disk, e.g. when you want to use them for your editor. +If that is the case, run the following command to generate the setting files to your directory of choice: + +```sh +$ pysen generate [out_dir] +``` + +You can specify the settings directory that pysen uses when you `pysen run`. +To do so add the following section to your config: + +```toml +[tool.pysen-cli] +settings_dir = "path/to/generate/settings" +``` + +When you specify a directory that already contains some configurations, pysen merges the contents. The resulting behavior may differ from when you don't specify `settings_dir`. + +Also keep in mind that this option is honored only when you use pysen through its CLI. When using pre-commit or setuptools you need to specify `settings_dir` as arguments. + +## Tips: IDE / Text editor integration + +### vim + +You can add errors that pysen reports to your quickfix window by: + +``` +:cex system("pysen run_files lint --error-format gnu ".expand('%:p')) +``` + +Another way is to set pysen to `makeprg`: + +``` +set makeprg=pysen\ run_files\ --error-format\ gnu\ lint\ % +``` + +Then running `:make` will populate your quickfix window with errors. +This also works with [`vim-dispatch`](https://github.com/tpope/vim-dispatch) as long as you invoke `:Make` instead of `:Dispatch` (for [this reason](https://github.com/tpope/vim-dispatch/issues/41#issuecomment-20555488)) + +The result will look like the following: + + + +A third party plugin is also available. +- [pysen.vim](https://github.com/bonprosoft/pysen.vim) + +### Emacs + +Refer to the [Compilation mode](https://www.gnu.org/software/emacs/manual/html_node/emacs/Compilation-Mode.html). +The following is an example hook for python. +```el +(add-hook 'python-mode-hook + (lambda () + (set (make-local-variable 'compile-command) + (concat "pysen run_files lint --error-format gnu " buffer-file-name)))) +``` + +### VSCode + +A [third party plugin](https://marketplace.visualstudio.com/items?itemName=bonprosoft.pysen-vscode) is available. + +Note that this may report duplicate errors if you have configured linters like `flake8` directly through your VSCode python extension. + +## Configure pysen + +We provide two methods to write configuration for pysen. + +One is the `[tool.pysen.lint]` section in the config. +It is the most simple way to configure pysen, but the settings we provide are limited. + +The other method is to write a python script that configures pysen directly. +If you want to customize configuration files that pysen generates, command-line arguments that pysen takes, or whatever actions pysen performs, we recommend you use this method. +For more examples, please refer to `pysen/examples`. + +### Configuration model + +Please refer to `pysen/pyproject_model.py` for the latest model. + +Here is an example of a basic configuration: +```toml +[tool.pysen] +version = "0.10" + +[tool.pysen.lint] +enable_black = true +enable_flake8 = true +enable_isort = true +enable_mypy = true +mypy_preset = "strict" +line_length = 88 +py_version = "py37" +isort_known_third_party = ["numpy"] +isort_known_first_party = ["pysen"] +mypy_ignore_packages = ["pysen.generated.*"] +mypy_path = ["stubs"] +[[tool.pysen.lint.mypy_targets]] + paths = [".", "tests/"] + +[tool.pysen.lint.source] + includes = ["."] + include_globs = ["**/*.template"] + excludes = ["third_party/"] + exclude_globs = ["**/*_grpc.py"] + +[tool.pysen.lint.mypy_modules."pysen.scripts"] + preset = "entry" + +[tool.pysen.lint.mypy_modules."numpy"] + ignore_errors = true +``` + +pysen looks for a configuration file in the following order: +1. `pysen.toml` with a `tool.pysen` section +2. `pyproject.toml` with a `tool.pysen` section + +### Create a plugin to customize pysen + +We provide a plugin interface for customizing our tool support, setting files management, setup commands and so on. +For more details, please refer to `pysen/examples/plugin_example`. + +## Development + +`pipenv` is required for managing our development environment. +```sh +# setup your environment +$ pipenv sync +# activate the environment +$ pipenv shell +``` + +- Update dependencies in `Pipfile.lock` +```sh +$ pipenv lock --pre +``` +- Run all tests +```sh +$ pipenv run tox +``` + +## mypy presets + +The mypy preset `strict` aims to make life easier for developers using the following packages: + +* OpenCV +* PyTorch +* scikit-learn + +We recommend developers mitigate some rules from the `very strict` preset to avoid some hassles. +If you use these packages with the `strict` preset and still have inconveniences, please let us know. + +## Contributing + +Our main priority is to fulfil the demands from projects within Preferred Networks. +Therefore, we must assess whether each feature/pull request is in the best interest of our projects. +In principle, we are open to minor things like the following: + +* Issues that report bugs +* Small PRs that fix typos or minor glitches + +As for new features or major feature enhancements, +the core developers will determine whether the proposed idea is in line with the +goals and concepts of `pysen` for each case. +When in doubt, don't hesitate to open an Issue first. + + + + +%package help +Summary: Development documents and examples for pysen +Provides: python3-pysen-doc +%description help +# pysen + + + +## Install + +### PyPI + +#### If you have no preference of linter versions (recommended for newbies) + +```sh +pip install "pysen[lint]" +``` + +#### Install pysen with your choice of linter versions + +```sh +pip install pysen +pip install black==21.10b0 flake8==4.0.1 isort==5.10.1 mypy==0.910 +``` + +### Other installation examples + +```sh +# pipenv +pipenv install --dev "pysen[lint]==0.10.4" +# poetry +poetry add -D pysen==0.10.4 -E lint +``` + +## Quickstart: Set up linters using pysen + +Put the following pysen configuration to either `pysen.toml` or `pyproject.toml` of your python package: +```toml +[tool.pysen] +version = "0.10" + +[tool.pysen.lint] +enable_black = true +enable_flake8 = true +enable_isort = true +enable_mypy = true +mypy_preset = "strict" +line_length = 88 +py_version = "py37" +[[tool.pysen.lint.mypy_targets]] + paths = ["."] +``` + +then, execute the following command: +```sh +$ pysen run lint +$ pysen run format # corrects errors with compatible commands (black, isort) +``` + +That's it! +pysen, or more accurately pysen tasks that support the specified linters, generate setting files for black, isort, mypy, and flake8 +and run them with the appropriate configuration. +For more details about the configuration items that you can write in a config file, please refer to `pysen/pyproject_model.py`. + +You can also add custom setup commands to your Python package by adding the following lines to its `setup.py`: +```py +import pysen +setup = pysen.setup_from_pyproject(__file__) +``` + +```sh +$ python setup.py lint +``` + +We also provide a Python interface for customizing our configuration and extending pysen. +For more details, please refer to the following two examples: +- Example configuration from Python: `examples/advanced_example/config.py` +- Example plugin for pysen: `examples/plugin_example/plugin.py` + +## Frequently Asked Questions + +Q. How do I use `mypy >= 0.800`? +A. See [Install pysen with your choice of linter versions](#install-pysen-with-your-choice-of-linter-versions) + +Q. mypy reports the error `Source file found twice under different module names`. +A. Add `tool.pysen.lint.mypy_targets` section(s) so file names are unique in each section. + +Q. How do I change specific settings for linter X? +A. We prioritize convention over configuration. However you can always create your own plugin. See: [Create a plugin to customize pysen](#create-a-plugin-to-customize-pysen) + +Q. pysen seems to ignore some files. +A. pysen only checks files that are tracked in git. Try `git add`ing the file under question. +You can also disable this behavior by setting the environment variable `PYSEN_IGNORE_GIT=1`. + +Q. How do I run only [flake8|black|isort|mypy]? +A. Try the `--enable` and `--disable` options, for example, `pysen --enable flake --enable black run lint`. + +Q. Files without filename extensions are not checked. +A. Explicitly add those files under the include section in `tool.pysen.lint.source`. + +Q. How do I add additional settings to my `pyproject.toml`, e.g., [pydantic-mypy](https://pydantic-docs.helpmanual.io/mypy_plugin/#configuring-the-plugin)? +A. Add `settings_dir="."` under the `[tool.pysen-cli]` section. + +## What is pysen? + +pysen aims to provide a unified platform to configure and run day-to-day development tools. +We envision the following scenarios in the future: + +- You open any project and `pysen run lint`, `pysen run format` will check and format the entire codebase +- Standardized coding styles are setup with a few lines in a single config file + +pysen centralizes the code and knowledge related to development tools that teams have accumulated, most notably for python linters. +You can make tasks that can be executed from both `setup.py` and our command-line tool. +We currently provide tasks that manage setting files for the following tools: + +- linters + - flake8 + - isort + - mypy + - black +- utilities + - (planned) protoc + +## What isn't pysen? + +* pysen is not a linting tool per se. Rather, `pysen run lint` orchestrates multiple python linting tools by automatically setting up their configurations from a more abstract setting for pysen. +* pysen does not manage your dependencies and packages. We recommend using package managers such as [pipenv](https://github.com/pypa/pipenv) or [poetry](https://python-poetry.org/) to lock your dependency versions, **including the versions for the linting tools that pysen coordinates** (i.e., isort, mypy, flake8, black). The _confirmed_ versions for these tools can be found in the `extra_requires/lint` section in pysen's [setup.py](https://github.com/pfnet/pysen/blob/main/setup.py), although higher versions may work. You should **not** rely on `pip install pysen[lint]` to control the versions of your linting tools. +* pysen is not limited to linting purposes or python. See the [plugin section](README.md#create-a-plugin-to-customize-pysen) for details. + +## How it works: Settings file directory + +Under the hood, whenever you run pysen, it generates the setting files as ephemeral temporary files to be used by linters. +You may want to keep those setting files on your disk, e.g. when you want to use them for your editor. +If that is the case, run the following command to generate the setting files to your directory of choice: + +```sh +$ pysen generate [out_dir] +``` + +You can specify the settings directory that pysen uses when you `pysen run`. +To do so add the following section to your config: + +```toml +[tool.pysen-cli] +settings_dir = "path/to/generate/settings" +``` + +When you specify a directory that already contains some configurations, pysen merges the contents. The resulting behavior may differ from when you don't specify `settings_dir`. + +Also keep in mind that this option is honored only when you use pysen through its CLI. When using pre-commit or setuptools you need to specify `settings_dir` as arguments. + +## Tips: IDE / Text editor integration + +### vim + +You can add errors that pysen reports to your quickfix window by: + +``` +:cex system("pysen run_files lint --error-format gnu ".expand('%:p')) +``` + +Another way is to set pysen to `makeprg`: + +``` +set makeprg=pysen\ run_files\ --error-format\ gnu\ lint\ % +``` + +Then running `:make` will populate your quickfix window with errors. +This also works with [`vim-dispatch`](https://github.com/tpope/vim-dispatch) as long as you invoke `:Make` instead of `:Dispatch` (for [this reason](https://github.com/tpope/vim-dispatch/issues/41#issuecomment-20555488)) + +The result will look like the following: + + + +A third party plugin is also available. +- [pysen.vim](https://github.com/bonprosoft/pysen.vim) + +### Emacs + +Refer to the [Compilation mode](https://www.gnu.org/software/emacs/manual/html_node/emacs/Compilation-Mode.html). +The following is an example hook for python. +```el +(add-hook 'python-mode-hook + (lambda () + (set (make-local-variable 'compile-command) + (concat "pysen run_files lint --error-format gnu " buffer-file-name)))) +``` + +### VSCode + +A [third party plugin](https://marketplace.visualstudio.com/items?itemName=bonprosoft.pysen-vscode) is available. + +Note that this may report duplicate errors if you have configured linters like `flake8` directly through your VSCode python extension. + +## Configure pysen + +We provide two methods to write configuration for pysen. + +One is the `[tool.pysen.lint]` section in the config. +It is the most simple way to configure pysen, but the settings we provide are limited. + +The other method is to write a python script that configures pysen directly. +If you want to customize configuration files that pysen generates, command-line arguments that pysen takes, or whatever actions pysen performs, we recommend you use this method. +For more examples, please refer to `pysen/examples`. + +### Configuration model + +Please refer to `pysen/pyproject_model.py` for the latest model. + +Here is an example of a basic configuration: +```toml +[tool.pysen] +version = "0.10" + +[tool.pysen.lint] +enable_black = true +enable_flake8 = true +enable_isort = true +enable_mypy = true +mypy_preset = "strict" +line_length = 88 +py_version = "py37" +isort_known_third_party = ["numpy"] +isort_known_first_party = ["pysen"] +mypy_ignore_packages = ["pysen.generated.*"] +mypy_path = ["stubs"] +[[tool.pysen.lint.mypy_targets]] + paths = [".", "tests/"] + +[tool.pysen.lint.source] + includes = ["."] + include_globs = ["**/*.template"] + excludes = ["third_party/"] + exclude_globs = ["**/*_grpc.py"] + +[tool.pysen.lint.mypy_modules."pysen.scripts"] + preset = "entry" + +[tool.pysen.lint.mypy_modules."numpy"] + ignore_errors = true +``` + +pysen looks for a configuration file in the following order: +1. `pysen.toml` with a `tool.pysen` section +2. `pyproject.toml` with a `tool.pysen` section + +### Create a plugin to customize pysen + +We provide a plugin interface for customizing our tool support, setting files management, setup commands and so on. +For more details, please refer to `pysen/examples/plugin_example`. + +## Development + +`pipenv` is required for managing our development environment. +```sh +# setup your environment +$ pipenv sync +# activate the environment +$ pipenv shell +``` + +- Update dependencies in `Pipfile.lock` +```sh +$ pipenv lock --pre +``` +- Run all tests +```sh +$ pipenv run tox +``` + +## mypy presets + +The mypy preset `strict` aims to make life easier for developers using the following packages: + +* OpenCV +* PyTorch +* scikit-learn + +We recommend developers mitigate some rules from the `very strict` preset to avoid some hassles. +If you use these packages with the `strict` preset and still have inconveniences, please let us know. + +## Contributing + +Our main priority is to fulfil the demands from projects within Preferred Networks. +Therefore, we must assess whether each feature/pull request is in the best interest of our projects. +In principle, we are open to minor things like the following: + +* Issues that report bugs +* Small PRs that fix typos or minor glitches + +As for new features or major feature enhancements, +the core developers will determine whether the proposed idea is in line with the +goals and concepts of `pysen` for each case. +When in doubt, don't hesitate to open an Issue first. + + + + +%prep +%autosetup -n pysen-0.10.4 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-pysen -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 0.10.4-1 +- Package Spec generated |