[Patch] Uses deprecated sha module in graphviz.py

[Dmitry Shurupov]

We've updated Python from 2.5 to 2.6 on our server with Trac installation. After that, we're getting Python warnings every single time graphviz plugin is used. The warning is as follows:

/usr/lib64/python2.6/site-packages/graphviz-0.7.4-py2.6.egg/graphviz/graphviz.py:23:
DeprecationWarning: the sha module is deprecated; use the hashlib module instead

The problem exists in 0.7.6dev version as well. I guess, this should be fixed.

[Russ Tyndall]

graphviz/graphviz.py

@@ -20 +20 @@
 import locale
 import os
 import re
-import sha
+import hashlib
 import subprocess
 import sys
 
@@ -310 +310 @@
         encoded_cmd = (processor + unicode(self.processor_options)) \
                 .encode(self.encoding)
         encoded_content = content.encode(self.encoding)
-        sha_key  = sha.new(encoded_cmd + encoded_content).hexdigest()
+        sha_key  = hashlib.sha1(encoded_cmd + encoded_content).hexdigest()
         img_name = '%s.%s.%s' % (sha_key, processor, out_format)
         # cache: hash.<dot>.<png>
         img_path = os.path.join(self.cache_dir, img_name)

I made the change earlier today, and this seems to work.

[anonymous]

Added cc for fix updates...

[paresh.solanki@…]

This works for me too.

Can this be applied to the next version?

[Sigurd Hogsbro]

It would be nice to get some of these trivial updates applied to the SVN tree.

[Ryan J Ollos]

It looks like cboos is maintaining this plugin, so you might need to talk with him.

[Itamar Oren]

Patch to fix sha module deprecation in Python 2.6 while maintaining compatability

[Itamar Oren]

I have attached a GraphViz-fix-py26-sha.patch​ that fixes the deprecation warning in Python 2.6 without breaking compatibility (since hashlib does not exist in pre-2.5).

Basically, I simply reused the fix that was made in Trac core via the trac.util.compat module.

Hope this gets in soon...

[Itamar Oren]

same patch, fixed mistake in import

[olaf.meeuwissen@…]

+1 and #8938 seems to be a duplicate of this ticket

[Ryan J Ollos]

I'd like to finally get this fixed too and get rid of the warnings in my log file. I'll go ahead and take care of committing this to the repos if cboos has no objections (or if we don't hear anything back in the standard 2 week time period).

[kuaima@…]

+1. It's annoying in the log to see the warning.

[kuaima@…]

Another suggestion, only replace module sha with hashlib.sha1 works for me. My environment pyton 2.6.7.

[Ryan J Ollos]

I'd like to go ahead and fix this if the maintainer has no objections.

[Ryan J Ollos]

I've issued sufficient warning in comment:11 and comment:14 ... time to apply this ;)

The patch by itamarost is great, except sha1 doesn't exist doesn't exist in trac.util.compat in 0.11, and we are trying to maintain compatibility on plugins back to 0.11.

hasienda, this is a perfect candidate for the trachacks-compat class, or whatever we end up calling it. From trac-0.11-stable:

try:
    from hashlib import md5, sha1
except ImportError:
    from md5 import md5
    from sha import new as sha1

[Ryan J Ollos]

(In [11263]) Refs #5747: (0.11 branch) Replaced import of deprecated sha with import of sha1 from the hashlib library. Falls back to still use sha if hashlib (since Python 2.5) is not available.

Thank you to bobbysmith007 and itamarost for useful suggestions on a solution.

This has been tested with trac0.11 and trac0.13dev ​[t 10966] with Python 2.6.

[Ryan J Ollos]

I'll leave this ticket open for a while to see if there are any issues.

hasienda, I had meant to cc you on comment:15, which you might find interesting.

[Ryan J Ollos]

Replying to rjollos:

hasienda, this is a perfect candidate for the trachacks-compat class, or whatever we end up calling it. From trac-0.11-stable:

There is a similar issue for the WorkLogPlugin in #9990.

[Ryan J Ollos]

It looks like the fix in [11263] will need to be merged over to the 1.0 branch, depending on what you decide to do with trunk going forward.

[Andrew Schulman]

Reopening for Trac 1.0, since the problem hasn't been fixed yet in the 1.0 branch.

[Ryan J Ollos]

If no one objects (or has a better idea), we could merge recent changes on the graphvizplugin/branches/1.0​ branch back to graphvizplugin/trunk​. Future development would then presumably follow the Trac's practice of making bugfixes on the branch and merging them to trunk. For [11263], we could make the change on the branch and do a record-only merge so that we don't get a conflict when merging 1.0 to the trunk.

[Jun Omae]

Fixed in [18525].