Add `-i/--issue` and `-s/--section` flags to `blurb add` #16

picnixz · 2024-06-25T13:52:28Z

Fixes #6. This is an alternative to #15.

@hugovk I've taken out your way of handling positional arguments (but would you consider a PR which refactors blurb in order to use argparse instead?). If you prefer --gh, I can also rename the variable!

for more information, see https://pre-commit.ci

…lags

hugovk · 2024-06-25T19:29:50Z

would you consider a PR which refactors blurb in order to use argparse instead?

That could make things easier, but I've not used subcommands much in argparse, how are they? We'd need to make sure all the commands and options work in the same way, blurb is used in a few different bits of automation and we wouldn't want to break any of them.

src/blurb/blurb.py

README.md

src/blurb/blurb.py

tests/test_blurb_add.py

picnixz · 2024-06-26T06:54:36Z

That could make things easier, but I've not used subcommands much in argparse, how are they? We'd need to make sure all the commands and options work in the same way, blurb is used in a few different bits of automation and we wouldn't want to break any of them.

From my personal usage of subcommands, it works the same. Actually, a subcommand is just an action that invokes an ArgumentParser. However, it might indeed come with some corner cases which I would first extensively test. If you can tell me where it's being used in automaton parts, then I'd be glad to check if I can make the transition.

hugovk · 2024-06-26T08:40:49Z

If you can tell me where it's being used in automaton parts, then I'd be glad to check if I can make the transition.

Hmm, well at least here:

tests/test_blurb_add.py

larryhastings

Some initial comments. I'll confer further with Hugo.

README.md

src/blurb/blurb.py

picnixz · 2024-07-12T17:25:19Z

Thank you Larry for your comments. I'll address them tomorrow (I don't have access to the project now)

- remove section IDs matching - do not render the table in case of a multi-match - simplify `add` docstring construction - update tests - update README.md

README.md

src/blurb/blurb.py

Co-authored-by: Hugo van Kemenade <[email protected]>

hugovk

Testing matching the sections, blurb add --section core works, but not:

❯ blurb add --section built
Invalid section name: 'built'

Choose from the following table:

+-------------------+
| Security          |
| Core and Builtins |
| Library           |
| Documentation     |
| Tests             |
| Build             |
| Windows           |
| macOS             |
| IDLE              |
| Tools/Demos       |
| C API             |
+-------------------+

Or:

❯ blurb add --section api
Invalid section name: 'api'

Choose from the following table:

+-------------------+
| Security          |
| Core and Builtins |
| Library           |
| Documentation     |
| Tests             |
| Build             |
| Windows           |
| macOS             |
| IDLE              |
| Tools/Demos       |
| C API             |
+-------------------+

Should they?

README.md

Co-authored-by: Hugo van Kemenade <[email protected]>

picnixz · 2024-07-13T09:52:10Z

Mmmh, I think I only matched from the beginning, not inside. Otherwise, you write 'l' and have a lot of matches (library, core and builtins, tools, etc). And I didn't want to special cases. But maybe we can use aliases? I don't remember now if 'capi' works (but maybe it should)

hugovk · 2024-07-13T10:06:57Z

Mmmh, I think I only matched from the beginning, not inside. Otherwise, you write 'l' and have a lot of matches (library, core and builtins, tools, etc).

Yeah, that's not so useful.

And I didn't want to special cases. But maybe we can use aliases? I don't remember now if 'capi' works (but maybe it should)

"capi" doesn't work:

❯ blurb add --section capi
Invalid section name: 'capi'

Choose from the following table:

+-------------------+
| Security          |
| Core and Builtins |
| Library           |
| Documentation     |
| Tests             |
| Build             |
| Windows           |
| macOS             |
| IDLE              |
| Tools/Demos       |
| C API             |
+-------------------+

I don't think we necessarily need to match "builtins" -> "Core and Builtins" or "demo" -> "Tools/Demos", but "capi" -> "C API" would help, and maybe also "api" -> "C API"?

picnixz · 2024-07-13T12:12:15Z

I don't think we necessarily need to match "builtins" -> "Core and Builtins" or "demo" -> "Tools/Demos", but "capi" -> "C API" would help, and maybe also "api" -> "C API"?

I ended up making them match like that (the tests should reflect what is now possible). I don't have a better way to cover the use cases so don't hesistate to tell me which cases should be checked.

larryhastings · 2024-07-13T12:15:19Z

Would it be sufficient to create a "nickname map", like

{ "".join(section.split()).lower(): section for section in sections }

picnixz · 2024-07-13T12:21:30Z

{ "".join(section.split()).lower(): section for section in sections }

Yes. But to construct additional patterns, I needed to use:

    _sanitized = re.sub(r'[ /]', ' ', _section)
    _section_words = re.split(r'\s+', _sanitized)
    _section_names_lower_nosep[_section] = ''.join(_section_words).lower()

