bumpver/pylint-ignore.md

119 lines
3.4 KiB
Markdown
Raw Normal View History

2020-09-06 21:15:27 +00:00
# Pylint-Ignore
2020-07-19 19:07:30 +00:00
**WARNING: This file is programatically generated.**
2020-09-06 21:15:27 +00:00
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.
2020-07-19 19:07:30 +00:00
- Do not edit this file manually.
- To update, use `pylint-ignore --update-ignorefile`
The recommended approach to using `pylint-ignore` is:
2020-09-06 21:15:27 +00:00
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`
2020-07-19 19:07:30 +00:00
2020-09-06 21:15:27 +00:00
# Overview
2020-07-19 19:07:30 +00:00
2020-10-03 23:44:38 +00:00
- [W0511: fixme (4x)](#w0511-fixme)
2020-09-18 17:50:13 +00:00
- [W0703: broad-except (1x)](#w0703-broad-except)
2020-09-06 21:15:27 +00:00
# W0511: fixme
2020-10-03 23:44:38 +00:00
## File src/pycalver/v1cli.py - Line 29 - W0511 (fixme)
- `message: TODO (mb 2020-10-03): This codepath is not tested since switch to`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-10-03T23:40:01`
```
23: def update_cfg_from_vcs(cfg: config.Config, all_tags: typ.List[str]) -> config.Config:
...
27: return cfg
28:
> 29: # TODO (mb 2020-10-03): This codepath is not tested since switch to
30: # v2 as default version_pattern.
31: version_tags.sort(reverse=True)
```
2020-10-02 20:52:54 +00:00
## File src/pycalver/vcs.py - Line 80 - W0511 (fixme)
2020-07-19 19:07:30 +00:00
2020-09-18 17:50:13 +00:00
- `message: TODO (mb 2018-11-15): Detect encoding of output? Use chardet?`
2020-07-19 19:07:30 +00:00
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
2020-09-18 17:50:13 +00:00
- `date : 2020-09-18T17:24:49`
2020-07-19 19:07:30 +00:00
```
2020-10-02 20:52:54 +00:00
69: def __call__(self, cmd_name: str, env: Env = None, **kwargs: str) -> str:
2020-07-19 19:07:30 +00:00
...
2020-10-02 20:52:54 +00:00
78: output_data: bytes = sp.check_output(cmd_parts, env=env, stderr=sp.STDOUT)
79:
> 80: # TODO (mb 2018-11-15): Detect encoding of output? Use chardet?
81: _encoding = "utf-8"
82: return output_data.decode(_encoding)
2020-09-19 22:35:48 +00:00
```
2020-10-02 20:52:54 +00:00
## File test/test_config.py - Line 170 - W0511 (fixme)
2020-07-19 19:07:30 +00:00
2020-10-02 20:52:54 +00:00
- `message: TODO (mb 2020-09-18):`
2020-07-19 19:07:30 +00:00
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
2020-10-02 20:52:54 +00:00
- `date : 2020-09-18T19:04:06`
2020-07-19 19:07:30 +00:00
```
2020-10-02 20:52:54 +00:00
156: def test_parse_v2_cfg():
2020-09-18 17:50:13 +00:00
...
2020-10-02 20:52:54 +00:00
168: assert "setup.cfg" in cfg.file_patterns
169:
> 170: # TODO (mb 2020-09-18):
2020-10-02 22:44:13 +00:00
171: # raw_patterns_by_filepath = _parse_raw_patterns_by_filepath(cfg)
172: # assert raw_patterns_by_filepath["setup.py" ] == ["vYYYY0M.BUILD[-RELEASE]", "YYYY0M.BLD[PYTAGNUM]"]
2020-07-19 19:07:30 +00:00
```
2020-10-03 23:42:52 +00:00
## File src/pycalver/__main__.py - Line 421 - W0511 (fixme)
2020-10-02 22:44:13 +00:00
- `message: TODO (mb 2020-09-18): Investigate error messages`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-19T16:24:10`
```
2020-10-03 23:42:52 +00:00
391: def _bump(
2020-10-02 22:44:13 +00:00
...
2020-10-03 23:42:52 +00:00
419: sys.exit(1)
420: except Exception as ex:
> 421: # TODO (mb 2020-09-18): Investigate error messages
422: logger.error(str(ex))
423: sys.exit(1)
2020-09-24 19:21:57 +00:00
```
2020-09-06 21:15:27 +00:00
# W0703: broad-except
2020-07-19 19:07:30 +00:00
2020-10-03 23:42:52 +00:00
## File src/pycalver/__main__.py - Line 420 - W0703 (broad-except)
2020-07-19 19:07:30 +00:00
2020-09-06 21:15:27 +00:00
- `message: Catching too general exception Exception`
2020-07-19 19:07:30 +00:00
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
2020-09-06 21:15:27 +00:00
- `date : 2020-09-05T14:30:17`
2020-07-19 19:07:30 +00:00
```
2020-10-03 23:42:52 +00:00
391: def _bump(
2020-09-06 21:15:27 +00:00
...
2020-10-03 23:42:52 +00:00
418: logger.error(str(ex))
419: sys.exit(1)
> 420: except Exception as ex:
421: # TODO (mb 2020-09-18): Investigate error messages
422: logger.error(str(ex))
2020-07-19 19:07:30 +00:00
```
2020-10-02 22:44:13 +00:00