From 08492430ff50d1ad16f8f32eac323f14cf749b54 Mon Sep 17 00:00:00 2001 From: Michael Howitz Date: Wed, 29 Jan 2025 08:17:35 +0100 Subject: [PATCH] Lint code. --- docs/conf.py | 142 +++++++++++---------- setup.py | 6 +- src/zope/location/interfaces.py | 2 +- src/zope/location/pickling.py | 2 +- src/zope/location/tests/test_location.py | 10 +- src/zope/location/tests/test_pickling.py | 2 +- src/zope/location/tests/test_traversing.py | 14 +- 7 files changed, 91 insertions(+), 87 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index b7ee8d8..3908981 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,30 +1,29 @@ -# -*- coding: utf-8 -*- # # zope.location documentation build configuration file, created by # sphinx-quickstart on Wed Jun 6 17:47:12 2012. # -# This file is execfile()d with the current directory set to its containing dir. +# This file is execfile()d with the current directory set to its containing +# dir. # # Note that not all possible configuration values are present in this # autogenerated file. # -# All configuration values have a default; values that are commented out -# serve to show the default. +# All configuration values have a default; values that are commented out serve +# to show the default. -import sys, os # 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 # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) +# sys.path.insert(0, os.path.abspath('.')) -# -- General configuration ----------------------------------------------------- +# -- General configuration ----------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', @@ -41,14 +40,14 @@ source_suffix = '.rst' # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. -project = u'zope.location' -copyright = u'2012, Zope Foundation Contributors' +project = 'zope.location' +copyright = '2012, Zope Foundation Contributors' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -61,40 +60,41 @@ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] -# -- Options for HTML output --------------------------------------------------- +# -- Options for HTML output --------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. @@ -103,26 +103,26 @@ # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -131,119 +131,123 @@ # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'zopelocationdoc' -# -- Options for LaTeX output -------------------------------------------------- +# -- Options for LaTeX output -------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', } -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). +# Grouping the document tree into LaTeX files. List of tuples (source start +# file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'zopelocation.tex', u'zope.location Documentation', - u'Zope Foundation Contributors', 'manual'), + ('index', 'zopelocation.tex', 'zope.location Documentation', + 'Zope Foundation Contributors', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True -# -- Options for manual page output -------------------------------------------- +# -- Options for manual page output -------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'zopelocation', u'zope.location Documentation', - [u'Zope Foundation Contributors'], 1) + ('index', 'zopelocation', 'zope.location Documentation', + ['Zope Foundation Contributors'], 1) ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False -# -- Options for Texinfo output ------------------------------------------------ +# -- Options for Texinfo output ------------------------------------------ # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'zopelocation', u'zope.location Documentation', - u'Zope Foundation Contributors', 'zopelocation', 'One line description of project.', - 'Miscellaneous'), + ('index', + 'zopelocation', + 'zope.location Documentation', + 'Zope Foundation Contributors', + 'zopelocation', + 'One line description of project.', + 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' diff --git a/setup.py b/setup.py index 0a59250..c12779a 100644 --- a/setup.py +++ b/setup.py @@ -66,11 +66,11 @@ def read(*rnames): 'License :: OSI Approved :: Zope Public License', 'Programming Language :: Python', 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', 'Programming Language :: Python :: 3.11', + 'Programming Language :: Python :: 3.12', + 'Programming Language :: Python :: 3.13', 'Programming Language :: Python :: Implementation :: CPython', 'Programming Language :: Python :: Implementation :: PyPy', 'Natural Language :: English', @@ -83,7 +83,7 @@ def read(*rnames): packages=find_packages('src'), package_dir={'': 'src'}, namespace_packages=['zope', ], - python_requires='>=3.7', + python_requires='>=3.9', install_requires=[ 'setuptools', 'zope.interface>=4.0.2', diff --git a/src/zope/location/interfaces.py b/src/zope/location/interfaces.py index 8cebaa5..a9e4e0c 100644 --- a/src/zope/location/interfaces.py +++ b/src/zope/location/interfaces.py @@ -130,6 +130,6 @@ class LocationError(KeyError, LookupError): # backward-compatibility try: from zope.component.interfaces import ISite -except ImportError: # pragma: no cover +except ModuleNotFoundError: # pragma: no cover class ISite(Interface): pass diff --git a/src/zope/location/pickling.py b/src/zope/location/pickling.py index a895d67..5eb71fe 100644 --- a/src/zope/location/pickling.py +++ b/src/zope/location/pickling.py @@ -23,7 +23,7 @@ try: from zope.copy.interfaces import ICopyHook from zope.copy.interfaces import ResumeCopy -except ImportError: # pragma: no cover +except ModuleNotFoundError: # pragma: no cover raise NotImplementedError("zope.location.pickling is not supported " "because zope.copy is not available") diff --git a/src/zope/location/tests/test_location.py b/src/zope/location/tests/test_location.py index 51d2204..5e2f002 100644 --- a/src/zope/location/tests/test_location.py +++ b/src/zope/location/tests/test_location.py @@ -56,7 +56,7 @@ class Dummy: parent = Dummy() dummy = Dummy() self._callFUT(dummy, parent) - self.assertTrue(dummy.__parent__ is parent) + self.assertIs(dummy.__parent__, parent) self.assertEqual(dummy.__name__, None) def test_w_name(self): @@ -65,7 +65,7 @@ class Dummy: parent = Dummy() dummy = Dummy() self._callFUT(dummy, parent, 'name') - self.assertTrue(dummy.__parent__ is parent) + self.assertIs(dummy.__parent__, parent) self.assertEqual(dummy.__name__, 'name') @@ -87,7 +87,7 @@ class Dummy: parent = Dummy() dummy = Dummy() self._callFUT(dummy, parent) - self.assertTrue(dummy.__parent__ is parent) + self.assertIs(dummy.__parent__, parent) self.assertEqual(dummy.__name__, None) def test_w_name_adaptable_to_ILocation(self): @@ -110,7 +110,7 @@ class Dummy: self._callFUT(dummy, parent, 'name') finally: adapter_hooks[:] = before - self.assertTrue(dummy.__parent__ is parent) + self.assertIs(dummy.__parent__, parent) self.assertEqual(dummy.__name__, 'name') self.assertEqual(len(_hooked), 1) self.assertEqual(_hooked[0], (ILocation, dummy)) @@ -269,7 +269,7 @@ def test_ctor_explicit(self): dummy = object() # can't setattr parent = object() proxy = self._makeOne(dummy, parent, 'name') - self.assertTrue(proxy.__parent__ is parent) + self.assertIs(proxy.__parent__, parent) self.assertEqual(proxy.__name__, 'name') def test___getattribute___wrapped(self): diff --git a/src/zope/location/tests/test_pickling.py b/src/zope/location/tests/test_pickling.py index e838201..ddcc274 100644 --- a/src/zope/location/tests/test_pickling.py +++ b/src/zope/location/tests/test_pickling.py @@ -52,7 +52,7 @@ class Dummy: top_level = Dummy() context = Dummy() hook = self._makeOne(context) - self.assertTrue(hook(top_level, object()) is context) + self.assertIs(hook(top_level, object()), context) def test_suite(): diff --git a/src/zope/location/tests/test_traversing.py b/src/zope/location/tests/test_traversing.py index 7671b81..149e0f1 100644 --- a/src/zope/location/tests/test_traversing.py +++ b/src/zope/location/tests/test_traversing.py @@ -65,7 +65,7 @@ class Dummy: three = Dummy() three.__parent__ = two proxy = self._makeOne(three) - self.assertTrue(proxy.getRoot() is one) + self.assertIs(proxy.getRoot(), one) def test_getRoot_w_cycle(self): class Dummy: @@ -171,7 +171,7 @@ class Dummy: three.__parent__ = two three.__name__ = 'three' proxy = self._makeOne(three) - self.assertTrue(proxy.getParent() is two) + self.assertIs(proxy.getParent(), two) def test_getParents_not_location_aware(self): proxy = self._makeOne(object()) @@ -240,7 +240,7 @@ class Dummy: context = Dummy() directlyProvides(context, ISite) proxy = self._makeOne(context) - self.assertTrue(proxy.getNearestSite() is context) + self.assertIs(proxy.getNearestSite(), context) def test_getNearestSite_ancestor_is_site(self): from zope.interface import directlyProvides @@ -260,7 +260,7 @@ class Dummy: three.__parent__ = two three.__name__ = 'three' proxy = self._makeOne(three) - self.assertTrue(proxy.getNearestSite() is one) + self.assertIs(proxy.getNearestSite(), one) def test_getNearestSite_no_site(self): from zope.interface import directlyProvides @@ -278,7 +278,7 @@ class Dummy: three.__parent__ = two three.__name__ = 'three' proxy = self._makeOne(three) - self.assertTrue(proxy.getNearestSite() is one) + self.assertIs(proxy.getNearestSite(), one) class RootPhysicallyLocatableTests( @@ -296,7 +296,7 @@ def _makeOne(self, obj=None): def test_getRoot(self): context = object() proxy = self._makeOne(context) - self.assertTrue(proxy.getRoot() is context) + self.assertIs(proxy.getRoot(), context) def test_getPath(self): context = object() @@ -321,4 +321,4 @@ def test_getName(self): def test_getNearestSite(self): context = object() proxy = self._makeOne(context) - self.assertTrue(proxy.getNearestSite() is context) + self.assertIs(proxy.getNearestSite(), context)