bumpver/pylint-ignore.md
2020-09-24 19:21:57 +00:00

198 lines
5.6 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 (9x)](#w0511-fixme)
- [W0703: broad-except (1x)](#w0703-broad-except)
# W0511: fixme
## File test/test_patterns.py - Line 14 - W0511 (fixme)
- `message: TODO (mb 2020-09-06): test for v2patterns`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-18T17:01:05`
```
12: from pycalver import v2patterns
13:
> 14: # TODO (mb 2020-09-06): test for v2patterns
15:
16: V2_PART_PATTERN_CASES = [
```
## File src/pycalver/vcs.py - Line 78 - W0511 (fixme)
- `message: TODO (mb 2018-11-15): Detect encoding of output? Use chardet?`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-18T17:24:49`
```
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? Use chardet?
79: _encoding = "utf-8"
80: return output_data.decode(_encoding)
```
## 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[-RELEASE]", "YYYY0M.BLD[PYTAGNUM]"]
158: # assert cfg.file_patterns["setup.cfg" ] == ['current_version = "vYYYY0M.BUILD[-RELEASE]"']
```
## File test/test_version.py - Line 168 - W0511 (fixme)
- `message: TODO (mb 2020-09-06): add tests for new style patterns`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-18T17:01:05`
```
163: def vnfo(**field_values):
...
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")],
```
## File src/pycalver/v1patterns.py - Line 214 - W0511 (fixme)
- `message: TODO (mb 2020-09-19): replace {version} etc with version_pattern`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-19T16:24:10`
```
201: def _compile_pattern_re(version_pattern: str, raw_pattern: str) -> typ.Pattern[str]:
...
212: escaped_pattern = escaped_pattern.replace(char, escaped)
213:
> 214: # TODO (mb 2020-09-19): replace {version} etc with version_pattern
215: pattern_str = _replace_pattern_parts(escaped_pattern)
216: return re.compile(pattern_str)
```
## File src/pycalver/__main__.py - Line 250 - W0511 (fixme)
- `message: TODO (mb 2020-09-18): Investigate error messages`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-19T16:24:10`
```
222: def _bump(
...
248: sys.exit(1)
249: except Exception as ex:
> 250: # TODO (mb 2020-09-18): Investigate error messages
251: logger.error(str(ex))
252: sys.exit(1)
```
## File src/pycalver/config.py - Line 273 - W0511 (fixme)
- `message: TODO (mb 2020-09-18): Validate Pattern`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-18T19:04:06`
```
251: def _parse_config(raw_cfg: RawConfig) -> Config:
...
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
```
## 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
```
## File src/pycalver/v2version.py - Line 551 - W0511 (fixme)
- `message: TODO (mb 2020-09-20): New Rollover Behaviour:`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-20T17:36:38`
```
508: def incr(
...
549: cur_vinfo = cur_vinfo._replace(patch=cur_vinfo.patch + 1)
550:
> 551: # TODO (mb 2020-09-20): New Rollover Behaviour:
552: # Reset major, minor, patch to zero if any part to the left of it is incremented
553:
```
# W0703: broad-except
## File src/pycalver/__main__.py - Line 249 - W0703 (broad-except)
- `message: Catching too general exception Exception`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-09-05T14:30:17`
```
222: def _bump(
...
247: logger.error(str(ex))
248: sys.exit(1)
> 249: except Exception as ex:
250: # TODO (mb 2020-09-18): Investigate error messages
251: logger.error(str(ex))
```