bumpver/pylint-ignore.md

181 lines
4.9 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-02 20:52:54 +00:00
- [W0511: fixme (8x)](#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-09-18 17:50:13 +00:00
## File test/test_patterns.py - Line 14 - W0511 (fixme)
2020-09-06 21:15:27 +00:00
2020-09-18 17:50:13 +00:00
- `message: TODO (mb 2020-09-06): test for v2patterns`
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:01:05`
2020-07-19 19:07:30 +00:00
```
2020-09-19 22:35:48 +00:00
12: from pycalver import v2patterns
2020-09-18 17:50:13 +00:00
13:
> 14: # TODO (mb 2020-09-06): test for v2patterns
15:
16: V2_PART_PATTERN_CASES = [
2020-07-19 19:07:30 +00:00
```
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
```
## File test/test_version.py - Line 168 - W0511 (fixme)
2020-07-19 19:07:30 +00:00
2020-09-18 17:50:13 +00:00
- `message: TODO (mb 2020-09-06): add tests for new style patterns`
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:01:05`
2020-07-19 19:07:30 +00:00
```
2020-09-19 22:35:48 +00:00
163: def vnfo(**field_values):
2020-07-19 19:07:30 +00:00
...
2020-09-19 22:35:48 +00:00
166:
167: PARSE_VERSION_TEST_CASES = [
> 168: # TODO (mb 2020-09-06): add tests for new style patterns
169: # ["YYYY.MM.DD" , "2017.06.07", vnfo(year="2017", month="06", dom="07")],
170: ["{year}.{month}.{dom}" , "2017.06.07", vnfo(year="2017", month="06", dom="07")],
2020-07-19 19:07:30 +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):
171: # raw_patterns_by_file = _parse_raw_patterns_by_file(cfg)
172: # assert raw_patterns_by_file["setup.py" ] == ["vYYYY0M.BUILD[-RELEASE]", "YYYY0M.BLD[PYTAGNUM]"]
2020-07-19 19:07:30 +00:00
```
2020-10-02 20:52:54 +00:00
## File src/pycalver/__main__.py - Line 259 - W0511 (fixme)
2020-07-19 19:07:30 +00:00
2020-09-19 22:35:48 +00:00
- `message: TODO (mb 2020-09-18): Investigate error messages`
2020-07-19 19:07:30 +00:00
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
2020-09-19 22:35:48 +00:00
- `date : 2020-09-19T16:24:10`
2020-07-19 19:07:30 +00:00
```
2020-10-02 20:52:54 +00:00
231: def _bump(
2020-07-19 19:07:30 +00:00
...
2020-10-02 20:52:54 +00:00
257: sys.exit(1)
258: except Exception as ex:
> 259: # TODO (mb 2020-09-18): Investigate error messages
260: logger.error(str(ex))
261: sys.exit(1)
2020-07-19 19:07:30 +00:00
```
2020-09-24 19:21:57 +00:00
## File src/pycalver/config.py - Line 273 - W0511 (fixme)
2020-07-19 19:07:30 +00:00
2020-09-19 22:35:48 +00:00
- `message: TODO (mb 2020-09-18): Validate Pattern`
2020-07-19 19:07:30 +00:00
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
2020-09-19 22:35:48 +00:00
- `date : 2020-09-18T19:04:06`
2020-07-19 19:07:30 +00:00
```
2020-09-24 19:21:57 +00:00
251: def _parse_config(raw_cfg: RawConfig) -> Config:
2020-09-18 17:50:13 +00:00
...
2020-09-24 19:21:57 +00:00
271: )
272:
> 273: # TODO (mb 2020-09-18): Validate Pattern
274: # detect YY with WW or UU -> suggest GG with VV
275: # detect YYMM -> suggest YY0M
2020-09-19 22:35:48 +00:00
```
2020-10-02 20:52:54 +00:00
## File test/test_cli.py - Line 599 - W0511 (fixme)
2020-09-19 22:35:48 +00:00
- `message: # TODO (mb 2020-09-18):`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-18T19:35:32`
```
2020-10-02 20:52:54 +00:00
597:
598: # def test_custom_commit_message(runner):
> 599: # # TODO (mb 2020-09-18):
600: # assert False
2020-07-19 19:07:30 +00:00
```
2020-10-02 20:52:54 +00:00
## File src/pycalver/v2version.py - Line 616 - W0511 (fixme)
2020-09-24 19:21:57 +00:00
- `message: TODO (mb 2020-09-20): New Rollover Behaviour:`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-20T17:36:38`
```
2020-10-02 20:52:54 +00:00
578: def incr(
2020-09-24 19:21:57 +00:00
...
2020-10-02 20:52:54 +00:00
614: )
615:
> 616: # TODO (mb 2020-09-20): New Rollover Behaviour:
617: # Reset major, minor, patch to zero if any part to the left of it is incremented
618:
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-02 20:52:54 +00:00
## File src/pycalver/__main__.py - Line 258 - 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-02 20:52:54 +00:00
231: def _bump(
2020-09-06 21:15:27 +00:00
...
2020-10-02 20:52:54 +00:00
256: logger.error(str(ex))
257: sys.exit(1)
> 258: except Exception as ex:
259: # TODO (mb 2020-09-18): Investigate error messages
260: logger.error(str(ex))
2020-07-19 19:07:30 +00:00
```