bumpver/pylint-ignore.md
Manuel Barkhau f92c7347ae doc updates
2020-10-03 23:44:38 +00:00

3.4 KiB

Pylint-Ignore

WARNING: This file is programatically generated.

This file is parsed by pylint-ignore to determine which Pylint messages 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

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)

File src/pycalver/vcs.py - Line 80 - 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
  69:     def __call__(self, cmd_name: str, env: Env = None, **kwargs: str) -> str:
  ...
  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)

File test/test_config.py - Line 170 - W0511 (fixme)

  • message: TODO (mb 2020-09-18):
  • author : Manuel Barkhau <mbarkhau@gmail.com>
  • date : 2020-09-18T19:04:06
  156: def test_parse_v2_cfg():
  ...
  168:     assert "setup.cfg" in cfg.file_patterns
  169:
> 170:     # TODO (mb 2020-09-18):
  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]"]

File src/pycalver/main.py - Line 421 - W0511 (fixme)

  • message: TODO (mb 2020-09-18): Investigate error messages
  • author : Manuel Barkhau <mbarkhau@gmail.com>
  • date : 2020-09-19T16:24:10
  391: def _bump(
  ...
  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)

W0703: broad-except

File src/pycalver/main.py - Line 420 - W0703 (broad-except)

  • message: Catching too general exception Exception
  • author : Manuel Barkhau <mbarkhau@gmail.com>
  • date : 2020-09-05T14:30:17
  391: def _bump(
  ...
  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))