bumpver/pylint-ignore.md
2020-09-06 21:36:34 +00:00

219 lines
5.7 KiB
Markdown

# Pylint-Ignore
**WARNING: This file is programatically generated.**
This file is parsed by [`pylint-ignore`](https://pypi.org/project/pylint-ignore/)
to determine which
[Pylint messages](https://pylint.pycqa.org/en/stable/technical_reference/features.html)
should be ignored.
- Do not edit this file manually.
- To update, use `pylint-ignore --update-ignorefile`
The recommended approach to using `pylint-ignore` is:
1. If a message refers to a valid issue, update your code rather than
ignoring the message.
2. If a message should *always* be ignored (globally), then to do so
via the usual `pylintrc` or `setup.cfg` files rather than this
`pylint-ignore.md` file.
3. If a message is a false positive, add a comment of this form to your code:
`# pylint:disable=<symbol> ; explain why this is a false positive`
# Overview
- [W0511: fixme (5x)](#w0511-fixme)
- [W0603: global-statement (1x)](#w0603-global-statement)
- [W0613: unused-argument (1x)](#w0613-unused-argument)
- [W0703: broad-except (2x)](#w0703-broad-except)
- [C0412: ungrouped-imports (2x)](#c0412-ungrouped-imports)
# W0511: fixme
## File src/pycalver/vcs.py - Line 78 - W0511 (fixme)
- `message: TODO (mb 2018-11-15): Detect encoding of output?`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-07-19T18:50:33`
```
68: def __call__(self, cmd_name: str, env: Env = None, **kwargs: str) -> str:
...
76: output_data: bytes = sp.check_output(cmd_str.split(), env=env, stderr=sp.STDOUT)
77:
> 78: # TODO (mb 2018-11-15): Detect encoding of output?
79: _encoding = "utf-8"
80: return output_data.decode(_encoding)
```
## File src/pycalver2/version.py - Line 184 - W0511 (fixme)
- `message: TODO (mb 2020-09-05): pytag`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-05T14:30:17`
```
176: def _parse_field_values(field_values: FieldValues) -> VersionInfo:
...
182: tag = TAG_ALIASES.get(tag, tag)
183: assert tag is not None
> 184: # TODO (mb 2020-09-05): pytag
185: pytag = ""
186:
```
## File src/pycalver/__main__.py - Line 220 - W0511 (fixme)
- `message: TODO (mb 2020-09-05): version switch`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-05T14:30:17`
```
200: def _bump(
...
218:
219: try:
> 220: # TODO (mb 2020-09-05): version switch
221: v1cli.rewrite(cfg, new_version)
222: v2cli.rewrite(cfg, new_version)
```
## File src/pycalver/__main__.py - Line 274 - W0511 (fixme)
- `message: TODO (mb 2020-09-05): version switch`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-05T14:30:17`
```
272:
273: def _update_cfg_from_vcs(cfg: config.Config, fetch: bool) -> config.Config:
> 274: # TODO (mb 2020-09-05): version switch
275: all_tags = vcs.get_tags(fetch=fetch)
276:
```
## File src/pycalver/__main__.py - Line 378 - W0511 (fixme)
- `message: # TODO (mb 2020-09-05): format from config`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-05T14:30:17`
```
324: def bump(
...
376: return
377:
> 378: # # TODO (mb 2020-09-05): format from config
379: # commit_message_kwargs = {
380: # new_version
```
# W0603: global-statement
## File src/pycalver/__main__.py - Line 75 - W0603 (global-statement)
- `message: Using the global statement`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-05T14:30:17`
```
73: def cli(verbose: int = 0) -> None:
74: """Automatically update PyCalVer version strings on python projects."""
> 75: global _VERBOSE
76: _VERBOSE = verbose
77:
```
# W0613: unused-argument
## File src/pycalver2/version.py - Line 431 - W0613 (unused-argument)
- `message: Unused argument 'kwargs'`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-05T14:30:17`
```
429:
430:
> 431: def _compile_format_template(pattern: str, kwargs: TemplateKwargs) -> str:
432: # NOTE (mb 2020-09-04): Some parts are optional, we need the kwargs to
433: # determine if part is set to its zero value
```
# W0703: broad-except
## File src/pycalver/vcs.py - Line 107 - W0703 (broad-except)
- `message: Catching too general exception Exception`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-07-19T18:50:33`
```
101: def has_remote(self) -> bool:
...
105: return False
106: return True
> 107: except Exception:
108: return False
109:
```
## File src/pycalver/__main__.py - Line 223 - W0703 (broad-except)
- `message: Catching too general exception Exception`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-05T14:30:17`
```
200: def _bump(
...
221: v1cli.rewrite(cfg, new_version)
222: v2cli.rewrite(cfg, new_version)
> 223: except Exception as ex:
224: logger.error(str(ex))
225: sys.exit(1)
```
# C0412: ungrouped-imports
## File src/pycalver/__main__.py - Line 21 - C0412 (ungrouped-imports)
- `message: Imports from package pycalver are not grouped`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-05T14:30:17`
```
19: import pycalver.cli as v1cli
20: import pycalver2.cli as v2cli
> 21: import pycalver.version as v1version
22: import pycalver2.version as v2version
23: from pycalver import vcs
```
## File src/pycalver/__main__.py - Line 22 - C0412 (ungrouped-imports)
- `message: Imports from package pycalver2 are not grouped`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-05T14:30:17`
```
20: import pycalver2.cli as v2cli
21: import pycalver.version as v1version
> 22: import pycalver2.version as v2version
23: from pycalver import vcs
24: from pycalver import config
```