From cccd7052b8fdb7e8679673fcc27f366b2aeaa964 Mon Sep 17 00:00:00 2001 From: Manuel Barkhau Date: Fri, 22 Feb 2019 10:40:31 +0100 Subject: [PATCH] update documentation --- README.md | 15 ++++++++++++++- src/pycalver/rewrite.py | 2 +- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5190402..261cc28 100644 --- a/README.md +++ b/README.md @@ -147,7 +147,7 @@ src/mymodule_v*/__init__.py = __version__ = "{pycalver}" README.md = [PyCalVer {calver}{build}{release}] - img.shields.io/badge/PyCalVer-{calver}{build}-{release}-blue + img.shields.io/static/v1.svg?label=PyCalVer&message={pycalver}&color=blue ``` To see if a pattern is found, you can use `pycalver bump --dry`, which will @@ -188,6 +188,19 @@ INFO - New Version: v201902.0002-beta license="MIT", ``` +If there is no match for a pattern, bump will report an error. + +```shell +$ pycalver bump --dry --no-fetch +INFO - Old Version: v201901.0001-beta +INFO - New Version: v201902.0002-beta +ERROR - No match for pattern 'img.shields.io/static/v1.svg?label=PyCalVer&message={pycalver}&color=blue' +ERROR - Pattern compiles to regex 'img\.shields\.io/static/v1\.svg\?label=PyCalVer&message=(?Pv(?P\d{4})(?P(?:0[0-9]|1[0-2]))\.(?P\d{4,})(?:-(?P +(?:alpha|beta|dev|rc|post|final)))?)&color=blue' +``` + +The internally used regular expression is also shown, which you can use to debug the issue, for example on https://regex101.com. + ### Pattern Search and Replacement diff --git a/src/pycalver/rewrite.py b/src/pycalver/rewrite.py index e41a063..771ea38 100644 --- a/src/pycalver/rewrite.py +++ b/src/pycalver/rewrite.py @@ -72,7 +72,7 @@ def rewrite_lines( log.error(f"No match for pattern '{non_matched_pattern}'") compiled_pattern = patterns._compile_pattern(non_matched_pattern) log.error(f"Pattern compiles to regex '{compiled_pattern}'") - raise ValueError("Invalid pattern(s)", list(non_matched_patterns)) + raise ValueError("Invalid pattern(s)") else: return new_lines