bumpver/pylint-ignore.md

200 lines
5.8 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-09-19 22:35:48 +00:00
- [E1123: unexpected-keyword-arg (1x)](#e1123-unexpected-keyword-arg)
- [W0511: fixme (9x)](#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-09-18 17:50:13 +00:00
## File src/pycalver/vcs.py - Line 78 - 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-09-18 17:50:13 +00:00
68: def __call__(self, cmd_name: str, env: Env = None, **kwargs: str) -> str:
2020-07-19 19:07:30 +00:00
...
2020-09-18 17:50:13 +00:00
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? Use chardet?
79: _encoding = "utf-8"
80: return output_data.decode(_encoding)
2020-07-19 19:07:30 +00:00
```
2020-09-19 22:35:48 +00:00
## File test/test_config.py - Line 156 - W0511 (fixme)
- `message: TODO (mb 2020-09-18):`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-18T19:04:06`
```
143: def test_parse_v2_cfg():
...
154: assert "setup.py" in cfg.file_patterns
155: assert "setup.cfg" in cfg.file_patterns
> 156: # TODO (mb 2020-09-18):
157: # assert cfg.file_patterns["setup.py" ] == ["vYYYY0M.BUILD[-TAG]", "YYYY0M.BLD[PYTAGNUM]"]
158: # assert cfg.file_patterns["setup.cfg" ] == ['current_version = "vYYYY0M.BUILD[-TAG]"']
```
## 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-09-19 22:35:48 +00:00
## File src/pycalver/v1patterns.py - Line 212 - W0511 (fixme)
2020-07-19 19:07:30 +00:00
2020-09-19 22:35:48 +00:00
- `message: TODO (mb 2020-09-19): replace {version} etc with version_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-19T16:24:10`
2020-07-19 19:07:30 +00:00
```
2020-09-19 22:35:48 +00:00
199: def _compile_pattern_re(version_pattern: str, raw_pattern: str) -> typ.Pattern[str]:
2020-09-18 17:50:13 +00:00
...
2020-09-19 22:35:48 +00:00
210: escaped_pattern = escaped_pattern.replace(char, escaped)
211:
> 212: # TODO (mb 2020-09-19): replace {version} etc with version_pattern
213: pattern_str = _replace_pattern_parts(escaped_pattern)
214: return re.compile(pattern_str)
2020-07-19 19:07:30 +00:00
```
2020-09-19 22:35:48 +00:00
## File src/pycalver/__main__.py - Line 247 - 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-09-19 22:35:48 +00:00
219: def _bump(
2020-07-19 19:07:30 +00:00
...
2020-09-19 22:35:48 +00:00
245: sys.exit(1)
246: except Exception as ex:
> 247: # TODO (mb 2020-09-18): Investigate error messages
248: logger.error(str(ex))
249: sys.exit(1)
2020-07-19 19:07:30 +00:00
```
2020-09-19 22:35:48 +00:00
## File src/pycalver/v2patterns.py - Line 256 - W0511 (fixme)
2020-07-19 19:07:30 +00:00
2020-09-19 22:35:48 +00:00
- `message: TODO (mb 2020-09-19): replace {version} etc with version_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-19T16:24:10`
2020-07-19 19:07:30 +00:00
```
2020-09-19 22:35:48 +00:00
240: def _compile_pattern_re(version_pattern: str, raw_pattern: str) -> typ.Pattern[str]:
2020-09-18 17:50:13 +00:00
...
2020-09-19 22:35:48 +00:00
254: print("<<<<", (normalized_pattern,))
255:
> 256: # TODO (mb 2020-09-19): replace {version} etc with version_pattern
257: pattern_str = _replace_pattern_parts(escaped_pattern)
258: return re.compile(pattern_str)
2020-07-19 19:07:30 +00:00
```
2020-09-19 22:35:48 +00:00
## File src/pycalver/config.py - Line 264 - 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-19 22:35:48 +00:00
250: def _parse_config(raw_cfg: RawConfig) -> Config:
2020-09-18 17:50:13 +00:00
...
2020-09-19 22:35:48 +00:00
262: is_new_pattern = "{" not in version_pattern and "}" not in version_pattern
263:
> 264: # TODO (mb 2020-09-18): Validate Pattern
265: # detect YY with WW or UU -> suggest GG with VV
266: # detect YYMM -> suggest YY0M
```
## File test/test_cli.py - Line 536 - W0511 (fixme)
- `message: # TODO (mb 2020-09-18):`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-18T19:35:32`
```
534:
535: # def test_custom_commit_message(runner):
> 536: # # TODO (mb 2020-09-18):
537: # assert False
2020-07-19 19:07:30 +00:00
```
2020-09-06 21:15:27 +00:00
# W0703: broad-except
2020-07-19 19:07:30 +00:00
2020-09-19 22:35:48 +00:00
## File src/pycalver/__main__.py - Line 246 - 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-09-19 22:35:48 +00:00
219: def _bump(
2020-09-06 21:15:27 +00:00
...
2020-09-19 22:35:48 +00:00
244: logger.error(str(ex))
245: sys.exit(1)
> 246: except Exception as ex:
247: # TODO (mb 2020-09-18): Investigate error messages
248: logger.error(str(ex))
2020-07-19 19:07:30 +00:00
```