Rename find_catalog() to docname_to_domain()

CHANGES

@@ -14,6 +14,7 @@ Deprecated
 ----------
 
 * ``sphinx.ext.autosummary.autolink_role()``
+* ``sphinx.util.i18n.find_catalog()``
 
 Features added
 --------------

doc/extdev/index.rst

@@ -239,6 +239,11 @@ The following is a list of deprecated interfaces.
      - 4.0
      - ``sphinx.ext.autosummary.AutoLink``
 
+   * - ``sphinx.util.i18n.find_catalog()``
+     - 2.1
+     - 4.0
+     - ``sphinx.util.i18n.docname_to_domain()``
+
    * - ``encoding`` argument of ``autodoc.Documenter.get_doc()``,
        ``autodoc.DocstringSignatureMixin.get_doc()``,
        ``autodoc.DocstringSignatureMixin._find_signature()``, and

sphinx/builders/__init__.py

@@ -23,7 +23,7 @@ from sphinx.util import i18n, import_object, logging, rst, progress_message, sta
 from sphinx.util.build_phase import BuildPhase
 from sphinx.util.console import bold  # type: ignore
 from sphinx.util.docutils import sphinx_domains
-from sphinx.util.i18n import find_catalog
+from sphinx.util.i18n import docname_to_domain
 from sphinx.util.matching import Matcher
 from sphinx.util.osutil import SEP, ensuredir, relative_uri, relpath
 from sphinx.util.parallel import ParallelTasks, SerialTasks, make_chunks, \
@@ -251,7 +251,7 @@ class Builder:
             # type: (str) -> str
             docname = self.env.path2doc(path.abspath(fpath))
             if docname:
-                return find_catalog(docname, self.config.gettext_compact)
+                return docname_to_domain(docname, self.config.gettext_compact)
             else:
                 return None
 

sphinx/builders/gettext.py

@@ -22,7 +22,7 @@ from sphinx.errors import ThemeError
 from sphinx.locale import __
 from sphinx.util import split_index_msg, logging, status_iterator
 from sphinx.util.console import bold  # type: ignore
-from sphinx.util.i18n import find_catalog
+from sphinx.util.i18n import docname_to_domain
 from sphinx.util.nodes import extract_messages, traverse_translatable_index
 from sphinx.util.osutil import relpath, ensuredir, canon_path
 from sphinx.util.tags import Tags
@@ -140,7 +140,7 @@ class I18nBuilder(Builder):
 
     def write_doc(self, docname, doctree):
         # type: (str, nodes.document) -> None
-        catalog = self.catalogs[find_catalog(docname, self.config.gettext_compact)]
+        catalog = self.catalogs[docname_to_domain(docname, self.config.gettext_compact)]
 
         for node, msg in extract_messages(doctree):
             catalog.add(msg, node)

sphinx/transforms/i18n.py

@@ -21,7 +21,7 @@ from sphinx.domains.std import make_glossary_term, split_term_classifiers
 from sphinx.locale import __, init as init_locale
 from sphinx.transforms import SphinxTransform
 from sphinx.util import split_index_msg, logging
-from sphinx.util.i18n import find_catalog
+from sphinx.util.i18n import docname_to_domain
 from sphinx.util.nodes import (
     LITERAL_TYPE_NODES, IMAGE_TYPE_NODES, NodeMatcher,
     extract_messages, is_pending_meta, traverse_translatable_index,
@@ -94,7 +94,7 @@ class Locale(SphinxTransform):
         assert source.startswith(self.env.srcdir)
         docname = path.splitext(relative_path(path.join(self.env.srcdir, 'dummy'),
                                               source))[0]
-        textdomain = find_catalog(docname, self.config.gettext_compact)
+        textdomain = docname_to_domain(docname, self.config.gettext_compact)
 
         # fetch translations
         dirs = [path.join(self.env.srcdir, directory)

sphinx/util/i18n.py

@@ -128,6 +128,8 @@ class CatalogRepository:
 
 def find_catalog(docname, compaction):
     # type: (str, bool) -> str
+    warnings.warn('find_catalog() is deprecated.',
+                  RemovedInSphinx40Warning, stacklevel=2)
     if compaction:
         ret = docname.split(SEP, 1)[0]
     else:
@@ -136,6 +138,15 @@ def find_catalog(docname, compaction):
     return ret
 
 
+def docname_to_domain(docname, compation):
+    # type: (str, bool) -> str
+    """Convert docname to domain for catalogs."""
+    if compation:
+        return docname.split(SEP, 1)[0]
+    else:
+        return docname
+
+
 def find_catalog_files(docname, srcdir, locale_dirs, lang, compaction):
     # type: (str, str, List[str], str, bool) -> List[str]
     if not(lang and locale_dirs):