From a6a1721de6ffdae3886e852b59f33630f1998477 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 30 Dec 2019 17:41:00 +0900 Subject: [PATCH] refactor: Rename var keyword argument to "**kwargs" --- sphinx/application.py | 10 +++++----- sphinx/builders/gettext.py | 4 ++-- sphinx/builders/html.py | 10 +++++----- sphinx/builders/singlehtml.py | 8 ++++---- sphinx/environment/adapters/toctree.py | 14 +++++++------- sphinx/ext/autodoc/mock.py | 2 +- sphinx/io.py | 7 ++++--- sphinx/testing/util.py | 8 ++++---- sphinx/util/jsonimpl.py | 20 ++++++++++---------- 9 files changed, 42 insertions(+), 41 deletions(-) diff --git a/sphinx/application.py b/sphinx/application.py index c295d2985..744e62a4e 100644 --- a/sphinx/application.py +++ b/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]]: diff --git a/sphinx/builders/gettext.py b/sphinx/builders/gettext.py index f5264837c..638408503 100644 --- a/sphinx/builders/gettext.py +++ b/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: - super().__init__(*args, **kw) # type: ignore + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) # type: ignore self.tzdelta = tzdelta def utcoffset(self, dt: datetime) -> timedelta: diff --git a/sphinx/builders/html.py b/sphinx/builders/html.py index e03d88478..b3d2f1da2 100644 --- a/sphinx/builders/html.py +++ b/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: - if 'includehidden' not in kwds: - kwds['includehidden'] = False + def _get_local_toctree(self, docname: str, collapse: bool = True, **kwargs: Any) -> str: + if 'includehidden' not in kwargs: + 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) diff --git a/sphinx/builders/singlehtml.py b/sphinx/builders/singlehtml.py index 1c47596b8..b145109a6 100644 --- a/sphinx/builders/singlehtml.py +++ b/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: - if 'includehidden' not in kwds: - kwds['includehidden'] = False - toctree = TocTree(self.env).get_toctree_for(docname, self, collapse, **kwds) + def _get_local_toctree(self, docname: str, collapse: bool = True, **kwargs: Any) -> str: + if 'includehidden' not in kwargs: + kwargs['includehidden'] = False + 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'] diff --git a/sphinx/environment/adapters/toctree.py b/sphinx/environment/adapters/toctree.py index fe8f43656..bd3abd9ed 100644 --- a/sphinx/environment/adapters/toctree.py +++ b/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: - kwds['includehidden'] = True - if 'maxdepth' not in kwds: - kwds['maxdepth'] = 0 - kwds['collapse'] = collapse + if 'includehidden' not in kwargs: + kwargs['includehidden'] = True + if 'maxdepth' not in kwargs: + kwargs['maxdepth'] = 0 + 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: diff --git a/sphinx/ext/autodoc/mock.py b/sphinx/ext/autodoc/mock.py index eea8a1740..0ee0fddc1 100644 --- a/sphinx/ext/autodoc/mock.py +++ b/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] diff --git a/sphinx/io.py b/sphinx/io.py index 706abc812..b1290ae89 100644 --- a/sphinx/io.py +++ b/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. - super().__init__(*args, **kwds) + kwargs['error_handler'] = 'sphinx' # py3: handle error on open. + super().__init__(*args, **kwargs) def warn_and_replace(self, error: Any) -> Tuple: return UnicodeDecodeErrorHandler(self.env.docname)(error) diff --git a/sphinx/testing/util.py b/sphinx/testing/util.py index a031e2523..f4ef35d61 100644 --- a/sphinx/testing/util.py +++ b/sphinx/testing/util.py @@ -92,8 +92,8 @@ def etree_parse(path: str) -> Any: class Struct: - def __init__(self, **kwds: Any) -> None: - self.__dict__.update(kwds) + def __init__(self, **kwargs: Any) -> None: + 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 diff --git a/sphinx/util/jsonimpl.py b/sphinx/util/jsonimpl.py index 52b4f2d3e..35501f03a 100644 --- a/sphinx/util/jsonimpl.py +++ b/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: - kwds['cls'] = SphinxJSONEncoder - json.dump(obj, fp, *args, **kwds) +def dump(obj: Any, fp: IO, *args: Any, **kwargs: Any) -> None: + kwargs['cls'] = SphinxJSONEncoder + json.dump(obj, fp, *args, **kwargs) -def dumps(obj: Any, *args: Any, **kwds: Any) -> str: - kwds['cls'] = SphinxJSONEncoder - return json.dumps(obj, *args, **kwds) +def dumps(obj: Any, *args: Any, **kwargs: Any) -> str: + kwargs['cls'] = SphinxJSONEncoder + return json.dumps(obj, *args, **kwargs) -def load(*args: Any, **kwds: Any) -> Any: - return json.load(*args, **kwds) +def load(*args: Any, **kwargs: Any) -> Any: + return json.load(*args, **kwargs) -def loads(*args: Any, **kwds: Any) -> Any: - return json.loads(*args, **kwds) +def loads(*args: Any, **kwargs: Any) -> Any: + return json.loads(*args, **kwargs)