- tor-commits - lists.torproject.org

[chutney/master] lint: Fix undefined names
by nickm＠torproject.org 15 May '20

15 May '20

commit 857c4705155182392620e5f62a8e09f9516e6507 Author: c <c(a)chroniko.jp> Date: Thu May 14 21:33:19 2020 +0000 lint: Fix undefined names Running flake8 on lib/chutney/*.py caught a few typographical errors and oversights. --- lib/chutney/Templating.py | 2 +- lib/chutney/TorNet.py | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/chutney/Templating.py b/lib/chutney/Templating.py index 2a658ab..43eb636 100755 --- a/lib/chutney/Templating.py +++ b/lib/chutney/Templating.py @@ -107,7 +107,7 @@ class _DictWrapper(object): self._parent = parent def _getitem(self, key, my): - raise NotImplemented() + raise NotImplementedError() def __getitem__(self, key): return self.lookup(key, self) diff --git a/lib/chutney/TorNet.py b/lib/chutney/TorNet.py index b68b240..41390e6 100644 --- a/lib/chutney/TorNet.py +++ b/lib/chutney/TorNet.py @@ -67,7 +67,7 @@ def getenv_type(env_var, default, type_, type_name=None): type_name = str(type_) raise ValueError(("Invalid value for environment variable '{}': " "expected {}, but got '{}'") - .format(env_var, typename, strval)) + .format(env_var, type_name, strval)) def getenv_int(env_var, default): """ @@ -1757,7 +1757,7 @@ class LocalNodeController(NodeController): node_status = self.getNodeDirInfoStatus() if node_status: status_code, _, _, _ = node_status - return status_code == LocalDirectoryController.SUCCESS_CODE + return status_code == LocalNodeController.SUCCESS_CODE else: # Clients don't publish descriptors, so they are always ok. # (But we shouldn't print a descriptor status for them.) @@ -2020,7 +2020,7 @@ class Network(object): def _addRequirement(self, requirement): requirement = requirement.upper() if requirement not in KNOWN_REQUIREMENTS: - raise RuntimemeError(("Unrecognized requirement %r"%requirement)) + raise RuntimeError(("Unrecognized requirement %r"%requirement)) self._requirements.append(requirement) def move_aside_nodes_dir(self):

1 0

[stem/master] Disable buggy cross referencing
by atagar＠torproject.org 14 May '20

14 May '20

commit a22ebbda06cc38b4d0eeb358f9bb6f4a930086de Author: Damian Johnson <atagar(a)torproject.org> Date: Thu May 14 16:14:11 2020 -0700 Disable buggy cross referencing Sphinx attempts to create cross-references for attribute and variable names... https://github.com/sphinx-doc/sphinx/issues/2549 https://github.com/sphinx-doc/sphinx/issues/3866 This results in numerous warnings of the form... WARNING: more than one target found for cross-reference 'digest' Adapting a patch from the tickets above. Sphinx deprecated override_domain(), so using add_domain() instead... https://www.sphinx-doc.org/en/2.0/extdev/appapi.html#sphinx.application.Sph… --- docs/conf.py | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index aef0ff93..b880b114 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,6 +12,7 @@ # serve to show the default. import sys, os +from sphinx.domains.python import PythonDomain # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -260,9 +261,35 @@ man_pages = [ trac_url = 'https://trac.torproject.org/{slug}' spec_url = 'https://gitweb.torproject.org/torspec.git/commit/?id={slug}' + def skip_members(app, what, name, obj, skip, options): if name in ('ATTRIBUTES', 'PARSER_FOR_LINE'): return True # skip the descriptor's parser constants + +class PythonDomainNoXref(PythonDomain): + """ + Sphinx attempts to create cross-reference links for variable names... + + https://github.com/sphinx-doc/sphinx/issues/2549 + https://github.com/sphinx-doc/sphinx/issues/3866 + + This causes alot of warnings such as... + + stem/descriptor/networkstatus.py:docstring of + stem.descriptor.networkstatus.DocumentDigest:: WARNING: more than one + target found for cross-reference 'digest': + stem.descriptor.extrainfo_descriptor.ExtraInfoDescriptor.digest, ... + """ + + def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode): + if 'refspecific' in node: + del node['refspecific'] + + return super(PythonDomainNoXref, self).resolve_xref( + env, fromdocname, builder, typ, target, node, contnode) + + def setup(app): app.connect('autodoc-skip-member', skip_members) + app.add_domain(PythonDomainNoXref, override = True)

1 0

[stem/master] Drop explicit __init__ from automodule
by atagar＠torproject.org 14 May '20

14 May '20

commit f99633ca62766f1f1c123132a75b745e255d26c4 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed May 13 15:56:07 2020 -0700 Drop explicit __init__ from automodule The only visible difference I can see between including '__init__' verses excluding it for automodule declarations is class names. If we include it the page cites classes as... stem.descriptor.__init__.DigestHash ... whereas without it the page renders... stem.descriptor.DigestHash The second is obviously correct so dropping the suffix. --- docs/api/descriptor/descriptor.rst | 2 +- docs/api/util/init.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/descriptor/descriptor.rst b/docs/api/descriptor/descriptor.rst index 0273b535..b5b642c6 100644 --- a/docs/api/descriptor/descriptor.rst +++ b/docs/api/descriptor/descriptor.rst @@ -1,5 +1,5 @@ Descriptor ========== -.. automodule:: stem.descriptor.__init__ +.. automodule:: stem.descriptor diff --git a/docs/api/util/init.rst b/docs/api/util/init.rst index fae27191..651826f0 100644 --- a/docs/api/util/init.rst +++ b/docs/api/util/init.rst @@ -1,5 +1,5 @@ Util ==== -.. automodule:: stem.util.__init__ +.. automodule:: stem.util

1 0

[stem/master] Drop line numbers in links
by atagar＠torproject.org 14 May '20

14 May '20

commit 328ef47332173504100cda24e16a155e928df157 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue May 12 17:11:02 2020 -0700 Drop line numbers in links Sphinx warns if multiple links have the same text but differing urls... /home/atagar/Desktop/stem/stem/descriptor/hidden_service.py:docstring of stem.descriptor.hidden_service.InnerLayer.create:19: WARNING: Duplicate explicit target name: "spec". /home/atagar/Desktop/stem/stem/descriptor/remote.py:docstring of stem.descriptor.remote.DescriptorDownloader.query:15: WARNING: Duplicate explicit target name: "'v3ident' in tor's config.c". On reflection the real problem here is that we supplied line numbers that have already fallen out of date. Simply citing the section number instead. --- stem/descriptor/hidden_service.py | 6 ++++-- stem/descriptor/remote.py | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/stem/descriptor/hidden_service.py b/stem/descriptor/hidden_service.py index 84e8e9c0..5b3b5178 100644 --- a/stem/descriptor/hidden_service.py +++ b/stem/descriptor/hidden_service.py @@ -1168,7 +1168,8 @@ class HiddenServiceDescriptorV3(HiddenServiceDescriptor): class OuterLayer(Descriptor): """ Initial encryped layer of a hidden service v3 descriptor (`spec - <https://gitweb.torproject.org/torspec.git/tree/rend-spec-v3.txt#n1154>`_). + <https://gitweb.torproject.org/torspec.git/tree/rend-spec-v3.txt>`_ section + 2.5.1.2). .. versionadded:: 1.8.0 @@ -1264,7 +1265,8 @@ class OuterLayer(Descriptor): class InnerLayer(Descriptor): """ Second encryped layer of a hidden service v3 descriptor (`spec - <https://gitweb.torproject.org/torspec.git/tree/rend-spec-v3.txt#n1308>`_). + <https://gitweb.torproject.org/torspec.git/tree/rend-spec-v3.txt>`_ section + 2.5.2.2). .. versionadded:: 1.8.0 diff --git a/stem/descriptor/remote.py b/stem/descriptor/remote.py index 2e2bb53b..9ced7de3 100644 --- a/stem/descriptor/remote.py +++ b/stem/descriptor/remote.py @@ -805,7 +805,7 @@ class DescriptorDownloader(object): :param str,list authority_v3idents: fingerprint or list of fingerprints of the authority keys, see `'v3ident' in tor's config.c - <https://gitweb.torproject.org/tor.git/tree/src/or/config.c#n819>`_ + <https://gitweb.torproject.org/tor.git/tree/src/or/config.c>`_ for the values. :param query_args: additional arguments for the :class:`~stem.descriptor.remote.Query` constructor

1 0

[stem/master] Sphinx 3.0.3 compatibility
by atagar＠torproject.org 14 May '20

14 May '20

commit 778c5a8c0b8b0cb90022c6d48f69c7c1c914b604 Merge: 99c3043f a22ebbda Author: Damian Johnson <atagar(a)torproject.org> Date: Thu May 14 16:24:45 2020 -0700 Sphinx 3.0.3 compatibility Upgrading Sphinx produced several warnings. Sphinx deprecated some configuration options, and apparently added some buggy features we need to work around. docs/api/descriptor/descriptor.rst | 2 +- docs/api/util/init.rst | 2 +- docs/conf.py | 65 +++++++++++++++++++++++++--- docs/download.rst | 2 +- docs/tutorials/east_of_the_sun.rst | 1 + docs/tutorials/mirror_mirror_on_the_wall.rst | 6 +-- stem/descriptor/collector.py | 10 ++--- stem/descriptor/hidden_service.py | 14 +++--- stem/descriptor/remote.py | 2 +- 9 files changed, 81 insertions(+), 23 deletions(-)

1 0

[stem/master] Ignore __all__ attributes when bulding site
by atagar＠torproject.org 14 May '20

14 May '20

commit 0354799f583ecdda814349d2fc57a7fb9494a200 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed May 13 18:07:47 2020 -0700 Ignore __all__ attributes when bulding site Sphinx emits the following warnings... WARNING: missing attribute mentioned in :members: or __all__: module stem, attribute directory WARNING: missing attribute mentioned in :members: or __all__: module stem, attribute process WARNING: missing attribute mentioned in :members: or __all__: module stem.descriptor, attribute remote WARNING: missing attribute mentioned in :members: or __all__: module stem.response, attribute getinfo WARNING: missing attribute mentioned in :members: or __all__: module stem.response, attribute getconf WARNING: missing attribute mentioned in :members: or __all__: module stem.response, attribute authchallenge WARNING: missing attribute mentioned in :members: or __all__: module stem.util, attribute lru_cache WARNING: missing attribute mentioned in :members: or __all__: module stem.util, attribute ordereddict WARNING: missing attribute mentioned in :members: or __all__: module stem.util, attribute term WARNING: missing attribute mentioned in :members: or __all__: module stem.util, attribute test_tools These submodules all exist, but importlib.import_module() does not have attributes corresponding to them unless we've transitively imported its code prior to Sphinx's attempt to reference it. Honestly I don't fully grok the nuance behind how importlib works, but this configuration flag resolves these warnings so calling it good. --- docs/conf.py | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 03268c57..aef0ff93 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -33,6 +33,30 @@ autodoc_default_options = { 'member-order': 'bysource', 'show-inheritance': True, 'undoc-members': True, + + # Without this Sphinx emits several warnings of the form... + # + # WARNING: missing attribute mentioned in :members: or __all__: module stem, attribute directory + # + # This is because Sphinx expects modules from importlib.import_module() to + # have attributes for its submodules. These attributes might or might not be + # present depending on what other modules have been imported. + # + # Said another way... + # + # % print(importlib.import_module('stem').__dict__.keys()) + # dict_keys(['__name__', '__doc__', '__package__', ...]) <= doesn't have submodules + # + # But if instead we call... + # + # % importlib.import_module('stem.connection') + # % print(importlib.import_module('stem').__dict__.keys()) + # dict_keys(['__name__', '__doc__', '__package__', ..., 'descriptor', 'control', 'connection']) <= includes submodules refernced by stem.connection + # + # By telling it to ignore our '__all__' attributes Sphinx will import in a + # fashon that doesn't emit these warnings. + + 'ignore-module-all': True, } # Add any paths that contain templates here, relative to this directory.

1 0

[stem/master] Fix broken parameter declarations
by atagar＠torproject.org 14 May '20

14 May '20

commit 08aeccdf890d8ba92794a734f34e2e93cd3e3219 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue May 12 17:02:06 2020 -0700 Fix broken parameter declarations Parameter declarations are of the form... :param type variable_name: description We wrap long lines, but it turns out that the ":param type variable_name:" portion must reside on a single line or Sphinx emits the following warnings... /home/atagar/Desktop/stem/stem/descriptor/hidden_service.py:docstring of stem.descriptor.hidden_service.HiddenServiceDescriptorV3.content:29: WARNING: Field list ends without a blank line; unexpected unindent. /home/atagar/Desktop/stem/stem/descriptor/hidden_service.py:docstring of stem.descriptor.hidden_service.HiddenServiceDescriptorV3.content:33: WARNING: Definition list ends without a blank line; unexpected unindent. --- stem/descriptor/hidden_service.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/stem/descriptor/hidden_service.py b/stem/descriptor/hidden_service.py index 2eb7d02f..84e8e9c0 100644 --- a/stem/descriptor/hidden_service.py +++ b/stem/descriptor/hidden_service.py @@ -964,10 +964,10 @@ class HiddenServiceDescriptorV3(HiddenServiceDescriptor): encrypted layer :param stem.descriptor.hidden_service.OuterLayer outer_layer: outer encrypted layer - :param cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey - identity_key: service identity key - :param cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey - signing_key: service signing key + :param cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey identity_key: + service identity key + :param cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey signing_key: + service signing key :param stem.descriptor.Ed25519CertificateV1 signing_cert: certificate signing this descriptor :param int revision_counter: descriptor revision number

1 0

[stem/master] Fix malformed class links
by atagar＠torproject.org 14 May '20

14 May '20

commit 3339630ee286f4f1059a5a17db6d17b0f10f2c40 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue May 12 16:52:28 2020 -0700 Fix malformed class links Sphinx class references are of the form... :class:`module.class_name` Our new collector module lacked a trailing backtick in a few spots. This caused the following build warnings... /home/atagar/Desktop/stem/stem/descriptor/collector.py:docstring of stem.descriptor.collector.File.read:4: WARNING: Inline interpreted text or phrase reference start-string without end-string. /home/atagar/Desktop/stem/stem/descriptor/collector.py:docstring of stem.descriptor.collector.CollecTor.get_microdescriptors:22: WARNING: Inline interpreted text or phrase reference start-string without end-string. /home/atagar/Desktop/stem/stem/descriptor/collector.py:docstring of stem.descriptor.collector.CollecTor.get_key_certificates:12: WARNING: Inline interpreted text or phrase reference start-string without end-string. /home/atagar/Desktop/stem/stem/descriptor/collector.py:docstring of stem.descriptor.collector.CollecTor.get_bandwidth_files:12: WARNING: Inline interpreted text or phrase reference start-string without end-string. /home/atagar/Desktop/stem/stem/descriptor/collector.py:docstring of stem.descriptor.collector.CollecTor.get_exit_lists:12: WARNING: Inline interpreted text or phrase reference start-string without end-string. --- stem/descriptor/collector.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/stem/descriptor/collector.py b/stem/descriptor/collector.py index 9749dadb..a978519d 100644 --- a/stem/descriptor/collector.py +++ b/stem/descriptor/collector.py @@ -212,7 +212,7 @@ class File(object): from disk as follows... * If this file has already been downloaded through - :func:`~stem.descriptor.collector.CollecTor.download' these descriptors + :func:`~stem.descriptor.collector.CollecTor.download` these descriptors are read from disk. * If a **directory** argument is provided and the file is already present @@ -485,7 +485,7 @@ class CollecTor(object): :param int retries: maximum attempts to impose on a per-archive basis :returns: **iterator** of - :class:`~stem.descriptor.microdescriptor.Microdescriptor + :class:`~stem.descriptor.microdescriptor.Microdescriptor` for the given time range :raises: :class:`~stem.DownloadFailed` if the download fails @@ -553,7 +553,7 @@ class CollecTor(object): :param int retries: maximum attempts to impose on a per-archive basis :returns: **iterator** of - :class:`~stem.descriptor.networkstatus.KeyCertificate + :class:`~stem.descriptor.networkstatus.KeyCertificate` for the given time range :raises: :class:`~stem.DownloadFailed` if the download fails @@ -577,7 +577,7 @@ class CollecTor(object): :param int retries: maximum attempts to impose on a per-archive basis :returns: **iterator** of - :class:`~stem.descriptor.bandwidth_file.BandwidthFile + :class:`~stem.descriptor.bandwidth_file.BandwidthFile` for the given time range :raises: :class:`~stem.DownloadFailed` if the download fails @@ -601,7 +601,7 @@ class CollecTor(object): :param int retries: maximum attempts to impose on a per-archive basis :returns: **iterator** of - :class:`~stem.descriptor.tordnsel.TorDNSEL + :class:`~stem.descriptor.tordnsel.TorDNSEL` for the given time range :raises: :class:`~stem.DownloadFailed` if the download fails

1 0

[stem/master] Fix smartquotes configuration
by atagar＠torproject.org 14 May '20

14 May '20

commit 06aba288d13400cc491e5dfb51432f21c009a106 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue May 12 16:06:49 2020 -0700 Fix smartquotes configuration Sphinx deprecated the configuration option we used to disable smartquotes... RemovedInSphinx17Warning: html_use_smartypants option is deprecated. Smart quotes are on by default; if you want to disable or customize them, use the smart_quotes option in docutils.conf. Despite this warning the actual configuration name they went with doesn't have an underscore... https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-smart… --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 247220f8..5e20a71b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -146,7 +146,7 @@ html_static_path = ['_static'] # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -html_use_smartypants = False +smartquotes = False # Custom sidebar templates, maps document names to template names. #html_sidebars = {}

1 0

[stem/master] Fix autodoc configuration
by atagar＠torproject.org 14 May '20

14 May '20

commit c78e068cef2569804c7cc50d00f2b3bd4a0e7f54 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon May 11 16:25:49 2020 -0700 Fix autodoc configuration Autodoc deprecated its autodoc_default_flags configuration in version 1.8. As a result with new Sphinx versions our API documentation is empty. Moving to their new configuration mechanism... https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-… --- docs/conf.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 6535135b..247220f8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,8 +28,12 @@ needs_sphinx = '1.1' # required for the sphinx-apidoc command # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'roles'] -autodoc_member_order = 'bysource' -autodoc_default_flags = ['members', 'show-inheritance', 'undoc-members'] +autodoc_default_options = { + 'members': True, + 'member-order': 'bysource', + 'show-inheritance': True, + 'undoc-members': True, +} # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']

1 0