file frags: use pattern key for consistency with e.g. tool.hatch.version

Author: hynek

README.md

@@ -102,11 +102,11 @@ Additionally it’s possible to cut away parts of the file before appending it:
 
 - **`start-after`** cuts away everything before the string specified.
 - **`end-before`** cuts away everything after.
-- **`regexp`** takes a regular expression and returns the first group from it.
+- **`pattern`** takes a [*regular expression*](https://docs.python.org/3/library/re.html) and returns the first group from it (you probably want to make your capture group non-greedy by appending a question mark: `(.*)?`).
   Internally, it uses
 
   ```python
-  re.search(regexp, whatever_is_left_after_slicing, re.DOTALL).group(1)
+  re.search(pattern, whatever_is_left_after_slicing, re.DOTALL).group(1)
   ```
 
   to find it.
@@ -132,7 +132,7 @@ together with:
 path = "path.md"
 start-after = "<!-- cut after this -->\n\n"
 end-before = "\n\n<!-- but before this -->"
-regexp = "the (.*) body"
+pattern = "the (.*) body"
 ```
 
 would append:
@@ -151,7 +151,7 @@ to your readme.
 >
 >   1. `start-after`
 >   2. `end-before`
->   3. `regexp`
+>   3. `pattern`
 
 For a complete example, please see our [example configuration][example-config].
 

src/hatch_fancy_pypi_readme/_fragments.py

@@ -103,7 +103,7 @@ def from_config(cls, cfg: dict[str, str]) -> Fragment:
         path = Path(cfg.pop("path"))
         start_after = cfg.pop("start-after", None)
         end_before = cfg.pop("end-before", None)
-        regexp = cfg.pop("regexp", None)
+        pattern = cfg.pop("pattern", None)
 
         errs: list[str] = []
         if cfg:
@@ -129,12 +129,12 @@ def from_config(cls, cfg: dict[str, str]) -> Fragment:
                     f"file fragment: 'end_before' {end_before!r} not found."
                 )
 
-        if regexp:
+        if pattern:
             try:
-                m = re.search(regexp, contents, re.DOTALL)
+                m = re.search(pattern, contents, re.DOTALL)
                 if not m:
                     errs.append(
-                        f"file fragment: pattern {regexp!r} not found."
+                        f"file fragment: pattern {pattern!r} not found."
                     )
                 else:
                     try:
@@ -145,7 +145,7 @@ def from_config(cls, cfg: dict[str, str]) -> Fragment:
                             "defined."
                         )
             except re.error as e:
-                errs.append(f"file fragment: invalid pattern {regexp!r}: {e}")
+                errs.append(f"file fragment: invalid pattern {pattern!r}: {e}")
 
         if errs:
             raise ConfigurationError(errs)

tests/example_pyproject.toml

@@ -35,7 +35,7 @@ Now let's add an extract from [`tests/example_changelog.md`](https://github.com/
 
 [[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
 path = "tests/example_changelog.md"
-regexp = "<!-- changelog follows -->\n\n\n(.*)\n\n## "
+pattern = "<!-- changelog follows -->\n\n\n(.*)?\n\n## "
 
 [[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
 text = "\n---\n\nPretty **cool**, huh?"

tests/test_fragments.py

@@ -142,62 +142,62 @@ def test_start_after_end_before_not_found(self, txt_path):
             "file fragment: 'end_before' 'also nope' not found.",
         ] == ei.value.errors
 
-    def test_invalid_regexp(self, txt_path):
+    def test_invalid_pattern(self, txt_path):
         """
         re-compilation errors are caught and reported.
         """
         with pytest.raises(ConfigurationError) as ei:
             FileFragment.from_config(
                 {
-                    "regexp": r"**",
                     "path": str(txt_path),
+                    "pattern": r"**",
                 }
             )
         assert [
             "file fragment: invalid pattern '**': nothing to repeat at "
             "position 0"
         ] == ei.value.errors
 
-    def test_regexp_no_match(self, txt_path):
+    def test_pattern_no_match(self, txt_path):
         """
-        If the regexp doesn't match, a helpful error is raises.
+        If the pattern doesn't match, a helpful error is raises.
         """
         with pytest.raises(ConfigurationError) as ei:
             FileFragment.from_config(
                 {
-                    "regexp": r"wtf",
                     "path": str(txt_path),
+                    "pattern": r"wtf",
                 }
             )
 
         assert ["file fragment: pattern 'wtf' not found."] == ei.value.errors
 
-    def test_regexp_no_group(self, txt_path):
+    def test_pattern_no_group(self, txt_path):
         """
-        If the regexp matches but lacks a group, tell the user.
+        If the pattern matches but lacks a group, tell the user.
         """
         with pytest.raises(ConfigurationError) as ei:
             FileFragment.from_config(
                 {
-                    "regexp": r"Uninteresting",
                     "path": str(txt_path),
+                    "pattern": r"Uninteresting",
                 }
             )
 
         assert [
             "file fragment: pattern matches, but no group defined."
         ] == ei.value.errors
 
-    def test_regexp_ok(self, txt_path):
+    def test_pattern_ok(self, txt_path):
         """
-        If the regexp matches and has a group, return it.
+        If the pattern matches and has a group, return it.
         """
         assert (
             "*interesting*"
             == FileFragment.from_config(
                 {
-                    "regexp": r"the (.*) body",
                     "path": str(txt_path),
+                    "pattern": r"the (.*) body",
                 }
             ).render()
         )