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

Add comments about the exceptions raised

Browse Source
This commit is contained in:
Ola Bini
2016-01-27 09:06:56 -05:00
parent e591a7666c
commit 15182d5aa4
1 changed files with 20 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
letsencrypt-nginx/letsencrypt_nginx/configurator.py
+20 -2
View File
@@ -517,6 +517,10 @@ class NginxConfigurator(common.Plugin):
:param bool temporary: Indicates whether the changes made will
be quickly reversed in the future (ie. challenges)
:raises .errors.PluginError: If there was an error in
an attempt to save the configuration, or an error creating a
checkpoint
"""
save_files = set(self.parser.parsed.keys())
@@ -548,6 +552,8 @@ class NginxConfigurator(common.Plugin):
Reverts all modified files that have not been saved as a checkpoint
:raises .errors.PluginError: If unable to recover the configuration
"""
try:
self.reverter.recovery_routine()
@@ -556,7 +562,11 @@ class NginxConfigurator(common.Plugin):
self.parser.load()
def revert_challenge_config(self):
"""Used to cleanup challenge configurations."""
"""Used to cleanup challenge configurations.
:raises .errors.PluginError: If unable to revert the challenge config.
"""
try:
self.reverter.revert_temporary_config()
except errors.ReverterError as err:
@@ -568,6 +578,9 @@ class NginxConfigurator(common.Plugin):
:param int rollback: Number of checkpoints to revert
:raises .errors.PluginError: If there is a problem with the input or
the function is unable to correctly revert the configuration
"""
try:
self.reverter.rollback_checkpoints(rollback)
@@ -576,7 +589,12 @@ class NginxConfigurator(common.Plugin):
self.parser.load()
def view_config_changes(self):
"""Show all of the configuration changes that have taken place."""
"""Show all of the configuration changes that have taken place.
:raises .errors.PluginError: If there is a problem while processing
the checkpoints directories.
"""
try:
self.reverter.view_config_changes()
except errors.ReverterError as err: