Merge pull request #6996 from tk0miya/refactor_kwargs

refactor: Rename var keyword argument to "**kwargs"

sphinx/application.py

@@ -525,7 +525,7 @@ class Sphinx:
         self.registry.add_translator(name, translator_class, override=override)
 
     def add_node(self, node: "Type[Element]", override: bool = False,
-                 **kwds: Tuple[Callable, Callable]) -> None:
+                 **kwargs: Tuple[Callable, Callable]) -> None:
         """Register a Docutils node class.
 
         This is necessary for Docutils internals.  It may also be used in the
@@ -555,17 +555,17 @@ class Sphinx:
         .. versionchanged:: 0.5
            Added the support for keyword arguments giving visit functions.
         """
-        logger.debug('[app] adding node: %r', (node, kwds))
+        logger.debug('[app] adding node: %r', (node, kwargs))
         if not override and docutils.is_node_registered(node):
             logger.warning(__('node class %r is already registered, '
                               'its visitors will be overridden'),
                            node.__name__, type='app', subtype='add_node')
         docutils.register_node(node)
-        self.registry.add_translation_handlers(node, **kwds)
+        self.registry.add_translation_handlers(node, **kwargs)
 
     def add_enumerable_node(self, node: "Type[Element]", figtype: str,
                             title_getter: TitleGetter = None, override: bool = False,
-                            **kwds: Tuple[Callable, Callable]) -> None:
+                            **kwargs: Tuple[Callable, Callable]) -> None:
         """Register a Docutils node class as a numfig target.
 
         Sphinx numbers the node automatically. And then the users can refer it
@@ -590,7 +590,7 @@ class Sphinx:
         .. versionadded:: 1.4
         """
         self.registry.add_enumerable_node(node, figtype, title_getter, override=override)
-        self.add_node(node, override=override, **kwds)
+        self.add_node(node, override=override, **kwargs)
 
     @property
     def enumerable_nodes(self) -> Dict["Type[Node]", Tuple[str, TitleGetter]]:

sphinx/builders/gettext.py

@@ -198,8 +198,8 @@ if source_date_epoch is not None:
 
 
 class LocalTimeZone(tzinfo):
-    def __init__(self, *args: Any, **kw: Any) -> None:
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
-        super().__init__(*args, **kw)  # type: ignore
+        super().__init__(*args, **kwargs)  # type: ignore
         self.tzdelta = tzdelta
 
     def utcoffset(self, dt: datetime) -> timedelta:

sphinx/builders/html.py

@@ -887,11 +887,11 @@ class StandaloneHTMLBuilder(Builder):
                         indexer_name, indexer_name),
                     RemovedInSphinx40Warning)
 
-    def _get_local_toctree(self, docname: str, collapse: bool = True, **kwds: Any) -> str:
+    def _get_local_toctree(self, docname: str, collapse: bool = True, **kwargs: Any) -> str:
-        if 'includehidden' not in kwds:
+        if 'includehidden' not in kwargs:
-            kwds['includehidden'] = False
+            kwargs['includehidden'] = False
         return self.render_partial(TocTree(self.env).get_toctree_for(
-            docname, self, collapse, **kwds))['fragment']
+            docname, self, collapse, **kwargs))['fragment']
 
     def get_outfilename(self, pagename: str) -> str:
         return path.join(self.outdir, os_path(pagename) + self.out_suffix)
@@ -1009,7 +1009,7 @@ class StandaloneHTMLBuilder(Builder):
             return ''  # return empty string
         ctx['warn'] = warn
 
-        ctx['toctree'] = lambda **kw: self._get_local_toctree(pagename, **kw)
+        ctx['toctree'] = lambda **kwargs: self._get_local_toctree(pagename, **kwargs)
         self.add_sidebars(pagename, ctx)
         ctx.update(addctx)
 

sphinx/builders/singlehtml.py

@@ -67,10 +67,10 @@ class SingleFileHTMLBuilder(StandaloneHTMLBuilder):
             if hashindex >= 0:
                 refnode['refuri'] = fname + refuri[hashindex:]
 
-    def _get_local_toctree(self, docname: str, collapse: bool = True, **kwds: Any) -> str:
+    def _get_local_toctree(self, docname: str, collapse: bool = True, **kwargs: Any) -> str:
-        if 'includehidden' not in kwds:
+        if 'includehidden' not in kwargs:
-            kwds['includehidden'] = False
+            kwargs['includehidden'] = False
-        toctree = TocTree(self.env).get_toctree_for(docname, self, collapse, **kwds)
+        toctree = TocTree(self.env).get_toctree_for(docname, self, collapse, **kwargs)
         if toctree is not None:
             self.fix_refuris(toctree)
         return self.render_partial(toctree)['fragment']

sphinx/environment/adapters/toctree.py

@@ -315,17 +315,17 @@ class TocTree:
         return toc
 
     def get_toctree_for(self, docname: str, builder: "Builder", collapse: bool,
-                        **kwds: Any) -> Element:
+                        **kwargs: Any) -> Element:
         """Return the global TOC nodetree."""
         doctree = self.env.get_doctree(self.env.config.master_doc)
         toctrees = []  # type: List[Element]
-        if 'includehidden' not in kwds:
+        if 'includehidden' not in kwargs:
-            kwds['includehidden'] = True
+            kwargs['includehidden'] = True
-        if 'maxdepth' not in kwds:
+        if 'maxdepth' not in kwargs:
-            kwds['maxdepth'] = 0
+            kwargs['maxdepth'] = 0
-        kwds['collapse'] = collapse
+        kwargs['collapse'] = collapse
         for toctreenode in doctree.traverse(addnodes.toctree):
-            toctree = self.resolve(docname, builder, toctreenode, prune=True, **kwds)
+            toctree = self.resolve(docname, builder, toctreenode, prune=True, **kwargs)
             if toctree:
                 toctrees.append(toctree)
         if not toctrees:

sphinx/ext/autodoc/mock.py

@@ -59,7 +59,7 @@ class _MockObject:
     def __getattr__(self, key: str) -> "_MockObject":
         return _make_subclass(key, self.__display_name__, self.__class__)()
 
-    def __call__(self, *args: Any, **kw: Any) -> Any:
+    def __call__(self, *args: Any, **kwargs: Any) -> Any:
         if args and type(args[0]) in [type, FunctionType, MethodType]:
             # Appears to be a decorator, pass through unchanged
             return args[0]

sphinx/io.py

@@ -192,15 +192,16 @@ class SphinxBaseFileInput(FileInput):
     It supports to replace unknown Unicode characters to '?'.
     """
 
-    def __init__(self, app: "Sphinx", env: BuildEnvironment, *args: Any, **kwds: Any) -> None:
+    def __init__(self, app: "Sphinx", env: BuildEnvironment,
+                 *args: Any, **kwargs: Any) -> None:
         self.app = app
         self.env = env
 
         warnings.warn('%s is deprecated.' % self.__class__.__name__,
                       RemovedInSphinx30Warning, stacklevel=2)
 
-        kwds['error_handler'] = 'sphinx'  # py3: handle error on open.
+        kwargs['error_handler'] = 'sphinx'  # py3: handle error on open.
-        super().__init__(*args, **kwds)
+        super().__init__(*args, **kwargs)
 
     def warn_and_replace(self, error: Any) -> Tuple:
         return UnicodeDecodeErrorHandler(self.env.docname)(error)

sphinx/testing/util.py

@@ -92,8 +92,8 @@ def etree_parse(path: str) -> Any:
 
 
 class Struct:
-    def __init__(self, **kwds: Any) -> None:
+    def __init__(self, **kwargs: Any) -> None:
-        self.__dict__.update(kwds)
+        self.__dict__.update(kwargs)
 
 
 class SphinxTestApp(application.Sphinx):
@@ -165,10 +165,10 @@ class SphinxTestAppWrapperForSkipBuilding:
     def __getattr__(self, name: str) -> Any:
         return getattr(self.app, name)
 
-    def build(self, *args: Any, **kw: Any) -> None:
+    def build(self, *args: Any, **kwargs: Any) -> None:
         if not self.app.outdir.listdir():  # type: ignore
             # if listdir is empty, do build.
-            self.app.build(*args, **kw)
+            self.app.build(*args, **kwargs)
             # otherwise, we can use built cache
 
 

sphinx/util/jsonimpl.py

@@ -28,19 +28,19 @@ class SphinxJSONEncoder(json.JSONEncoder):
         return super().default(obj)
 
 
-def dump(obj: Any, fp: IO, *args: Any, **kwds: Any) -> None:
+def dump(obj: Any, fp: IO, *args: Any, **kwargs: Any) -> None:
-    kwds['cls'] = SphinxJSONEncoder
+    kwargs['cls'] = SphinxJSONEncoder
-    json.dump(obj, fp, *args, **kwds)
+    json.dump(obj, fp, *args, **kwargs)
 
 
-def dumps(obj: Any, *args: Any, **kwds: Any) -> str:
+def dumps(obj: Any, *args: Any, **kwargs: Any) -> str:
-    kwds['cls'] = SphinxJSONEncoder
+    kwargs['cls'] = SphinxJSONEncoder
-    return json.dumps(obj, *args, **kwds)
+    return json.dumps(obj, *args, **kwargs)
 
 
-def load(*args: Any, **kwds: Any) -> Any:
+def load(*args: Any, **kwargs: Any) -> Any:
-    return json.load(*args, **kwds)
+    return json.load(*args, **kwargs)
 
 
-def loads(*args: Any, **kwds: Any) -> Any:
+def loads(*args: Any, **kwargs: Any) -> Any:
-    return json.loads(*args, **kwds)
+    return json.loads(*args, **kwargs)