mercurial-scm/hg: hgext/releasenotes.py annotate

annotate hgext/releasenotes.py @ 48946:642e31cb55f0

py3: use class X: instead of class X(object): The inheritance from object is implied in Python 3. So this should be equivalent. This change was generated via an automated search and replace. So there may have been some accidental changes. Differential Revision: https://phab.mercurial-scm.org/D12352

author	Gregory Szorc <gregory.szorc@gmail.com>
date	Mon, 21 Feb 2022 13:08:28 -0700
parents	f254fc73d956
children	2e726c934fcd

rev	line source
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1 # Copyright 2017-present Gregory Szorc <gregory.szorc@gmail.com>
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	2 #
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	3 # This software may be used and distributed according to the terms of the
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	4 # GNU General Public License version 2 or any later version.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	5
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	6 """generate release notes from commit messages (EXPERIMENTAL)
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	7
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	8 It is common to maintain files detailing changes in a project between
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	9 releases. Maintaining these files can be difficult and time consuming.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	10 The :hg:`releasenotes` command provided by this extension makes the
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	11 process simpler by automating it.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	12 """
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	13
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	14
33881 6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	15 import difflib
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	16 import errno
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	17 import re
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	18
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	19 from mercurial.i18n import _
43085 eef9a2d67051 py3: manually import pycompat.open into files that need it Gregory Szorc <gregory.szorc@gmail.com> parents: 43077 diff changeset	20 from mercurial.pycompat import open
46113 59fa3890d40a node: import symbols explicitly Joerg Sonnenberger <joerg@bec.de> parents: 45055 diff changeset	21 from mercurial.node import hex
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	22 from mercurial import (
43898 023ad45e2fd2 releasenotes: extract helper for checking for incompatible arguments Martin von Zweigbergk <martinvonz@google.com> parents: 43117 diff changeset	23 cmdutil,
33571 9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	24 config,
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	25 error,
48116 5ced12cfa41b errors: raise InputError on bad revset to revrange() iff provided by the user Martin von Zweigbergk <martinvonz@google.com> parents: 47847 diff changeset	26 logcmdutil,
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	27 minirst,
35003 e68dd1909af3 py3: handle keyword arguments in hgext/releasenotes.py Pulkit Goyal <7895pulkit@gmail.com> parents: 34813 diff changeset	28 pycompat,
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	29 registrar,
33571 9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	30 util,
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	31 )
45055 4c1b4805db57 pycompat: change users of pycompat.{stdin,stdout,stderr} to use procutil.std* Manuel Jacob <me@manueljacob.de> parents: 44194 diff changeset	32 from mercurial.utils import (
4c1b4805db57 pycompat: change users of pycompat.{stdin,stdout,stderr} to use procutil.std* Manuel Jacob <me@manueljacob.de> parents: 44194 diff changeset	33 procutil,
4c1b4805db57 pycompat: change users of pycompat.{stdin,stdout,stderr} to use procutil.std* Manuel Jacob <me@manueljacob.de> parents: 44194 diff changeset	34 stringutil,
4c1b4805db57 pycompat: change users of pycompat.{stdin,stdout,stderr} to use procutil.std* Manuel Jacob <me@manueljacob.de> parents: 44194 diff changeset	35 )
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	36
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	37 cmdtable = {}
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	38 command = registrar.command(cmdtable)
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	39
34812 bc2caa4b4480 releasenotes: move import of fuzzywuzzy to import level Pulkit Goyal <7895pulkit@gmail.com> parents: 34811 diff changeset	40 try:
47847 8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	41 # Silence a warning about python-Levenshtein.
8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	42 #
8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	43 # We don't need the the performance that much and it get anoying in tests.
8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	44 import warnings
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	45
47847 8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	46 with warnings.catch_warnings():
8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	47 warnings.filterwarnings(
8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	48 action="ignore",
8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	49 message=".python-Levenshtein.",
8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	50 category=UserWarning,
8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	51 module="fuzzywuzzy.fuzz",
8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	52 )
8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	53
8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	54 import fuzzywuzzy.fuzz as fuzz
8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	55
8843de648aed pyoxidized: silence the fuzzywuzzy warning about python-Levenshtein Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46639 diff changeset	56 fuzz.token_set_ratio
34812 bc2caa4b4480 releasenotes: move import of fuzzywuzzy to import level Pulkit Goyal <7895pulkit@gmail.com> parents: 34811 diff changeset	57 except ImportError:
bc2caa4b4480 releasenotes: move import of fuzzywuzzy to import level Pulkit Goyal <7895pulkit@gmail.com> parents: 34811 diff changeset	58 fuzz = None
bc2caa4b4480 releasenotes: move import of fuzzywuzzy to import level Pulkit Goyal <7895pulkit@gmail.com> parents: 34811 diff changeset	59
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	60 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	61 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	62 # be specifying the version(s) of Mercurial they are tested with, or
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	63 # leave the attribute unspecified.
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	64 testedwith = b'ships-with-hg-core'
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	65
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	66 DEFAULT_SECTIONS = [
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	67 (b'feature', _(b'New Features')),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	68 (b'bc', _(b'Backwards Compatibility Changes')),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	69 (b'fix', _(b'Bug Fixes')),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	70 (b'perf', _(b'Performance Improvements')),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	71 (b'api', _(b'API Changes')),
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	72 ]
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	73
41532 bd3f03d8cc9f global: use raw strings for regular expressions with escapes Gregory Szorc <gregory.szorc@gmail.com> parents: 40293 diff changeset	74 RE_DIRECTIVE = re.compile(br'^\.\. ([a-zA-Z0-9_]+)::\s*([^$]+)?$')
40235 a7cdd81f191b releasenotes: fix remaining bytes/unicode issues caught by tests Augie Fackler <augie@google.com> parents: 40234 diff changeset	75 RE_ISSUE = br'\bissue ?[0-9]{4,6}(?![0-9])\b'
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	76
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	77 BULLET_SECTION = _(b'Other Changes')
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	78
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	79
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	80 class parsedreleasenotes:
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	81 def __init__(self):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	82 self.sections = {}
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	83
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	84 def __contains__(self, section):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	85 return section in self.sections
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	86
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	87 def __iter__(self):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	88 return iter(sorted(self.sections))
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	89
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	90 def addtitleditem(self, section, title, paragraphs):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	91 """Add a titled release note entry."""
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	92 self.sections.setdefault(section, ([], []))
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	93 self.sections[section][0].append((title, paragraphs))
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	94
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	95 def addnontitleditem(self, section, paragraphs):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	96 """Adds a non-titled release note entry.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	97
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	98 Will be rendered as a bullet point.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	99 """
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	100 self.sections.setdefault(section, ([], []))
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	101 self.sections[section][1].append(paragraphs)
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	102
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	103 def titledforsection(self, section):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	104 """Returns titled entries in a section.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	105
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	106 Returns a list of (title, paragraphs) tuples describing sub-sections.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	107 """
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	108 return self.sections.get(section, ([], []))[0]
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	109
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	110 def nontitledforsection(self, section):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	111 """Returns non-titled, bulleted paragraphs in a section."""
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	112 return self.sections.get(section, ([], []))[1]
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	113
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	114 def hastitledinsection(self, section, title):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	115 return any(t[0] == title for t in self.titledforsection(section))
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	116
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	117 def merge(self, ui, other):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	118 """Merge another instance into this one.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	119
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	120 This is used to combine multiple sources of release notes together.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	121 """
34813 288fad8c55f9 releasenotes: show a warning if fuzzywuzzy is not present Pulkit Goyal <7895pulkit@gmail.com> parents: 34812 diff changeset	122 if not fuzz:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	123 ui.warn(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	124 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	125 b"module 'fuzzywuzzy' not found, merging of similar "
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	126 b"releasenotes is disabled\n"
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	127 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	128 )
34813 288fad8c55f9 releasenotes: show a warning if fuzzywuzzy is not present Pulkit Goyal <7895pulkit@gmail.com> parents: 34812 diff changeset	129
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	130 for section in other:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	131 existingnotes = converttitled(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	132 self.titledforsection(section)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	133 ) + convertnontitled(self.nontitledforsection(section))
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	134 for title, paragraphs in other.titledforsection(section):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	135 if self.hastitledinsection(section, title):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	136 # TODO prompt for resolution if different and running in
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	137 # interactive mode.
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	138 ui.write(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	139 _(b'%s already exists in %s section; ignoring\n')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	140 % (title, section)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	141 )
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	142 continue
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	143
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	144 incoming_str = converttitled([(title, paragraphs)])[0]
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	145 if section == b'fix':
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	146 issue = getissuenum(incoming_str)
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	147 if issue:
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	148 if findissue(ui, existingnotes, issue):
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	149 continue
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	150
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	151 if similar(ui, existingnotes, incoming_str):
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	152 continue
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	153
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	154 self.addtitleditem(section, title, paragraphs)
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	155
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	156 for paragraphs in other.nontitledforsection(section):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	157 if paragraphs in self.nontitledforsection(section):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	158 continue
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	159
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	160 incoming_str = convertnontitled([paragraphs])[0]
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	161 if section == b'fix':
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	162 issue = getissuenum(incoming_str)
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	163 if issue:
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	164 if findissue(ui, existingnotes, issue):
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	165 continue
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	166
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	167 if similar(ui, existingnotes, incoming_str):
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	168 continue
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	169
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	170 self.addnontitleditem(section, paragraphs)
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	171
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	172
48946 642e31cb55f0 py3: use class X: instead of class X(object): Gregory Szorc <gregory.szorc@gmail.com> parents: 48913 diff changeset	173 class releasenotessections:
33571 9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	174 def __init__(self, ui, repo=None):
9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	175 if repo:
9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	176 sections = util.sortdict(DEFAULT_SECTIONS)
9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	177 custom_sections = getcustomadmonitions(repo)
9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	178 if custom_sections:
9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	179 sections.update(custom_sections)
48913 f254fc73d956 global: bulk replace simple pycompat.iteritems(x) with x.items() Gregory Szorc <gregory.szorc@gmail.com> parents: 48875 diff changeset	180 self._sections = list(sections.items())
33571 9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	181 else:
9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	182 self._sections = list(DEFAULT_SECTIONS)
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	183
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	184 def __iter__(self):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	185 return iter(self._sections)
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	186
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	187 def names(self):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	188 return [t[0] for t in self._sections]
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	189
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	190 def sectionfromtitle(self, title):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	191 for name, value in self._sections:
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	192 if value == title:
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	193 return name
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	194
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	195 return None
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	196
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	197
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	198 def converttitled(titledparagraphs):
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	199 """
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	200 Convert titled paragraphs to strings
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	201 """
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	202 string_list = []
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	203 for title, paragraphs in titledparagraphs:
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	204 lines = []
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	205 for para in paragraphs:
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	206 lines.extend(para)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	207 string_list.append(b' '.join(lines))
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	208 return string_list
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	209
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	210
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	211 def convertnontitled(nontitledparagraphs):
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	212 """
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	213 Convert non-titled bullets to strings
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	214 """
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	215 string_list = []
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	216 for paragraphs in nontitledparagraphs:
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	217 lines = []
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	218 for para in paragraphs:
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	219 lines.extend(para)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	220 string_list.append(b' '.join(lines))
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	221 return string_list
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	222
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	223
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	224 def getissuenum(incoming_str):
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	225 """
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	226 Returns issue number from the incoming string if it exists
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	227 """
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	228 issue = re.search(RE_ISSUE, incoming_str, re.IGNORECASE)
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	229 if issue:
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	230 issue = issue.group()
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	231 return issue
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	232
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	233
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	234 def findissue(ui, existing, issue):
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	235 """
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	236 Returns true if issue number already exists in notes.
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	237 """
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	238 if any(issue in s for s in existing):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	239 ui.write(_(b'"%s" already exists in notes; ignoring\n') % issue)
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	240 return True
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	241 else:
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	242 return False
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	243
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	244
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	245 def similar(ui, existing, incoming_str):
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	246 """
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	247 Returns true if similar note found in existing notes.
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	248 """
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	249 if len(incoming_str.split()) > 10:
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	250 merge = similaritycheck(incoming_str, existing)
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	251 if not merge:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	252 ui.write(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	253 _(b'"%s" already exists in notes file; ignoring\n')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	254 % incoming_str
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	255 )
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	256 return True
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	257 else:
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	258 return False
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	259 else:
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	260 return False
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	261
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	262
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	263 def similaritycheck(incoming_str, existingnotes):
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	264 """
34780 070ba789f4d0 releasenotes: fix documentation of similaritycheck() Pulkit Goyal <7895pulkit@gmail.com> parents: 34736 diff changeset	265 Returns false when note fragment can be merged to existing notes.
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	266 """
34812 bc2caa4b4480 releasenotes: move import of fuzzywuzzy to import level Pulkit Goyal <7895pulkit@gmail.com> parents: 34811 diff changeset	267 # fuzzywuzzy not present
bc2caa4b4480 releasenotes: move import of fuzzywuzzy to import level Pulkit Goyal <7895pulkit@gmail.com> parents: 34811 diff changeset	268 if not fuzz:
34810 44bd29168d14 releasenotes: make the import of fuzzywuzzy optional Pulkit Goyal <7895pulkit@gmail.com> parents: 34780 diff changeset	269 return True
44bd29168d14 releasenotes: make the import of fuzzywuzzy optional Pulkit Goyal <7895pulkit@gmail.com> parents: 34780 diff changeset	270
33698 3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	271 merge = True
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	272 for bullet in existingnotes:
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	273 score = fuzz.token_set_ratio(incoming_str, bullet)
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	274 if score > 75:
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	275 merge = False
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	276 break
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	277 return merge
3748098d072a releasenotes: add similarity check function to compare incoming notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33571 diff changeset	278
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	279
33571 9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	280 def getcustomadmonitions(repo):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	281 ctx = repo[b'.']
33571 9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	282 p = config.config()
9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	283
9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	284 def read(f, sections=None, remap=None):
9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	285 if f in ctx:
9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	286 data = ctx[f].data()
9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	287 p.parse(f, data, sections, remap, read)
9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	288 else:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	289 raise error.Abort(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	290 _(b".hgreleasenotes file \'%s\' not found") % repo.pathto(f)
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	291 )
33571 9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	292
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	293 if b'.hgreleasenotes' in ctx:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	294 read(b'.hgreleasenotes')
46639 88bd085cf2f8 releasenotes: use the right API to access the 'sections' Pierre-Yves David <pierre-yves.david@octobus.net> parents: 46113 diff changeset	295 return p.items(b'sections')
33571 9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	296
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	297
33881 6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	298 def checkadmonitions(ui, repo, directives, revs):
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	299 """
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	300 Checks the commit messages for admonitions and their validity.
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	301
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	302 .. abcd::
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	303
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	304 First paragraph under this admonition
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	305
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	306 For this commit message, using `hg releasenotes -r . --check`
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	307 returns: Invalid admonition 'abcd' present in changeset 3ea92981e103
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	308
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	309 As admonition 'abcd' is neither present in default nor custom admonitions
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	310 """
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	311 for rev in revs:
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	312 ctx = repo[rev]
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	313 admonition = re.search(RE_DIRECTIVE, ctx.description())
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	314 if admonition:
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	315 if admonition.group(1) in directives:
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	316 continue
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	317 else:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	318 ui.write(
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43105 diff changeset	319 _(b"Invalid admonition '%s' present in changeset %s\n")
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	320 % (admonition.group(1), ctx.hex()[:12])
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	321 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	322 sim = lambda x: difflib.SequenceMatcher(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	323 None, admonition.group(1), x
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	324 ).ratio()
33881 6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	325
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	326 similar = [s for s in directives if sim(s) > 0.6]
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	327 if len(similar) == 1:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	328 ui.write(_(b"(did you mean %s?)\n") % similar[0])
33881 6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	329 elif similar:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	330 ss = b", ".join(sorted(similar))
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	331 ui.write(_(b"(did you mean one of %s?)\n") % ss)
33881 6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	332
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	333
33940 2a37459aedf2 releasenotes: view admonition titles using -l flag Rishabh Madan <rishabhmadan96@gmail.com> parents: 33881 diff changeset	334 def _getadmonitionlist(ui, sections):
2a37459aedf2 releasenotes: view admonition titles using -l flag Rishabh Madan <rishabhmadan96@gmail.com> parents: 33881 diff changeset	335 for section in sections:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	336 ui.write(b"%s: %s\n" % (section[0], section[1]))
33940 2a37459aedf2 releasenotes: view admonition titles using -l flag Rishabh Madan <rishabhmadan96@gmail.com> parents: 33881 diff changeset	337
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	338
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	339 def parsenotesfromrevisions(repo, directives, revs):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	340 notes = parsedreleasenotes()
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	341
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	342 for rev in revs:
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	343 ctx = repo[rev]
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	344
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	345 blocks, pruned = minirst.parse(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	346 ctx.description(), admonitions=directives
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	347 )
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	348
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	349 for i, block in enumerate(blocks):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	350 if block[b'type'] != b'admonition':
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	351 continue
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	352
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	353 directive = block[b'admonitiontitle']
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	354 title = block[b'lines'][0].strip() if block[b'lines'] else None
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	355
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	356 if i + 1 == len(blocks):
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	357 raise error.Abort(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	358 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	359 b'changeset %s: release notes directive %s '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	360 b'lacks content'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	361 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	362 % (ctx, directive)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	363 )
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	364
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	365 # Now search ahead and find all paragraphs attached to this
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	366 # admonition.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	367 paragraphs = []
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	368 for j in range(i + 1, len(blocks)):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	369 pblock = blocks[j]
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	370
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	371 # Margin blocks may appear between paragraphs. Ignore them.
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	372 if pblock[b'type'] == b'margin':
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	373 continue
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	374
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	375 if pblock[b'type'] == b'admonition':
36770 a5891e94bfe1 releasenotes: allow notes for multiple directives in a single changeset Rishabh Madan <rishabhmadan96@gmail.com> parents: 36769 diff changeset	376 break
a5891e94bfe1 releasenotes: allow notes for multiple directives in a single changeset Rishabh Madan <rishabhmadan96@gmail.com> parents: 36769 diff changeset	377
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	378 if pblock[b'type'] != b'paragraph':
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	379 repo.ui.warn(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	380 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	381 b'changeset %s: unexpected block in release '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	382 b'notes directive %s\n'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	383 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	384 % (ctx, directive)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	385 )
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	386
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	387 if pblock[b'indent'] > 0:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	388 paragraphs.append(pblock[b'lines'])
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	389 else:
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	390 break
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	391
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	392 # TODO consider using title as paragraph for more concise notes.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	393 if not paragraphs:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	394 repo.ui.warn(
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43105 diff changeset	395 _(b"error parsing releasenotes for revision: '%s'\n")
46113 59fa3890d40a node: import symbols explicitly Joerg Sonnenberger <joerg@bec.de> parents: 45055 diff changeset	396 % hex(ctx.node())
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	397 )
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	398 if title:
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	399 notes.addtitleditem(directive, title, paragraphs)
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	400 else:
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	401 notes.addnontitleditem(directive, paragraphs)
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	402
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	403 return notes
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	404
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	405
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	406 def parsereleasenotesfile(sections, text):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	407 """Parse text content containing generated release notes."""
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	408 notes = parsedreleasenotes()
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	409
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	410 blocks = minirst.parse(text)[0]
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	411
33012 5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	412 def gatherparagraphsbullets(offset, title=False):
5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	413 notefragment = []
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	414
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	415 for i in range(offset + 1, len(blocks)):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	416 block = blocks[i]
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	417
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	418 if block[b'type'] == b'margin':
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	419 continue
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	420 elif block[b'type'] == b'section':
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	421 break
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	422 elif block[b'type'] == b'bullet':
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	423 if block[b'indent'] != 0:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	424 raise error.Abort(_(b'indented bullet lists not supported'))
33012 5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	425 if title:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	426 lines = [l[1:].strip() for l in block[b'lines']]
33012 5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	427 notefragment.append(lines)
5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	428 continue
5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	429 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	430 lines = [[l[1:].strip() for l in block[b'lines']]]
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	431
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	432 for block in blocks[i + 1 :]:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	433 if block[b'type'] in (b'bullet', b'section'):
33012 5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	434 break
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	435 if block[b'type'] == b'paragraph':
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	436 lines.append(block[b'lines'])
33012 5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	437 notefragment.append(lines)
5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	438 continue
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	439 elif block[b'type'] != b'paragraph':
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	440 raise error.Abort(
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43105 diff changeset	441 _(b'unexpected block type in release notes: %s')
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	442 % block[b'type']
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	443 )
33012 5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	444 if title:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	445 notefragment.append(block[b'lines'])
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	446
33012 5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	447 return notefragment
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	448
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	449 currentsection = None
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	450 for i, block in enumerate(blocks):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	451 if block[b'type'] != b'section':
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	452 continue
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	453
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	454 title = block[b'lines'][0]
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	455
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	456 # TODO the parsing around paragraphs and bullet points needs some
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	457 # work.
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	458 if block[b'underline'] == b'=': # main section
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	459 name = sections.sectionfromtitle(title)
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	460 if not name:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	461 raise error.Abort(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	462 _(b'unknown release notes section: %s') % title
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	463 )
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	464
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	465 currentsection = name
33012 5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	466 bullet_points = gatherparagraphsbullets(i)
5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	467 if bullet_points:
5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	468 for para in bullet_points:
5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	469 notes.addnontitleditem(currentsection, para)
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	470
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	471 elif block[b'underline'] == b'-': # sub-section
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	472 if title == BULLET_SECTION:
33012 5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	473 bullet_points = gatherparagraphsbullets(i)
5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	474 for para in bullet_points:
5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	475 notes.addnontitleditem(currentsection, para)
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	476 else:
33012 5814db57941c releasenotes: improve parsing around bullet points Rishabh Madan <rishabhmadan96@gmail.com> parents: 32778 diff changeset	477 paragraphs = gatherparagraphsbullets(i, True)
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	478 notes.addtitleditem(currentsection, title, paragraphs)
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	479 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	480 raise error.Abort(_(b'unsupported section type for %s') % title)
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	481
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	482 return notes
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	483
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	484
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	485 def serializenotes(sections, notes):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	486 """Serialize release notes from parsed fragments and notes.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	487
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	488 This function essentially takes the output of ``parsenotesfromrevisions()``
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	489 and ``parserelnotesfile()`` and produces output combining the 2.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	490 """
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	491 lines = []
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	492
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	493 for sectionname, sectiontitle in sections:
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	494 if sectionname not in notes:
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	495 continue
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	496
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	497 lines.append(sectiontitle)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	498 lines.append(b'=' * len(sectiontitle))
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	499 lines.append(b'')
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	500
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	501 # First pass to emit sub-sections.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	502 for title, paragraphs in notes.titledforsection(sectionname):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	503 lines.append(title)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	504 lines.append(b'-' * len(title))
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	505 lines.append(b'')
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	506
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	507 for i, para in enumerate(paragraphs):
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	508 if i:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	509 lines.append(b'')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	510 lines.extend(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	511 stringutil.wrap(b' '.join(para), width=78).splitlines()
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	512 )
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	513
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	514 lines.append(b'')
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	515
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	516 # Second pass to emit bullet list items.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	517
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	518 # If the section has titled and non-titled items, we can't
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	519 # simply emit the bullet list because it would appear to come
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	520 # from the last title/section. So, we emit a new sub-section
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	521 # for the non-titled items.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	522 nontitled = notes.nontitledforsection(sectionname)
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	523 if notes.titledforsection(sectionname) and nontitled:
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	524 # TODO make configurable.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	525 lines.append(BULLET_SECTION)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	526 lines.append(b'-' * len(BULLET_SECTION))
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	527 lines.append(b'')
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	528
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	529 for paragraphs in nontitled:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	530 lines.extend(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	531 stringutil.wrap(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	532 b' '.join(paragraphs[0]),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	533 width=78,
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	534 initindent=b'* ',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	535 hangindent=b' ',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	536 ).splitlines()
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	537 )
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	538
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	539 for para in paragraphs[1:]:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	540 lines.append(b'')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	541 lines.extend(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	542 stringutil.wrap(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	543 b' '.join(para),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	544 width=78,
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	545 initindent=b' ',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	546 hangindent=b' ',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	547 ).splitlines()
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	548 )
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	549
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	550 lines.append(b'')
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	551
33784 589fda7895da releasenotes: minor bug fix for index error while serializing Rishabh Madan <rishabhmadan96@gmail.com> parents: 33698 diff changeset	552 if lines and lines[-1]:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	553 lines.append(b'')
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	554
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	555 return b'\n'.join(lines)
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	556
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	557
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	558 @command(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	559 b'releasenotes',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	560 [
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	561 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	562 b'r',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	563 b'rev',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	564 b'',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	565 _(b'revisions to process for release notes'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	566 _(b'REV'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	567 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	568 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	569 b'c',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	570 b'check',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	571 False,
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	572 _(b'checks for validity of admonitions (if any)'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	573 _(b'REV'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	574 ),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	575 (
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	576 b'l',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	577 b'list',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	578 False,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	579 _(b'list the available admonitions with their title'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	580 None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	581 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	582 ],
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	583 _(b'hg releasenotes [-r REV] [-c] FILE'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	584 helpcategory=command.CATEGORY_CHANGE_NAVIGATION,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	585 )
33881 6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	586 def releasenotes(ui, repo, file_=None, **opts):
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	587 """parse release notes from commit messages into an output file
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	588
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	589 Given an output file and set of revisions, this command will parse commit
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	590 messages for release notes then add them to the output file.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	591
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	592 Release notes are defined in commit messages as ReStructuredText
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	593 directives. These have the form::
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	594
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	595 .. directive:: title
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	596
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	597 content
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	598
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	599 Each ``directive`` maps to an output section in a generated release notes
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	600 file, which itself is ReStructuredText. For example, the ``.. feature::``
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	601 directive would map to a ``New Features`` section.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	602
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	603 Release note directives can be either short-form or long-form. In short-
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	604 form, ``title`` is omitted and the release note is rendered as a bullet
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	605 list. In long form, a sub-section with the title ``title`` is added to the
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	606 section.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	607
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	608 The ``FILE`` argument controls the output file to write gathered release
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	609 notes to. The format of the file is::
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	610
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	611 Section 1
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	612 =========
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	613
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	614 ...
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	615
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	616 Section 2
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	617 =========
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	618
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	619 ...
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	620
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	621 Only sections with defined release notes are emitted.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	622
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	623 If a section only has short-form notes, it will consist of bullet list::
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	624
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	625 Section
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	626 =======
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	627
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	628 * Release note 1
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	629 * Release note 2
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	630
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	631 If a section has long-form notes, sub-sections will be emitted::
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	632
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	633 Section
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	634 =======
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	635
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	636 Note 1 Title
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	637 ------------
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	638
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	639 Description of the first long-form note.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	640
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	641 Note 2 Title
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	642 ------------
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	643
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	644 Description of the second long-form note.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	645
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	646 If the ``FILE`` argument points to an existing file, that file will be
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	647 parsed for release notes having the format that would be generated by this
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	648 command. The notes from the processed commit messages will be merged
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	649 into this parsed set.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	650
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	651 During release notes merging:
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	652
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	653 * Duplicate items are automatically ignored
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	654 * Items that are different are automatically ignored if the similarity is
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	655 greater than a threshold.
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	656
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	657 This means that the release notes file can be updated independently from
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	658 this command and changes should not be lost when running this command on
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	659 that file. A particular use case for this is to tweak the wording of a
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	660 release note after it has been added to the release notes file.
34341 01e8ab4b6573 releasenotes: update docstrings with information on additional flags Rishabh Madan <rishabhmadan96@gmail.com> parents: 34340 diff changeset	661
01e8ab4b6573 releasenotes: update docstrings with information on additional flags Rishabh Madan <rishabhmadan96@gmail.com> parents: 34340 diff changeset	662 The -c/--check option checks the commit message for invalid admonitions.
01e8ab4b6573 releasenotes: update docstrings with information on additional flags Rishabh Madan <rishabhmadan96@gmail.com> parents: 34340 diff changeset	663
01e8ab4b6573 releasenotes: update docstrings with information on additional flags Rishabh Madan <rishabhmadan96@gmail.com> parents: 34340 diff changeset	664 The -l/--list option, presents the user with a list of existing available
01e8ab4b6573 releasenotes: update docstrings with information on additional flags Rishabh Madan <rishabhmadan96@gmail.com> parents: 34340 diff changeset	665 admonitions along with their title. This also includes the custom
01e8ab4b6573 releasenotes: update docstrings with information on additional flags Rishabh Madan <rishabhmadan96@gmail.com> parents: 34340 diff changeset	666 admonitions (if any).
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	667 """
35003 e68dd1909af3 py3: handle keyword arguments in hgext/releasenotes.py Pulkit Goyal <7895pulkit@gmail.com> parents: 34813 diff changeset	668
e68dd1909af3 py3: handle keyword arguments in hgext/releasenotes.py Pulkit Goyal <7895pulkit@gmail.com> parents: 34813 diff changeset	669 opts = pycompat.byteskwargs(opts)
33571 9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	670 sections = releasenotessections(ui, repo)
34340 741a511492d3 releasenotes: raise error on simultaneous usage of flags Rishabh Madan <rishabhmadan96@gmail.com> parents: 33940 diff changeset	671
44194 d4c1501225c4 cmdutil: change check_incompatible_arguments() arg to single iterable Martin von Zweigbergk <martinvonz@google.com>* parents: 43898 diff changeset	672 cmdutil.check_incompatible_arguments(opts, b'list', [b'rev', b'check'])
34340 741a511492d3 releasenotes: raise error on simultaneous usage of flags Rishabh Madan <rishabhmadan96@gmail.com> parents: 33940 diff changeset	673
43898 023ad45e2fd2 releasenotes: extract helper for checking for incompatible arguments Martin von Zweigbergk <martinvonz@google.com> parents: 43117 diff changeset	674 if opts.get(b'list'):
33940 2a37459aedf2 releasenotes: view admonition titles using -l flag Rishabh Madan <rishabhmadan96@gmail.com> parents: 33881 diff changeset	675 return _getadmonitionlist(ui, sections)
2a37459aedf2 releasenotes: view admonition titles using -l flag Rishabh Madan <rishabhmadan96@gmail.com> parents: 33881 diff changeset	676
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	677 rev = opts.get(b'rev')
48116 5ced12cfa41b errors: raise InputError on bad revset to revrange() iff provided by the user Martin von Zweigbergk <martinvonz@google.com> parents: 47847 diff changeset	678 revs = logcmdutil.revrange(repo, [rev or b'not public()'])
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	679 if opts.get(b'check'):
33881 6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	680 return checkadmonitions(ui, repo, sections.names(), revs)
6a49c74b1e8f releasenotes: add check flag for use of admonitions and its validity Rishabh Madan <rishabhmadan96@gmail.com> parents: 33784 diff changeset	681
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	682 incoming = parsenotesfromrevisions(repo, sections.names(), revs)
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	683
34404 159a6f7e09a9 releasenotes: display release notes when no filename is specified Rishabh Madan <rishabhmadan96@gmail.com> parents: 34341 diff changeset	684 if file_ is None:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	685 ui.pager(b'releasenotes')
34404 159a6f7e09a9 releasenotes: display release notes when no filename is specified Rishabh Madan <rishabhmadan96@gmail.com> parents: 34341 diff changeset	686 return ui.write(serializenotes(sections, incoming))
159a6f7e09a9 releasenotes: display release notes when no filename is specified Rishabh Madan <rishabhmadan96@gmail.com> parents: 34341 diff changeset	687
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	688 try:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	689 with open(file_, b'rb') as fh:
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	690 notes = parsereleasenotesfile(sections, fh.read())
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	691 except IOError as e:
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	692 if e.errno != errno.ENOENT:
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	693 raise
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	694
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	695 notes = parsedreleasenotes()
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	696
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	697 notes.merge(ui, incoming)
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	698
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	699 with open(file_, b'wb') as fh:
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	700 fh.write(serializenotes(sections, notes))
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	701
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 41759 diff changeset	702
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	703 @command(b'debugparsereleasenotes', norepo=True)
33571 9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	704 def debugparsereleasenotes(ui, path, repo=None):
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	705 """parse release notes and print resulting data structure"""
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	706 if path == b'-':
45055 4c1b4805db57 pycompat: change users of pycompat.{stdin,stdout,stderr} to use procutil.std* Manuel Jacob <me@manueljacob.de> parents: 44194 diff changeset	707 text = procutil.stdin.read()
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	708 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	709 with open(path, b'rb') as fh:
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	710 text = fh.read()
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	711
33571 9a944e908ecf releasenotes: add custom admonitions support for release notes Rishabh Madan <rishabhmadan96@gmail.com> parents: 33012 diff changeset	712 sections = releasenotessections(ui, repo)
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	713
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	714 notes = parsereleasenotesfile(sections, text)
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	715
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	716 for section in notes:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	717 ui.write(_(b'section: %s\n') % section)
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	718 for title, paragraphs in notes.titledforsection(section):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	719 ui.write(_(b' subsection: %s\n') % title)
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	720 for para in paragraphs:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	721 ui.write(_(b' paragraph: %s\n') % b' '.join(para))
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	722
91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	723 for paragraphs in notes.nontitledforsection(section):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	724 ui.write(_(b' bullet point:\n'))
32778 91e355a0408b releasenotes: command to manage release notes files Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	725 for para in paragraphs:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	726 ui.write(_(b' paragraph: %s\n') % b' '.join(para))

Mercurial > public > mercurial-scm > hg

annotate hgext/releasenotes.py @ 48946:642e31cb55f0