Architecture¶
Class Overview¶
General Classes¶
Standard Yabs Classes¶
Workflow Tasks¶
Workflow Tasks¶
Context Variables¶
TaskContext
- inc (str)
…
- repo (str)
The GitHub repository name, e.g. “mar10/wsgidav”.
Back to top
digraph inheritanceeb82e8ae29 {
bgcolor=transparent;
rankdir=LR;
size="8.0, 12.0";
"abc.ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"];
"task_runner.TaskInstance" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"task_runner.TaskRunner" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"util.CheckError" [URL="rg_mod_yabs.html#yabs.util.CheckError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="--check condition failed."];
"util.ExitingYabsError" -> "util.CheckError" [arrowsize=0.5,style="setlinewidth(0.5)"];
"util.ConfigError" [URL="rg_mod_yabs.html#yabs.util.ConfigError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Invalid yabs.yaml or command line (terminates without stacktrace)."];
"util.ExitingYabsError" -> "util.ConfigError" [arrowsize=0.5,style="setlinewidth(0.5)"];
"util.ExitingYabsError" [URL="rg_mod_yabs.html#yabs.util.ExitingYabsError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="YabsError the will cause sys.exit()."];
"util.YabsError" -> "util.ExitingYabsError" [arrowsize=0.5,style="setlinewidth(0.5)"];
"util.FolderContentMonitor" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"util.NO_DEFAULT" [URL="rg_mod_yabs.html#yabs.util.NO_DEFAULT",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Used as default parameter to distinguish from `None`."];
"util.YabsError" [URL="rg_mod_yabs.html#yabs.util.YabsError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for all exception that we deliberatly throw."];
"version_manager.PyprojectTomlParser" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Read/write version numbers from pyproject.toml files."];
"version_manager.VersionFileParser" -> "version_manager.PyprojectTomlParser" [arrowsize=0.5,style="setlinewidth(0.5)"];
"version_manager.SafeFileWriter" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Open a file for writing, create a backup and prevent corruption on errors."];
"version_manager.SetupCfgFileParser" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Read/write version numbers from setup.cfg files."];
"version_manager.VersionFileParser" -> "version_manager.SetupCfgFileParser" [arrowsize=0.5,style="setlinewidth(0.5)"];
"version_manager.TextFileParser" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Read/write version numbers from plain text files."];
"version_manager.VersionFileParser" -> "version_manager.TextFileParser" [arrowsize=0.5,style="setlinewidth(0.5)"];
"version_manager.VersionFileManager" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Maintain a list of version locations."];
"version_manager.VersionFileParser" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for config file parsers."];
"abc.ABC" -> "version_manager.VersionFileParser" [arrowsize=0.5,style="setlinewidth(0.5)"];
}
digraph inheritancef183fdc759 {
bgcolor=transparent;
rankdir=LR;
size="8.0, 12.0";
"abc.ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"];
"task.bump.BumpTask" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"task.common.WorkflowTask" -> "task.bump.BumpTask" [arrowsize=0.5,style="setlinewidth(0.5)"];
"task.check.CheckTask" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"task.common.WorkflowTask" -> "task.check.CheckTask" [arrowsize=0.5,style="setlinewidth(0.5)"];
"task.commit.CommitTask" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"task.common.WorkflowTask" -> "task.commit.CommitTask" [arrowsize=0.5,style="setlinewidth(0.5)"];
"task.common.ErrorTaskResult" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"task.common.OkTaskResult" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"task.common.SkipTaskResult" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"task.common.TaskContext" [URL="rg_mod_yabs.html#yabs.task.common.TaskContext",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Context information that is passed by the task runner to all tasks."];
"task.common.WarningTaskResult" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"task.common.WorkflowTask" [URL="rg_mod_yabs.html#yabs.task.common.WorkflowTask",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Common base class for all yabs tasks."];
"abc.ABC" -> "task.common.WorkflowTask" [arrowsize=0.5,style="setlinewidth(0.5)"];
"task.exec.ExecTask" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"task.common.WorkflowTask" -> "task.exec.ExecTask" [arrowsize=0.5,style="setlinewidth(0.5)"];
"task.github_release.GithubReleaseTask" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"task.common.WorkflowTask" -> "task.github_release.GithubReleaseTask" [arrowsize=0.5,style="setlinewidth(0.5)"];
"task.push.PushTask" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"task.common.WorkflowTask" -> "task.push.PushTask" [arrowsize=0.5,style="setlinewidth(0.5)"];
"task.pypi_release.PypiReleaseTask" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"task.common.WorkflowTask" -> "task.pypi_release.PypiReleaseTask" [arrowsize=0.5,style="setlinewidth(0.5)"];
"task.tag.TagTask" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"task.common.WorkflowTask" -> "task.tag.TagTask" [arrowsize=0.5,style="setlinewidth(0.5)"];
"task.winget_release.WingetReleaseTask" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"];
"task.common.WorkflowTask" -> "task.winget_release.WingetReleaseTask" [arrowsize=0.5,style="setlinewidth(0.5)"];
}