diff options
Diffstat (limited to 'passlib')
| -rw-r--r-- | passlib/_setup/docdist.py | 69 | ||||
| -rw-r--r-- | passlib/utils/handlers.py | 3 |
2 files changed, 71 insertions, 1 deletions
diff --git a/passlib/_setup/docdist.py b/passlib/_setup/docdist.py new file mode 100644 index 0000000..cc8fcfa --- /dev/null +++ b/passlib/_setup/docdist.py @@ -0,0 +1,69 @@ +"custom command to build doc.zip file" +#========================================================= +#imports +#========================================================= +#core +import os +from distutils import dir_util +from distutils.cmd import Command +#local +__all__ = [ + "docdist" +] +#========================================================= +#command +#========================================================= +class docdist(Command): + + description = "create zip file containing standalone html docs" + + user_options = [ + ('build-dir=', None, 'Build directory'), + ('dist-dir=', 'd', + "directory to put the source distribution archive(s) in " + "[default: dist]"), + ('format=', 'f', + "archive format to create (tar, ztar, gztar, zip)"), + ] + + def initialize_options(self): + self.build_dir = None + self.dist_dir = None + self.format = None + self.keep_temp = False + + def finalize_options(self): + if self.build_dir is None: + cmd = self.get_finalized_command('build') + self.build_dir = os.path.join(cmd.build_base, 'docdist') + if not self.dist_dir: + self.dist_dir = "dist" + if not self.format: + self.format = "zip" + + def run(self): + # call build sphinx to build docs + self.run_command("build_sphinx") + cmd = self.get_finalized_command("build_sphinx") + source_dir = cmd.builder_target_dir + + # copy to directory with appropriate name + dist = self.distribution + arc_name = "%s-docs-%s" % (dist.get_name(), dist.get_version()) + tmp_dir = os.path.join(self.build_dir, arc_name) + if os.path.exists(tmp_dir): + dir_util.remove_tree(tmp_dir, dry_run=self.dry_run) + self.copy_tree(source_dir, tmp_dir, preserve_symlinks=True) + + # make archive from dir + arc_base = os.path.join(self.dist_dir, arc_name) + self.arc_filename = self.make_archive(arc_base, self.format, + self.build_dir) + + #cleanup + if not self.keep_temp: + dir_util.remove_tree(tmp_dir, dry_run=self.dry_run) + +#========================================================= +#eof +#========================================================= diff --git a/passlib/utils/handlers.py b/passlib/utils/handlers.py index 0bdf178..410ffca 100644 --- a/passlib/utils/handlers.py +++ b/passlib/utils/handlers.py @@ -172,7 +172,8 @@ class StaticHandler(object): The default :meth:`verify` method uses simple equality to compare hash strings. If your hash may have multiple encoding (eg case-insensitive), this - method should be overridden on a per-handler basis. + method (or the private :meth:`_norm_hash` method) + should be overridden on a per-handler basis. If your hash has options, such as multiple identifiers, salts, or variable rounds, this is not the right class to start with. |