From 8bbc7b83c059e099db41dc8774c155cb1723e9aa Mon Sep 17 00:00:00 2001 From: Lars Hupfeldt Date: Tue, 5 May 2020 10:12:41 +0200 Subject: [PATCH] Rename fips_safe_md5 to md5 --- sphinx/builders/html/__init__.py | 4 ++-- sphinx/ext/inheritance_diagram.py | 4 ++-- sphinx/util/__init__.py | 10 +++++----- tests/test_build_html.py | 6 +++--- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/sphinx/builders/html/__init__.py b/sphinx/builders/html/__init__.py index 982889b74..463e19b7b 100644 --- a/sphinx/builders/html/__init__.py +++ b/sphinx/builders/html/__init__.py @@ -37,7 +37,7 @@ from sphinx.highlighting import PygmentsBridge from sphinx.locale import _, __ from sphinx.search import js_index from sphinx.theming import HTMLThemeFactory -from sphinx.util import logging, progress_message, status_iterator, fips_safe_md5 +from sphinx.util import logging, progress_message, status_iterator, md5 from sphinx.util.docutils import is_html5_writer_available, new_document from sphinx.util.fileutil import copy_asset from sphinx.util.i18n import format_date @@ -76,7 +76,7 @@ def get_stable_hash(obj: Any) -> str: return get_stable_hash(list(obj.items())) elif isinstance(obj, (list, tuple)): obj = sorted(get_stable_hash(o) for o in obj) - return fips_safe_md5(str(obj).encode()).hexdigest() + return md5(str(obj).encode()).hexdigest() class Stylesheet(str): diff --git a/sphinx/ext/inheritance_diagram.py b/sphinx/ext/inheritance_diagram.py index 407fe09f5..7b2383fca 100644 --- a/sphinx/ext/inheritance_diagram.py +++ b/sphinx/ext/inheritance_diagram.py @@ -54,7 +54,7 @@ from sphinx.ext.graphviz import ( graphviz, figure_wrapper, render_dot_html, render_dot_latex, render_dot_texinfo ) -from sphinx.util import fips_safe_md5 +from sphinx.util import md5 from sphinx.util.docutils import SphinxDirective from sphinx.writers.html import HTMLTranslator from sphinx.writers.latex import LaTeXTranslator @@ -387,7 +387,7 @@ class InheritanceDiagram(SphinxDirective): def get_graph_hash(node: inheritance_diagram) -> str: encoded = (node['content'] + str(node['parts'])).encode() - return fips_safe_md5(encoded).hexdigest()[-10:] + return md5(encoded).hexdigest()[-10:] def html_visit_inheritance_diagram(self: HTMLTranslator, node: inheritance_diagram) -> None: diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py index 3400041ac..eeee1248e 100644 --- a/sphinx/util/__init__.py +++ b/sphinx/util/__init__.py @@ -10,6 +10,7 @@ import fnmatch import functools +import hashlib import os import posixpath import re @@ -21,7 +22,6 @@ import warnings from codecs import BOM_UTF8 from collections import deque from datetime import datetime -from hashlib import md5 from importlib import import_module from os import path from time import mktime, strptime @@ -170,7 +170,7 @@ class FilenameUniqDict(dict): self._existing = state -def fips_safe_md5(data=b'', **kwargs): +def md5(data=b'', **kwargs): """Wrapper around hashlib.md5 Attempt call with 'usedforsecurity=False' if we get a ValueError, which happens when @@ -181,9 +181,9 @@ def fips_safe_md5(data=b'', **kwargs): """ try: - return md5(data, **kwargs) # type: ignore + return hashlib.md5(data, **kwargs) # type: ignore except ValueError: - return md5(data, **kwargs, usedforsecurity=False) # type: ignore + return hashlib.md5(data, **kwargs, usedforsecurity=False) # type: ignore class DownloadFiles(dict): @@ -195,7 +195,7 @@ class DownloadFiles(dict): def add_file(self, docname: str, filename: str) -> str: if filename not in self: - digest = fips_safe_md5(filename.encode()).hexdigest() + digest = md5(filename.encode()).hexdigest() dest = '%s/%s' % (digest, os.path.basename(filename)) self[filename] = (set(), dest) diff --git a/tests/test_build_html.py b/tests/test_build_html.py index a93553361..b3406b74c 100644 --- a/tests/test_build_html.py +++ b/tests/test_build_html.py @@ -18,7 +18,7 @@ from html5lib import HTMLParser from sphinx.builders.html import validate_html_extra_path, validate_html_static_path from sphinx.errors import ConfigError from sphinx.testing.util import strip_escseq -from sphinx.util import docutils, fips_safe_md5 +from sphinx.util import docutils, md5 from sphinx.util.inventory import InventoryFile @@ -449,9 +449,9 @@ def test_html_download(app): @pytest.mark.sphinx('html', testroot='roles-download') def test_html_download_role(app, status, warning): app.build() - digest = fips_safe_md5(b'dummy.dat').hexdigest() + digest = md5(b'dummy.dat').hexdigest() assert (app.outdir / '_downloads' / digest / 'dummy.dat').exists() - digest_another = fips_safe_md5(b'another/dummy.dat').hexdigest() + digest_another = md5(b'another/dummy.dat').hexdigest() assert (app.outdir / '_downloads' / digest_another / 'dummy.dat').exists() content = (app.outdir / 'index.html').read_text()