(Your suggestion is in my case implemented as ''.join(_section_words).lower())

src/blurb/blurb.py

hugovk

I'm not fully sold on the smart matching, I don't think we need to worry about things like blurb add --section "cOre _ and - bUILtins".

Would case-insensitive substring matching be enough, as long as the substring is unique?

So these would work:

blurb add --section mac
blurb add --section core
blurb add --section build
blurb add --section built

But not:

blurb add --section buil
blurb add --section i

hugovk · 2025-06-30T08:01:26Z

src/blurb/blurb.py

+    if issue.startswith('gh-'):
+        issue = issue[3:]


Suggested change

if issue.startswith('gh-'):

issue = issue[3:]

issue = issue.removeprefix('gh-')

hugovk · 2025-06-30T08:04:06Z

src/blurb/blurb.py

+    del _sanitized
+    # '_', '-', ' ' and '/' are the allowed (user) separators
+    _section_pattern = r'[_\- /]?'.join(map(re.escape, _section_words))
+    # add '$' to avoid matching after the pattern
+    _section_pattern = f'{_section_pattern}$'
+    del _section_words
+    _section_pattern = re.compile(_section_pattern, re.I)
+    _section_special_patterns[_section].add(_section_pattern)
+    del _section_pattern, _section


Do we really need these dels?

Suggested change

del _sanitized

# '_', '-', ' ' and '/' are the allowed (user) separators

_section_pattern = r'[_\- /]?'.join(map(re.escape, _section_words))

# add '$' to avoid matching after the pattern

_section_pattern = f'{_section_pattern}$'

del _section_words

_section_pattern = re.compile(_section_pattern, re.I)

_section_special_patterns[_section].add(_section_pattern)

del _section_pattern, _section

# '_', '-', ' ' and '/' are the allowed (user) separators

_section_pattern = r'[_\- /]?'.join(map(re.escape, _section_words))

# add '$' to avoid matching after the pattern

_section_pattern = f'{_section_pattern}$'

_section_pattern = re.compile(_section_pattern, re.I)

_section_special_patterns[_section].add(_section_pattern)

hugovk · 2025-06-30T08:08:00Z

src/blurb/blurb.py

+del _sec_name_width
+sections_table = '\n'.join(map(_format_row, sections))
+del _format_row
+sections_table = '\n'.join((_sec_row_rule, sections_table, _sec_row_rule))
+del _sec_row_rule


Suggested change

del _sec_name_width

sections_table = '\n'.join(map(_format_row, sections))

del _format_row

sections_table = '\n'.join((_sec_row_rule, sections_table, _sec_row_rule))

del _sec_row_rule

sections_table = '\n'.join(map(_format_row, sections))

sections_table = '\n'.join((_sec_row_rule, sections_table, _sec_row_rule))

hugovk · 2025-06-30T08:43:30Z

tests/test_blurb_add.py

+    def check(section, expect):
+        actual = blurb._extract_section_name(section)
+        assert actual == expect


To match the other test files:

Suggested change

def check(section, expect):

actual = blurb._extract_section_name(section)

assert actual == expect

def check(section, expected):

actual = blurb._extract_section_name(section)

assert actual == expected

hugovk · 2025-06-30T08:46:24Z

tests/test_blurb_add.py

+        res = blurb._update_blurb_template(issue=None, section=section)
+        res = res.splitlines()
+        for section_name in blurb.sections:
+            if section_name == expect:


Suggested change

if section_name == expect:

if section_name == expected:

hugovk · 2025-06-30T08:53:25Z

tests/test_blurb_add.py

