k.vۦ FdZddlZddlZddlmZddlmZddlmZddl m Z m Z m Z m Z mZmZmZmZddlmZmZiZej,eZ ddlZej05ej2dd ed ddlmZej:dddd Zd edfdedfdedfdedfdedfgZ ejBdejDZ#dZ$edZ%GddZ&GddZ'dZ(dZ)d Z*d!Z+d"Z,d#Z-d$Z.d%Z/d&Z0d'Z1d(Z2d)Z3ed*d+d,d-ed.ed/fd0d1d2ed3ed/fd4d5d2ed6dfged7ejh8d>d9Z5ed:d;<d>d=Z6y#1swYxYw#e$rdZY wxYw)?a/generate release notes from commit messages (EXPERIMENTAL) It is common to maintain files detailing changes in a project between releases. Maintaining these files can be difficult and time consuming. The :hg:`releasenotes` command provided by this extension makes the process simpler by automating it. N)_)open)hex)cmdutilconfigerror logcmdutilminirstpycompat registrarutil)procutil stringutilignorez.*python-Levenshtein.*zfuzzywuzzy.fuzz)actionmessagecategorymodulesships-with-hg-coresfeatures New FeaturessbcsBackwards Compatibility Changesfixs Bug FixessperfsPerformance Improvementssapis API Changess#^\.\. ([a-zA-Z0-9_]+)::\s*([^$]+)?$s\bissue ?[0-9]{4,6}(?![0-9])\bs Other ChangescBeZdZdZdZdZdZdZdZdZ dZ d Z y ) parsedreleasenotesci|_yNsectionsselfs 6usr/lib/python3.12/site-packages/hgext/releasenotes.py__init__zparsedreleasenotes.__init__Ps  c||jvSrrrsections r __contains__zparsedreleasenotes.__contains__Ss$--''r c>tt|jSr)itersortedrrs r__iter__zparsedreleasenotes.__iter__VsF4==)**r c|jj|ggf|j|dj||fy)z Add a titled release note entry.rNr setdefaultappend)rr#title paragraphss r addtitleditemz parsedreleasenotes.addtitleditemYs;   2r(3 gq!((%)<=r c|jj|ggf|j|dj|y)z[Adds a non-titled release note entry. Will be rendered as a bullet point. Nr*)rr#r.s raddnontitleditemz#parsedreleasenotes.addnontitleditem^s8   2r(3 gq!((4r cD|jj|ggfdS)z|Returns titled entries in a section. Returns a list of (title, paragraphs) tuples describing sub-sections. rrgetr"s rtitledforsectionz#parsedreleasenotes.titledforsectionfs$ }}  2r(3A66r cD|jj|ggfdS)z5Returns non-titled, bulleted paragraphs in a section.r1r4r"s rnontitledforsectionz&parsedreleasenotes.nontitledforsectionms"}}  2r(3A66r cJtfd|j|DS)Nc3.K|] }|dk(yw)rN).0tr-s r z8parsedreleasenotes.hastitledinsection..rsI*HQ1Q45=*Hs)anyr6)rr#r-s `rhastitledinsectionz%parsedreleasenotes.hastitledinsectionqsI$*?*?*HIIIr cts|jtd|D]N}t|j |t |j |z}|j |D]\}}|j||r |jtd||fz8t||fgd}|dk(rt|}|rt|||rit|||rw|j||||j |D]e}||j |vrt |gd}|dk(rt|}|rt|||rFt|||rT|j||gQy)z{Merge another instance into this one. This is used to combine multiple sources of release notes together. sKmodule 'fuzzywuzzy' not found, merging of similar releasenotes is disabled s*%s already exists in %s section; ignoring rrN)fuzzwarnr converttitledr6convertnontitledr8r@write getissuenum findissuesimilarr/r2) ruiotherr# existingnotesr-r. incoming_strissues rmergezparsedreleasenotes.mergets  GG2 G)%%g. !9!9'!BCDM&+%;%;G%D!z**7E:HHHI '*+,uj.A-BCAF f$' 5E$R>$2}l;""7E:>)&E,$77@ !9!9'!BB/ =a@ f$' 5E$R>$2}l;%%gz:A5r N) __name__ __module__ __qualname__rr$r(r/r2r6r8r@rOr;r rrrOs0(+> 577J5;r rc&eZdZddZdZdZdZy)releasenotessectionsNc|rVtjt}t|}|r|j |t |j |_yt t|_yr)r sortdictDEFAULT_SECTIONSgetcustomadmonitionsupdatelistitems _sections)rrJreporcustom_sectionss rrzreleasenotessections.__init__sM }}%56H248O0!(.."23DN!"23DNr c,t|jSr)r&r\rs rr(zreleasenotessections.__iter__sDNN##r cF|jDcgc]}|d c}Scc}w)Nrr\)rr=s rnameszreleasenotessections.namess""nn-n!n---s c>|jD]\}}||k(s |cSyrra)rr-namevalues rsectionfromtitlez%releasenotessections.sectionfromtitles%>>KD%~ *r r)rPrQrRrr(rbrfr;r rrTrTs4$.r rTcg}|D]?\}}g}|D]}|j||jdj|A|S)z. Convert titled paragraphs to strings  extendr,join)titledparagraphs string_listr-r.linesparas rrDrDsRK-zD LL 499U+, . r cg}|D]<}g}|D]}|j||jdj|>|S)z/ Convert non-titled bullets to strings rhri)nontitledparagraphsrmr.rnros rrErEsMK) D LL 499U+, * r c|tjt|tj}|r|j }|S)zD Returns issue number from the incoming string if it exists )researchRE_ISSUE IGNORECASEgroup)rMrNs rrGrGs- IIh bmm zfindissue..s (x!5A:xss'"%s" already exists in notes; ignoring TF)r?rFr)rJexistingrNs `rrHrHs0 (x (( >?%GHr ct|jdkDr-t||}|s|jt d|zyyy)z? Returns true if similar note found in existing notes. s,"%s" already exists in notes file; ignoring TF)lensplitsimilaritycheckrFr)rJr{rMrOs rrIrIsQ <    2% h7 HHBC r cftsyd}|D]"}tj||}|dkDsd}|S|S)zK Returns false when note fragment can be merged to existing notes. TKF)rBtoken_set_ratio)rMrLrObulletscores rrrsF  E$$\6: 2:E  L  Lr cdtjdfd dvrdjdS)N.c|vr)|j}j||||ytjt dj |z)Ns#.hgreleasenotes file '%s' not found)dataparserAbortrpathto)frremaprctxpreadr]s rrz"getcustomadmonitions..readsT 8q6;;=D GGAtXud 3++:;dkk!nL r s.hgreleasenotesssections)NN)rr[)r]rrrs`@@@rrXrXsC t*C AS   77; r c: |D]}||}tjt|j s4 j d|vrH|j t d j d|jddfz fd}|Dcgc]}||dkDs|}}t|dk(r!|j t d|dz|sd jt|} |j t d | zycc}w) a` Checks the commit messages for admonitions and their validity. .. abcd:: First paragraph under this admonition For this commit message, using `hg releasenotes -r . --check` returns: Invalid admonition 'abcd' present in changeset 3ea92981e103 As admonition 'abcd' is neither present in default nor custom admonitions r1s0Invalid admonition '%s' present in changeset %s N cltjdjd|jS)Nr1)difflibSequenceMatcherrwratio)x admonitions rz"checkadmonitions..As. 7 7***1-q!%'!r g333333?s(did you mean %s?) rs, s(did you mean one of %s?) ) rsrt RE_DIRECTIVE descriptionrwrFrrr~rkr') rJr] directivesrevsrevrsimrzrIssrs @rcheckadmonitionsr)s3iYY|S__->? "j0JK!''*CGGIcrN;<'1AjCFSL1jAw<1$HHQ67'!*DEF7O4BHHQ=>CD)Bs D%DcJ|D]}|jd|d|dfz y)Ns%s: %s rr1)rF)rJrr#s r_getadmonitionlistrMs*  GAJ778r c Lt}|D]}||}tj|j|\}}t |D]T\}} | ddk7r| d} | dr| ddj nd} |dzt |k(r#tjtd|| fzg} t|dzt |D]i} || }|dd k(r|ddk(rnQ|dd k7r)|jjtd || fz|d dkDr| j|din| s>|jjtd t|jz| r|j!| | | C|j#| | W|S)N) admonitionstypes admonitionsadmonitiontitlelinesrr1s6changeset %s: release notes directive %s lacks contentmargin paragraphs=changeset %s: unexpected block in release notes directive %s indents.error parsing releasenotes for revision: '%s' )rr rr enumeratestripr~rrrrangerJrCr,rnoder/r2)r]rrnotesrrblocksprunediblock directiver-r.jpblocks rparsenotesfromrevisionsrRs  E3i  OO : "&)HAuW~.01I27/E(OA&,,.tE1uF #kk)I& 'J1q5#f+.'?i/'?m3'?l2GGLL4 * +)$q(%%fX&67-/2 HI#((*o&##IujA&&y*=i*z Lr cJ t}tj|d d fd }d}t D]\}}|ddk7r|dd}|ddk(r[|j |}|s!t j td |z|}||} | s`| D]} |j|| z|dd k(rH|tk(r"||} | D]} |j|| ||d } |j||| t j td |z|S)z6Parse text content containing generated release notes.rcg}t|dztD]/}|}|ddk(r|ddk(r|S|ddk(r|ddk7rtjt d|r5|d Dcgc]}|ddj }}|j ||d Dcgc]}|ddj c}g}|dzdD](}|dd vrn|dd k(s|j |d *|j ||dd k7r$tjt d |dz|s|j |d 2|Scc}wcc}w) Nr1rrsectionbulletrrs#indented bullet lists not supportedr)rrrs*unexpected block type in release notes: %s)rr~rrrrr,)offsetr- notefragmentrrlrnrs rgatherparagraphsbulletsz6parsereleasenotesfile..gatherparagraphsbulletss vz3v;/A1IEW~*w:-43w9,#q(++a(N&OPP49(ODOqQqrU[[]OED ''.5:8_E_aekkm_EFE!'A >-DD! >\9!LLx9 "1 !''.w</kkCDGn%##E(O4=0@+EFs 0E%ENrrrs underline=s!unknown release notes section: %s-Tsunsupported section type for %s)F) rr rrrfrrrr2BULLET_SECTIONr/) rtextrrcurrentsectionrrr-rd bullet_pointsror.rs @rparsereleasenotesfilersG  E ]]4  #F#JNf%5 >Z ' h"  $ &,,U3Dkk:;eC"N3A6M)D**>4@*< D (& 7 : )D**>4@*5Q= ##NE:F++a BCeKL L=&@ Lr c g}|D]G\}}||vr |j||jdt|z|jd|j|D]\}}|j||jdt|z|jdt|D][\}}|r|jd|j t j dj|dj]|jd|j|} |j|rI| rG|jt|jdttz|jd| D]}|j t j dj|dddd j|d d D]X}|jd|j t j dj|dd d jZ|jdJ|r|d r|jddj|S)zSerialize release notes from parsed fragments and notes. This function essentially takes the output of ``parsenotesfromrevisions()`` and ``parserelnotesfile()`` and produces output combining the 2. rr rrhN)widthrs* s )r initindent hangindentr1N ) r,r~r6rrjrwraprk splitlinesr8r) rrrn sectionname sectiontitler-r.rro nontitleds rserializenotesrs E%-! \ e #  \" TC --. S"'!7!7 !D E: LL  LLE * + LL $Z04LL% OODIIdO2>IIK1 LL "E(--k:  ! !+ .9 LL ( LLN 33 4 LL #J LLIIjm,$$  *,  #12 S! OO $ #(#(  !jl ' LL +$I&.v r S ::e r releasenotesrrevr s&revisions to process for release notessREVccheckFs+checks for validity of admonitions (if any)llists/list the available admonitions with their titles"hg releasenotes [-r REV] [-c] FILE) helpcategoryc <tj|}t||}tj|dddg|j dr t ||S|j d}tj||xsdg}|j drt|||j|St||j|}|,|jd|jt||S t|d5}t!||j#} ddd j)||t|d5}|jt|| dddy#1swYLxYw#t$$r t'} YdwxYw#1swYyxYw) a parse release notes from commit messages into an output file Given an output file and set of revisions, this command will parse commit messages for release notes then add them to the output file. Release notes are defined in commit messages as ReStructuredText directives. These have the form:: .. directive:: title content Each ``directive`` maps to an output section in a generated release notes file, which itself is ReStructuredText. For example, the ``.. feature::`` directive would map to a ``New Features`` section. Release note directives can be either short-form or long-form. In short- form, ``title`` is omitted and the release note is rendered as a bullet list. In long form, a sub-section with the title ``title`` is added to the section. The ``FILE`` argument controls the output file to write gathered release notes to. The format of the file is:: Section 1 ========= ... Section 2 ========= ... Only sections with defined release notes are emitted. If a section only has short-form notes, it will consist of bullet list:: Section ======= * Release note 1 * Release note 2 If a section has long-form notes, sub-sections will be emitted:: Section ======= Note 1 Title ------------ Description of the first long-form note. Note 2 Title ------------ Description of the second long-form note. If the ``FILE`` argument points to an existing file, that file will be parsed for release notes having the format that would be generated by this command. The notes from the processed commit messages will be *merged* into this parsed set. During release notes merging: * Duplicate items are automatically ignored * Items that are different are automatically ignored if the similarity is greater than a threshold. This means that the release notes file can be updated independently from this command and changes should not be lost when running this command on that file. A particular use case for this is to tweak the wording of a release note after it has been added to the release notes file. The -c/--check option checks the commit message for invalid admonitions. The -l/--list option, presents the user with a list of existing available admonitions along with their title. This also includes the custom admonitions (if any). rrrs not public()Nrrbswb)r byteskwargsrTrcheck_incompatible_argumentsr5rr revrangerrbrpagerrFrrrrFileNotFoundErrorrrO) rJr]file_optsrrrincomingfhrs r releasenotesr-s`^    %D#B-H ((w8JK xx!"h// ((6 C   tc&<_%= >D xxD(..*:DAA&tX^^-=tDH } !xxx:;;% % 2)(BGGI>E  KKH eU r %01    %"$%  s6; E9E-"E9F-E62E99FFFsdebugparsereleasenotesT)norepoc |dk(rtjj}n%t|d5}|j}dddt ||}t |}|D]}|j td|z|j|D]U\}} |j td|z| D].} |j tddj| z0W|j|D]O} |j td| D].} |j tddj| z0Qy#1swYxYw) z6parse release notes and print resulting data structurerrNs section: %s s subsection: %s s paragraph: %s rhs bullet point: ) rstdinrrrTrrFrr6rkr8) rJpathr]rrrrr#r-r.ros rdebugparsereleasenotesrs* t|~~""$ $ "779D$B-H !(D 1E #$w./!&!7!7!@ E: HHQ,-5 6"12TYYt_DE#"A  33Grs7  #     )  H %  ", $   '  #$# ?#$ A0 12 Q|_ a+,- Q~  rzzA2<<P -#$Z;Z;z2  $" $!EH9 @FL^FR     7 8 fI      < = fI      @ A   .+,3358o298o2d "40F1F_ # " Ds*F#)F  F FFF F