Part of twisted.python View Source
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).
Function | runCommand | Execute a vector of arguments. |
Class | CommandFailed | Raised when a child process exits unsuccessfully. |
Function | getNextVersion | Calculate the version number for a new release of Twisted based on the previous version number. |
Function | changeAllProjectVersions | Change the version of all projects (including core and all subprojects). |
Class | Project | A representation of a project that has a version. |
Function | findTwistedProjects | Find all Twisted-style projects beneath a base directory. |
Function | generateVersionFileData | Generate the data to be placed into a _version.py file. |
Function | replaceProjectVersion | Write version specification code into the given filename, which sets the version to the given version number. |
Function | replaceInFile | I replace the text `oldstr' with `newstr' in `filename' using science. |
Class | NoDocumentsFound | Raised when no input documents are found. |
Class | LoreBuilderMixin | Base class for builders which invoke lore. |
Class | DocBuilder | Generate HTML documentation for projects. |
Class | ManBuilder | Generate man pages of the different existing scripts. |
Class | APIBuilder | No summary |
Class | BookBuilder | Generate the LaTeX and PDF documentation. |
Class | NewsBuilder | Generate the new section of a NEWS file. |
Function | filePathDelta | Return a list of strings that represent destination as a
path relative to origin . |
Class | DistributionBuilder | A builder of Twisted distributions. |
Class | UncleanWorkingDirectory | Raised when the working directory of an SVN checkout is unclean. |
Class | NotWorkingDirectory | Raised when a directory does not appear to be an SVN working directory. |
Function | buildAllTarballs | Build complete tarballs (including documentation) for Twisted and all subprojects. |
Class | ChangeVersionsScriptOptions | Options for ChangeVersionsScript . |
Class | ChangeVersionsScript | A thing for changing version numbers. See main . |
Class | BuildTarballsScript | A thing for building release tarballs. See main . |
Class | BuildAPIDocsScript | A thing for building API documentation. See main . |
Function | _changeVersionInFile | Replace the old version number with the new
one in the given filename . |
Parameters | args | A list of arguments, the first of which will be used as the executable to
run. (type: list of str ) |
Returns | All of the standard output. (type: str ) | |
Raises | CommandFailed | when the program exited with a non-0 exit code. |
old
version number with the new
one in the given filename
.Parameters | version | The previous version number. |
prerelease | If True , make the next version a pre-release one. If
version is a pre-release, it increments the pre-release
counter, otherwise create a new version with prerelease set to 1. (type: bool ) | |
patch | If True , make the next version a patch release. It increments
the micro counter. (type: bool ) | |
today | The current date. (type: datetime ) |
If the current version of a project is pre-release, then also change the versions in the current NEWS entries for that project.
Parameters | root | The root of the Twisted source tree. (type: FilePath ) |
prerelease | (type: bool ) | |
patch | (type: bool ) | |
today | Defaults to the current day, according to the system clock. (type: datetime ) |
Parameters | baseDirectory | A twisted.python.filepath.FilePath
to look inside. |
Returns | A list of Project . |
Parameters | version | A version object. |
Parameters | filename | A filename which is most likely a "_version.py" under some Twisted project. |
newversion | A version object. |
destination
as a
path relative to origin
.
It is assumed that both paths represent directories, not files. That is
to say, the delta of twisted.python.filepath.FilePath
/foo/bar to twisted.python.filepath.FilePath
/foo/baz will be ../baz
, not baz
.
Parameters | origin | The origin of the relative path. (type: twisted.python.filepath.FilePath ) |
destination | The destination of the relative path. (type: twisted.python.filepath.FilePath ) |
This should be called after the version numbers have been updated and NEWS files created.
Parameters | checkout | The SVN working copy from which a pristine source tree will be exported. (type: FilePath ) |
destination | The directory in which tarballs will be placed. (type: FilePath ) | |
templatePath | Location of the template file that is used for the howto documentation. (type: FilePath ) | |
Raises | UncleanWorkingDirectory | If there are modifications to the working directory of
checkout . |
NotWorkingDirectory | If the checkout path is not an SVN checkout. |