+        ('section', 'expect'),
+        tuple(zip(blurb.sections, blurb.sections))
+    )
+    def test_exact_names(self, section, expect):
+        self.check(section, expect)
+
+    @pytest.mark.parametrize(
+        ('section', 'expect'), [


Suggested change

('section', 'expect'),

tuple(zip(blurb.sections, blurb.sections))

)

def test_exact_names(self, section, expect):

self.check(section, expect)

@pytest.mark.parametrize(

('section', 'expect'), [

('section', 'expected'),

tuple(zip(blurb.sections, blurb.sections))

)

def test_exact_names(self, section, expected):

self.check(section, expected)

@pytest.mark.parametrize(

('section', 'expected'), [

hugovk · 2025-06-30T08:53:39Z

tests/test_blurb_add.py

+    def test_partial_words(self, section, expect):
+        self.check(section, expect)
+
+    @pytest.mark.parametrize(
+        ('section', 'expect'), [


Suggested change

def test_partial_words(self, section, expect):

self.check(section, expect)

@pytest.mark.parametrize(

('section', 'expect'), [

def test_partial_words(self, section, expected):

self.check(section, expected)

@pytest.mark.parametrize(

('section', 'expected'), [

hugovk · 2025-06-30T08:53:49Z

tests/test_blurb_add.py

+    def test_partial_special_names(self, section, expect):
+        self.check(section, expect)
+
+    @pytest.mark.parametrize(
+        ('section', 'expect'), [


Suggested change

def test_partial_special_names(self, section, expect):

self.check(section, expect)

@pytest.mark.parametrize(

('section', 'expect'), [

def test_partial_special_names(self, section, expected):

self.check(section, expected)

@pytest.mark.parametrize(

('section', 'expected'), [

hugovk · 2025-06-30T08:54:08Z

tests/test_blurb_add.py

+    def test_partial_separators(self, section, expect):
+        # normalize the separtors '_', '-', ' ' and '/'
+        self.check(section, expect)
+
+    @pytest.mark.parametrize(
+        ('prefix', 'expect'), [


Plus a typo

Suggested change

def test_partial_separators(self, section, expect):

# normalize the separtors '_', '-', ' ' and '/'

self.check(section, expect)

@pytest.mark.parametrize(

('prefix', 'expect'), [

def test_partial_separators(self, section, expected):

# normalize the separators '_', '-', ' ' and '/'

self.check(section, expected)

@pytest.mark.parametrize(

('prefix', 'expected'), [

hugovk · 2025-06-30T08:54:44Z

tests/test_blurb_add.py

+    def test_partial_prefix_words(self, prefix, expect):
+        # try to find a match using prefixes (without separators and lowercase)
+        self.check(prefix, expect)
+
+    @pytest.mark.parametrize(
+        ('section', 'expect'),
+        [(name.lower(), name) for name in blurb.sections],
+    )
+    def test_exact_names_lowercase(self, section, expect):
+        self.check(section, expect)
+
+    @pytest.mark.parametrize(
+        ('section', 'expect'),
+        [(name.upper(), name) for name in blurb.sections],
+    )
+    def test_exact_names_uppercase(self, section, expect):
+        self.check(section, expect)


Suggested change

def test_partial_prefix_words(self, prefix, expect):

# try to find a match using prefixes (without separators and lowercase)

self.check(prefix, expect)

@pytest.mark.parametrize(

('section', 'expect'),

[(name.lower(), name) for name in blurb.sections],

)

def test_exact_names_lowercase(self, section, expect):

self.check(section, expect)

@pytest.mark.parametrize(

('section', 'expect'),

[(name.upper(), name) for name in blurb.sections],

)

def test_exact_names_uppercase(self, section, expect):

self.check(section, expect)

def test_partial_prefix_words(self, prefix, expected):

# try to find a match using prefixes (without separators and lowercase)

self.check(prefix, expected)

@pytest.mark.parametrize(

('section', 'expected'),

[(name.lower(), name) for name in blurb.sections],

)

def test_exact_names_lowercase(self, section, expected):

self.check(section, expected)

@pytest.mark.parametrize(

('section', 'expected'),

[(name.upper(), name) for name in blurb.sections],

)

def test_exact_names_uppercase(self, section, expected):

self.check(section, expected)

picnixz · 2025-07-01T06:30:54Z

I think it would be enough.

@picnixz

Integrate the user-friendly features from PR python#16 by @picnixz into the automation support from PR python#45, making the CLI more intuitive: - Change --gh-issue to --issue, accepting multiple formats: * Plain numbers: --issue 12345 * With gh- prefix: --issue gh-12345 * GitHub URLs: --issue python/cpython#12345 - Add smart section matching with: * Case-insensitive matching: --section lib matches "Library" * Partial matching: --section doc matches "Documentation" * Common aliases: --section api matches "C API" * Separator normalization: --section core-and-builtins - Improve error messages for invalid sections This combines the automation features from PR python#45 with the interface improvements suggested by @picnixz in PR python#16, as reviewed by @hugovk and @larryhastings. Co-authored-by: picnixz <[email protected]>

@picnixz

Integrate the user-friendly features from PR python#16 by @picnixz into the automation support from PR python#45, making the CLI more intuitive: - Change --gh-issue to --issue, accepting multiple formats: * Plain numbers: --issue 12345 * With gh- prefix: --issue gh-12345 * GitHub URLs: --issue python/cpython#12345 - Add smart section matching with: * Case-insensitive matching: --section lib matches "Library" * Partial matching: --section doc matches "Documentation" * Common aliases: --section api matches "C API" * Separator normalization: --section core-and-builtins - Improve error messages for invalid sections This combines the automation features from PR python#45 with the interface improvements suggested by @picnixz in PR python#16, as reviewed by @hugovk and @larryhastings.

picnixz and others added 5 commits June 25, 2024 15:47

Improve blurb add command.

d5d11a2

update version

eaddee3

[pre-commit.ci] auto fixes from pre-commit.com hooks

403d387

for more information, see https://pre-commit.ci

fix CI/CD

ad230fe

Merge branch 'add-gh-flags' of github.com:picnixz/blurb into add-gh-f…

edd8eea

…lags

hugovk reviewed Jun 25, 2024

View reviewed changes

picnixz added 5 commits June 26, 2024 08:58

fixup! typos

9856548

add test for known section names

a2a1fce

expand tests

7d67830

improve section name detection

635c8ac

improve tests

992b8ec

hugovk reviewed Jun 26, 2024

View reviewed changes

tests/test_blurb_add.py Outdated Show resolved Hide resolved

tests/test_blurb_add.py Outdated Show resolved Hide resolved

tests/test_blurb_add.py Outdated Show resolved Hide resolved

hugovk added the enhancement New feature or request label Jun 26, 2024

picnixz added 3 commits June 26, 2024 14:12

address review!

842bc2d

remove extraneous line

99261a5

Merge branch 'main' into add-gh-flags

114013c

larryhastings reviewed Jul 12, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

src/blurb/blurb.py Outdated Show resolved Hide resolved

src/blurb/blurb.py Outdated Show resolved Hide resolved

src/blurb/blurb.py Outdated Show resolved Hide resolved

picnixz added 5 commits July 13, 2024 09:35

address Larry's comments

18a5563

- remove section IDs matching - do not render the table in case of a multi-match - simplify `add` docstring construction - update tests - update README.md

remove local fix

350daeb

remove un-necessary blank line

0e25cc0

...

2b976e2

use the same example in the README and the docstring of add

d578f92

hugovk reviewed Jul 13, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

src/blurb/blurb.py Outdated Show resolved Hide resolved

picnixz and others added 3 commits July 13, 2024 11:32

Update README.md

f11b9f1

Update README.md

6737ea4

Co-authored-by: Hugo van Kemenade <[email protected]>

Update src/blurb/blurb.py

384079d

Co-authored-by: Hugo van Kemenade <[email protected]>

Update src/blurb/blurb.py

9242ddc

hugovk reviewed Jul 13, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

8619bc2

Co-authored-by: Hugo van Kemenade <[email protected]>

picnixz added 2 commits July 13, 2024 14:10

improve matching algorithm

9de55af

increase test coverage

a7cd263

update comments

ba33c38

picnixz added 4 commits July 13, 2024 14:21

simplify supported separators

cb04947

fix regex

33ae76e

improve error messages

48fc24b

cleanup

15271e1

hugovk mentioned this pull request Jul 22, 2024

Add --gh and --section flags to "blurb add" #15

Closed

picnixz added 5 commits August 14, 2024 09:51

Merge branch 'main' into add-gh-flags

a3899ec

Update README.md

026052c

Update CHANGELOG.md

5fe40bd

Merge branch 'main' into add-gh-flags

1f789b0

Merge branch 'main' into add-gh-flags

792c0a6

picnixz commented Jun 1, 2025

View reviewed changes

src/blurb/blurb.py Outdated Show resolved Hide resolved

src/blurb/blurb.py Outdated Show resolved Hide resolved

src/blurb/blurb.py Outdated Show resolved Hide resolved

Apply suggestions from code review

9775d8f

hugovk changed the title ~~gh-6: add -i/--issue and -s/--section flags to blurb add~~ Add -i/--issue and -s/--section flags to blurb add Jun 2, 2025

hugovk mentioned this pull request Jun 29, 2025

Allow the GH issue + Section as --flags and take news via stdin #45

Open

hugovk reviewed Jun 30, 2025

View reviewed changes

gpshead mentioned this pull request Jul 4, 2025

Add user-friendly interface improvements to blurb add command gpshead/blurb#1

Merged

	if issue.startswith('gh-'):
	issue = issue[3:]
	issue = issue.removeprefix('gh-')

Add -i/--issue and -s/--section flags to blurb add #16

Are you sure you want to change the base?

Add -i/--issue and -s/--section flags to blurb add #16

Uh oh!

Conversation

picnixz commented Jun 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hugovk commented Jun 25, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

picnixz commented Jun 26, 2024

Uh oh!

hugovk commented Jun 26, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

larryhastings left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

picnixz commented Jul 12, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

picnixz commented Jul 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hugovk commented Jul 13, 2024

Uh oh!

picnixz commented Jul 13, 2024

Uh oh!

larryhastings commented Jul 13, 2024

Uh oh!

picnixz commented Jul 13, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

picnixz commented Jul 1, 2025

Uh oh!

Uh oh!

Add `-i/--issue` and `-s/--section` flags to `blurb add` #16

Add `-i/--issue` and `-s/--section` flags to `blurb add` #16

picnixz commented Jun 25, 2024 •

edited

Loading

picnixz commented Jul 13, 2024 •

edited

Loading