Browse Source

Random cleanups

Remove some cruft from Sphinx config files, drop the use of 'u' prefixed
strings, which are unnecessary in Python 3, and generally tidy stuff up.

Change-Id: Ib0f33576e160ec842d7fc82b4fcfee99829623d7
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
changes/81/709081/1
Stephen Finucane 1 year ago
parent
commit
b9a7e03074
  1. 30
      HACKING.rst
  2. 24
      doc/source/conf.py
  3. 8
      novaclient/tests/unit/test_utils.py
  4. 2
      novaclient/tests/unit/v2/test_hypervisors.py
  5. 2
      novaclient/tests/unit/v2/test_instance_usage_audit_log.py
  6. 2
      novaclient/tests/unit/v2/test_servers.py
  7. 216
      releasenotes/source/conf.py

30
HACKING.rst

@ -5,30 +5,12 @@ Nova Client Style Commandments
https://docs.openstack.org/hacking/latest
- Step 2: Read on
Nova Client Specific Commandments
---------------------------------
None so far
Text encoding
-------------
- All text within python code should be of type 'unicode'.
WRONG:
>>> s = 'foo'
>>> s
'foo'
>>> type(s)
<type 'str'>
RIGHT:
>>> u = u'foo'
>>> u
u'foo'
>>> type(u)
<type 'unicode'>
- Transitions between internal unicode and external strings should always
be immediately and explicitly encoded or decoded.
@ -36,13 +18,13 @@ Text encoding
- All external text that is not explicitly encoded (database storage,
commandline arguments, etc.) should be presumed to be encoded as utf-8.
WRONG:
Wrong::
mystring = infile.readline()
myreturnstring = do_some_magic_with(mystring)
outfile.write(myreturnstring)
RIGHT:
Right::
mystring = infile.readline()
mytext = s.decode('utf-8')
@ -52,8 +34,8 @@ Text encoding
Running Tests
-------------
The testing system is based on a combination of tox and testr. If you just
want to run the whole suite, run `tox` and all will be fine. However, if
The testing system is based on a combination of tox and stestr. If you just
want to run the whole suite, run ``tox`` and all will be fine. However, if
you'd like to dig in a bit more, you might want to learn some things about
testr itself. A basic walkthrough for OpenStack can be found at
http://wiki.openstack.org/testr
stestr itself.

24
doc/source/conf.py

@ -33,12 +33,6 @@ apidoc_separate_modules = True
# directive.
autoclass_content = 'both'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
@ -48,19 +42,6 @@ bug_project = 'python-novaclient'
bug_tag = 'doc'
copyright = 'OpenStack Contributors'
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = []
# If true, '()' will be appended to :func: etc. cross-reference text.
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
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# -- Options for HTML output --------------------------------------------------
@ -72,11 +53,12 @@ html_theme = 'openstackdocs'
# robots.txt.
html_extra_path = ['_extra']
# -- Options for LaTeX output -------------------------------------------------
latex_documents = [
('index', 'doc-python-novaclient.tex', u'python-novaclient Documentation',
u'OpenStack Foundation', 'manual'),
('index', 'doc-python-novaclient.tex', 'python-novaclient Documentation',
'OpenStack Foundation', 'manual'),
]
latex_elements = {

8
novaclient/tests/unit/test_utils.py

@ -237,9 +237,9 @@ class PrintResultTestCase(test_utils.TestCase):
@mock.patch('sys.stdout', io.StringIO())
def test_print_unicode_list(self):
objs = [_FakeResult("k", u'\u2026')]
objs = [_FakeResult("k", '\u2026')]
utils.print_list(objs, ["Name", "Value"])
s = u'\u2026'
s = '\u2026'
self.assertEqual('+------+-------+\n'
'| Name | Value |\n'
'+------+-------+\n'
@ -314,9 +314,9 @@ class PrintResultTestCase(test_utils.TestCase):
@mock.patch('sys.stdout', io.StringIO())
def test_print_unicode_dict(self):
dict = {'k': u'\u2026'}
dict = {'k': '\u2026'}
utils.print_dict(dict)
s = u'\u2026'
s = '\u2026'
self.assertEqual('+----------+-------+\n'
'| Property | Value |\n'
'+----------+-------+\n'

2
novaclient/tests/unit/v2/test_hypervisors.py

@ -109,7 +109,7 @@ class HypervisorsTest(utils.FixturedTestCase):
self.compare_to_expected(expected[idx], hyper)
def test_hypervisor_search_unicode(self):
hypervisor_match = u'\\u5de5\\u4f5c'
hypervisor_match = '\\u5de5\\u4f5c'
if self.cs.api_version >= api_versions.APIVersion('2.53'):
self.assertRaises(exceptions.BadRequest,
self.cs.hypervisors.search,

2
novaclient/tests/unit/v2/test_instance_usage_audit_log.py

@ -38,6 +38,6 @@ class InstanceUsageAuditLogTests(utils.TestCase):
'/os-instance_usage_audit_log/2016-12-10%2013%3A59%3A59.999999')
def test_instance_usage_audit_log_with_before_unicode(self):
before = u'\\u5de5\\u4f5c'
before = '\\u5de5\\u4f5c'
self.assertRaises(exceptions.BadRequest,
self.cs.instance_usage_audit_log.get, before)

2
novaclient/tests/unit/v2/test_servers.py

@ -55,7 +55,7 @@ class ServersTest(utils.FixturedTestCase):
self.assertIsInstance(s, servers.Server)
def test_filter_servers_unicode(self):
sl = self.cs.servers.list(search_opts={'name': u't€sting'})
sl = self.cs.servers.list(search_opts={'name': 't€sting'})
self.assert_request_id(sl, fakes.FAKE_REQUEST_ID_LIST)
self.assert_called('GET', '/servers/detail?name=t%E2%82%ACsting')
for s in sl:

216
releasenotes/source/conf.py

@ -1,27 +1,9 @@
# -*- coding: utf-8 -*-
#
# Nova Client Release Notes documentation build configuration file, created by
# sphinx-quickstart on Mon Nov 23 20:38:38 2015.
#
# 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.
# 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('.'))
# python-novaclient Release Notes documentation build configuration file
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#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.
@ -30,59 +12,9 @@ extensions = [
'openstackdocstheme',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
copyright = u'2015, Nova developers'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#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 = []
# 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
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#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 = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Options for HTML output ----------------------------------------------
@ -90,151 +22,7 @@ pygments_style = 'sphinx'
# a list of builtin themes.
html_theme = 'openstackdocs'
# 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 = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#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
# 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
# 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,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# 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'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'NovaClientReleaseNotestdoc'
# -- Options for LaTeX output ---------------------------------------------
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'PythonNovaClient.tex', u'Nova Client Release Notes Documentation',
u'Nova developers', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'pythonnovaclient', u'Nova Client Release Notes Documentation',
[u'Nova developers'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- 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', 'PythonNovaClient', u'Nova Client Release Notes Documentation',
u'Nova developers', 'PythonNovaClient', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# -- Options for Internationalization output ------------------------------
locale_dirs = ['locale/']
Loading…
Cancel
Save