starred/certbot-certbot-2
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-08-02 00:22:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

Explictly state assumptions made by certbot

Browse Source
This commit is contained in:
Brad Warren
2016-06-23 16:14:34 -07:00
parent 9514221a6d
commit cb441606d5
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
certbot/interfaces.py
+8 -2
View File
@@ -180,6 +180,9 @@ class IAuthenticator(IPlugin):
def cleanup(achalls): def cleanup(achalls):
"""Revert changes and shutdown after challenges complete. """Revert changes and shutdown after challenges complete.
This method should be able to revert all changes made by
perform, even if perform exited abnormally.
:param list achalls: Non-empty (guaranteed) list of :param list achalls: Non-empty (guaranteed) list of
:class:`~certbot.achallenges.AnnotatedChallenge` :class:`~certbot.achallenges.AnnotatedChallenge`
instances, a subset of those previously passed to :func:`perform`. instances, a subset of those previously passed to :func:`perform`.
@@ -304,8 +307,11 @@ class IInstaller(IPlugin):
Both title and temporary are needed because a save may be Both title and temporary are needed because a save may be
intended to be permanent, but the save is not ready to be a full intended to be permanent, but the save is not ready to be a full
checkpoint. If an exception is raised, it is assumed a new checkpoint.
checkpoint was not created.
It is assumed that at most one checkpoint is finalized by this
method. Additionally, if an exception is raised, it is assumed a
new checkpoint was not finalized.
:param str title: The title of the save. If a title is given, the :param str title: The title of the save. If a title is given, the
configuration will be saved as a new checkpoint and put in a configuration will be saved as a new checkpoint and put in a