o bI@s$dZddlZddlZddlmZmZmZddlmZddl m Z m Z ddl m Z ddlmZgdZgd Zd d ZGd d d e Ze eGdddZddZGdddZddZddZGdddeZGdddZGdddZddZGd d!d!eZGd"d#d#ZGd$d%d%Z dS)&aL Twisted's automated release system. This module is only for use within Twisted's release system. If you are anyone else, do not use it. The interface and behaviour will change without notice. Only Linux is supported by this code. It should not be used by any tools which must run on multiple platforms (eg the setup.py script). N)STDOUTCalledProcessError check_output)Dict) Interface implementer)execfile)FilePath)docbugfixmiscfeatureremoval) z%https://docs.python.org/3/objects.invz-https://cryptography.io/en/latest/objects.invz6https://pyopenssl.readthedocs.io/en/stable/objects.invz6https://hyperlink.readthedocs.io/en/stable/objects.invz/https://twisted.org/constantly/docs/objects.invz0https://twisted.org/incremental/docs/objects.invz@https://python-hyper.org/projects/hyper-h2/en/stable/objects.invz5https://priority.readthedocs.io/en/stable/objects.invz:https://zopeinterface.readthedocs.io/en/latest/objects.invz4https://automat.readthedocs.io/en/latest/objects.invcKst|d<t|fi|S)aExecute a vector of arguments. This is a wrapper around L{subprocess.check_output}, so it takes the same arguments as L{subprocess.Popen} with one difference: all arguments after the vector must be keyword arguments. @param args: arguments passed to L{subprocess.check_output} @param kwargs: keyword arguments passed to L{subprocess.check_output} @return: command output @rtype: L{bytes} stderr)rr)argskwargsr9/usr/lib/python3/dist-packages/twisted/python/_release.py runCommand)s rc@s0eZdZdZddZddZddZdd Zd S) IVCSCommandz( An interface for VCS commands. cCdS)z Ensure that C{path} is a working directory of this VCS. @type path: L{twisted.python.filepath.FilePath} @param path: The path to check. NrpathrrrensureIsWorkingDirectory>z$IVCSCommand.ensureIsWorkingDirectorycCr) Return the Git status of the files in the specified path. @type path: L{twisted.python.filepath.FilePath} @param path: The path to get the status from (can be a directory or a file.) Nrrrrr isStatusCleanFrzIVCSCommand.isStatusCleancCr)z Remove the specified path from a the VCS. @type path: L{twisted.python.filepath.FilePath} @param path: The path to remove from the repository. NrrrrrremoveOrzIVCSCommand.removecCr)a Export the content of the VCSrepository to the specified directory. @type fromDir: L{twisted.python.filepath.FilePath} @param fromDir: The path to the VCS repository to export. @type exportDir: L{twisted.python.filepath.FilePath} @param exportDir: The directory to export the content of the repository to. This directory doesn't have to exist prior to exporting the repository. NrfromDir exportDirrrrexportToWrzIVCSCommand.exportToN)__name__ __module__ __qualname____doc__rrrr!rrrrr9s  rc@s@eZdZdZeddZeddZeddZedd Zd S) GitCommandzJ Subset of Git commands to release Twisted from a Git repository. c Cs<z tddg|jdWdSttfyt|jdw)z Ensure that C{path} is a Git working directory. @type path: L{twisted.python.filepath.FilePath} @param path: The path to check. gitz rev-parsecwdz( does not appear to be a Git repository.N)rrrOSErrorNotWorkingDirectoryrrrrrks z#GitCommand.ensureIsWorkingDirectorycCs tdd|jddg}|dkS)rr'-Cstatusz--short)rrstrip)rr-rrrrzs zGitCommand.isStatusCleancCstdd|d|jgdS)z Remove the specified path from a Git repository. @type path: L{twisted.python.filepath.FilePath} @param path: The path to remove from the repository. r'r,rmN)rdirnamerrrrrrszGitCommand.removec Cs$tdd|jdddd|jdgdS) a Export the content of a Git repository to the specified directory. @type fromDir: L{twisted.python.filepath.FilePath} @param fromDir: The path to the Git repository to export. @type exportDir: L{twisted.python.filepath.FilePath} @param exportDir: The directory to export the content of the repository to. This directory doesn't have to exist prior to exporting the repository. r'r,zcheckout-indexz--allz--forcez--prefix/N)rrrrrrr!s zGitCommand.exportToN) r"r#r$r% staticmethodrrrr!rrrrr&es    r&c Cs8zt|tWSttfyYnwtd|j)a Detect the VCS used in the specified directory and return a L{GitCommand} if the directory is a Git repository. If the directory is not git, it raises a L{NotWorkingDirectory} exception. @type directory: L{FilePath} @param directory: The directory to detect the VCS used from. @rtype: L{GitCommand} @raise NotWorkingDirectory: if no supported VCS can be found from the specified directory. z!No supported VCS can be found in )r&rr+r*r directoryrrrgetRepositoryCommands r6c@s.eZdZdZddZdefddZddZd S) ProjectaC A representation of a project that has a version. @ivar directory: A L{twisted.python.filepath.FilePath} pointing to the base directory of a Twisted-style Python package. The package should contain a C{_version.py} file and a C{newsfragments} directory that contains a C{README} file. cC ||_dSNr4)selfr5rrr__init__ zProject.__init__returncCs|jjd|jdS)N()) __class__r"r5)r:rrr__repr__szProject.__repr__cCsTi}|j}|s&|jdkrtd|dks|}n t|dj||r|dS)z @return: A L{incremental.Version} specifying the version number of the project based on live python modules. r2zNot inside a Twisted project.twistedz _version.py __version__)r5r Exceptionbasenameparentrchild)r: namespacer5rrr getVersions   zProject.getVersionN)r"r#r$r%r;strrArIrrrrr7s   r7cCs8g}|D]}|dkr|}|t|q|S)z Find all Twisted-style projects beneath a base directory. @param baseDirectory: A L{twisted.python.filepath.FilePath} to look inside. @return: A list of L{Project}. newsfragments)walkrErFappendr7) baseDirectoryprojectsfilePathprojectDirectoryrrrfindTwistedProjectss  rRcCst||dt|d }|}Wdn1swY|D] \}}|||}q&t|dd }||Wdn1sHwYt|d|t|ddS)zP I replace the text `oldstr' with `newstr' in `filename' using science. z.bakNz.neww)osrenameopenreaditemsreplacewriteunlink)filenameoldToNewfdkvrrr replaceInFiles  rbc@eZdZdZdS)NoDocumentsFoundz3 Raised when no input documents are found. Nr"r#r$r%rrrrrdrdc@seZdZdZddZdS) APIBuilderz Generate API documentation from source files using U{pydoctor}. This requires pydoctor to be installed and usable. c Csg}tD] }|d||qddlm}ttd} d|d|ddd |jd | jd |d |jd ddg|} | |j|| dS)ah Call pydoctor's entry point with options which will generate HTML documentation for the specified package's API. @type projectName: C{str} @param projectName: The name of the package for which to generate documentation. @type projectURL: C{str} @param projectURL: The location (probably an HTTP URL) of the project on the web. @type sourceURL: C{str} @param sourceURL: The location (probably an HTTP URL) of the root of the source browser for the project. @type packagePath: L{FilePath} @param packagePath: The path to the top-level of the package named by C{projectName}. @type outputPath: L{FilePath} @param outputPath: An existing directory to which the generated API documentation will be written. z --intersphinxr)main_pydoctortemplatesz--project-namez --project-urlz--system-classz&twisted.python._pydoctor.TwistedSystemz--project-base-dirz--template-dirz--html-viewsource-basez --html-outputz--quietz --make-htmlz--warnings-as-errorsN) intersphinxURLsrMpydoctor.driverrhr __file__rFrGr) r: projectName projectURL sourceURL packagePath outputPath intersphinxes intersphinxrh templatesPathrrrrbuilds8     zAPIBuilder.buildN)r"r#r$r%rurrrrrg s rgc@s"eZdZdZddZdddZdS) SphinxBuildera Generate HTML documentation using Sphinx. Generates and runs a shell command that looks something like:: sphinx-build -b html -d [BUILDDIR]/doctrees [DOCDIR]/source [BUILDDIR]/html where DOCDIR is a directory containing another directory called "source" which contains the Sphinx source files, and BUILDDIR is the directory in which the Sphinx output will be created. cCs>|t|dd}|rtjd|dtddS)a] Build the main documentation. @type args: list of str @param args: The command line arguments to process. This must contain one string argument: the path to the root of a Twisted checkout. Additional arguments will be ignored for compatibility with legacy build infrastructure. rdocszUnclean build:  N)rur rGsysstdoutrZexit)r:routputrrrrhZs   zSphinxBuilder.mainNc Cs|dur |d}|d}tddddd|j|j|jgd }||D],}|d krV||}|}|rE|| d }|s;| sQ| | |q*|S) a Build the documentation in C{docDir} with Sphinx. @param docDir: The directory of the documentation. This is a directory which contains another directory called "source" which contains the Sphinx "conf.py" file and sphinx source documents. @type docDir: L{twisted.python.filepath.FilePath} @param buildDir: The directory to build the documentation in. By default this will be a child directory of {docDir} named "build". @type buildDir: L{twisted.python.filepath.FilePath} @param version: The version of Twisted to set in the docs. @type version: C{str} @return: the output produced by running the command @rtype: L{str} Nr doctreesz sphinx-buildz-qz-bhtmlz-dzutf-8manr) rFrGrrdecoderrLrE segmentsFrompopisdirmakedirscopyTo) r:docDirbuildDirversion doctreeDirr}rsegmentsdestrrrruis:        zSphinxBuilder.build)Nr~)r"r#r$r%rhrurrrrrvKsrvcCshd}|jtj}|jtj}t||D] \}}||kr"|d7}qdgt||}|||dS)a4 Return a list of strings that represent C{destination} as a path relative to C{origin}. It is assumed that both paths represent directories, not files. That is to say, the delta of L{twisted.python.filepath.FilePath} /foo/bar to L{twisted.python.filepath.FilePath} /foo/baz will be C{../baz}, not C{baz}. @type origin: L{twisted.python.filepath.FilePath} @param origin: The origin of the relative path. @type destination: L{twisted.python.filepath.FilePath} @param destination: The destination of the relative path. rryz..N)rsplitrTsepziplen)origin destination commonItemspath1path2elem1elem2rrrr filePathDeltas rc@rc)r+zf Raised when a directory does not appear to be a repository directory of a supported VCS. Nrerrrrr+rfr+c@ eZdZdZddZddZdS)BuildAPIDocsScriptz> A thing for building API documentation. See L{main}. cCsJt|d}|}d|fd}t}|dd||d|dS)a Build the API documentation of Twisted, with our project policy. @param projectRoot: A L{FilePath} representing the root of the Twisted checkout. @param output: A L{FilePath} pointing to the desired output directory. rBz2https://github.com/twisted/twisted/tree/twisted-%sz/srcTwistedzhttps://twistedmatrix.com/N)r7rGrIbasergru)r: projectRootr}r versionStringro apiBuilderrrr buildAPIDocss zBuildAPIDocsScript.buildAPIDocscCs6t|dkr td|t|dt|ddS)a Build API documentation. @type args: list of str @param args: The command line arguments to process. This must contain two strings: the path to the root of the Twisted checkout, and a path to an output directory. zAMust specify two arguments: Twisted checkout and destination pathrryN)rrzr|rr )r:rrrrrhs  zBuildAPIDocsScript.mainN)r"r#r$r%rrhrrrrrs rc@r)CheckNewsfragmentScriptzE A thing for checking whether a checkout has a newsfragment. cCr8r9)_print)r:rrrrr;r<z CheckNewsfragmentScript.__init__c Cst|dkr tdtjjpd}tj|d}tgd|d | }tgd|d | }|s?| dtd| tj }| d |D]}| |qN| d t|dkrw|dtjgd krw| d tdg}|D]}tjd tj|vrd|vr|dddtvr||q{|dr|r| dtdn | dtdtjdddkr|r| dtdn | dtd|D]}| d|tdq| dtddS)z Run the script. @type args: L{list} of L{str} @param args: The command line arguments to process. This must contain one string: the path to the root of the Twisted checkout. ryz/Must specify one argument: the Twisted checkoutasciir)gits rev-parses --abbrev-refHEADr()rsdiffs --name-onlysorigin/trunk...s--diff-filter=dz9On trunk or no diffs from trunk; no need to look at this.zLooking at these files:z----)rwfunzTwisted.Quotesz+Quotes change only; no newsfragment needed.rK.zrelease-z1No newsfragments should be on the release branch.z/Release branch with no newsfragments, all good.GITHUB_HEAD_REFr~zpre-commit-ci-update-configzs2    ,G!AR,